{"_id":"@dfulginiti/lotr-sdk","name":"@dfulginiti/lotr-sdk","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@dfulginiti/lotr-sdk","version":"1.0.0","description":"An SDK for The One API.","main":"./src/index.ts","scripts":{"test":"mocha"},"repository":{"type":"git","url":"git+https://github.com/dfulginiti/derek_fulginiti_sdk.git"},"author":{"name":"Derek Fulginiti"},"license":"MIT","devDependencies":{"@types/mocha":"^10.0.1","chai":"^4.3.7","chai-fetch-mock":"^3.0.0","fetch-mock":"^9.11.0","mocha":"^10.2.0","typescript":"^5.0.4"},"gitHead":"2a2af8a8e9c0ec31b9f56832940113ba03e5bf76","bugs":{"url":"https://github.com/dfulginiti/derek_fulginiti_sdk/issues"},"homepage":"https://github.com/dfulginiti/derek_fulginiti_sdk#readme","_id":"@dfulginiti/lotr-sdk@1.0.0","_nodeVersion":"18.8.0","_npmVersion":"8.18.0","dist":{"integrity":"sha512-BgfGOnC4mUYaunHZ563gelAE5Xo686Mjtwyh7wd+/qzKJ/H3PgOn/JBXcZnrMFRzrCMKiR0XD/Oi3CSGPr9njw==","shasum":"aef0eabccdf419db17ddf14d5765ed573920ed7c","tarball":"https://registry.npmjs.org/@dfulginiti/lotr-sdk/-/lotr-sdk-1.0.0.tgz","fileCount":12,"unpackedSize":8831,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCbU1Z75866nfIvgbcKWH8tv5FgLxryHoq8+6bt+iIANgIhAKEgw9zU+pq+qd7usBcqlmjRKMkkp8O3vE9P+dmZumrB"}]},"_npmUser":{"name":"dfulginiti","email":"derek.fulginiti@gmail.com"},"directories":{},"maintainers":[{"name":"dfulginiti","email":"derek.fulginiti@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/lotr-sdk_1.0.0_1683476196632_0.7934443235587361"},"_hasShrinkwrap":false}},"time":{"created":"2023-05-07T16:16:36.470Z","1.0.0":"2023-05-07T16:16:36.816Z","modified":"2023-05-07T16:16:37.150Z"},"maintainers":[{"name":"dfulginiti","email":"derek.fulginiti@gmail.com"}],"description":"An SDK for The One API.","homepage":"https://github.com/dfulginiti/derek_fulginiti_sdk#readme","repository":{"type":"git","url":"git+https://github.com/dfulginiti/derek_fulginiti_sdk.git"},"author":{"name":"Derek Fulginiti"},"bugs":{"url":"https://github.com/dfulginiti/derek_fulginiti_sdk/issues"},"license":"MIT","readme":"# derek_fulginiti_sdk\nSDK for The One API (Lord of the Rings informational API)\n\n## Installation\n```bash\nnpm install @dfulginiti/lotr-sdk\n```\n\n## Obtaining an API Key\n[Create an account](https://the-one-api.dev/sign-up) in order to obtain an API key.\n\n## Basic Usage\n\n### Initialization\n\nYou can initialize the Lotr class with the following syntax:\n\n```ts\nimport Lotr from '@dfulginiti/lotr-sdk';\n\nconst lotr = new Lotr('API_KEY');\n```\n\n### Resources\n\nThe SDK currently supports the Movie and Quote resources.\nWith it, you can retrieve either one or all of a specific resource.\nYou can also retrieve a list of quotes for a specific movie.\n\n### Example Usage\n\nFetching all movies\n\n```ts\nlotr.movies();\n```\n\nFetching one movie\n\n```ts\nlotr.movie('5cd95395de30eff6ebccde5b'); // The Two Towers\n```\n\nFetching movie quotes\n\n```ts\nlotr.movieQuotes('5cd95395de30eff6ebccde5b');\n```\n\n## Rate Limit\n\nYou may only hit the API up to 100 times in a 10 minute span, so use wisely!\n\n## Pagination, Filtering, and Sorting\n\nThe SDK does not currently support pagination, filtering, or sorting. Perhaps in the future!\n\n## API Documentation\n\nFor more information on the underlying API, please see: <https://the-one-api.dev/documentation>","readmeFilename":"README.md"}