{"_id":"@atechadventurer/birdweather","_rev":"2-06767b608af34c49e538a2c0789d1492","name":"@atechadventurer/birdweather","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"@atechadventurer/birdweather","version":"1.0.0","keywords":["typescript","sdk","api","client"],"author":"","_id":"@atechadventurer/birdweather@1.0.0","maintainers":[{"name":"atechadventurer","email":"Cam.steeleis@gmail.com"}],"dist":{"shasum":"e7d24f939d9c9ff5531aaf38c9d92188da51a1d0","tarball":"https://registry.npmjs.org/@atechadventurer/birdweather/-/birdweather-1.0.0.tgz","fileCount":5,"integrity":"sha512-XT42qPZpCd89k1FD/GWibpJfRlc/agwNPISKHsbXzbvSIv4pVF+X2LBTZDQsnDiBiJu9FSPWYE3JEHk7sgEjWA==","signatures":[{"sig":"MEUCIHmEYwB3fBjyyGGzSWbKti98GvQRk+kYCWvoNNJfeA+2AiEAtdvxlGEtfjX/KMfoIvxReHGkHUL481EaRAcRUTxHMnY=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":329861},"main":"./dist/index.js","types":"./dist/index.d.ts","unpkg":"./dist/index.js","module":"./dist/index.mjs","source":"./src/index.ts","browser":"./dist/index.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","require":"./dist/index.js"}},"private":false,"scripts":{"test":"tsc --noEmit","build":"tsup-node src/index.ts --format cjs,esm --dts --clean","prepublishOnly":"npm run build"},"_npmUser":{"name":"atechadventurer","email":"Cam.steeleis@gmail.com"},"_npmVersion":"10.8.2","description":"This is the OpenAPI specification for V1 of the BirdWeather API.","directories":{},"_nodeVersion":"20.17.0","dependencies":{"zod":"3.22.0"},"_hasShrinkwrap":false,"devDependencies":{"tsup":"^6.7.0","typescript":"5.3.3","@types/node":"^22.13.9"},"_npmOperationalInternal":{"tmp":"tmp/birdweather_1.0.0_1746117322722_0.7059101254032749","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"name":"@atechadventurer/birdweather","version":"1.0.1","description":"This is the OpenAPI specification for V1 of the BirdWeather API.","source":"./src/index.ts","main":"./dist/index.js","module":"./dist/index.mjs","browser":"./dist/index.js","unpkg":"./dist/index.js","types":"./dist/index.d.ts","private":false,"scripts":{"test":"tsc --noEmit","build":"tsup-node src/index.ts --format cjs,esm --dts --clean","prepublishOnly":"npm run build"},"keywords":["typescript","sdk","api","client"],"author":"","devDependencies":{"typescript":"5.3.3","@types/node":"^22.13.9","tsup":"^6.7.0"},"dependencies":{"zod":"3.22.0"},"exports":{".":{"require":"./dist/index.js","import":"./dist/index.js","types":"./dist/index.d.ts"}},"_id":"@atechadventurer/birdweather@1.0.1","_nodeVersion":"20.17.0","_npmVersion":"10.8.2","dist":{"integrity":"sha512-VDT3XG4cfWOZsvZxyTc7XPgQ5uO9vdfQDhhM/FjEGlH2EZcn9KMojje2P9DOzhxWjrwpAyzLw0J4dECFWvPhSg==","shasum":"40030fc302d9f1ef407663843f24d1aa14b94f9d","tarball":"https://registry.npmjs.org/@atechadventurer/birdweather/-/birdweather-1.0.1.tgz","fileCount":36,"unpackedSize":368175,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIEKH7OLO3QsnQbVFb03Pv1Fi7Q5M/y4Bc+15QoEiL7BtAiB9sZWvmcJCFBSYCckF6PKz/BBHQ/J3sEvdOsBJtey4dA=="}]},"_npmUser":{"name":"atechadventurer","email":"Cam.steeleis@gmail.com"},"directories":{},"maintainers":[{"name":"atechadventurer","email":"Cam.steeleis@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/birdweather_1.0.1_1746217869145_0.5984485753494226"},"_hasShrinkwrap":false}},"time":{"created":"2025-05-01T16:35:22.650Z","modified":"2025-05-02T20:31:09.507Z","1.0.0":"2025-05-01T16:35:22.927Z","1.0.1":"2025-05-02T20:31:09.329Z"},"keywords":["typescript","sdk","api","client"],"description":"This is the OpenAPI specification for V1 of the BirdWeather API.","maintainers":[{"name":"atechadventurer","email":"Cam.steeleis@gmail.com"}],"readme":"# BirdweatherSdk TypeScript SDK 1.0.0\n\nWelcome to the BirdweatherSdk SDK documentation. This guide will help you get started with integrating and using the BirdweatherSdk SDK in your project.\n\n[![This SDK was generated by liblab](https://public-liblab-readme-assets.s3.us-east-1.amazonaws.com/built-by-liblab-icon.svg)](https://liblab.com/?utm_source=readme)\n\n## Versions\n\n- API version: `1.0.0`\n- SDK version: `1.0.0`\n\n## About the API\n\nThis is the OpenAPI specification for V1 of the BirdWeather API.\n\n## Table of Contents\n\n- [Setup & Configuration](#setup--configuration)\n - [Supported Language Versions](#supported-language-versions)\n - [Installation](#installation)\n- [Authentication](#authentication)\n - [API Key Authentication](#api-key-authentication)\n- [Setting a Custom Timeout](#setting-a-custom-timeout)\n- [Sample Usage](#sample-usage)\n- [Services](#services)\n- [Models](#models)\n\n# Setup & Configuration\n\n## Supported Language Versions\n\nThis SDK is compatible with the following versions: `TypeScript >= 4.8.4`\n\n## Installation\n\nTo get started with the SDK, we recommend installing using `npm`:\n\n```bash\nnpm install @atechadventurer/birdweather\n```\n\n## Authentication\n\n### API Key Authentication\n\nThe BirdweatherSdk API uses API keys as a form of authentication. An API key is a unique identifier used to authenticate a user, developer, or a program that is calling the API.\n\n#### Setting the API key\n\nWhen you initialize the SDK, you can set the API key as follows:\n\n```ts\nconst sdk = new BirdweatherSdk({ apiKey: 'YOUR_API_KEY' });\n```\n\nIf you need to set or update the API key after initializing the SDK, you can use:\n\n```ts\nconst sdk = new BirdweatherSdk();\nsdk.apiKey = 'YOUR_API_KEY';\n```\n\n## Setting a Custom Timeout\n\nYou can set a custom timeout for the SDK's HTTP requests as follows:\n\n```ts\nconst birdweatherSdk = new BirdweatherSdk({ timeout: 10000 });\n```\n\n# Sample Usage\n\nBelow is a comprehensive example demonstrating how to authenticate and call a simple endpoint:\n\n```ts\nimport { BirdweatherSdk } from '@atechadventurer/birdweather';\n\n(async () => {\n const birdweatherSdk = new BirdweatherSdk({\n apiKey: 'YOUR_API_KEY',\n });\n\n const period = 'day';\n\n const { data } = await birdweatherSdk.stations.getStationStats('1234567890', {\n period: period,\n since: '2023-10-01',\n });\n\n console.log(data);\n})();\n```\n\n## Services\n\nThe SDK provides various services to interact with the API.\n\n
\nBelow is a list of all available services with links to their detailed documentation:\n\n| Name |\n| :----------------------------------------------------------- |\n| [StationsService](documentation/services/StationsService.md) |\n| [SpeciesService](documentation/services/SpeciesService.md) |\n\n
\n\n## Models\n\nThe SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.\n\n
\nBelow is a list of all available models with links to their detailed documentation:\n\n| Name | Description |\n| :----------------------------------------------------------------------------------------------- | :--------------------------------------------------------------- |\n| [Period](documentation/models/Period.md) | The time period to filter detections. |\n| [GetStationStatsOkResponse](documentation/models/GetStationStatsOkResponse.md) | |\n| [ErrorResponse](documentation/models/ErrorResponse.md) | |\n| [Sort](documentation/models/Sort.md) | |\n| [Order](documentation/models/Order.md) | Sort order. Default is asc when sorting by name, otherwise desc. |\n| [ListStationSpeciesOkResponse](documentation/models/ListStationSpeciesOkResponse.md) | |\n| [ListStationDetectionsOkResponse](documentation/models/ListStationDetectionsOkResponse.md) | |\n| [Detection](documentation/models/Detection.md) | |\n| [RegisterDetectionRequest](documentation/models/RegisterDetectionRequest.md) | |\n| [RegisterDetectionCreatedResponse](documentation/models/RegisterDetectionCreatedResponse.md) | |\n| [\\_\\_](documentation/models/__.md) | |\n| [GetStationDetectionByIdOkResponse](documentation/models/GetStationDetectionByIdOkResponse.md) | |\n| [ListStationSoundscapesOkResponse](documentation/models/ListStationSoundscapesOkResponse.md) | |\n| [Soundscape](documentation/models/Soundscape.md) | |\n| [UploadSoundscapeCreatedResponse](documentation/models/UploadSoundscapeCreatedResponse.md) | |\n| [GetStationSoundscapeByIdOkResponse](documentation/models/GetStationSoundscapeByIdOkResponse.md) | |\n| [StationConfig](documentation/models/StationConfig.md) | |\n| [UpdateStationConfigOkResponse](documentation/models/UpdateStationConfigOkResponse.md) | |\n| [Station](documentation/models/Station.md) | |\n| [GetSpeciesByIdOkResponse](documentation/models/GetSpeciesByIdOkResponse.md) | |\n| [Species](documentation/models/Species.md) | |\n| [ErrorResponse](documentation/models/ErrorResponse.md) | |\n| [LookupSpeciesRequest](documentation/models/LookupSpeciesRequest.md) | |\n| [LookupSpeciesOkResponse](documentation/models/LookupSpeciesOkResponse.md) | |\n\n
\n","readmeFilename":"README.md"}