@tolt/api 0.6.1 → 1.0.0

package/dist/api/resources/transactions/client/Client.js

@@ -12,11 +12,14 @@ export class TransactionsClient {
         this._options = normalizeClientOptionsWithAuth(options);
     }
     /**
+     * Lists transactions. Filter by program, partner, customer or status, and page with cursors.
+     *
      * @param {ToltApi.ListTransactionsRequest} request
      * @param {TransactionsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ToltApi.BadRequestError}
      * @throws {@link ToltApi.UnauthorizedError}
+     * @throws {@link ToltApi.ContentTooLargeError}
      * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
@@ -24,83 +27,105 @@ export class TransactionsClient {
      * @example
      *     await client.transactions.list()
      */
-    list(request = {}, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__list(request, requestOptions));
-    }
-    async __list(request = {}, requestOptions) {
-        const { limit, order, sort, starting_after: startingAfter, ending_before: endingBefore, created_after: createdAfter, created_before: createdBefore, updated_after: updatedAfter, updated_before: updatedBefore, program_id: programId, partner_id: partnerId, customer_id: customerId, status, search, } = request;
-        const _queryParams = {
-            limit,
-            order: order != null ? order : undefined,
-            sort: sort != null ? sort : undefined,
-            starting_after: startingAfter,
-            ending_before: endingBefore,
-            created_after: createdAfter != null ? createdAfter : undefined,
-            created_before: createdBefore != null ? createdBefore : undefined,
-            updated_after: updatedAfter != null ? updatedAfter : undefined,
-            updated_before: updatedBefore != null ? updatedBefore : undefined,
-            program_id: programId,
-            partner_id: partnerId,
-            customer_id: customerId,
-            status,
-            search,
-        };
-        const _authRequest = await this._options.authProvider.getAuthRequest();
-        const _headers = mergeHeaders(_authRequest.headers, this._options?.headers, requestOptions?.headers);
-        const _response = await core.fetcher({
-            url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
-                (await core.Supplier.get(this._options.environment)) ??
-                environments.ToltApiEnvironment.Production, "v2/transactions"),
-            method: "GET",
-            headers: _headers,
-            queryString: core.url
-                .queryBuilder()
-                .addMany(_queryParams)
-                .mergeAdditional(requestOptions?.queryParams)
-                .build(),
-            timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
-            maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
-            abortSignal: requestOptions?.abortSignal,
-            fetchFn: this._options?.fetch,
-            logging: this._options.logging,
-        });
-        if (_response.ok) {
-            return { data: _response.body, rawResponse: _response.rawResponse };
-        }
-        if (_response.error.reason === "status-code") {
-            switch (_response.error.statusCode) {
-                case 400:
-                    throw new ToltApi.BadRequestError(_response.error.body, _response.rawResponse);
-                case 401:
-                    throw new ToltApi.UnauthorizedError(_response.error.body, _response.rawResponse);
-                case 429:
-                    throw new ToltApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
-                default:
-                    throw new errors.ToltApiError({
-                        statusCode: _response.error.statusCode,
-                        body: _response.error.body,
-                        rawResponse: _response.rawResponse,
-                    });
+    async list(request = {}, requestOptions) {
+        const list = core.HttpResponsePromise.interceptFunction(async (request) => {
+            const { limit, order, sort, starting_after: startingAfter, ending_before: endingBefore, created_after: createdAfter, created_before: createdBefore, updated_after: updatedAfter, updated_before: updatedBefore, program_id: programId, partner_id: partnerId, customer_id: customerId, status, search, } = request;
+            const _queryParams = {
+                limit,
+                order: order != null ? order : undefined,
+                sort: sort != null ? sort : undefined,
+                starting_after: startingAfter,
+                ending_before: endingBefore,
+                created_after: createdAfter != null ? createdAfter : undefined,
+                created_before: createdBefore != null ? createdBefore : undefined,
+                updated_after: updatedAfter != null ? updatedAfter : undefined,
+                updated_before: updatedBefore != null ? updatedBefore : undefined,
+                program_id: programId,
+                partner_id: partnerId,
+                customer_id: customerId,
+                status,
+                search,
+            };
+            const _authRequest = await this._options.authProvider.getAuthRequest();
+            const _headers = mergeHeaders(_authRequest.headers, this._options?.headers, requestOptions?.headers);
+            const _response = await core.fetcher({
+                url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
+                    (await core.Supplier.get(this._options.environment)) ??
+                    environments.ToltApiEnvironment.Default, "v2/transactions"),
+                method: "GET",
+                headers: _headers,
+                queryString: core.url
+                    .queryBuilder()
+                    .addMany(_queryParams)
+                    .mergeAdditional(requestOptions?.queryParams)
+                    .build(),
+                timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
+                maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
+                abortSignal: requestOptions?.abortSignal,
+                fetchFn: this._options?.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return {
+                    data: _response.body,
+                    rawResponse: _response.rawResponse,
+                };
             }
-        }
-        return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v2/transactions");
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new ToltApi.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new ToltApi.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 413:
+                        throw new ToltApi.ContentTooLargeError(_response.error.body, _response.rawResponse);
+                    case 429:
+                        throw new ToltApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.ToltApiError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v2/transactions");
+        });
+        const dataWithRawResponse = await list(request).withRawResponse();
+        return new core.Page({
+            response: dataWithRawResponse.data,
+            rawResponse: dataWithRawResponse.rawResponse,
+            hasNextPage: (response) => response?.next_cursor != null &&
+                !(typeof response?.next_cursor === "string" && response?.next_cursor === ""),
+            getItems: (response) => response?.data ?? [],
+            loadPage: (response) => {
+                return list(core.setObjectProperty(request, "starting_after", response?.next_cursor));
+            },
+        });
     }
     /**
      * Supports historical created_at values. product_id and product_name are stored and returned in product_ids and product_names arrays.
      *
-     * @param {ToltApi.CreateTransactionsRequest} request
+     * @param {ToltApi.CreateTransactionRequest} request
      * @param {TransactionsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ToltApi.BadRequestError}
      * @throws {@link ToltApi.UnauthorizedError}
+     * @throws {@link ToltApi.ConflictError}
+     * @throws {@link ToltApi.ContentTooLargeError}
      * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
      * @example
      *     await client.transactions.create({
-     *         amount: 1,
-     *         customer_id: "customer_id"
+     *         product_id: "prod_pro",
+     *         product_name: "Pro plan",
+     *         amount: 5000,
+     *         customer_id: "cus_LBfjvtfct9pVUeLojMHiGnXv",
+     *         billing_type: "subscription",
+     *         interval: "month",
+     *         source: "api"
      *     })
      */
     create(request, requestOptions) {
@@ -112,7 +137,7 @@ export class TransactionsClient {
         const _response = await core.fetcher({
             url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
                 (await core.Supplier.get(this._options.environment)) ??
-                environments.ToltApiEnvironment.Production, "v2/transactions"),
+                environments.ToltApiEnvironment.Default, "v2/transactions"),
             method: "POST",
             headers: _headers,
             contentType: "application/json",
@@ -120,7 +145,7 @@ export class TransactionsClient {
             requestType: "json",
             body: mergeAdditionalBodyParameters(request, requestOptions?.additionalBodyParameters),
             timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
-            maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
+            maxRetries: 0,
             abortSignal: requestOptions?.abortSignal,
             fetchFn: this._options?.fetch,
             logging: this._options.logging,
@@ -134,6 +159,10 @@ export class TransactionsClient {
                     throw new ToltApi.BadRequestError(_response.error.body, _response.rawResponse);
                 case 401:
                     throw new ToltApi.UnauthorizedError(_response.error.body, _response.rawResponse);
+                case 409:
+                    throw new ToltApi.ConflictError(_response.error.body, _response.rawResponse);
+                case 413:
+                    throw new ToltApi.ContentTooLargeError(_response.error.body, _response.rawResponse);
                 case 429:
                     throw new ToltApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
                 default:
@@ -147,18 +176,21 @@ export class TransactionsClient {
         return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v2/transactions");
     }
     /**
-     * @param {ToltApi.GetTransactionsRequest} request
+     * Gets a transaction by ID, with its amount, status, billing details, products and the customer it belongs to.
+     *
+     * @param {ToltApi.GetTransactionRequest} request
      * @param {TransactionsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ToltApi.UnauthorizedError}
      * @throws {@link ToltApi.NotFoundError}
+     * @throws {@link ToltApi.ContentTooLargeError}
      * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
      * @example
      *     await client.transactions.get({
-     *         id: "id"
+     *         id: "txn_fB3egT1sKNVNu3ZYuU1ypYDA"
      *     })
      */
     get(request, requestOptions) {
@@ -171,7 +203,7 @@ export class TransactionsClient {
         const _response = await core.fetcher({
             url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
                 (await core.Supplier.get(this._options.environment)) ??
-                environments.ToltApiEnvironment.Production, `v2/transactions/${core.url.encodePathParam(id)}`),
+                environments.ToltApiEnvironment.Default, `v2/transactions/${core.url.encodePathParam(id, errors.ToltApiError)}`),
             method: "GET",
             headers: _headers,
             queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
@@ -190,6 +222,8 @@ export class TransactionsClient {
                     throw new ToltApi.UnauthorizedError(_response.error.body, _response.rawResponse);
                 case 404:
                     throw new ToltApi.NotFoundError(_response.error.body, _response.rawResponse);
+                case 413:
+                    throw new ToltApi.ContentTooLargeError(_response.error.body, _response.rawResponse);
                 case 429:
                     throw new ToltApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
                 default:
@@ -203,20 +237,25 @@ export class TransactionsClient {
         return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v2/transactions/{id}");
     }
     /**
-     * @param {ToltApi.UpdateTransactionsRequest} request
+     * Updates a transaction's amount, status, billing or product details. Refunded transactions cannot be modified.
+     *
+     * @param {ToltApi.UpdateTransactionRequest} request
      * @param {TransactionsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ToltApi.BadRequestError}
      * @throws {@link ToltApi.UnauthorizedError}
      * @throws {@link ToltApi.NotFoundError}
      * @throws {@link ToltApi.ConflictError}
+     * @throws {@link ToltApi.ContentTooLargeError}
      * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
      * @example
      *     await client.transactions.update({
-     *         id: "id"
+     *         id: "txn_fB3egT1sKNVNu3ZYuU1ypYDA",
+     *         amount: 5000,
+     *         product_name: "Pro plan"
      *     })
      */
     update(request, requestOptions) {
@@ -229,7 +268,7 @@ export class TransactionsClient {
         const _response = await core.fetcher({
             url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
                 (await core.Supplier.get(this._options.environment)) ??
-                environments.ToltApiEnvironment.Production, `v2/transactions/${core.url.encodePathParam(id)}`),
+                environments.ToltApiEnvironment.Default, `v2/transactions/${core.url.encodePathParam(id, errors.ToltApiError)}`),
             method: "PUT",
             headers: _headers,
             contentType: "application/json",
@@ -255,6 +294,8 @@ export class TransactionsClient {
                     throw new ToltApi.NotFoundError(_response.error.body, _response.rawResponse);
                 case 409:
                     throw new ToltApi.ConflictError(_response.error.body, _response.rawResponse);
+                case 413:
+                    throw new ToltApi.ContentTooLargeError(_response.error.body, _response.rawResponse);
                 case 429:
                     throw new ToltApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
                 default:
@@ -268,19 +309,22 @@ export class TransactionsClient {
         return handleNonStatusCodeError(_response.error, _response.rawResponse, "PUT", "/v2/transactions/{id}");
     }
     /**
-     * @param {ToltApi.DeleteTransactionsRequest} request
+     * Deletes a transaction. Refunded transactions and transactions that already have commissions cannot be deleted.
+     *
+     * @param {ToltApi.DeleteTransactionRequest} request
      * @param {TransactionsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ToltApi.UnauthorizedError}
      * @throws {@link ToltApi.NotFoundError}
      * @throws {@link ToltApi.ConflictError}
+     * @throws {@link ToltApi.ContentTooLargeError}
      * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
      * @example
      *     await client.transactions.delete({
-     *         id: "id"
+     *         id: "txn_fB3egT1sKNVNu3ZYuU1ypYDA"
      *     })
      */
     delete(request, requestOptions) {
@@ -293,7 +337,7 @@ export class TransactionsClient {
         const _response = await core.fetcher({
             url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
                 (await core.Supplier.get(this._options.environment)) ??
-                environments.ToltApiEnvironment.Production, `v2/transactions/${core.url.encodePathParam(id)}`),
+                environments.ToltApiEnvironment.Default, `v2/transactions/${core.url.encodePathParam(id, errors.ToltApiError)}`),
             method: "DELETE",
             headers: _headers,
             queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
@@ -314,6 +358,8 @@ export class TransactionsClient {
                     throw new ToltApi.NotFoundError(_response.error.body, _response.rawResponse);
                 case 409:
                     throw new ToltApi.ConflictError(_response.error.body, _response.rawResponse);
+                case 413:
+                    throw new ToltApi.ContentTooLargeError(_response.error.body, _response.rawResponse);
                 case 429:
                     throw new ToltApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
                 default:
@@ -329,19 +375,20 @@ export class TransactionsClient {
     /**
      * Unpaid commissions are zeroed while preserving their original deducted commission amount, and affected draft invoices are recalculated. Paid commissions and commissions linked to legacy autopayout invoices receive a negative reversal.
      *
-     * @param {ToltApi.RefundTransactionsRequest} request
+     * @param {ToltApi.RefundTransactionRequest} request
      * @param {TransactionsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ToltApi.UnauthorizedError}
      * @throws {@link ToltApi.NotFoundError}
      * @throws {@link ToltApi.ConflictError}
+     * @throws {@link ToltApi.ContentTooLargeError}
      * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
      * @example
      *     await client.transactions.refund({
-     *         id: "id"
+     *         id: "txn_fB3egT1sKNVNu3ZYuU1ypYDA"
      *     })
      */
     refund(request, requestOptions) {
@@ -354,7 +401,7 @@ export class TransactionsClient {
         const _response = await core.fetcher({
             url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
                 (await core.Supplier.get(this._options.environment)) ??
-                environments.ToltApiEnvironment.Production, `v2/transactions/${core.url.encodePathParam(id)}/refund`),
+                environments.ToltApiEnvironment.Default, `v2/transactions/${core.url.encodePathParam(id, errors.ToltApiError)}/refund`),
             method: "POST",
             headers: _headers,
             queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
@@ -375,6 +422,8 @@ export class TransactionsClient {
                     throw new ToltApi.NotFoundError(_response.error.body, _response.rawResponse);
                 case 409:
                     throw new ToltApi.ConflictError(_response.error.body, _response.rawResponse);
+                case 413:
+                    throw new ToltApi.ContentTooLargeError(_response.error.body, _response.rawResponse);
                 case 429:
                     throw new ToltApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
                 default:
@@ -390,19 +439,20 @@ export class TransactionsClient {
     /**
      * Re-queues the transaction for asynchronous flow processing. Only transactions without an existing commission are eligible, so a rerun cannot create a duplicate commission.
      *
-     * @param {ToltApi.RerunFlowsTransactionsRequest} request
+     * @param {ToltApi.RerunTransactionFlowsRequest} request
      * @param {TransactionsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ToltApi.UnauthorizedError}
      * @throws {@link ToltApi.NotFoundError}
      * @throws {@link ToltApi.ConflictError}
+     * @throws {@link ToltApi.ContentTooLargeError}
      * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
      * @example
      *     await client.transactions.rerunFlows({
-     *         id: "id"
+     *         id: "txn_fB3egT1sKNVNu3ZYuU1ypYDA"
      *     })
      */
     rerunFlows(request, requestOptions) {
@@ -415,12 +465,12 @@ export class TransactionsClient {
         const _response = await core.fetcher({
             url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
                 (await core.Supplier.get(this._options.environment)) ??
-                environments.ToltApiEnvironment.Production, `v2/transactions/${core.url.encodePathParam(id)}/rerun-flows`),
+                environments.ToltApiEnvironment.Default, `v2/transactions/${core.url.encodePathParam(id, errors.ToltApiError)}/rerun-flows`),
             method: "POST",
             headers: _headers,
             queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
             timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
-            maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
+            maxRetries: 0,
             abortSignal: requestOptions?.abortSignal,
             fetchFn: this._options?.fetch,
             logging: this._options.logging,
@@ -439,6 +489,8 @@ export class TransactionsClient {
                     throw new ToltApi.NotFoundError(_response.error.body, _response.rawResponse);
                 case 409:
                     throw new ToltApi.ConflictError(_response.error.body, _response.rawResponse);
+                case 413:
+                    throw new ToltApi.ContentTooLargeError(_response.error.body, _response.rawResponse);
                 case 429:
                     throw new ToltApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
                 default:

package/dist/api/resources/transactions/client/requests/CreateTransactionRequest.d.ts

@@ -0,0 +1,34 @@
+/**
+ * @example
+ *     {
+ *         product_id: "prod_pro",
+ *         product_name: "Pro plan",
+ *         amount: 5000,
+ *         customer_id: "cus_LBfjvtfct9pVUeLojMHiGnXv",
+ *         billing_type: "subscription",
+ *         interval: "month",
+ *         source: "api"
+ *     }
+ */
+export interface CreateTransactionRequest {
+    /** When the payment happened, as a timestamp with a time zone, for example 2026-03-01T12:00:00Z. Reports and date filters place the transaction on this date. Defaults to now. */
+    created_at?: string;
+    /** Id of the purchased product in your billing system. Commission flows can match on it. */
+    product_id?: string;
+    /** Readable name of the purchased product, such as Pro plan. It is saved as the transaction's product name, which revenue_by_product groups revenue by; flows match on product_id, not on this name. */
+    product_name?: string;
+    /** The payment amount in the smallest unit of the program currency (cents for USD); percentage commissions are calculated from it. */
+    amount: number;
+    /** Id of the customer who paid (cus_...), as returned when listing customers. The transaction goes to that customer's partner and program, and the customer becomes active. */
+    customer_id: string;
+    /** Kind of payment: subscription for a recurring payment, or one_time. Commission flows can match on it. */
+    billing_type?: string;
+    /** Id of the payment in your billing system, such as a Stripe charge id. A customer can have only one transaction per charge_id, so retrying a create with the same value returns 409 instead of booking the payment twice. An empty or whitespace-only charge_id is stored as no charge id and is not checked; any other value is stored and compared exactly as sent. */
+    charge_id?: string;
+    /** Id of the tracked click behind this payment, as returned when listing clicks. Commission flows use its link before falling back to the customer's link. */
+    click_id?: string;
+    /** Billing period of a subscription payment: month or year. Commission flows can match on it. Flows can also split a yearly payment into monthly commissions. */
+    interval?: string;
+    /** Where the transaction came from, such as stripe or api. Commissions that flows create from it copy this value. */
+    source?: string;
+}

package/dist/api/resources/transactions/client/requests/DeleteTransactionRequest.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @example
+ *     {
+ *         id: "txn_fB3egT1sKNVNu3ZYuU1ypYDA"
+ *     }
+ */
+export interface DeleteTransactionRequest {
+    id: string;
+}

package/dist/api/resources/transactions/client/requests/GetTransactionRequest.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @example
+ *     {
+ *         id: "txn_fB3egT1sKNVNu3ZYuU1ypYDA"
+ *     }
+ */
+export interface GetTransactionRequest {
+    id: string;
+}

package/dist/api/resources/transactions/client/requests/ListTransactionsRequest.d.ts

@@ -4,25 +4,32 @@ import type * as ToltApi from "../../../../index.js";
  *     {}
  */
 export interface ListTransactionsRequest {
+    /** How many rows to return in one page. */
     limit?: number;
+    /** Ranking direction: desc puts the most recently created or updated rows first. */
     order?: ToltApi.ListTransactionsRequestOrder;
-    /** Column the list is ordered and paged by. */
+    /** Timestamp to order and page by: created_at follows creation order, updated_at follows each item's most recent change. */
     sort?: ToltApi.ListTransactionsRequestSort;
     /** Continue after a position: the next_cursor of a previous page, or an item id when sorting by created_at. Cannot be combined with ending_before. */
     starting_after?: string;
     /** Page backward from a position: the prev_cursor of a previous page, or an item id when sorting by created_at. Cannot be combined with starting_after. */
     ending_before?: string;
-    /** Only items created at or after this ISO 8601 time. */
+    /** Start of a window on when items were created: items created at this time or later are included, for example 2026-01-01T00:00:00Z. Leave it out for no lower bound. */
     created_after?: string;
-    /** Only items created before this ISO 8601 time. */
+    /** End of a window on when items were created: only items created before this time are included. Leave it out for no upper bound. */
     created_before?: string;
-    /** Only items updated at or after this ISO 8601 time. Combine with sort=updated_at to sync changes. */
+    /** Only items last changed at or after this moment; with sort=updated_at, use it to fetch what changed since a previous sync. */
     updated_after?: string;
-    /** Only items updated before this ISO 8601 time. */
+    /** Only items last changed before this moment; pair it with updated_after to fetch what changed in a period. */
     updated_before?: string;
+    /** Limit to one program, by its id (prg_...) as returned when listing programs. */
     program_id?: string;
+    /** Limit to one partner, by its id (part_...) as returned when listing partners. */
     partner_id?: string;
+    /** Only transactions from this customer, by Tolt customer id (cus_...) as returned when listing customers. */
     customer_id?: string;
+    /** Only transactions in this status, matched exactly, such as paid or refunded. */
     status?: string;
+    /** Text matched anywhere in the transaction id or its charge_id, ignoring case. */
     search?: string;
 }

package/dist/api/resources/transactions/client/requests/RefundTransactionRequest.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @example
+ *     {
+ *         id: "txn_fB3egT1sKNVNu3ZYuU1ypYDA"
+ *     }
+ */
+export interface RefundTransactionRequest {
+    id: string;
+}

package/dist/api/resources/transactions/client/requests/RerunTransactionFlowsRequest.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @example
+ *     {
+ *         id: "txn_fB3egT1sKNVNu3ZYuU1ypYDA"
+ *     }
+ */
+export interface RerunTransactionFlowsRequest {
+    id: string;
+}

package/dist/api/resources/transactions/client/requests/UpdateTransactionRequest.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @example
+ *     {
+ *         id: "txn_fB3egT1sKNVNu3ZYuU1ypYDA",
+ *         amount: 5000,
+ *         product_name: "Pro plan"
+ *     }
+ */
+export interface UpdateTransactionRequest {
+    id: string;
+    /** The payment amount in the smallest unit of the program currency (cents for USD); percentage commissions are calculated from it. */
+    amount?: number;
+    /** Payment status text, such as paid, which is what new transactions get. refunded is not accepted here: refund a transaction with the refund action. null clears the status. */
+    status?: string | null;
+    /** Where the transaction came from, such as stripe or api. */
+    source?: string | null;
+    /** Kind of payment: subscription for a recurring payment, or one_time. */
+    billing_type?: string | null;
+    /** Id of the payment in your billing system, such as a Stripe charge id. */
+    charge_id?: string | null;
+    /** Id of the tracked click behind this payment, as returned when listing clicks. */
+    click_id?: string | null;
+    /** Id of the purchased product in your billing system. */
+    product_id?: string | null;
+    /** Readable name of the purchased product, such as Pro plan. It is saved as the transaction's product name, which revenue_by_product groups revenue by; flows match on product_id, not on this name. null clears it. */
+    product_name?: string | null;
+    /** Billing period of a subscription payment: month or year. */
+    interval?: string | null;
+    /** When the payment happened, as a timestamp with a time zone, for example 2026-03-01T12:00:00Z. Reports and date filters place the transaction on this date. */
+    created_at?: string;
+}

package/dist/api/resources/transactions/client/requests/index.d.ts

@@ -1,7 +1,7 @@
-export type { CreateTransactionsRequest } from "./CreateTransactionsRequest.js";
-export type { DeleteTransactionsRequest } from "./DeleteTransactionsRequest.js";
-export type { GetTransactionsRequest } from "./GetTransactionsRequest.js";
+export type { CreateTransactionRequest } from "./CreateTransactionRequest.js";
+export type { DeleteTransactionRequest } from "./DeleteTransactionRequest.js";
+export type { GetTransactionRequest } from "./GetTransactionRequest.js";
 export type { ListTransactionsRequest } from "./ListTransactionsRequest.js";
-export type { RefundTransactionsRequest } from "./RefundTransactionsRequest.js";
-export type { RerunFlowsTransactionsRequest } from "./RerunFlowsTransactionsRequest.js";
-export type { UpdateTransactionsRequest } from "./UpdateTransactionsRequest.js";
+export type { RefundTransactionRequest } from "./RefundTransactionRequest.js";
+export type { RerunTransactionFlowsRequest } from "./RerunTransactionFlowsRequest.js";
+export type { UpdateTransactionRequest } from "./UpdateTransactionRequest.js";

package/dist/api/resources/transactions/types/{CreateTransactionsResponse.d.ts → CreateTransactionResponse.d.ts}

@@ -1,5 +1,5 @@
 import type * as ToltApi from "../../../index.js";
-export interface CreateTransactionsResponse {
+export interface CreateTransactionResponse {
     success: boolean;
     message: string;
     data: ToltApi.Transaction;

package/dist/api/resources/transactions/types/{DeleteTransactionsResponse.d.ts → DeleteTransactionResponse.d.ts}

@@ -1,5 +1,5 @@
 import type * as ToltApi from "../../../index.js";
-export interface DeleteTransactionsResponse {
+export interface DeleteTransactionResponse {
     success: boolean;
     message: string;
     data: ToltApi.Transaction;

package/dist/api/resources/transactions/types/{GetTransactionsResponse.d.ts → GetTransactionResponse.d.ts}

@@ -1,5 +1,5 @@
 import type * as ToltApi from "../../../index.js";
-export interface GetTransactionsResponse {
+export interface GetTransactionResponse {
     success: boolean;
     message: string;
     data: ToltApi.Transaction;

package/dist/api/resources/transactions/types/ListTransactionsRequestOrder.d.ts

@@ -1,3 +1,4 @@
+/** Ranking direction: desc puts the most recently created or updated rows first. */
 export declare const ListTransactionsRequestOrder: {
     readonly Asc: "asc";
     readonly Desc: "desc";

package/dist/api/resources/transactions/types/ListTransactionsRequestOrder.js

@@ -1,4 +1,5 @@
 // This file was auto-generated by Fern from our API Definition.
+/** Ranking direction: desc puts the most recently created or updated rows first. */
 export const ListTransactionsRequestOrder = {
     Asc: "asc",
     Desc: "desc",

package/dist/api/resources/transactions/types/ListTransactionsRequestSort.d.ts

@@ -1,4 +1,4 @@
-/** Column the list is ordered and paged by. */
+/** Timestamp to order and page by: created_at follows creation order, updated_at follows each item's most recent change. */
 export declare const ListTransactionsRequestSort: {
     readonly CreatedAt: "created_at";
     readonly UpdatedAt: "updated_at";