@paygentic/sdk 0.3.1-beta.0

package/README.md

@@ -0,0 +1,625 @@
+# paygentic
+
+Developer-friendly & type-safe Typescript SDK specifically catered to leverage *paygentic* API.
+
+<div align="left">
+    <a href="https://www.speakeasy.com/?utm_source=paygentic&utm_campaign=typescript"><img src="https://www.speakeasy.com/assets/badges/built-by-speakeasy.svg" /></a>
+    <a href="https://opensource.org/licenses/MIT">
+        <img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" />
+    </a>
+</div>
+
+
+<br /><br />
+> [!IMPORTANT]
+> This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your [workspace](https://app.speakeasy.com/org/paygentic/default). Delete this section before > publishing to a package manager.
+
+<!-- Start Summary [summary] -->
+## Summary
+
+Paygentic API: The Paygentic API provides a comprehensive platform for building and scaling monetization infrastructure.
+
+## Authentication
+All API requests require authentication using an API key passed in the `Authorization` header:
+```
+Authorization: Bearer YOUR_API_KEY
+```
+
+## Base URL
+All API requests should be made to:
+```
+https://api.paygentic.io/v0
+```
+<!-- End Summary [summary] -->
+
+<!-- Start Table of Contents [toc] -->
+## Table of Contents
+<!-- $toc-max-depth=2 -->
+* [paygentic](#paygentic)
+  * [Authentication](#authentication)
+  * [Base URL](#base-url)
+  * [SDK Installation](#sdk-installation)
+  * [Requirements](#requirements)
+  * [SDK Example Usage](#sdk-example-usage)
+  * [Authentication](#authentication-1)
+  * [Available Resources and Operations](#available-resources-and-operations)
+  * [Standalone functions](#standalone-functions)
+  * [Retries](#retries)
+  * [Error Handling](#error-handling)
+  * [Server Selection](#server-selection)
+  * [Custom HTTP Client](#custom-http-client)
+  * [Debugging](#debugging)
+* [Development](#development)
+  * [Maturity](#maturity)
+  * [Contributions](#contributions)
+
+<!-- End Table of Contents [toc] -->
+
+<!-- Start SDK Installation [installation] -->
+## SDK Installation
+
+The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
+
+### NPM
+
+```bash
+npm add @paygentic/sdk
+```
+
+### PNPM
+
+```bash
+pnpm add @paygentic/sdk
+```
+
+### Bun
+
+```bash
+bun add @paygentic/sdk
+```
+
+### Yarn
+
+```bash
+yarn add @paygentic/sdk
+```
+
+> [!NOTE]
+> This package is published with CommonJS and ES Modules (ESM) support.
+<!-- End SDK Installation [installation] -->
+
+<!-- Start Requirements [requirements] -->
+## Requirements
+
+For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
+<!-- End Requirements [requirements] -->
+
+<!-- Start SDK Example Usage [usage] -->
+## SDK Example Usage
+
+### Example
+
+```typescript
+import { Paygentic } from "@paygentic/sdk";
+
+const paygentic = new Paygentic({
+  bearerAuth: process.env["PAYGENTIC_BEARER_AUTH"] ?? "",
+});
+
+async function run() {
+  const result = await paygentic.merchants.get({
+    id: "<id>",
+  });
+
+  console.log(result);
+}
+
+run();
+
+```
+<!-- End SDK Example Usage [usage] -->
+
+<!-- Start Authentication [security] -->
+## Authentication
+
+### Per-Client Security Schemes
+
+This SDK supports the following security scheme globally:
+
+| Name         | Type | Scheme      | Environment Variable    |
+| ------------ | ---- | ----------- | ----------------------- |
+| `bearerAuth` | http | HTTP Bearer | `PAYGENTIC_BEARER_AUTH` |
+
+To authenticate with the API the `bearerAuth` parameter must be set when initializing the SDK client instance. For example:
+```typescript
+import { Paygentic } from "@paygentic/sdk";
+
+const paygentic = new Paygentic({
+  bearerAuth: process.env["PAYGENTIC_BEARER_AUTH"] ?? "",
+});
+
+async function run() {
+  const result = await paygentic.merchants.get({
+    id: "<id>",
+  });
+
+  console.log(result);
+}
+
+run();
+
+```
+<!-- End Authentication [security] -->
+
+<!-- Start Available Resources and Operations [operations] -->
+## Available Resources and Operations
+
+<details open>
+<summary>Available methods</summary>
+
+### [billableMetrics](docs/sdks/billablemetrics/README.md)
+
+* [create](docs/sdks/billablemetrics/README.md#create) - Create a new billable metric
+* [list](docs/sdks/billablemetrics/README.md#list) - List billable metrics
+* [get](docs/sdks/billablemetrics/README.md#get) - Get billable metric by ID
+* [update](docs/sdks/billablemetrics/README.md#update) - Update billable metric
+* [getPrice](docs/sdks/billablemetrics/README.md#getprice) - Get billable metric price for a subscription
+* [getPriceLegacy](docs/sdks/billablemetrics/README.md#getpricelegacy) - Get billable metric price for a subscription
+
+### [consumers](docs/sdks/consumers/README.md)
+
+* [get](docs/sdks/consumers/README.md#get) - Get consumer
+* [listOffSessionPaymentMethods](docs/sdks/consumers/README.md#listoffsessionpaymentmethods) - List off-session payment methods
+
+### [customers](docs/sdks/customers/README.md)
+
+* [list](docs/sdks/customers/README.md#list) - List customers of a merchant organization
+* [create](docs/sdks/customers/README.md#create) - Create new customer
+* [get](docs/sdks/customers/README.md#get) - Get customer details
+* [updateCustomer](docs/sdks/customers/README.md#updatecustomer) - Update customer details
+* [createAuthorizationSession](docs/sdks/customers/README.md#createauthorizationsession) - Create authorization session for customer
+* [checkAuthorizationSessionStatus](docs/sdks/customers/README.md#checkauthorizationsessionstatus) - Fetch the authorization session
+
+### [disputes](docs/sdks/disputes/README.md)
+
+* [create](docs/sdks/disputes/README.md#create) - Create a dispute for a usage event
+* [list](docs/sdks/disputes/README.md#list) - List disputes
+
+### [entitlements](docs/sdks/entitlements/README.md)
+
+* [listActive](docs/sdks/entitlements/README.md#listactive) - Get active entitlements for a customer
+* [create](docs/sdks/entitlements/README.md#create) - Create an entitlement
+
+### [externalBankAccounts](docs/sdks/externalbankaccounts/README.md)
+
+* [create](docs/sdks/externalbankaccounts/README.md#create) - Create a new external bank account
+* [list](docs/sdks/externalbankaccounts/README.md#list) - List external bank accounts
+* [get](docs/sdks/externalbankaccounts/README.md#get) - Get an external bank account
+* [update](docs/sdks/externalbankaccounts/README.md#update) - Update an external bank account
+* [delete](docs/sdks/externalbankaccounts/README.md#delete) - Delete an external bank account
+
+### [merchants](docs/sdks/merchants/README.md)
+
+* [get](docs/sdks/merchants/README.md#get) - Get merchant organization by ID
+* [listEligibleCountries](docs/sdks/merchants/README.md#listeligiblecountries) - Get a list of supported countries and geographies for merchant services.
+
+
+### [payouts](docs/sdks/payouts/README.md)
+
+* [list](docs/sdks/payouts/README.md#list) - Get a list of payouts
+* [listMethods](docs/sdks/payouts/README.md#listmethods) - Get a list of payout methods
+* [get](docs/sdks/payouts/README.md#get) - Get a payout by ID
+
+### [plans](docs/sdks/plans/README.md)
+
+* [create](docs/sdks/plans/README.md#create) - Create a new plan
+* [list](docs/sdks/plans/README.md#list) - List plans
+* [get](docs/sdks/plans/README.md#get) - Get a plan by ID
+* [update](docs/sdks/plans/README.md#update) - Update a plan
+
+### [prices](docs/sdks/prices/README.md)
+
+* [create](docs/sdks/prices/README.md#create) - Create a new price
+* [list](docs/sdks/prices/README.md#list) - List prices
+* [get](docs/sdks/prices/README.md#get) - Get a price by ID
+* [update](docs/sdks/prices/README.md#update) - Update a price
+
+### [products](docs/sdks/products/README.md)
+
+* [create](docs/sdks/products/README.md#create) - Create a new product
+* [list](docs/sdks/products/README.md#list) - List products
+* [get](docs/sdks/products/README.md#get) - Get product by ID
+* [update](docs/sdks/products/README.md#update) - Update product
+
+### [sources](docs/sdks/sources/README.md)
+
+* [add](docs/sdks/sources/README.md#add) - Create a new source
+* [list](docs/sdks/sources/README.md#list) - List sources
+* [get](docs/sdks/sources/README.md#get) - Get source by ID
+* [update](docs/sdks/sources/README.md#update) - Update source
+* [listEvents](docs/sdks/sources/README.md#listevents) - List source events
+* [approveEvent](docs/sdks/sources/README.md#approveevent) - Approve source event
+* [rejectEvent](docs/sdks/sources/README.md#rejectevent) - Reject source event
+* [bulkApproveEvents](docs/sdks/sources/README.md#bulkapproveevents) - Bulk approve source events
+* [listRules](docs/sdks/sources/README.md#listrules) - List source rules
+* [create](docs/sdks/sources/README.md#create) - Create a new source rule
+* [getRule](docs/sdks/sources/README.md#getrule) - Get a specific source rule
+* [updateRule](docs/sdks/sources/README.md#updaterule) - Update a source rule
+* [delete](docs/sdks/sources/README.md#delete) - Delete a source rule
+
+#### [sources.events](docs/sdks/events/README.md)
+
+* [bulkReject](docs/sdks/events/README.md#bulkreject) - Bulk reject source events
+
+### [subscriptions](docs/sdks/subscriptions/README.md)
+
+* [list](docs/sdks/subscriptions/README.md#list) - List subscriptions
+* [get](docs/sdks/subscriptions/README.md#get) - Get a subscription
+* [generatePortalLink](docs/sdks/subscriptions/README.md#generateportallink) - Generate customer portal access link
+
+### [usageEvents](docs/sdks/usageevents/README.md)
+
+* [create](docs/sdks/usageevents/README.md#create) - Create a usage event
+* [list](docs/sdks/usageevents/README.md#list) - List usage events
+* [get](docs/sdks/usageevents/README.md#get) - Get a usage event by ID
+* [batchCreate](docs/sdks/usageevents/README.md#batchcreate) - Batch create usage events
+
+### [users](docs/sdks/users/README.md)
+
+* [get](docs/sdks/users/README.md#get) - Get user by ID
+* [update](docs/sdks/users/README.md#update) - Update user
+
+### [wallets](docs/sdks/wallets/README.md)
+
+* [list](docs/sdks/wallets/README.md#list) - List wallets owned by an organization or associated with a plan
+* [get](docs/sdks/wallets/README.md#get) - Get wallet by ID
+* [createTopup](docs/sdks/wallets/README.md#createtopup) - Create a new topup for a wallet
+* [listTopups](docs/sdks/wallets/README.md#listtopups) - List topups for a wallet
+* [getTopup](docs/sdks/wallets/README.md#gettopup) - Get a specific topup by ID
+
+</details>
+<!-- End Available Resources and Operations [operations] -->
+
+<!-- Start Standalone functions [standalone-funcs] -->
+## Standalone functions
+
+All the methods listed above are available as standalone functions. These
+functions are ideal for use in applications running in the browser, serverless
+runtimes or other environments where application bundle size is a primary
+concern. When using a bundler to build your application, all unused
+functionality will be either excluded from the final bundle or tree-shaken away.
+
+To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
+
+<details>
+
+<summary>Available standalone functions</summary>
+
+- [`billableMetricsCreate`](docs/sdks/billablemetrics/README.md#create) - Create a new billable metric
+- [`billableMetricsGet`](docs/sdks/billablemetrics/README.md#get) - Get billable metric by ID
+- [`billableMetricsGetPrice`](docs/sdks/billablemetrics/README.md#getprice) - Get billable metric price for a subscription
+- [`billableMetricsGetPriceLegacy`](docs/sdks/billablemetrics/README.md#getpricelegacy) - Get billable metric price for a subscription
+- [`billableMetricsList`](docs/sdks/billablemetrics/README.md#list) - List billable metrics
+- [`billableMetricsUpdate`](docs/sdks/billablemetrics/README.md#update) - Update billable metric
+- [`consumersGet`](docs/sdks/consumers/README.md#get) - Get consumer
+- [`consumersListOffSessionPaymentMethods`](docs/sdks/consumers/README.md#listoffsessionpaymentmethods) - List off-session payment methods
+- [`customersCheckAuthorizationSessionStatus`](docs/sdks/customers/README.md#checkauthorizationsessionstatus) - Fetch the authorization session
+- [`customersCreate`](docs/sdks/customers/README.md#create) - Create new customer
+- [`customersCreateAuthorizationSession`](docs/sdks/customers/README.md#createauthorizationsession) - Create authorization session for customer
+- [`customersGet`](docs/sdks/customers/README.md#get) - Get customer details
+- [`customersList`](docs/sdks/customers/README.md#list) - List customers of a merchant organization
+- [`customersUpdateCustomer`](docs/sdks/customers/README.md#updatecustomer) - Update customer details
+- [`disputesCreate`](docs/sdks/disputes/README.md#create) - Create a dispute for a usage event
+- [`disputesList`](docs/sdks/disputes/README.md#list) - List disputes
+- [`entitlementsCreate`](docs/sdks/entitlements/README.md#create) - Create an entitlement
+- [`entitlementsListActive`](docs/sdks/entitlements/README.md#listactive) - Get active entitlements for a customer
+- [`externalBankAccountsCreate`](docs/sdks/externalbankaccounts/README.md#create) - Create a new external bank account
+- [`externalBankAccountsDelete`](docs/sdks/externalbankaccounts/README.md#delete) - Delete an external bank account
+- [`externalBankAccountsGet`](docs/sdks/externalbankaccounts/README.md#get) - Get an external bank account
+- [`externalBankAccountsList`](docs/sdks/externalbankaccounts/README.md#list) - List external bank accounts
+- [`externalBankAccountsUpdate`](docs/sdks/externalbankaccounts/README.md#update) - Update an external bank account
+- [`merchantsGet`](docs/sdks/merchants/README.md#get) - Get merchant organization by ID
+- [`merchantsListEligibleCountries`](docs/sdks/merchants/README.md#listeligiblecountries) - Get a list of supported countries and geographies for merchant services.
+- [`payoutsGet`](docs/sdks/payouts/README.md#get) - Get a payout by ID
+- [`payoutsList`](docs/sdks/payouts/README.md#list) - Get a list of payouts
+- [`payoutsListMethods`](docs/sdks/payouts/README.md#listmethods) - Get a list of payout methods
+- [`plansCreate`](docs/sdks/plans/README.md#create) - Create a new plan
+- [`plansGet`](docs/sdks/plans/README.md#get) - Get a plan by ID
+- [`plansList`](docs/sdks/plans/README.md#list) - List plans
+- [`plansUpdate`](docs/sdks/plans/README.md#update) - Update a plan
+- [`pricesCreate`](docs/sdks/prices/README.md#create) - Create a new price
+- [`pricesGet`](docs/sdks/prices/README.md#get) - Get a price by ID
+- [`pricesList`](docs/sdks/prices/README.md#list) - List prices
+- [`pricesUpdate`](docs/sdks/prices/README.md#update) - Update a price
+- [`productsCreate`](docs/sdks/products/README.md#create) - Create a new product
+- [`productsGet`](docs/sdks/products/README.md#get) - Get product by ID
+- [`productsList`](docs/sdks/products/README.md#list) - List products
+- [`productsUpdate`](docs/sdks/products/README.md#update) - Update product
+- [`sourcesAdd`](docs/sdks/sources/README.md#add) - Create a new source
+- [`sourcesApproveEvent`](docs/sdks/sources/README.md#approveevent) - Approve source event
+- [`sourcesBulkApproveEvents`](docs/sdks/sources/README.md#bulkapproveevents) - Bulk approve source events
+- [`sourcesCreate`](docs/sdks/sources/README.md#create) - Create a new source rule
+- [`sourcesDelete`](docs/sdks/sources/README.md#delete) - Delete a source rule
+- [`sourcesEventsBulkReject`](docs/sdks/events/README.md#bulkreject) - Bulk reject source events
+- [`sourcesGet`](docs/sdks/sources/README.md#get) - Get source by ID
+- [`sourcesGetRule`](docs/sdks/sources/README.md#getrule) - Get a specific source rule
+- [`sourcesList`](docs/sdks/sources/README.md#list) - List sources
+- [`sourcesListEvents`](docs/sdks/sources/README.md#listevents) - List source events
+- [`sourcesListRules`](docs/sdks/sources/README.md#listrules) - List source rules
+- [`sourcesRejectEvent`](docs/sdks/sources/README.md#rejectevent) - Reject source event
+- [`sourcesUpdate`](docs/sdks/sources/README.md#update) - Update source
+- [`sourcesUpdateRule`](docs/sdks/sources/README.md#updaterule) - Update a source rule
+- [`subscriptionsGeneratePortalLink`](docs/sdks/subscriptions/README.md#generateportallink) - Generate customer portal access link
+- [`subscriptionsGet`](docs/sdks/subscriptions/README.md#get) - Get a subscription
+- [`subscriptionsList`](docs/sdks/subscriptions/README.md#list) - List subscriptions
+- [`usageEventsBatchCreate`](docs/sdks/usageevents/README.md#batchcreate) - Batch create usage events
+- [`usageEventsCreate`](docs/sdks/usageevents/README.md#create) - Create a usage event
+- [`usageEventsGet`](docs/sdks/usageevents/README.md#get) - Get a usage event by ID
+- [`usageEventsList`](docs/sdks/usageevents/README.md#list) - List usage events
+- [`usersGet`](docs/sdks/users/README.md#get) - Get user by ID
+- [`usersUpdate`](docs/sdks/users/README.md#update) - Update user
+- [`walletsCreateTopup`](docs/sdks/wallets/README.md#createtopup) - Create a new topup for a wallet
+- [`walletsGet`](docs/sdks/wallets/README.md#get) - Get wallet by ID
+- [`walletsGetTopup`](docs/sdks/wallets/README.md#gettopup) - Get a specific topup by ID
+- [`walletsList`](docs/sdks/wallets/README.md#list) - List wallets owned by an organization or associated with a plan
+- [`walletsListTopups`](docs/sdks/wallets/README.md#listtopups) - List topups for a wallet
+
+</details>
+<!-- End Standalone functions [standalone-funcs] -->
+
+<!-- Start Retries [retries] -->
+## Retries
+
+Some of the endpoints in this SDK support retries.  If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API.  However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
+
+To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
+```typescript
+import { Paygentic } from "@paygentic/sdk";
+
+const paygentic = new Paygentic({
+  bearerAuth: process.env["PAYGENTIC_BEARER_AUTH"] ?? "",
+});
+
+async function run() {
+  const result = await paygentic.merchants.get({
+    id: "<id>",
+  }, {
+    retries: {
+      strategy: "backoff",
+      backoff: {
+        initialInterval: 1,
+        maxInterval: 50,
+        exponent: 1.1,
+        maxElapsedTime: 100,
+      },
+      retryConnectionErrors: false,
+    },
+  });
+
+  console.log(result);
+}
+
+run();
+
+```
+
+If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
+```typescript
+import { Paygentic } from "@paygentic/sdk";
+
+const paygentic = new Paygentic({
+  retryConfig: {
+    strategy: "backoff",
+    backoff: {
+      initialInterval: 1,
+      maxInterval: 50,
+      exponent: 1.1,
+      maxElapsedTime: 100,
+    },
+    retryConnectionErrors: false,
+  },
+  bearerAuth: process.env["PAYGENTIC_BEARER_AUTH"] ?? "",
+});
+
+async function run() {
+  const result = await paygentic.merchants.get({
+    id: "<id>",
+  });
+
+  console.log(result);
+}
+
+run();
+
+```
+<!-- End Retries [retries] -->
+
+<!-- Start Error Handling [errors] -->
+## Error Handling
+
+[`PaygenticError`](./src/models/errors/paygenticerror.ts) is the base class for all HTTP error responses. It has the following properties:
+
+| Property            | Type       | Description                                                                             |
+| ------------------- | ---------- | --------------------------------------------------------------------------------------- |
+| `error.message`     | `string`   | Error message                                                                           |
+| `error.statusCode`  | `number`   | HTTP response status code eg `404`                                                      |
+| `error.headers`     | `Headers`  | HTTP response headers                                                                   |
+| `error.body`        | `string`   | HTTP body. Can be empty string if no body is returned.                                  |
+| `error.rawResponse` | `Response` | Raw HTTP response                                                                       |
+| `error.data$`       |            | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). |
+
+### Example
+```typescript
+import { Paygentic } from "@paygentic/sdk";
+import * as errors from "@paygentic/sdk/models/errors";
+
+const paygentic = new Paygentic({
+  bearerAuth: process.env["PAYGENTIC_BEARER_AUTH"] ?? "",
+});
+
+async function run() {
+  try {
+    const result = await paygentic.merchants.get({
+      id: "<id>",
+    });
+
+    console.log(result);
+  } catch (error) {
+    // The base class for HTTP error responses
+    if (error instanceof errors.PaygenticError) {
+      console.log(error.message);
+      console.log(error.statusCode);
+      console.log(error.body);
+      console.log(error.headers);
+
+      // Depending on the method different errors may be thrown
+      if (error instanceof errors.ErrorT) {
+        console.log(error.data$.error); // string
+        console.log(error.data$.message); // string
+        console.log(error.data$.details); // { [k: string]: any }
+      }
+    }
+  }
+}
+
+run();
+
+```
+
+### Error Classes
+**Primary errors:**
+* [`PaygenticError`](./src/models/errors/paygenticerror.ts): The base class for HTTP error responses.
+  * [`ErrorT`](./src/models/errors/errort.ts): Not Found - The requested resource could not be found.
+
+<details><summary>Less common errors (7)</summary>
+
+<br />
+
+**Network errors:**
+* [`ConnectionError`](./src/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server.
+* [`RequestTimeoutError`](./src/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal.
+* [`RequestAbortedError`](./src/models/errors/httpclienterrors.ts): HTTP request was aborted by the client.
+* [`InvalidRequestError`](./src/models/errors/httpclienterrors.ts): Any input used to create a request is invalid.
+* [`UnexpectedClientError`](./src/models/errors/httpclienterrors.ts): Unrecognised or unexpected error.
+
+
+**Inherit from [`PaygenticError`](./src/models/errors/paygenticerror.ts)**:
+* [`ValidationError`](./src/models/errors/validationerror.ts): Bad Request - The request could not be understood or was missing required parameters. Status code `400`. Applicable to 37 of 68 methods.*
+* [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
+
+</details>
+
+\* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable.
+<!-- End Error Handling [errors] -->
+
+<!-- Start Server Selection [server] -->
+## Server Selection
+
+### Override Server URL Per-Client
+
+The default server can be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
+```typescript
+import { Paygentic } from "@paygentic/sdk";
+
+const paygentic = new Paygentic({
+  serverURL: "https://api.paygentic.io/v0",
+  bearerAuth: process.env["PAYGENTIC_BEARER_AUTH"] ?? "",
+});
+
+async function run() {
+  const result = await paygentic.merchants.get({
+    id: "<id>",
+  });
+
+  console.log(result);
+}
+
+run();
+
+```
+<!-- End Server Selection [server] -->
+
+<!-- Start Custom HTTP Client [http-client] -->
+## Custom HTTP Client
+
+The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native
+[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). This
+client is a thin wrapper around `fetch` and provides the ability to attach hooks
+around the request lifecycle that can be used to modify the request or handle
+errors and response.
+
+The `HTTPClient` constructor takes an optional `fetcher` argument that can be
+used to integrate a third-party HTTP client or when writing tests to mock out
+the HTTP client and feed in fixtures.
+
+The following example shows how to use the `"beforeRequest"` hook to to add a
+custom header and a timeout to requests and how to use the `"requestError"` hook
+to log errors:
+
+```typescript
+import { Paygentic } from "@paygentic/sdk";
+import { HTTPClient } from "@paygentic/sdk/lib/http";
+
+const httpClient = new HTTPClient({
+  // fetcher takes a function that has the same signature as native `fetch`.
+  fetcher: (request) => {
+    return fetch(request);
+  }
+});
+
+httpClient.addHook("beforeRequest", (request) => {
+  const nextRequest = new Request(request, {
+    signal: request.signal || AbortSignal.timeout(5000)
+  });
+
+  nextRequest.headers.set("x-custom-header", "custom value");
+
+  return nextRequest;
+});
+
+httpClient.addHook("requestError", (error, request) => {
+  console.group("Request Error");
+  console.log("Reason:", `${error}`);
+  console.log("Endpoint:", `${request.method} ${request.url}`);
+  console.groupEnd();
+});
+
+const sdk = new Paygentic({ httpClient: httpClient });
+```
+<!-- End Custom HTTP Client [http-client] -->
+
+<!-- Start Debugging [debug] -->
+## Debugging
+
+You can setup your SDK to emit debug logs for SDK requests and responses.
+
+You can pass a logger that matches `console`'s interface as an SDK option.
+
+> [!WARNING]
+> Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
+
+```typescript
+import { Paygentic } from "@paygentic/sdk";
+
+const sdk = new Paygentic({ debugLogger: console });
+```
+
+You can also enable a default debug logger by setting an environment variable `PAYGENTIC_DEBUG` to true.
+<!-- End Debugging [debug] -->
+
+<!-- Placeholder for Future Speakeasy SDK Sections -->
+
+# Development
+
+## Maturity
+
+This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
+to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
+looking for the latest version.
+
+## Contributions
+
+While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. 
+We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release. 
+
+### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=paygentic&utm_campaign=typescript)

package/RUNTIMES.md

@@ -0,0 +1,48 @@
+# Supported JavaScript runtimes
+
+This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses the following features:
+
+* [Web Fetch API][web-fetch]
+* [Web Streams API][web-streams] and in particular `ReadableStream`
+* [Async iterables][async-iter] using `Symbol.asyncIterator`
+
+[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
+[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
+[async-iter]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_async_iterator_and_async_iterable_protocols
+
+Runtime environments that are explicitly supported are:
+
+- Evergreen browsers which include: Chrome, Safari, Edge, Firefox
+- Node.js active and maintenance LTS releases
+  - Currently, this is v18 and v20
+- Bun v1 and above
+- Deno v1.39
+  - Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
+
+[deno-file-streaming]: https://github.com/denoland/deno/issues/11018
+
+## Recommended TypeScript compiler options
+
+The following `tsconfig.json` options are recommended for projects using this
+SDK in order to get static type support for features like async iterables,
+streams and `fetch`-related APIs ([`for await...of`][for-await-of], 
+[`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and
+so on):
+
+[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
+[abort-signal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
+[request]: https://developer.mozilla.org/en-US/docs/Web/API/Request
+[response]: https://developer.mozilla.org/en-US/docs/Web/API/Response
+
+```jsonc
+{
+  "compilerOptions": {
+    "target": "es2020", // or higher
+    "lib": ["es2020", "dom", "dom.iterable"],
+  }
+}
+```
+
+While `target` can be set to older ECMAScript versions, it may result in extra,
+unnecessary compatibility code being generated if you are not targeting old
+runtimes.

package/core.d.ts

@@ -0,0 +1,10 @@
+import { ClientSDK } from "./lib/sdks.js";
+/**
+ * A minimal client to use when calling standalone SDK functions. Typically, an
+ * instance of this class would be instantiated once at the start of an
+ * application and passed around through some dependency injection mechanism  to
+ * parts of an application that need to make SDK calls.
+ */
+export declare class PaygenticCore extends ClientSDK {
+}
+//# sourceMappingURL=core.d.ts.map

package/core.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"core.d.ts","sourceRoot":"","sources":["src/core.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C;;;;;GAKG;AACH,qBAAa,aAAc,SAAQ,SAAS;CAAG"}