@tolt/api 0.6.1 → 0.7.0

package/dist/api/errors/ContentTooLargeError.d.ts

@@ -0,0 +1,7 @@
+import type * as core from "../../core/index.js";
+import * as errors from "../../errors/index.js";
+import type * as ToltApi from "../index.js";
+export declare class ContentTooLargeError extends errors.ToltApiError {
+    readonly body: ToltApi.Error_;
+    constructor(body: ToltApi.Error_, rawResponse?: core.RawResponse);
+}

package/dist/api/errors/ContentTooLargeError.js

@@ -0,0 +1,17 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as errors from "../../errors/index.js";
+export class ContentTooLargeError extends errors.ToltApiError {
+    constructor(body, rawResponse) {
+        super({
+            message: "ContentTooLargeError",
+            statusCode: 413,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+        this.name = "ContentTooLargeError";
+    }
+}

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

@@ -1,5 +1,6 @@
 export * from "./BadRequestError.js";
 export * from "./ConflictError.js";
+export * from "./ContentTooLargeError.js";
 export * from "./NotFoundError.js";
 export * from "./TooManyRequestsError.js";
 export * from "./UnauthorizedError.js";

package/dist/api/errors/index.js

@@ -1,5 +1,6 @@
 export * from "./BadRequestError.js";
 export * from "./ConflictError.js";
+export * from "./ContentTooLargeError.js";
 export * from "./NotFoundError.js";
 export * from "./TooManyRequestsError.js";
 export * from "./UnauthorizedError.js";

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

@@ -18,6 +18,7 @@ export declare class ClicksClient {
      *
      * @throws {@link ToltApi.BadRequestError}
      * @throws {@link ToltApi.UnauthorizedError}
+     * @throws {@link ToltApi.ContentTooLargeError}
      * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
@@ -38,6 +39,7 @@ export declare class ClicksClient {
      *
      * @throws {@link ToltApi.BadRequestError}
      * @throws {@link ToltApi.UnauthorizedError}
+     * @throws {@link ToltApi.ContentTooLargeError}
      * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
@@ -50,18 +52,21 @@ export declare class ClicksClient {
     create(request: ToltApi.CreateClicksRequest, requestOptions?: ClicksClient.RequestOptions): core.HttpResponsePromise<ToltApi.CreateClicksResponse>;
     private __create;
     /**
+     * Gets a recorded click by ID, with the partner, link, page, referrer, country, device and browser it came from.
+     *
      * @param {ToltApi.GetClicksRequest} request
      * @param {ClicksClient.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.clicks.get({
-     *         id: "id"
+     *         id: "clk_mEsbFYv6ZjqXjAoFwokjS6v6"
      *     })
      */
     get(request: ToltApi.GetClicksRequest, requestOptions?: ClicksClient.RequestOptions): core.HttpResponsePromise<ToltApi.GetClicksResponse>;

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

@@ -19,6 +19,7 @@ export class ClicksClient {
      *
      * @throws {@link ToltApi.BadRequestError}
      * @throws {@link ToltApi.UnauthorizedError}
+     * @throws {@link ToltApi.ContentTooLargeError}
      * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
@@ -55,7 +56,7 @@ export class ClicksClient {
         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/clicks"),
+                environments.ToltApiEnvironment.Default, "v2/clicks"),
             method: "GET",
             headers: _headers,
             queryString: core.url
@@ -78,6 +79,8 @@ export class ClicksClient {
                     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:
@@ -98,6 +101,7 @@ export class ClicksClient {
      *
      * @throws {@link ToltApi.BadRequestError}
      * @throws {@link ToltApi.UnauthorizedError}
+     * @throws {@link ToltApi.ContentTooLargeError}
      * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
@@ -116,7 +120,7 @@ export class ClicksClient {
         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/clicks"),
+                environments.ToltApiEnvironment.Default, "v2/clicks"),
             method: "POST",
             headers: _headers,
             contentType: "application/json",
@@ -138,6 +142,8 @@ export class ClicksClient {
                     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:
@@ -151,18 +157,21 @@ export class ClicksClient {
         return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v2/clicks");
     }
     /**
+     * Gets a recorded click by ID, with the partner, link, page, referrer, country, device and browser it came from.
+     *
      * @param {ToltApi.GetClicksRequest} request
      * @param {ClicksClient.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.clicks.get({
-     *         id: "id"
+     *         id: "clk_mEsbFYv6ZjqXjAoFwokjS6v6"
      *     })
      */
     get(request, requestOptions) {
@@ -175,7 +184,7 @@ export class ClicksClient {
         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/clicks/${core.url.encodePathParam(id)}`),
+                environments.ToltApiEnvironment.Default, `v2/clicks/${core.url.encodePathParam(id)}`),
             method: "GET",
             headers: _headers,
             queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
@@ -194,6 +203,8 @@ export class ClicksClient {
                     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/clicks/client/requests/GetClicksRequest.d.ts

@@ -1,7 +1,7 @@
 /**
  * @example
  *     {
- *         id: "id"
+ *         id: "clk_mEsbFYv6ZjqXjAoFwokjS6v6"
  *     }
  */
 export interface GetClicksRequest {

package/dist/api/resources/clicks/client/requests/ListClicksRequest.d.ts

@@ -7,24 +7,29 @@ import type * as ToltApi from "../../../../index.js";
  *     }
  */
 export interface ListClicksRequest {
+    /** How many rows to return in one page. */
     limit?: number;
+    /** Ranking direction: desc puts the most recently created or updated rows first. */
     order?: ToltApi.ListClicksRequestOrder;
-    /** 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.ListClicksRequestSort;
     /** 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;
+    /** Limit to one referral link, by its id (lnk_...) as returned when listing links. */
     link_id?: string;
     /** Filter by the click's stored country, matched exactly (values are not normalized). Clicks recorded by the tracking script store a country name (e.g. `Canada`); clicks created through the API store a 2-letter ISO code (e.g. `CA`). Filter by the exact form you expect. */
     country?: string;

package/dist/api/resources/clicks/types/ListClicksRequestOrder.d.ts

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

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

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

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

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

@@ -18,13 +18,14 @@ export declare class CommissionsClient {
      *
      * @throws {@link ToltApi.BadRequestError}
      * @throws {@link ToltApi.UnauthorizedError}
+     * @throws {@link ToltApi.ContentTooLargeError}
      * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
      * @example
      *     await client.commissions.bulkApprove({
-     *         ids: ["part_9fQ2xLL", "part_3RtV9k"]
+     *         ids: ["comm_X85RLnefjTCNrypH4MA1PdSp", "comm_3RtV9kQ2mW8nX5pL1sB7cD4f"]
      *     })
      */
     bulkApprove(request: ToltApi.BulkApproveCommissionsRequest, requestOptions?: CommissionsClient.RequestOptions): core.HttpResponsePromise<ToltApi.BulkApproveCommissionsResponse>;
@@ -37,23 +38,27 @@ export declare class CommissionsClient {
      *
      * @throws {@link ToltApi.BadRequestError}
      * @throws {@link ToltApi.UnauthorizedError}
+     * @throws {@link ToltApi.ContentTooLargeError}
      * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
      * @example
      *     await client.commissions.bulkDecline({
-     *         ids: ["part_9fQ2xLL", "part_3RtV9k"]
+     *         ids: ["comm_X85RLnefjTCNrypH4MA1PdSp", "comm_3RtV9kQ2mW8nX5pL1sB7cD4f"]
      *     })
      */
     bulkDecline(request: ToltApi.BulkDeclineCommissionsRequest, requestOptions?: CommissionsClient.RequestOptions): core.HttpResponsePromise<ToltApi.BulkDeclineCommissionsResponse>;
     private __bulkDecline;
     /**
+     * Lists commissions. Filter by program, partner, customer, transaction, status or type, and page with cursors.
+     *
      * @param {ToltApi.ListCommissionsRequest} request
      * @param {CommissionsClient.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}
@@ -72,6 +77,7 @@ export declare class CommissionsClient {
      * @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}
@@ -84,18 +90,21 @@ export declare class CommissionsClient {
     create(request: ToltApi.CreateCommissionsRequest, requestOptions?: CommissionsClient.RequestOptions): core.HttpResponsePromise<ToltApi.CreateCommissionsResponse>;
     private __create;
     /**
+     * Gets a commission by ID, with its amount, status, type and partner, plus its customer and transaction when it has them.
+     *
      * @param {ToltApi.GetCommissionsRequest} request
      * @param {CommissionsClient.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.commissions.get({
-     *         id: "id"
+     *         id: "comm_X85RLnefjTCNrypH4MA1PdSp"
      *     })
      */
     get(request: ToltApi.GetCommissionsRequest, requestOptions?: CommissionsClient.RequestOptions): core.HttpResponsePromise<ToltApi.GetCommissionsResponse>;
@@ -110,18 +119,24 @@ export declare class CommissionsClient {
      * @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.commissions.update({
-     *         id: "id"
+     *         id: "comm_X85RLnefjTCNrypH4MA1PdSp",
+     *         amount: 1000,
+     *         revenue: 5000,
+     *         status: "approved"
      *     })
      */
     update(request: ToltApi.UpdateCommissionsRequest, requestOptions?: CommissionsClient.RequestOptions): core.HttpResponsePromise<ToltApi.UpdateCommissionsResponse>;
     private __update;
     /**
+     * Deletes a commission. Fails for paid commissions, refund commissions, commissions on a refunded transaction, and those on a confirmed or legacy autopayout invoice.
+     *
      * @param {ToltApi.DeleteCommissionsRequest} request
      * @param {CommissionsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -129,18 +144,21 @@ export declare class CommissionsClient {
      * @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.commissions.delete({
-     *         id: "id"
+     *         id: "comm_X85RLnefjTCNrypH4MA1PdSp"
      *     })
      */
     delete(request: ToltApi.DeleteCommissionsRequest, requestOptions?: CommissionsClient.RequestOptions): core.HttpResponsePromise<ToltApi.DeleteCommissionsResponse>;
     private __delete;
     /**
+     * Marks a commission approved so it is included in the next payout. Fails for paid commissions, refund commissions, commissions on a refunded transaction, and those on a confirmed or legacy autopayout invoice.
+     *
      * @param {ToltApi.ApproveCommissionsRequest} request
      * @param {CommissionsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -148,18 +166,21 @@ export declare class CommissionsClient {
      * @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.commissions.approve({
-     *         id: "id"
+     *         id: "comm_X85RLnefjTCNrypH4MA1PdSp"
      *     })
      */
     approve(request: ToltApi.ApproveCommissionsRequest, requestOptions?: CommissionsClient.RequestOptions): core.HttpResponsePromise<ToltApi.ApproveCommissionsResponse>;
     private __approve;
     /**
+     * Marks a commission declined so it is left out of payouts until it is approved again. Fails for paid commissions, refund commissions, commissions on a refunded transaction, and those on a confirmed or legacy autopayout invoice.
+     *
      * @param {ToltApi.DeclineCommissionsRequest} request
      * @param {CommissionsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -167,13 +188,14 @@ export declare class CommissionsClient {
      * @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.commissions.decline({
-     *         id: "id"
+     *         id: "comm_X85RLnefjTCNrypH4MA1PdSp"
      *     })
      */
     decline(request: ToltApi.DeclineCommissionsRequest, requestOptions?: CommissionsClient.RequestOptions): core.HttpResponsePromise<ToltApi.DeclineCommissionsResponse>;