@tolt/api 0.6.1 → 1.0.0

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

@@ -11,11 +11,14 @@ export class GroupsClient {
         this._options = normalizeClientOptionsWithAuth(options);
     }
     /**
+     * Lists partner groups. Filter by program or by the default group, and page with cursors.
+     *
      * @param {ToltApi.ListGroupsRequest} request
      * @param {GroupsClient.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,78 +26,93 @@ export class GroupsClient {
      * @example
      *     await client.groups.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, search, default: default_, } = 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,
-            search,
-            default: default_ != null ? default_ : undefined,
-        };
-        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/groups"),
-            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, search, default: default_, } = 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,
+                search,
+                default: default_,
+            };
+            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/groups"),
+                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/groups");
+            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/groups");
+        });
+        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.GetGroupsRequest} request
+     * Gets a partner group by ID, with the program it belongs to and whether it is the program's default group.
+     *
+     * @param {ToltApi.GetGroupRequest} request
      * @param {GroupsClient.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.groups.get({
-     *         id: "id"
+     *         id: "grp_zUQ8Pt281MsbNDApmDPN3Y2a"
      *     })
      */
     get(request, requestOptions) {
@@ -107,7 +125,7 @@ export class GroupsClient {
         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/groups/${core.url.encodePathParam(id)}`),
+                environments.ToltApiEnvironment.Default, `v2/groups/${core.url.encodePathParam(id, errors.ToltApiError)}`),
             method: "GET",
             headers: _headers,
             queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
@@ -126,6 +144,8 @@ export class GroupsClient {
                     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/groups/client/requests/GetGroupRequest.d.ts

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

package/dist/api/resources/groups/client/requests/ListGroupsRequest.d.ts

@@ -4,23 +4,28 @@ import type * as ToltApi from "../../../../index.js";
  *     {}
  */
 export interface ListGroupsRequest {
+    /** How many rows to return in one page. */
     limit?: number;
+    /** Ranking direction: desc puts the most recently created or updated rows first. */
     order?: ToltApi.ListGroupsRequestOrder;
-    /** 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.ListGroupsRequestSort;
     /** 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;
+    /** Text matched anywhere in the group's name, description or public key, ignoring case. */
     search?: string;
-    default?: ToltApi.ListGroupsRequestDefault;
+    /** true lists only default groups, where new partners are placed unless another group is chosen; false lists the others. */
+    default?: boolean;
 }

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

@@ -1,2 +1,2 @@
-export type { GetGroupsRequest } from "./GetGroupsRequest.js";
+export type { GetGroupRequest } from "./GetGroupRequest.js";
 export type { ListGroupsRequest } from "./ListGroupsRequest.js";

package/dist/api/resources/groups/types/{GetGroupsResponse.d.ts → GetGroupResponse.d.ts}

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

package/dist/api/resources/groups/types/ListGroupsRequestOrder.d.ts

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

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

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

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

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

@@ -1,5 +1,4 @@
-export * from "./GetGroupsResponse.js";
-export * from "./ListGroupsRequestDefault.js";
+export * from "./GetGroupResponse.js";
 export * from "./ListGroupsRequestOrder.js";
 export * from "./ListGroupsRequestSort.js";
 export * from "./ListGroupsResponse.js";

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

@@ -1,5 +1,4 @@
-export * from "./GetGroupsResponse.js";
-export * from "./ListGroupsRequestDefault.js";
+export * from "./GetGroupResponse.js";
 export * from "./ListGroupsRequestOrder.js";
 export * from "./ListGroupsRequestSort.js";
 export * from "./ListGroupsResponse.js";

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

@@ -7,9 +7,9 @@ export * from "./commissions/types/index.js";
 export * from "./customers/client/requests/index.js";
 export * as customers from "./customers/index.js";
 export * from "./customers/types/index.js";
-export * from "./embed/client/requests/index.js";
-export * as embed from "./embed/index.js";
-export * from "./embed/types/index.js";
+export * from "./embedTokens/client/requests/index.js";
+export * as embedTokens from "./embedTokens/index.js";
+export * from "./embedTokens/types/index.js";
 export * from "./flows/client/requests/index.js";
 export * as flows from "./flows/index.js";
 export * from "./flows/types/index.js";

package/dist/api/resources/index.js

@@ -7,9 +7,9 @@ export * from "./commissions/types/index.js";
 export * from "./customers/client/requests/index.js";
 export * as customers from "./customers/index.js";
 export * from "./customers/types/index.js";
-export * from "./embed/client/requests/index.js";
-export * as embed from "./embed/index.js";
-export * from "./embed/types/index.js";
+export * from "./embedTokens/client/requests/index.js";
+export * as embedTokens from "./embedTokens/index.js";
+export * from "./embedTokens/types/index.js";
 export * from "./flows/client/requests/index.js";
 export * as flows from "./flows/index.js";
 export * from "./flows/types/index.js";

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

@@ -18,6 +18,7 @@ export declare class LinksClient {
      *
      * @throws {@link ToltApi.BadRequestError}
      * @throws {@link ToltApi.UnauthorizedError}
+     * @throws {@link ToltApi.ContentTooLargeError}
      * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
@@ -25,35 +26,40 @@ export declare class LinksClient {
      * @example
      *     await client.links.list()
      */
-    list(request?: ToltApi.ListLinksRequest, requestOptions?: LinksClient.RequestOptions): core.HttpResponsePromise<ToltApi.ListLinksResponse>;
-    private __list;
+    list(request?: ToltApi.ListLinksRequest, requestOptions?: LinksClient.RequestOptions): Promise<core.Page<ToltApi.Link, ToltApi.ListLinksResponse>>;
     /**
-     * @param {ToltApi.CreateLinksRequest} request
+     * Creates a referral link for a partner. The value must be unique for its parameter, and param defaults to the program's.
+     *
+     * @param {ToltApi.CreateLinkRequest} request
      * @param {LinksClient.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.links.create({
-     *         value: "value",
-     *         partner_id: "partner_id"
+     *         value: "sam",
+     *         param: "ref",
+     *         partner_id: "part_NLYzgNKuSuASvrvoxNtau6SY"
      *     })
      */
-    create(request: ToltApi.CreateLinksRequest, requestOptions?: LinksClient.RequestOptions): core.HttpResponsePromise<ToltApi.CreateLinksResponse>;
+    create(request: ToltApi.CreateLinkRequest, requestOptions?: LinksClient.RequestOptions): core.HttpResponsePromise<ToltApi.CreateLinkResponse>;
     private __create;
     /**
      * Looks up a single link by its parameter and value (value matched case-insensitively). Returns 404 when none matches.
      *
-     * @param {ToltApi.GetByParamValueLinksRequest} request
+     * @param {ToltApi.GetLinkByParamValueRequest} request
      * @param {LinksClient.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}
@@ -64,65 +70,70 @@ export declare class LinksClient {
      *         value: "sam"
      *     })
      */
-    getByParamValue(request: ToltApi.GetByParamValueLinksRequest, requestOptions?: LinksClient.RequestOptions): core.HttpResponsePromise<ToltApi.GetByParamValueLinksResponse>;
+    getByParamValue(request: ToltApi.GetLinkByParamValueRequest, requestOptions?: LinksClient.RequestOptions): core.HttpResponsePromise<ToltApi.GetLinkByParamValueResponse>;
     private __getByParamValue;
     /**
      * Gets an ordinary or campaign-managed link by ID.
      *
-     * @param {ToltApi.GetLinksRequest} request
+     * @param {ToltApi.GetLinkRequest} request
      * @param {LinksClient.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.links.get({
-     *         id: "id"
+     *         id: "lnk_mtTeeckFa1vMdvDFXretQNs6"
      *     })
      */
-    get(request: ToltApi.GetLinksRequest, requestOptions?: LinksClient.RequestOptions): core.HttpResponsePromise<ToltApi.GetLinksResponse>;
+    get(request: ToltApi.GetLinkRequest, requestOptions?: LinksClient.RequestOptions): core.HttpResponsePromise<ToltApi.GetLinkResponse>;
     private __get;
     /**
      * Updates an ordinary link. Campaign-managed links must be changed through campaigns.
      *
-     * @param {ToltApi.UpdateLinksRequest} request
+     * @param {ToltApi.UpdateLinkRequest} request
      * @param {LinksClient.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.links.update({
-     *         id: "id"
+     *         id: "lnk_mtTeeckFa1vMdvDFXretQNs6",
+     *         param: "ref",
+     *         value: "sam"
      *     })
      */
-    update(request: ToltApi.UpdateLinksRequest, requestOptions?: LinksClient.RequestOptions): core.HttpResponsePromise<ToltApi.UpdateLinksResponse>;
+    update(request: ToltApi.UpdateLinkRequest, requestOptions?: LinksClient.RequestOptions): core.HttpResponsePromise<ToltApi.UpdateLinkResponse>;
     private __update;
     /**
      * Deletes an ordinary link. Campaign-managed links must be changed through campaigns.
      *
-     * @param {ToltApi.DeleteLinksRequest} request
+     * @param {ToltApi.DeleteLinkRequest} request
      * @param {LinksClient.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.links.delete({
-     *         id: "id"
+     *         id: "lnk_mtTeeckFa1vMdvDFXretQNs6"
      *     })
      */
-    delete(request: ToltApi.DeleteLinksRequest, requestOptions?: LinksClient.RequestOptions): core.HttpResponsePromise<ToltApi.DeleteLinksResponse>;
+    delete(request: ToltApi.DeleteLinkRequest, requestOptions?: LinksClient.RequestOptions): core.HttpResponsePromise<ToltApi.DeleteLinkResponse>;
     private __delete;
 }