@airtop/sdk 0.1.36 → 1.0.0-alpha2.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Airtop
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,154 +1,21 @@
-# Airtop TypeScript Library
-
-[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fairtop-ai%2Fairtop-node-sdk)
-[![npm shield](https://img.shields.io/npm/v/@airtop/sdk)](https://www.npmjs.com/package/@airtop/sdk)
-
-The Airtop TypeScript library provides convenient access to the Airtop API from TypeScript.
+# Airtop Typescript SDK
 
 ## Installation
 
-```sh
-npm i -s @airtop/sdk
+```bash
+npm install @airtop/sdk
 ```
 
-## Reference
-
-A full reference for this library is available [here](./reference.md).
-
 ## Usage
 
-Instantiate and use the client with the following:
-
-```typescript
-import { AirtopClient } from "@airtop/sdk";
-
-const client = new AirtopClient({ apiKey: "YOUR_API_KEY" });
-await client.windows.asyncCreateAutomation(
-    "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
-    "0334da2a-91b0-42c5-6156-76a5eba87430",
-);
-```
-
-## Request And Response Types
-
-The SDK exports all request and response types as TypeScript interfaces. Simply import them with the
-following namespace:
-
-```typescript
-import { Airtop } from "@airtop/sdk";
-
-const request: Airtop.AsyncCreateAutomationRequest = {
-    ...
-};
-```
-
-## Exception Handling
-
-When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
-will be thrown.
-
-```typescript
-import { AirtopError } from "@airtop/sdk";
-
-try {
-    await client.windows.asyncCreateAutomation(...);
-} catch (err) {
-    if (err instanceof AirtopError) {
-        console.log(err.statusCode);
-        console.log(err.message);
-        console.log(err.body);
-    }
-}
-```
-
-## Advanced
-
-### Additional Headers
-
-If you would like to send additional headers as part of the request, use the `headers` request option.
-
 ```typescript
-const response = await client.windows.asyncCreateAutomation(..., {
-    headers: {
-        'X-Custom-Header': 'custom value'
-    }
-});
-```
-
-### Retries
-
-The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
-as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
-retry limit (default: 2).
 
-A request is deemed retryable when any of the following HTTP status codes is returned:
-
-- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
-- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
-- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
-
-Use the `maxRetries` request option to configure this behavior.
-
-```typescript
-const response = await client.windows.asyncCreateAutomation(..., {
-    maxRetries: 0 // override maxRetries at the request level
-});
-```
-
-### Timeouts
-
-The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
-
-```typescript
-const response = await client.windows.asyncCreateAutomation(..., {
-    timeoutInSeconds: 30 // override timeout to 30s
-});
-```
-
-### Aborting Requests
-
-The SDK allows users to abort requests at any point by passing in an abort signal.
-
-```typescript
-const controller = new AbortController();
-const response = await client.windows.asyncCreateAutomation(..., {
-    abortSignal: controller.signal
-});
-controller.abort(); // aborts the request
-```
-
-### Runtime Compatibility
-
-The SDK defaults to `node-fetch` but will use the global fetch client if present. The SDK works in the following
-runtimes:
-
-- Node.js 18+
-- Vercel
-- Cloudflare Workers
-- Deno v1.25+
-- Bun 1.0+
-- React Native
-
-### Customizing Fetch Client
-
-The SDK provides a way for your to customize the underlying HTTP client / Fetch function. If you're running in an
-unsupported environment, this provides a way for you to break glass and ensure the SDK works.
-
-```typescript
-import { AirtopClient } from "@airtop/sdk";
+import { AirtopClient } from '@airtop/sdk';
 
 const client = new AirtopClient({
-    ...
-    fetcher: // provide your implementation here
+  apiKey: 'airtop-api-key'
 });
 ```
 
-## Contributing
-
-While we value open-source contributions to this SDK, this library is generated programmatically.
-Additions made directly to this library would have to be moved over to our generation code,
-otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
-a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
-an issue first to discuss with us!
-
-On the other hand, contributions to the README are always very welcome!
+- See [constructor options](https://docs-v2.airtop.ai/sdk/typescript/@airtop/sdk/interfaces/AirtopConstructorConfig/)
+- See [API documentation](https://docs-v2.airtop.ai/sdk/typescript/@airtop/sdk/classes/AirtopClient/)