@tolt/api 0.6.1 → 1.0.0

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

@@ -12,11 +12,14 @@ export class CustomersClient {
         this._options = normalizeClientOptionsWithAuth(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}
@@ -24,82 +27,106 @@ export class CustomersClient {
      * @example
      *     await client.customers.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, click_id: clickId, link_id: linkId, } = 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: status != null ? status : undefined,
-            search,
-            click_id: clickId,
-            link_id: linkId,
-        };
-        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/customers"),
-            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, click_id: clickId, link_id: linkId, } = 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: status != null ? status : undefined,
+                search,
+                click_id: clickId,
+                link_id: linkId,
+            };
+            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/customers"),
+                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/customers");
+            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/customers");
+        });
+        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));
+            },
+        });
     }
     /**
-     * @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 = {}, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__create(request, requestOptions));
@@ -110,7 +137,7 @@ export class CustomersClient {
         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/customers"),
+                environments.ToltApiEnvironment.Default, "v2/customers"),
             method: "POST",
             headers: _headers,
             contentType: "application/json",
@@ -118,7 +145,7 @@ export class CustomersClient {
             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 +161,8 @@ export class CustomersClient {
                     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 CustomersClient {
         return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v2/customers");
     }
     /**
-     * @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, requestOptions) {
@@ -171,7 +203,7 @@ export class CustomersClient {
         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/customers/${core.url.encodePathParam(id)}`),
+                environments.ToltApiEnvironment.Default, `v2/customers/${core.url.encodePathParam(id, errors.ToltApiError)}`),
             method: "GET",
             headers: _headers,
             queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
@@ -190,6 +222,8 @@ export class CustomersClient {
                     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 CustomersClient {
         return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v2/customers/{id}");
     }
     /**
-     * @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, requestOptions) {
@@ -229,7 +268,7 @@ export class CustomersClient {
         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/customers/${core.url.encodePathParam(id)}`),
+                environments.ToltApiEnvironment.Default, `v2/customers/${core.url.encodePathParam(id, errors.ToltApiError)}`),
             method: "PUT",
             headers: _headers,
             contentType: "application/json",
@@ -255,6 +294,8 @@ export class CustomersClient {
                     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 CustomersClient {
         return handleNonStatusCodeError(_response.error, _response.rawResponse, "PUT", "/v2/customers/{id}");
     }
     /**
-     * @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, requestOptions) {
@@ -293,7 +337,7 @@ export class CustomersClient {
         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/customers/${core.url.encodePathParam(id)}`),
+                environments.ToltApiEnvironment.Default, `v2/customers/${core.url.encodePathParam(id, errors.ToltApiError)}`),
             method: "DELETE",
             headers: _headers,
             queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
@@ -314,6 +358,8 @@ export class CustomersClient {
                     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:

package/dist/api/resources/customers/client/requests/CreateCustomerRequest.d.ts

@@ -0,0 +1,47 @@
+/**
+ * @example
+ *     {
+ *         email: "alex@example.com",
+ *         name: "Alex Morgan",
+ *         customer_id: "user_4821",
+ *         link_id: "lnk_mtTeeckFa1vMdvDFXretQNs6",
+ *         partner_id: "part_NLYzgNKuSuASvrvoxNtau6SY"
+ *     }
+ */
+export interface CreateCustomerRequest {
+    /** Customer's email, stored lowercased and used as their identifier. It must not belong to another customer. Provide this or customer_id. */
+    email?: string;
+    /** Resolve a code in the partner’s program, ignoring case, preferring partner, group, then program scope. An unmatched code leaves attribution unchanged. */
+    promotion_code?: string;
+    /** When the customer was created, for backdating. Defaults to now; lead_at, and active_at for active customers, default to it. */
+    created_at?: string;
+    /** Customer's full name as you want it shown in the dashboard; it does not affect attribution or matching. */
+    name?: string;
+    /** Customer's id in your billing system, such as a Stripe customer id. The billing integration matches payments to this customer by it. Provide this or email. */
+    customer_id?: string;
+    /** Lifecycle stage of the customer. Defaults to lead (signed up, not paying yet); recording a transaction for the customer makes them active. */
+    status?: CreateCustomerRequest.Status;
+    /** Customer's subscription id in your billing system, such as a Stripe subscription id. */
+    subscription_id?: string;
+    /** Id of the tracked click the customer came from, as returned when listing clicks. It must belong to the partner, and its link is used when link_id is omitted. */
+    click_id?: string;
+    /** Id of the referral link the customer came through (lnk_...). Without partner_id the link's partner is used; with it, the link must belong to that partner. */
+    link_id?: string;
+    /** Id of the partner who referred the customer (part_...), as returned when listing partners. The customer joins that partner's program. Provide this or link_id. */
+    partner_id?: string;
+    /** When the customer signed up as a lead, as a timestamp with a time zone, for example 2026-03-01T12:00:00Z. Defaults to created_at. */
+    lead_at?: string | null;
+    /** When the customer became a paying customer, as a timestamp with a time zone. Defaults to created_at when status is active, otherwise it is set when a transaction is recorded for the customer. */
+    active_at?: string | null;
+}
+export declare namespace CreateCustomerRequest {
+    /** Lifecycle stage of the customer. Defaults to lead (signed up, not paying yet); recording a transaction for the customer makes them active. */
+    const Status: {
+        readonly Lead: "lead";
+        readonly Active: "active";
+        readonly Canceled: "canceled";
+        readonly Suspended: "suspended";
+        readonly Trialing: "trialing";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+}

package/dist/api/resources/customers/client/requests/CreateCustomerRequest.js

@@ -0,0 +1,12 @@
+// This file was auto-generated by Fern from our API Definition.
+export var CreateCustomerRequest;
+(function (CreateCustomerRequest) {
+    /** Lifecycle stage of the customer. Defaults to lead (signed up, not paying yet); recording a transaction for the customer makes them active. */
+    CreateCustomerRequest.Status = {
+        Lead: "lead",
+        Active: "active",
+        Canceled: "canceled",
+        Suspended: "suspended",
+        Trialing: "trialing",
+    };
+})(CreateCustomerRequest || (CreateCustomerRequest = {}));

package/dist/api/resources/customers/client/requests/DeleteCustomerRequest.d.ts

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

package/dist/api/resources/customers/client/requests/GetCustomerRequest.d.ts

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

package/dist/api/resources/customers/client/requests/ListCustomersRequest.d.ts

@@ -4,27 +4,36 @@ import type * as ToltApi from "../../../../index.js";
  *     {}
  */
 export interface ListCustomersRequest {
+    /** How many rows to return in one page. */
     limit?: number;
+    /** Ranking direction: desc puts the most recently created or updated rows first. */
     order?: ToltApi.ListCustomersRequestOrder;
-    /** 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.ListCustomersRequestSort;
     /** 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;
+    /** Exact match on the customer's customer_id field, the id the customer has in your own system or billing provider; not the Tolt customer id. */
     customer_id?: string;
+    /** Keep only customers at this lifecycle stage, from signed-up leads through trials to paying, canceled or suspended customers. Leave it out to include every stage. */
     status?: ToltApi.ListCustomersRequestStatus;
+    /** Text matched anywhere in the customer's email, name, identifier or customer_id, ignoring case. */
     search?: string;
+    /** Only the customers attributed to this click, by its id (clk_...). */
     click_id?: string;
+    /** Only customers attributed to this referral link (lnk_...), directly or through one of its clicks. */
     link_id?: string;
 }

package/dist/api/resources/customers/client/requests/UpdateCustomerRequest.d.ts

@@ -0,0 +1,44 @@
+/**
+ * @example
+ *     {
+ *         id: "cus_LBfjvtfct9pVUeLojMHiGnXv",
+ *         name: "Alex Morgan",
+ *         status: "active"
+ *     }
+ */
+export interface UpdateCustomerRequest {
+    id: string;
+    /** New email, stored lowercased and used as the customer's identifier. It must not belong to another customer. */
+    email?: string;
+    /** Resolve a code in the partner’s program, ignoring case, preferring partner, group, then program scope. An unmatched code leaves attribution unchanged. Null clears the promotion code and its derived attribution. */
+    promotion_code?: string | null;
+    /** When the customer was created, as a timestamp with a time zone, for example 2026-03-01T12:00:00Z. Reports and filters that date customers by creation use it; those that date them by conversion read active_at, which this does not change. */
+    created_at?: string;
+    /** Customer's full name as you want it shown in the dashboard; it does not affect attribution or matching. */
+    name?: string | null;
+    /** Lifecycle stage of the customer. Changing it does not set active_at or run commission flows. */
+    status?: UpdateCustomerRequest.Status | null;
+    /** Customer's id in your billing system, such as a Stripe customer id. The billing integration matches payments to this customer by it. */
+    customer_id?: string;
+    /** Customer's subscription id in your billing system, such as a Stripe subscription id. */
+    subscription_id?: string | null;
+    /** Id of the tracked click the customer came from, as returned when listing clicks. It must belong to the customer's partner; link_id is not changed. */
+    click_id?: string | null;
+    /** Id of the referral link the customer came through (lnk_...). It must belong to the customer's partner; a customer without a partner takes the link's partner and program. */
+    link_id?: string | null;
+    /** When the customer signed up as a lead, as a timestamp with a time zone, for example 2026-03-01T12:00:00Z. */
+    lead_at?: string | null;
+    /** When the customer became a paying customer, as a timestamp with a time zone. */
+    active_at?: string | null;
+}
+export declare namespace UpdateCustomerRequest {
+    /** Lifecycle stage of the customer. Changing it does not set active_at or run commission flows. */
+    const Status: {
+        readonly Lead: "lead";
+        readonly Active: "active";
+        readonly Canceled: "canceled";
+        readonly Suspended: "suspended";
+        readonly Trialing: "trialing";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+}

package/dist/api/resources/customers/client/requests/UpdateCustomerRequest.js

@@ -0,0 +1,12 @@
+// This file was auto-generated by Fern from our API Definition.
+export var UpdateCustomerRequest;
+(function (UpdateCustomerRequest) {
+    /** Lifecycle stage of the customer. Changing it does not set active_at or run commission flows. */
+    UpdateCustomerRequest.Status = {
+        Lead: "lead",
+        Active: "active",
+        Canceled: "canceled",
+        Suspended: "suspended",
+        Trialing: "trialing",
+    };
+})(UpdateCustomerRequest || (UpdateCustomerRequest = {}));

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

@@ -1,5 +1,5 @@
-export { CreateCustomersRequest } from "./CreateCustomersRequest.js";
-export type { DeleteCustomersRequest } from "./DeleteCustomersRequest.js";
-export type { GetCustomersRequest } from "./GetCustomersRequest.js";
+export { CreateCustomerRequest } from "./CreateCustomerRequest.js";
+export type { DeleteCustomerRequest } from "./DeleteCustomerRequest.js";
+export type { GetCustomerRequest } from "./GetCustomerRequest.js";
 export type { ListCustomersRequest } from "./ListCustomersRequest.js";
-export { UpdateCustomersRequest } from "./UpdateCustomersRequest.js";
+export { UpdateCustomerRequest } from "./UpdateCustomerRequest.js";

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

@@ -1,2 +1,2 @@
-export { CreateCustomersRequest } from "./CreateCustomersRequest.js";
-export { UpdateCustomersRequest } from "./UpdateCustomersRequest.js";
+export { CreateCustomerRequest } from "./CreateCustomerRequest.js";
+export { UpdateCustomerRequest } from "./UpdateCustomerRequest.js";

package/dist/api/resources/customers/types/{DeleteCustomersResponse.d.ts → CreateCustomerResponse.d.ts}

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

package/dist/api/resources/customers/types/{UpdateCustomersResponse.d.ts → DeleteCustomerResponse.d.ts}

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

package/dist/api/resources/customers/types/{GetCustomersResponse.d.ts → GetCustomerResponse.d.ts}

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

package/dist/api/resources/customers/types/ListCustomersRequestOrder.d.ts

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

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

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

package/dist/api/resources/customers/types/ListCustomersRequestSort.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 ListCustomersRequestSort = {
     CreatedAt: "created_at",
     UpdatedAt: "updated_at",

package/dist/api/resources/customers/types/ListCustomersRequestStatus.d.ts

@@ -1,3 +1,4 @@
+/** Keep only customers at this lifecycle stage, from signed-up leads through trials to paying, canceled or suspended customers. Leave it out to include every stage. */
 export declare const ListCustomersRequestStatus: {
     readonly Lead: "lead";
     readonly Active: "active";

package/dist/api/resources/customers/types/ListCustomersRequestStatus.js

@@ -1,4 +1,5 @@
 // This file was auto-generated by Fern from our API Definition.
+/** Keep only customers at this lifecycle stage, from signed-up leads through trials to paying, canceled or suspended customers. Leave it out to include every stage. */
 export const ListCustomersRequestStatus = {
     Lead: "lead",
     Active: "active",

package/dist/api/resources/customers/types/{CreateCustomersResponse.d.ts → UpdateCustomerResponse.d.ts}

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

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

@@ -1,8 +1,8 @@
-export * from "./CreateCustomersResponse.js";
-export * from "./DeleteCustomersResponse.js";
-export * from "./GetCustomersResponse.js";
+export * from "./CreateCustomerResponse.js";
+export * from "./DeleteCustomerResponse.js";
+export * from "./GetCustomerResponse.js";
 export * from "./ListCustomersRequestOrder.js";
 export * from "./ListCustomersRequestSort.js";
 export * from "./ListCustomersRequestStatus.js";
 export * from "./ListCustomersResponse.js";
-export * from "./UpdateCustomersResponse.js";
+export * from "./UpdateCustomerResponse.js";