@rainapi/rain-sdk 0.1.0-alpha.3

package/README.md

@@ -0,0 +1,412 @@
+# Rain TypeScript API Library
+
+[![NPM version](<https://img.shields.io/npm/v/@rainapi/rain-sdk.svg?label=npm%20(stable)>)](https://npmjs.org/package/@rainapi/rain-sdk) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@rainapi/rain-sdk)
+
+This library provides convenient access to the Rain REST API from server-side TypeScript or JavaScript.
+
+The full API of this library can be found in [api.md](api.md).
+
+It is generated with [Stainless](https://www.stainless.com/).
+
+## Installation
+
+```sh
+npm install @rainapi/rain-sdk
+```
+
+## Usage
+
+The full API of this library can be found in [api.md](api.md).
+
+<!-- prettier-ignore -->
+```js
+import Rain from '@rainapi/rain-sdk';
+
+const client = new Rain({
+  apiKey: process.env['RAIN_API_KEY'], // This is the default and can be omitted
+  environment: 'production', // defaults to 'dev'
+});
+
+const issuingChargeCreateResponse = await client.companies.charge(
+  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+  { amount: 123, description: 'Custom fee charge' },
+);
+
+console.log(issuingChargeCreateResponse.id);
+```
+
+### Request & Response types
+
+This library includes TypeScript definitions for all request params and response fields. You may import and use them like so:
+
+<!-- prettier-ignore -->
+```ts
+import Rain from '@rainapi/rain-sdk';
+
+const client = new Rain({
+  apiKey: process.env['RAIN_API_KEY'], // This is the default and can be omitted
+  environment: 'production', // defaults to 'dev'
+});
+
+const params: Rain.CompanyChargeParams = { amount: 123, description: 'Custom fee charge' };
+const issuingChargeCreateResponse: Rain.IssuingChargeCreateResponse = await client.companies.charge(
+  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+  params,
+);
+```
+
+Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.
+
+## File uploads
+
+Request parameters that correspond to file uploads can be passed in many different forms:
+
+- `File` (or an object with the same structure)
+- a `fetch` `Response` (or an object with the same structure)
+- an `fs.ReadStream`
+- the return value of our `toFile` helper
+
+```ts
+import fs from 'fs';
+import Rain, { toFile } from '@rainapi/rain-sdk';
+
+const client = new Rain();
+
+// If you have access to Node `fs` we recommend using `fs.createReadStream()`:
+await client.applications.company.uploadDocument('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
+  document: fs.createReadStream('/path/to/file'),
+});
+
+// Or if you have the web `File` API you can pass a `File` instance:
+await client.applications.company.uploadDocument('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
+  document: new File(['my bytes'], 'file'),
+});
+
+// You can also pass a `fetch` `Response`:
+await client.applications.company.uploadDocument('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
+  document: await fetch('https://somesite/file'),
+});
+
+// Finally, if none of the above are convenient, you can use our `toFile` helper:
+await client.applications.company.uploadDocument('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
+  document: await toFile(Buffer.from('my bytes'), 'file'),
+});
+await client.applications.company.uploadDocument('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
+  document: await toFile(new Uint8Array([0, 1, 2]), 'file'),
+});
+```
+
+## Handling errors
+
+When the library is unable to connect to the API,
+or if the API returns a non-success status code (i.e., 4xx or 5xx response),
+a subclass of `APIError` will be thrown:
+
+<!-- prettier-ignore -->
+```ts
+const issuingChargeCreateResponse = await client.companies
+  .charge('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { amount: 123, description: 'Custom fee charge' })
+  .catch(async (err) => {
+    if (err instanceof Rain.APIError) {
+      console.log(err.status); // 400
+      console.log(err.name); // BadRequestError
+      console.log(err.headers); // {server: 'nginx', ...}
+    } else {
+      throw err;
+    }
+  });
+```
+
+Error codes are as follows:
+
+| Status Code | Error Type                 |
+| ----------- | -------------------------- |
+| 400         | `BadRequestError`          |
+| 401         | `AuthenticationError`      |
+| 403         | `PermissionDeniedError`    |
+| 404         | `NotFoundError`            |
+| 422         | `UnprocessableEntityError` |
+| 429         | `RateLimitError`           |
+| >=500       | `InternalServerError`      |
+| N/A         | `APIConnectionError`       |
+
+### Retries
+
+Certain errors will be automatically retried 2 times by default, with a short exponential backoff.
+Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,
+429 Rate Limit, and >=500 Internal errors will all be retried by default.
+
+You can use the `maxRetries` option to configure or disable this:
+
+<!-- prettier-ignore -->
+```js
+// Configure the default for all requests:
+const client = new Rain({
+  maxRetries: 0, // default is 2
+});
+
+// Or, configure per-request:
+await client.companies.charge('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { amount: 123, description: 'Custom fee charge' }, {
+  maxRetries: 5,
+});
+```
+
+### Timeouts
+
+Requests time out after 1 minute by default. You can configure this with a `timeout` option:
+
+<!-- prettier-ignore -->
+```ts
+// Configure the default for all requests:
+const client = new Rain({
+  timeout: 20 * 1000, // 20 seconds (default is 1 minute)
+});
+
+// Override per-request:
+await client.companies.charge('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { amount: 123, description: 'Custom fee charge' }, {
+  timeout: 5 * 1000,
+});
+```
+
+On timeout, an `APIConnectionTimeoutError` is thrown.
+
+Note that requests which time out will be [retried twice by default](#retries).
+
+## Advanced Usage
+
+### Accessing raw Response data (e.g., headers)
+
+The "raw" `Response` returned by `fetch()` can be accessed through the `.asResponse()` method on the `APIPromise` type that all methods return.
+This method returns as soon as the headers for a successful response are received and does not consume the response body, so you are free to write custom parsing or streaming logic.
+
+You can also use the `.withResponse()` method to get the raw `Response` along with the parsed data.
+Unlike `.asResponse()` this method consumes the body, returning once it is parsed.
+
+<!-- prettier-ignore -->
+```ts
+const client = new Rain();
+
+const response = await client.companies
+  .charge('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { amount: 123, description: 'Custom fee charge' })
+  .asResponse();
+console.log(response.headers.get('X-My-Header'));
+console.log(response.statusText); // access the underlying Response object
+
+const { data: issuingChargeCreateResponse, response: raw } = await client.companies
+  .charge('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { amount: 123, description: 'Custom fee charge' })
+  .withResponse();
+console.log(raw.headers.get('X-My-Header'));
+console.log(issuingChargeCreateResponse.id);
+```
+
+### Logging
+
+> [!IMPORTANT]
+> All log messages are intended for debugging only. The format and content of log messages
+> may change between releases.
+
+#### Log levels
+
+The log level can be configured in two ways:
+
+1. Via the `RAIN_LOG` environment variable
+2. Using the `logLevel` client option (overrides the environment variable if set)
+
+```ts
+import Rain from '@rainapi/rain-sdk';
+
+const client = new Rain({
+  logLevel: 'debug', // Show all log messages
+});
+```
+
+Available log levels, from most to least verbose:
+
+- `'debug'` - Show debug messages, info, warnings, and errors
+- `'info'` - Show info messages, warnings, and errors
+- `'warn'` - Show warnings and errors (default)
+- `'error'` - Show only errors
+- `'off'` - Disable all logging
+
+At the `'debug'` level, all HTTP requests and responses are logged, including headers and bodies.
+Some authentication-related headers are redacted, but sensitive data in request and response bodies
+may still be visible.
+
+#### Custom logger
+
+By default, this library logs to `globalThis.console`. You can also provide a custom logger.
+Most logging libraries are supported, including [pino](https://www.npmjs.com/package/pino), [winston](https://www.npmjs.com/package/winston), [bunyan](https://www.npmjs.com/package/bunyan), [consola](https://www.npmjs.com/package/consola), [signale](https://www.npmjs.com/package/signale), and [@std/log](https://jsr.io/@std/log). If your logger doesn't work, please open an issue.
+
+When providing a custom logger, the `logLevel` option still controls which messages are emitted, messages
+below the configured level will not be sent to your logger.
+
+```ts
+import Rain from '@rainapi/rain-sdk';
+import pino from 'pino';
+
+const logger = pino();
+
+const client = new Rain({
+  logger: logger.child({ name: 'Rain' }),
+  logLevel: 'debug', // Send all messages to pino, allowing it to filter
+});
+```
+
+### Making custom/undocumented requests
+
+This library is typed for convenient access to the documented API. If you need to access undocumented
+endpoints, params, or response properties, the library can still be used.
+
+#### Undocumented endpoints
+
+To make requests to undocumented endpoints, you can use `client.get`, `client.post`, and other HTTP verbs.
+Options on the client, such as retries, will be respected when making these requests.
+
+```ts
+await client.post('/some/path', {
+  body: { some_prop: 'foo' },
+  query: { some_query_arg: 'bar' },
+});
+```
+
+#### Undocumented request params
+
+To make requests using undocumented parameters, you may use `// @ts-expect-error` on the undocumented
+parameter. This library doesn't validate at runtime that the request matches the type, so any extra values you
+send will be sent as-is.
+
+```ts
+client.companies.charge({
+  // ...
+  // @ts-expect-error baz is not yet public
+  baz: 'undocumented option',
+});
+```
+
+For requests with the `GET` verb, any extra params will be in the query, all other requests will send the
+extra param in the body.
+
+If you want to explicitly send an extra argument, you can do so with the `query`, `body`, and `headers` request
+options.
+
+#### Undocumented response properties
+
+To access undocumented response properties, you may access the response object with `// @ts-expect-error` on
+the response object, or cast the response object to the requisite type. Like the request params, we do not
+validate or strip extra properties from the response from the API.
+
+### Customizing the fetch client
+
+By default, this library expects a global `fetch` function is defined.
+
+If you want to use a different `fetch` function, you can either polyfill the global:
+
+```ts
+import fetch from 'my-fetch';
+
+globalThis.fetch = fetch;
+```
+
+Or pass it to the client:
+
+```ts
+import Rain from '@rainapi/rain-sdk';
+import fetch from 'my-fetch';
+
+const client = new Rain({ fetch });
+```
+
+### Fetch options
+
+If you want to set custom `fetch` options without overriding the `fetch` function, you can provide a `fetchOptions` object when instantiating the client or making a request. (Request-specific options override client options.)
+
+```ts
+import Rain from '@rainapi/rain-sdk';
+
+const client = new Rain({
+  fetchOptions: {
+    // `RequestInit` options
+  },
+});
+```
+
+#### Configuring proxies
+
+To modify proxy behavior, you can provide custom `fetchOptions` that add runtime-specific proxy
+options to requests:
+
+<img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/node.svg" align="top" width="18" height="21"> **Node** <sup>[[docs](https://github.com/nodejs/undici/blob/main/docs/docs/api/ProxyAgent.md#example---proxyagent-with-fetch)]</sup>
+
+```ts
+import Rain from '@rainapi/rain-sdk';
+import * as undici from 'undici';
+
+const proxyAgent = new undici.ProxyAgent('http://localhost:8888');
+const client = new Rain({
+  fetchOptions: {
+    dispatcher: proxyAgent,
+  },
+});
+```
+
+<img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/bun.svg" align="top" width="18" height="21"> **Bun** <sup>[[docs](https://bun.sh/guides/http/proxy)]</sup>
+
+```ts
+import Rain from '@rainapi/rain-sdk';
+
+const client = new Rain({
+  fetchOptions: {
+    proxy: 'http://localhost:8888',
+  },
+});
+```
+
+<img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/deno.svg" align="top" width="18" height="21"> **Deno** <sup>[[docs](https://docs.deno.com/api/deno/~/Deno.createHttpClient)]</sup>
+
+```ts
+import Rain from 'npm:@rainapi/rain-sdk';
+
+const httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });
+const client = new Rain({
+  fetchOptions: {
+    client: httpClient,
+  },
+});
+```
+
+## Frequently Asked Questions
+
+## Semantic versioning
+
+This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:
+
+1. Changes that only affect static types, without breaking runtime behavior.
+2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_
+3. Changes that we do not expect to impact the vast majority of users in practice.
+
+We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
+
+We are keen for your feedback; please open an [issue](https://www.github.com/SignifyHQ/rain-sdk-typescript/issues) with questions, bugs, or suggestions.
+
+## Requirements
+
+TypeScript >= 4.9 is supported.
+
+The following runtimes are supported:
+
+- Web browsers (Up-to-date Chrome, Firefox, Safari, Edge, and more)
+- Node.js 20 LTS or later ([non-EOL](https://endoflife.date/nodejs)) versions.
+- Deno v1.28.0 or higher.
+- Bun 1.0 or later.
+- Cloudflare Workers.
+- Vercel Edge Runtime.
+- Jest 28 or greater with the `"node"` environment (`"jsdom"` is not supported at this time).
+- Nitro v2.6 or greater.
+
+Note that React Native is not supported at this time.
+
+If you are interested in other runtime environments, please open or upvote an issue on GitHub.
+
+## Contributing
+
+See [the contributing documentation](./CONTRIBUTING.md).

package/api-promise.d.mts

@@ -0,0 +1,2 @@
+export * from "./core/api-promise.mjs";
+//# sourceMappingURL=api-promise.d.mts.map

package/api-promise.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-promise.d.mts","sourceRoot":"","sources":["src/api-promise.ts"],"names":[],"mappings":""}

package/api-promise.d.ts

@@ -0,0 +1,2 @@
+export * from "./core/api-promise.js";
+//# sourceMappingURL=api-promise.d.ts.map

package/api-promise.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-promise.d.ts","sourceRoot":"","sources":["src/api-promise.ts"],"names":[],"mappings":""}

package/api-promise.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("./internal/tslib.js");
+/** @deprecated Import from ./core/api-promise instead */
+tslib_1.__exportStar(require("./core/api-promise.js"), exports);
+//# sourceMappingURL=api-promise.js.map

package/api-promise.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-promise.js","sourceRoot":"","sources":["src/api-promise.ts"],"names":[],"mappings":";;;AAAA,yDAAyD;AACzD,gEAAmC"}

package/api-promise.mjs

@@ -0,0 +1,2 @@
+export * from "./core/api-promise.mjs";
+//# sourceMappingURL=api-promise.mjs.map

package/api-promise.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-promise.mjs","sourceRoot":"","sources":["src/api-promise.ts"],"names":[],"mappings":""}

package/client.d.mts

@@ -0,0 +1,222 @@
+import type { RequestInit, RequestInfo } from "./internal/builtin-types.mjs";
+import type { PromiseOrValue, MergedRequestInit, FinalizedRequestInit } from "./internal/types.mjs";
+export type { Logger, LogLevel } from "./internal/utils/log.mjs";
+import * as Opts from "./internal/request-options.mjs";
+import * as Errors from "./core/error.mjs";
+import * as Uploads from "./core/uploads.mjs";
+import * as API from "./resources/index.mjs";
+import { APIPromise } from "./core/api-promise.mjs";
+import { BalanceRetrieveResponse, Balances } from "./resources/balances.mjs";
+import { ContractListResponse, Contracts } from "./resources/contracts.mjs";
+import { KeyCreateParams, KeyCreateResponse, Keys } from "./resources/keys.mjs";
+import { PaymentInitiateParams, PaymentInitiateResponse, Payments } from "./resources/payments.mjs";
+import { SignatureRetrievePaymentSignatureParams, SignatureRetrieveWithdrawalSignatureParams, Signatures } from "./resources/signatures.mjs";
+import { Applications } from "./resources/applications/applications.mjs";
+import { CardListParams, CardListResponse, CardRetrieveSecretsParams, CardRetrieveSecretsResponse, CardUpdateParams, Cards, IssuingCard, IssuingCardLimit, IssuingCardStatus } from "./resources/cards/cards.mjs";
+import { Companies, CompanyChargeParams, CompanyCreateUserParams, CompanyInitiatePaymentParams, CompanyInitiatePaymentResponse, CompanyListParams, CompanyListResponse, CompanyRetrieveBalancesResponse, CompanyRetrieveContractsResponse, CompanyUpdateParams, IssuingChargeCreateBody, IssuingChargeCreateResponse, IssuingContract } from "./resources/companies/companies.mjs";
+import { DisputeListParams, DisputeListResponse, DisputeUpdateParams, Disputes, IssuingDispute } from "./resources/disputes/disputes.mjs";
+import { IssuingTransaction, TransactionCreateDisputeParams, TransactionListParams, TransactionListResponse, TransactionUpdateParams, Transactions } from "./resources/transactions/transactions.mjs";
+import { UserCreateCardParams, UserCreateChargeParams, UserCreateParams, UserInitiatePaymentParams, UserInitiatePaymentResponse, UserListParams, UserListResponse, UserRetrieveBalancesResponse, UserRetrieveContractsResponse, UserUpdateParams, Users } from "./resources/users/users.mjs";
+import { type Fetch } from "./internal/builtin-types.mjs";
+import { HeadersLike, NullableHeaders } from "./internal/headers.mjs";
+import { FinalRequestOptions, RequestOptions } from "./internal/request-options.mjs";
+import { type LogLevel, type Logger } from "./internal/utils/log.mjs";
+declare const environments: {
+    dev: string;
+    production: string;
+};
+type Environment = keyof typeof environments;
+export interface ClientOptions {
+    /**
+     * Defaults to process.env['RAIN_API_KEY'].
+     */
+    apiKey?: string | undefined;
+    /**
+     * Specifies the environment to use for the API.
+     *
+     * Each environment maps to a different base URL:
+     * - `dev` corresponds to `https://api-dev.raincards.xyz/v1/issuing`
+     * - `production` corresponds to `https://api.raincards.xyz/v1/issuing`
+     */
+    environment?: Environment | undefined;
+    /**
+     * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
+     *
+     * Defaults to process.env['RAIN_BASE_URL'].
+     */
+    baseURL?: string | null | undefined;
+    /**
+     * The maximum amount of time (in milliseconds) that the client should wait for a response
+     * from the server before timing out a single request.
+     *
+     * Note that request timeouts are retried by default, so in a worst-case scenario you may wait
+     * much longer than this timeout before the promise succeeds or fails.
+     *
+     * @unit milliseconds
+     */
+    timeout?: number | undefined;
+    /**
+     * Additional `RequestInit` options to be passed to `fetch` calls.
+     * Properties will be overridden by per-request `fetchOptions`.
+     */
+    fetchOptions?: MergedRequestInit | undefined;
+    /**
+     * Specify a custom `fetch` function implementation.
+     *
+     * If not provided, we expect that `fetch` is defined globally.
+     */
+    fetch?: Fetch | undefined;
+    /**
+     * The maximum number of times that the client will retry a request in case of a
+     * temporary failure, like a network error or a 5XX error from the server.
+     *
+     * @default 2
+     */
+    maxRetries?: number | undefined;
+    /**
+     * Default headers to include with every request to the API.
+     *
+     * These can be removed in individual requests by explicitly setting the
+     * header to `null` in request options.
+     */
+    defaultHeaders?: HeadersLike | undefined;
+    /**
+     * Default query parameters to include with every request to the API.
+     *
+     * These can be removed in individual requests by explicitly setting the
+     * param to `undefined` in request options.
+     */
+    defaultQuery?: Record<string, string | undefined> | undefined;
+    /**
+     * Set the log level.
+     *
+     * Defaults to process.env['RAIN_LOG'] or 'warn' if it isn't set.
+     */
+    logLevel?: LogLevel | undefined;
+    /**
+     * Set the logger.
+     *
+     * Defaults to globalThis.console.
+     */
+    logger?: Logger | undefined;
+}
+/**
+ * API Client for interfacing with the Rain API.
+ */
+export declare class Rain {
+    #private;
+    apiKey: string;
+    baseURL: string;
+    maxRetries: number;
+    timeout: number;
+    logger: Logger;
+    logLevel: LogLevel | undefined;
+    fetchOptions: MergedRequestInit | undefined;
+    private fetch;
+    protected idempotencyHeader?: string;
+    private _options;
+    /**
+     * API Client for interfacing with the Rain API.
+     *
+     * @param {string | undefined} [opts.apiKey=process.env['RAIN_API_KEY'] ?? undefined]
+     * @param {Environment} [opts.environment=dev] - Specifies the environment URL to use for the API.
+     * @param {string} [opts.baseURL=process.env['RAIN_BASE_URL'] ?? https://api-dev.raincards.xyz/v1/issuing] - Override the default base URL for the API.
+     * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
+     * @param {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls.
+     * @param {Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
+     * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
+     * @param {HeadersLike} opts.defaultHeaders - Default headers to include with every request to the API.
+     * @param {Record<string, string | undefined>} opts.defaultQuery - Default query parameters to include with every request to the API.
+     */
+    constructor({ baseURL, apiKey, ...opts }?: ClientOptions);
+    /**
+     * Create a new client instance re-using the same options given to the current client with optional overriding.
+     */
+    withOptions(options: Partial<ClientOptions>): this;
+    protected defaultQuery(): Record<string, string | undefined> | undefined;
+    protected validateHeaders({ values, nulls }: NullableHeaders): void;
+    protected authHeaders(opts: FinalRequestOptions): Promise<NullableHeaders | undefined>;
+    protected stringifyQuery(query: Record<string, unknown>): string;
+    private getUserAgent;
+    protected defaultIdempotencyKey(): string;
+    protected makeStatusError(status: number, error: Object, message: string | undefined, headers: Headers): Errors.APIError;
+    buildURL(path: string, query: Record<string, unknown> | null | undefined, defaultBaseURL?: string | undefined): string;
+    /**
+     * Used as a callback for mutating the given `FinalRequestOptions` object.
+     */
+    protected prepareOptions(options: FinalRequestOptions): Promise<void>;
+    /**
+     * Used as a callback for mutating the given `RequestInit` object.
+     *
+     * This is useful for cases where you want to add certain headers based off of
+     * the request properties, e.g. `method` or `url`.
+     */
+    protected prepareRequest(request: RequestInit, { url, options }: {
+        url: string;
+        options: FinalRequestOptions;
+    }): Promise<void>;
+    get<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
+    post<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
+    patch<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
+    put<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
+    delete<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
+    private methodRequest;
+    request<Rsp>(options: PromiseOrValue<FinalRequestOptions>, remainingRetries?: number | null): APIPromise<Rsp>;
+    private makeRequest;
+    fetchWithTimeout(url: RequestInfo, init: RequestInit | undefined, ms: number, controller: AbortController): Promise<Response>;
+    private shouldRetry;
+    private retryRequest;
+    private calculateDefaultRetryTimeoutMillis;
+    buildRequest(inputOptions: FinalRequestOptions, { retryCount }?: {
+        retryCount?: number;
+    }): Promise<{
+        req: FinalizedRequestInit;
+        url: string;
+        timeout: number;
+    }>;
+    private buildHeaders;
+    private _makeAbort;
+    private buildBody;
+    static Rain: typeof Rain;
+    static DEFAULT_TIMEOUT: number;
+    static RainError: typeof Errors.RainError;
+    static APIError: typeof Errors.APIError;
+    static APIConnectionError: typeof Errors.APIConnectionError;
+    static APIConnectionTimeoutError: typeof Errors.APIConnectionTimeoutError;
+    static APIUserAbortError: typeof Errors.APIUserAbortError;
+    static NotFoundError: typeof Errors.NotFoundError;
+    static ConflictError: typeof Errors.ConflictError;
+    static RateLimitError: typeof Errors.RateLimitError;
+    static BadRequestError: typeof Errors.BadRequestError;
+    static AuthenticationError: typeof Errors.AuthenticationError;
+    static InternalServerError: typeof Errors.InternalServerError;
+    static PermissionDeniedError: typeof Errors.PermissionDeniedError;
+    static UnprocessableEntityError: typeof Errors.UnprocessableEntityError;
+    static toFile: typeof Uploads.toFile;
+    applications: API.Applications;
+    balances: API.Balances;
+    cards: API.Cards;
+    companies: API.Companies;
+    contracts: API.Contracts;
+    disputes: API.Disputes;
+    keys: API.Keys;
+    payments: API.Payments;
+    signatures: API.Signatures;
+    transactions: API.Transactions;
+    users: API.Users;
+}
+export declare namespace Rain {
+    export type RequestOptions = Opts.RequestOptions;
+    export { Applications as Applications };
+    export { Balances as Balances, type BalanceRetrieveResponse as BalanceRetrieveResponse };
+    export { Cards as Cards, type IssuingCard as IssuingCard, type IssuingCardLimit as IssuingCardLimit, type IssuingCardStatus as IssuingCardStatus, type CardListResponse as CardListResponse, type CardRetrieveSecretsResponse as CardRetrieveSecretsResponse, type CardUpdateParams as CardUpdateParams, type CardListParams as CardListParams, type CardRetrieveSecretsParams as CardRetrieveSecretsParams, };
+    export { Companies as Companies, type IssuingChargeCreateBody as IssuingChargeCreateBody, type IssuingChargeCreateResponse as IssuingChargeCreateResponse, type IssuingContract as IssuingContract, type CompanyListResponse as CompanyListResponse, type CompanyInitiatePaymentResponse as CompanyInitiatePaymentResponse, type CompanyRetrieveBalancesResponse as CompanyRetrieveBalancesResponse, type CompanyRetrieveContractsResponse as CompanyRetrieveContractsResponse, type CompanyUpdateParams as CompanyUpdateParams, type CompanyListParams as CompanyListParams, type CompanyChargeParams as CompanyChargeParams, type CompanyCreateUserParams as CompanyCreateUserParams, type CompanyInitiatePaymentParams as CompanyInitiatePaymentParams, };
+    export { Contracts as Contracts, type ContractListResponse as ContractListResponse };
+    export { Disputes as Disputes, type IssuingDispute as IssuingDispute, type DisputeListResponse as DisputeListResponse, type DisputeUpdateParams as DisputeUpdateParams, type DisputeListParams as DisputeListParams, };
+    export { Keys as Keys, type KeyCreateResponse as KeyCreateResponse, type KeyCreateParams as KeyCreateParams, };
+    export { Payments as Payments, type PaymentInitiateResponse as PaymentInitiateResponse, type PaymentInitiateParams as PaymentInitiateParams, };
+    export { Signatures as Signatures, type SignatureRetrievePaymentSignatureParams as SignatureRetrievePaymentSignatureParams, type SignatureRetrieveWithdrawalSignatureParams as SignatureRetrieveWithdrawalSignatureParams, };
+    export { Transactions as Transactions, type IssuingTransaction as IssuingTransaction, type TransactionListResponse as TransactionListResponse, type TransactionUpdateParams as TransactionUpdateParams, type TransactionListParams as TransactionListParams, type TransactionCreateDisputeParams as TransactionCreateDisputeParams, };
+    export { Users as Users, type UserListResponse as UserListResponse, type UserInitiatePaymentResponse as UserInitiatePaymentResponse, type UserRetrieveBalancesResponse as UserRetrieveBalancesResponse, type UserRetrieveContractsResponse as UserRetrieveContractsResponse, type UserCreateParams as UserCreateParams, type UserUpdateParams as UserUpdateParams, type UserListParams as UserListParams, type UserCreateCardParams as UserCreateCardParams, type UserCreateChargeParams as UserCreateChargeParams, type UserInitiatePaymentParams as UserInitiatePaymentParams, };
+}
+//# sourceMappingURL=client.d.mts.map