@tolt/api 0.6.1 → 1.0.0

package/dist/api/resources/commissions/client/requests/ListCommissionsRequest.d.ts

@@ -4,27 +4,36 @@ import type * as ToltApi from "../../../../index.js";
  *     {}
  */
 export interface ListCommissionsRequest {
+    /** How many rows to return in one page. */
     limit?: number;
+    /** Ranking direction: desc puts the most recently created or updated rows first. */
     order?: ToltApi.ListCommissionsRequestOrder;
-    /** 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.ListCommissionsRequestSort;
     /** 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 commissions for this customer, by Tolt customer id (cus_...) as returned when listing customers. */
     customer_id?: string;
+    /** Only commissions linked to this transaction, by its id (txn_...). */
     transaction_id?: string;
+    /** Only commissions in this status, matched exactly, such as pending, approved or paid. */
     status?: string;
+    /** Only commissions whose type equals this stored value exactly. */
     type?: string;
+    /** Text matched anywhere in the commission id or its charge_id, ignoring case. */
     search?: string;
 }

package/dist/api/resources/commissions/client/requests/UpdateCommissionRequest.d.ts

@@ -0,0 +1,33 @@
+/**
+ * @example
+ *     {
+ *         id: "comm_X85RLnefjTCNrypH4MA1PdSp",
+ *         amount: 1000,
+ *         revenue: 5000,
+ *         status: "approved"
+ *     }
+ */
+export interface UpdateCommissionRequest {
+    id: string;
+    /** What the partner earns for this commission, in minor units of the program currency (cents for USD). */
+    amount?: number;
+    /** The sale amount the commission is based on, in minor units of the program currency. */
+    revenue?: number;
+    status?: UpdateCommissionRequest.Status;
+    /** Free-form label for where the commission came from, such as stripe or api. */
+    source?: string | null;
+    /** Id of the payment in your billing system that the commission is for, such as a Stripe charge id. */
+    charge_id?: string | null;
+    /** Id of the transaction the commission is for (txn_...). It must belong to the commission's customer, or to its partner and program, and must not be refunded. */
+    transaction_id?: string | null;
+    /** When the commission was earned, as a timestamp with a time zone, for example 2026-03-01T12:00:00Z. Reports and filters by creation date place the commission on this date; the upcoming approvals forecast goes by its scheduled approval date, which this does not change. */
+    created_at?: string;
+}
+export declare namespace UpdateCommissionRequest {
+    const Status: {
+        readonly Pending: "pending";
+        readonly Approved: "approved";
+        readonly Rejected: "rejected";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+}

package/dist/api/resources/commissions/client/requests/UpdateCommissionRequest.js

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+export var UpdateCommissionRequest;
+(function (UpdateCommissionRequest) {
+    UpdateCommissionRequest.Status = {
+        Pending: "pending",
+        Approved: "approved",
+        Rejected: "rejected",
+    };
+})(UpdateCommissionRequest || (UpdateCommissionRequest = {}));

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

@@ -1,8 +1,9 @@
-export type { ApproveCommissionsRequest } from "./ApproveCommissionsRequest.js";
+export type { ApproveCommissionRequest } from "./ApproveCommissionRequest.js";
 export type { BulkApproveCommissionsRequest } from "./BulkApproveCommissionsRequest.js";
 export type { BulkDeclineCommissionsRequest } from "./BulkDeclineCommissionsRequest.js";
-export type { DeclineCommissionsRequest } from "./DeclineCommissionsRequest.js";
-export type { DeleteCommissionsRequest } from "./DeleteCommissionsRequest.js";
-export type { GetCommissionsRequest } from "./GetCommissionsRequest.js";
+export { CreateCommissionRequest } from "./CreateCommissionRequest.js";
+export type { DeclineCommissionRequest } from "./DeclineCommissionRequest.js";
+export type { DeleteCommissionRequest } from "./DeleteCommissionRequest.js";
+export type { GetCommissionRequest } from "./GetCommissionRequest.js";
 export type { ListCommissionsRequest } from "./ListCommissionsRequest.js";
-export type { UpdateCommissionsRequest } from "./UpdateCommissionsRequest.js";
+export { UpdateCommissionRequest } from "./UpdateCommissionRequest.js";

package/dist/api/resources/commissions/client/requests/index.js

@@ -1 +1,2 @@
-export {};
+export { CreateCommissionRequest } from "./CreateCommissionRequest.js";
+export { UpdateCommissionRequest } from "./UpdateCommissionRequest.js";

package/dist/api/resources/commissions/types/{UpdateCommissionsResponse.d.ts → ApproveCommissionResponse.d.ts}

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

package/dist/api/resources/commissions/types/{DeleteCommissionsResponse.d.ts → CreateCommissionResponse.d.ts}

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

package/dist/api/resources/commissions/types/{CreateCommissionsResponse.d.ts → DeclineCommissionResponse.d.ts}

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

package/dist/api/resources/commissions/types/DeleteCommissionResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as ToltApi from "../../../index.js";
+export interface DeleteCommissionResponse {
+    success: boolean;
+    message: string;
+    data: ToltApi.Commission;
+}

package/dist/api/resources/commissions/types/{GetCommissionsResponse.d.ts → GetCommissionResponse.d.ts}

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

package/dist/api/resources/commissions/types/ListCommissionsRequestOrder.d.ts

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

package/dist/api/resources/commissions/types/ListCommissionsRequestOrder.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 ListCommissionsRequestOrder = {
     Asc: "asc",
     Desc: "desc",

package/dist/api/resources/commissions/types/ListCommissionsRequestSort.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 ListCommissionsRequestSort: {
     readonly CreatedAt: "created_at";
     readonly UpdatedAt: "updated_at";

package/dist/api/resources/commissions/types/ListCommissionsRequestSort.js

@@ -1,5 +1,5 @@
 // This file was auto-generated by Fern from our API Definition.
-/** 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 const ListCommissionsRequestSort = {
     CreatedAt: "created_at",
     UpdatedAt: "updated_at",

package/dist/api/resources/commissions/types/UpdateCommissionResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as ToltApi from "../../../index.js";
+export interface UpdateCommissionResponse {
+    success: boolean;
+    message: string;
+    data: ToltApi.Commission;
+}

package/dist/api/resources/commissions/types/index.d.ts

@@ -1,12 +1,11 @@
-export * from "./ApproveCommissionsResponse.js";
+export * from "./ApproveCommissionResponse.js";
 export * from "./BulkApproveCommissionsResponse.js";
 export * from "./BulkDeclineCommissionsResponse.js";
-export * from "./CreateCommissionsRequest.js";
-export * from "./CreateCommissionsResponse.js";
-export * from "./DeclineCommissionsResponse.js";
-export * from "./DeleteCommissionsResponse.js";
-export * from "./GetCommissionsResponse.js";
+export * from "./CreateCommissionResponse.js";
+export * from "./DeclineCommissionResponse.js";
+export * from "./DeleteCommissionResponse.js";
+export * from "./GetCommissionResponse.js";
 export * from "./ListCommissionsRequestOrder.js";
 export * from "./ListCommissionsRequestSort.js";
 export * from "./ListCommissionsResponse.js";
-export * from "./UpdateCommissionsResponse.js";
+export * from "./UpdateCommissionResponse.js";

package/dist/api/resources/commissions/types/index.js

@@ -1,12 +1,11 @@
-export * from "./ApproveCommissionsResponse.js";
+export * from "./ApproveCommissionResponse.js";
 export * from "./BulkApproveCommissionsResponse.js";
 export * from "./BulkDeclineCommissionsResponse.js";
-export * from "./CreateCommissionsRequest.js";
-export * from "./CreateCommissionsResponse.js";
-export * from "./DeclineCommissionsResponse.js";
-export * from "./DeleteCommissionsResponse.js";
-export * from "./GetCommissionsResponse.js";
+export * from "./CreateCommissionResponse.js";
+export * from "./DeclineCommissionResponse.js";
+export * from "./DeleteCommissionResponse.js";
+export * from "./GetCommissionResponse.js";
 export * from "./ListCommissionsRequestOrder.js";
 export * from "./ListCommissionsRequestSort.js";
 export * from "./ListCommissionsResponse.js";
-export * from "./UpdateCommissionsResponse.js";
+export * from "./UpdateCommissionResponse.js";

package/dist/api/resources/customers/client/Client.d.ts

@@ -11,11 +11,14 @@ export declare class CustomersClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<CustomersClient.Options>;
     constructor(options: CustomersClient.Options);
     /**
+     * Lists customers. Filter by program, partner, link, click, status or your own customer_id, and page with cursors.
+     *
      * @param {ToltApi.ListCustomersRequest} request
      * @param {CustomersClient.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}
@@ -23,76 +26,95 @@ export declare class CustomersClient {
      * @example
      *     await client.customers.list()
      */
-    list(request?: ToltApi.ListCustomersRequest, requestOptions?: CustomersClient.RequestOptions): core.HttpResponsePromise<ToltApi.ListCustomersResponse>;
-    private __list;
+    list(request?: ToltApi.ListCustomersRequest, requestOptions?: CustomersClient.RequestOptions): Promise<core.Page<ToltApi.Customer, ToltApi.ListCustomersResponse>>;
     /**
-     * @param {ToltApi.CreateCustomersRequest} request
+     * Creates a customer attributed to a partner. Pass partner_id or link_id, and optionally the click_id that brought them in.
+     *
+     * @param {ToltApi.CreateCustomerRequest} request
      * @param {CustomersClient.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.customers.create()
+     *     await client.customers.create({
+     *         email: "alex@example.com",
+     *         name: "Alex Morgan",
+     *         customer_id: "user_4821",
+     *         link_id: "lnk_mtTeeckFa1vMdvDFXretQNs6",
+     *         partner_id: "part_NLYzgNKuSuASvrvoxNtau6SY"
+     *     })
      */
-    create(request?: ToltApi.CreateCustomersRequest, requestOptions?: CustomersClient.RequestOptions): core.HttpResponsePromise<ToltApi.CreateCustomersResponse>;
+    create(request?: ToltApi.CreateCustomerRequest, requestOptions?: CustomersClient.RequestOptions): core.HttpResponsePromise<ToltApi.CreateCustomerResponse>;
     private __create;
     /**
-     * @param {ToltApi.GetCustomersRequest} request
+     * Gets a customer by ID, with its status, the partner it is attributed to and your own customer and subscription IDs.
+     *
+     * @param {ToltApi.GetCustomerRequest} request
      * @param {CustomersClient.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.customers.get({
-     *         id: "id"
+     *         id: "cus_LBfjvtfct9pVUeLojMHiGnXv"
      *     })
      */
-    get(request: ToltApi.GetCustomersRequest, requestOptions?: CustomersClient.RequestOptions): core.HttpResponsePromise<ToltApi.GetCustomersResponse>;
+    get(request: ToltApi.GetCustomerRequest, requestOptions?: CustomersClient.RequestOptions): core.HttpResponsePromise<ToltApi.GetCustomerResponse>;
     private __get;
     /**
-     * @param {ToltApi.UpdateCustomersRequest} request
+     * Updates a customer's name, email, status, your own IDs, or the click and link the customer came from.
+     *
+     * @param {ToltApi.UpdateCustomerRequest} request
      * @param {CustomersClient.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.customers.update({
-     *         id: "id"
+     *         id: "cus_LBfjvtfct9pVUeLojMHiGnXv",
+     *         name: "Alex Morgan",
+     *         status: "active"
      *     })
      */
-    update(request: ToltApi.UpdateCustomersRequest, requestOptions?: CustomersClient.RequestOptions): core.HttpResponsePromise<ToltApi.UpdateCustomersResponse>;
+    update(request: ToltApi.UpdateCustomerRequest, requestOptions?: CustomersClient.RequestOptions): core.HttpResponsePromise<ToltApi.UpdateCustomerResponse>;
     private __update;
     /**
-     * @param {ToltApi.DeleteCustomersRequest} request
+     * Deletes a customer. Fails when any of the customer's commissions is paid or already included in a payout.
+     *
+     * @param {ToltApi.DeleteCustomerRequest} request
      * @param {CustomersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ToltApi.BadRequestError}
      * @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.customers.delete({
-     *         id: "id"
+     *         id: "cus_LBfjvtfct9pVUeLojMHiGnXv"
      *     })
      */
-    delete(request: ToltApi.DeleteCustomersRequest, requestOptions?: CustomersClient.RequestOptions): core.HttpResponsePromise<ToltApi.DeleteCustomersResponse>;
+    delete(request: ToltApi.DeleteCustomerRequest, requestOptions?: CustomersClient.RequestOptions): core.HttpResponsePromise<ToltApi.DeleteCustomerResponse>;
     private __delete;
 }