@paid-ai/paid-node 0.0.5

package/README.md

@@ -0,0 +1,166 @@
+# Paid 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%2FAgentPaid%2Fpaid-node)
+[![npm shield](https://img.shields.io/npm/v/@paid-ai/paid-node)](https://www.npmjs.com/package/@paid-ai/paid-node)
+
+The Paid TypeScript library provides convenient access to the Paid API from TypeScript.
+
+## Installation
+
+```sh
+npm i -s @paid-ai/paid-node
+```
+
+## Reference
+
+A full reference for this library is available [here](https://github.com/AgentPaid/paid-node/blob/HEAD/./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```typescript
+import { PaidApiClient } from "@paid-ai/paid-node";
+
+const client = new PaidApiClient({ token: "YOUR_TOKEN" });
+await client.customers.create({
+    name: "name",
+});
+```
+
+## Request And Response Types
+
+The SDK exports all request and response types as TypeScript interfaces. Simply import them with the
+following namespace:
+
+```typescript
+import { PaidApi } from "@paid-ai/paid-node";
+
+const request: PaidApi.CustomerCreate = {
+    ...
+};
+```
+
+## 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 { PaidApiError } from "@paid-ai/paid-node";
+
+try {
+    await client.customers.create(...);
+} catch (err) {
+    if (err instanceof PaidApiError) {
+        console.log(err.statusCode);
+        console.log(err.message);
+        console.log(err.body);
+        console.log(err.rawResponse);
+    }
+}
+```
+
+## 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.customers.create(..., {
+    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.customers.create(..., {
+    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.customers.create(..., {
+    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.customers.create(..., {
+    abortSignal: controller.signal
+});
+controller.abort(); // aborts the request
+```
+
+### Access Raw Response Data
+
+The SDK provides access to raw response data, including headers, through the `.withRawResponse()` method.
+The `.withRawResponse()` method returns a promise that results to an object with a `data` and a `rawResponse` property.
+
+```typescript
+const { data, rawResponse } = await client.customers.create(...).withRawResponse();
+
+console.log(data);
+console.log(rawResponse.headers['X-My-Header']);
+```
+
+### 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 you 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 { PaidApiClient } from "@paid-ai/paid-node";
+
+const client = new PaidApiClient({
+    ...
+    fetcher: // provide your implementation here
+});
+```
+
+## 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!

package/dist/cjs/Client.d.ts

@@ -0,0 +1,44 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "./environments.js";
+import * as core from "./core/index.js";
+import { Customers } from "./api/resources/customers/client/Client.js";
+import { Agents } from "./api/resources/agents/client/Client.js";
+import { Contacts } from "./api/resources/contacts/client/Client.js";
+import { Orders } from "./api/resources/orders/client/Client.js";
+import { Usage } from "./api/resources/usage/client/Client.js";
+export declare namespace PaidApiClient {
+    interface Options {
+        environment?: core.Supplier<environments.PaidApiEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        token: core.Supplier<core.BearerToken>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+    }
+}
+export declare class PaidApiClient {
+    protected readonly _options: PaidApiClient.Options;
+    protected _customers: Customers | undefined;
+    protected _agents: Agents | undefined;
+    protected _contacts: Contacts | undefined;
+    protected _orders: Orders | undefined;
+    protected _usage: Usage | undefined;
+    constructor(_options: PaidApiClient.Options);
+    get customers(): Customers;
+    get agents(): Agents;
+    get contacts(): Contacts;
+    get orders(): Orders;
+    get usage(): Usage;
+}

package/dist/cjs/Client.js

@@ -0,0 +1,79 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PaidApiClient = void 0;
+const core = __importStar(require("./core/index.js"));
+const headers_js_1 = require("./core/headers.js");
+const Client_js_1 = require("./api/resources/customers/client/Client.js");
+const Client_js_2 = require("./api/resources/agents/client/Client.js");
+const Client_js_3 = require("./api/resources/contacts/client/Client.js");
+const Client_js_4 = require("./api/resources/orders/client/Client.js");
+const Client_js_5 = require("./api/resources/usage/client/Client.js");
+class PaidApiClient {
+    constructor(_options) {
+        this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
+                "X-Fern-Language": "JavaScript",
+                "X-Fern-SDK-Name": "@paid-ai/paid-node",
+                "X-Fern-SDK-Version": "0.0.5",
+                "User-Agent": "@paid-ai/paid-node/0.0.5",
+                "X-Fern-Runtime": core.RUNTIME.type,
+                "X-Fern-Runtime-Version": core.RUNTIME.version,
+            }, _options === null || _options === void 0 ? void 0 : _options.headers) });
+    }
+    get customers() {
+        var _a;
+        return ((_a = this._customers) !== null && _a !== void 0 ? _a : (this._customers = new Client_js_1.Customers(this._options)));
+    }
+    get agents() {
+        var _a;
+        return ((_a = this._agents) !== null && _a !== void 0 ? _a : (this._agents = new Client_js_2.Agents(this._options)));
+    }
+    get contacts() {
+        var _a;
+        return ((_a = this._contacts) !== null && _a !== void 0 ? _a : (this._contacts = new Client_js_3.Contacts(this._options)));
+    }
+    get orders() {
+        var _a;
+        return ((_a = this._orders) !== null && _a !== void 0 ? _a : (this._orders = new Client_js_4.Orders(this._options)));
+    }
+    get usage() {
+        var _a;
+        return ((_a = this._usage) !== null && _a !== void 0 ? _a : (this._usage = new Client_js_5.Usage(this._options)));
+    }
+}
+exports.PaidApiClient = PaidApiClient;

package/dist/cjs/api/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./types/index.js";
+export * from "./resources/index.js";

package/dist/cjs/api/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./types/index.js"), exports);
+__exportStar(require("./resources/index.js"), exports);

package/dist/cjs/api/resources/agents/client/Client.d.ts

@@ -0,0 +1,107 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments.js";
+import * as core from "../../../../core/index.js";
+import * as PaidApi from "../../../index.js";
+export declare namespace Agents {
+    interface Options {
+        environment?: core.Supplier<environments.PaidApiEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        token: core.Supplier<core.BearerToken>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+    }
+}
+export declare class Agents {
+    protected readonly _options: Agents.Options;
+    constructor(_options: Agents.Options);
+    /**
+     * @param {Agents.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.agents.list()
+     */
+    list(requestOptions?: Agents.RequestOptions): core.HttpResponsePromise<PaidApi.Agent[]>;
+    private __list;
+    /**
+     * @param {PaidApi.AgentCreate} request
+     * @param {Agents.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.agents.create({
+     *         name: "name",
+     *         description: "description"
+     *     })
+     */
+    create(request: PaidApi.AgentCreate, requestOptions?: Agents.RequestOptions): core.HttpResponsePromise<PaidApi.Agent>;
+    private __create;
+    /**
+     * @param {string} agentId
+     * @param {Agents.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.agents.get("agentId")
+     */
+    get(agentId: string, requestOptions?: Agents.RequestOptions): core.HttpResponsePromise<PaidApi.Agent>;
+    private __get;
+    /**
+     * @param {string} agentId
+     * @param {PaidApi.AgentUpdate} request
+     * @param {Agents.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.agents.update("agentId", {})
+     */
+    update(agentId: string, request: PaidApi.AgentUpdate, requestOptions?: Agents.RequestOptions): core.HttpResponsePromise<PaidApi.Agent>;
+    private __update;
+    /**
+     * @param {string} agentId
+     * @param {Agents.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.agents.delete("agentId")
+     */
+    delete(agentId: string, requestOptions?: Agents.RequestOptions): core.HttpResponsePromise<void>;
+    private __delete;
+    /**
+     * @param {string} externalId
+     * @param {Agents.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.agents.getByExternalId("externalId")
+     */
+    getByExternalId(externalId: string, requestOptions?: Agents.RequestOptions): core.HttpResponsePromise<PaidApi.Agent>;
+    private __getByExternalId;
+    /**
+     * @param {string} externalId
+     * @param {PaidApi.AgentUpdate} request
+     * @param {Agents.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.agents.updateByExternalId("externalId", {})
+     */
+    updateByExternalId(externalId: string, request: PaidApi.AgentUpdate, requestOptions?: Agents.RequestOptions): core.HttpResponsePromise<PaidApi.Agent>;
+    private __updateByExternalId;
+    /**
+     * @param {string} externalId
+     * @param {Agents.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.agents.deleteByExternalId("externalId")
+     */
+    deleteByExternalId(externalId: string, requestOptions?: Agents.RequestOptions): core.HttpResponsePromise<void>;
+    private __deleteByExternalId;
+    protected _getAuthorizationHeader(): Promise<string>;
+}