@tolt/api 0.6.1 → 1.0.0

package/dist/BaseClient.js

@@ -5,6 +5,7 @@ import * as core from "./core/index.js";
 export function normalizeClientOptions(options) {
     const headers = mergeHeaders({
         "X-Fern-Language": "JavaScript",
+        "User-Agent": "tolt-typescript/1.0.0",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
     }, options?.headers);

package/dist/Client.d.ts

@@ -1,7 +1,7 @@
 import { ClicksClient } from "./api/resources/clicks/client/Client.js";
 import { CommissionsClient } from "./api/resources/commissions/client/Client.js";
 import { CustomersClient } from "./api/resources/customers/client/Client.js";
-import { EmbedClient } from "./api/resources/embed/client/Client.js";
+import { EmbedTokensClient } from "./api/resources/embedTokens/client/Client.js";
 import { FlowsClient } from "./api/resources/flows/client/Client.js";
 import { GroupsClient } from "./api/resources/groups/client/Client.js";
 import { LinksClient } from "./api/resources/links/client/Client.js";
@@ -20,7 +20,7 @@ export declare namespace ToltApiClient {
 }
 export declare class ToltApiClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<ToltApiClient.Options>;
-    protected _embed: EmbedClient | undefined;
+    protected _embedTokens: EmbedTokensClient | undefined;
     protected _groups: GroupsClient | undefined;
     protected _flows: FlowsClient | undefined;
     protected _clicks: ClicksClient | undefined;
@@ -33,7 +33,7 @@ export declare class ToltApiClient {
     protected _promotionCodes: PromotionCodesClient | undefined;
     protected _reports: ReportsClient | undefined;
     constructor(options: ToltApiClient.Options);
-    get embed(): EmbedClient;
+    get embedTokens(): EmbedTokensClient;
     get groups(): GroupsClient;
     get flows(): FlowsClient;
     get clicks(): ClicksClient;

package/dist/Client.js

@@ -2,7 +2,7 @@
 import { ClicksClient } from "./api/resources/clicks/client/Client.js";
 import { CommissionsClient } from "./api/resources/commissions/client/Client.js";
 import { CustomersClient } from "./api/resources/customers/client/Client.js";
-import { EmbedClient } from "./api/resources/embed/client/Client.js";
+import { EmbedTokensClient } from "./api/resources/embedTokens/client/Client.js";
 import { FlowsClient } from "./api/resources/flows/client/Client.js";
 import { GroupsClient } from "./api/resources/groups/client/Client.js";
 import { LinksClient } from "./api/resources/links/client/Client.js";
@@ -17,8 +17,8 @@ export class ToltApiClient {
     constructor(options) {
         this._options = normalizeClientOptionsWithAuth(options);
     }
-    get embed() {
-        return (this._embed ??= new EmbedClient(this._options));
+    get embedTokens() {
+        return (this._embedTokens ??= new EmbedTokensClient(this._options));
     }
     get groups() {
         return (this._groups ??= new GroupsClient(this._options));

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

@@ -2,6 +2,6 @@ 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 BadRequestError extends errors.ToltApiError {
-    readonly body: ToltApi.Error_;
-    constructor(body: ToltApi.Error_, rawResponse?: core.RawResponse);
+    readonly body: ToltApi.ErrorResponse;
+    constructor(body: ToltApi.ErrorResponse, rawResponse?: core.RawResponse);
 }

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

@@ -2,6 +2,6 @@ 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 ConflictError extends errors.ToltApiError {
-    readonly body: ToltApi.Error_;
-    constructor(body: ToltApi.Error_, rawResponse?: core.RawResponse);
+    readonly body: ToltApi.ErrorResponse;
+    constructor(body: ToltApi.ErrorResponse, rawResponse?: core.RawResponse);
 }

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.ErrorResponse;
+    constructor(body: ToltApi.ErrorResponse, 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/NotFoundError.d.ts

@@ -2,6 +2,6 @@ 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 NotFoundError extends errors.ToltApiError {
-    readonly body: ToltApi.Error_;
-    constructor(body: ToltApi.Error_, rawResponse?: core.RawResponse);
+    readonly body: ToltApi.ErrorResponse;
+    constructor(body: ToltApi.ErrorResponse, rawResponse?: core.RawResponse);
 }

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

@@ -2,6 +2,6 @@ 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 TooManyRequestsError extends errors.ToltApiError {
-    readonly body: ToltApi.Error_;
-    constructor(body: ToltApi.Error_, rawResponse?: core.RawResponse);
+    readonly body: ToltApi.ErrorResponse;
+    constructor(body: ToltApi.ErrorResponse, rawResponse?: core.RawResponse);
 }

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

@@ -2,6 +2,6 @@ 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 UnauthorizedError extends errors.ToltApiError {
-    readonly body: ToltApi.Error_;
-    constructor(body: ToltApi.Error_, rawResponse?: core.RawResponse);
+    readonly body: ToltApi.ErrorResponse;
+    constructor(body: ToltApi.ErrorResponse, rawResponse?: core.RawResponse);
 }

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}
@@ -28,42 +29,49 @@ export declare class ClicksClient {
      *         device: "desktop"
      *     })
      */
-    list(request?: ToltApi.ListClicksRequest, requestOptions?: ClicksClient.RequestOptions): core.HttpResponsePromise<ToltApi.ListClicksResponse>;
-    private __list;
+    list(request?: ToltApi.ListClicksRequest, requestOptions?: ClicksClient.RequestOptions): Promise<core.Page<ToltApi.Click, ToltApi.ListClicksResponse>>;
     /**
      * Records a click on a partner's link from your own server, for visits the browser script cannot see. Identify the source by link_id, by partner_id with an optional link_id, or by the link's param and value; the partner and program are resolved from it. Pass the returned id as click_id when you create the customer.
      *
-     * @param {ToltApi.CreateClicksRequest} request
+     * @param {ToltApi.CreateClickRequest} request
      * @param {ClicksClient.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}
      *
      * @example
      *     await client.clicks.create({
-     *         "key": "value"
+     *         link_id: "lnk_mtTeeckFa1vMdvDFXretQNs6",
+     *         country: "US",
+     *         device: "desktop",
+     *         page: "https://example.com/pricing?ref=sam",
+     *         referrer: "https://partner.example.com"
      *     })
      */
-    create(request: ToltApi.CreateClicksRequest, requestOptions?: ClicksClient.RequestOptions): core.HttpResponsePromise<ToltApi.CreateClicksResponse>;
+    create(request?: ToltApi.CreateClickRequest, requestOptions?: ClicksClient.RequestOptions): core.HttpResponsePromise<ToltApi.CreateClickResponse>;
     private __create;
     /**
-     * @param {ToltApi.GetClicksRequest} request
+     * Gets a recorded click by ID, with the partner, link, page, referrer, country, device and browser it came from.
+     *
+     * @param {ToltApi.GetClickRequest} 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>;
+    get(request: ToltApi.GetClickRequest, requestOptions?: ClicksClient.RequestOptions): core.HttpResponsePromise<ToltApi.GetClickResponse>;
     private __get;
 }

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}
@@ -29,94 +30,111 @@ export class ClicksClient {
      *         device: "desktop"
      *     })
      */
-    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, link_id: linkId, country, device, } = 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,
-            link_id: linkId,
-            country,
-            device,
-        };
-        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/clicks"),
-            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, link_id: linkId, country, device, } = 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,
+                link_id: linkId,
+                country,
+                device,
+            };
+            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/clicks"),
+                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/clicks");
+            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/clicks");
+        });
+        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));
+            },
+        });
     }
     /**
      * Records a click on a partner's link from your own server, for visits the browser script cannot see. Identify the source by link_id, by partner_id with an optional link_id, or by the link's param and value; the partner and program are resolved from it. Pass the returned id as click_id when you create the customer.
      *
-     * @param {ToltApi.CreateClicksRequest} request
+     * @param {ToltApi.CreateClickRequest} request
      * @param {ClicksClient.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}
      *
      * @example
      *     await client.clicks.create({
-     *         "key": "value"
+     *         link_id: "lnk_mtTeeckFa1vMdvDFXretQNs6",
+     *         country: "US",
+     *         device: "desktop",
+     *         page: "https://example.com/pricing?ref=sam",
+     *         referrer: "https://partner.example.com"
      *     })
      */
-    create(request, requestOptions) {
+    create(request = {}, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__create(request, requestOptions));
     }
-    async __create(request, requestOptions) {
+    async __create(request = {}, requestOptions) {
         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/clicks"),
+                environments.ToltApiEnvironment.Default, "v2/clicks"),
             method: "POST",
             headers: _headers,
             contentType: "application/json",
@@ -124,7 +142,7 @@ export class ClicksClient {
             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,
@@ -138,6 +156,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 +171,21 @@ export class ClicksClient {
         return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v2/clicks");
     }
     /**
-     * @param {ToltApi.GetClicksRequest} request
+     * Gets a recorded click by ID, with the partner, link, page, referrer, country, device and browser it came from.
+     *
+     * @param {ToltApi.GetClickRequest} 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 +198,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, errors.ToltApiError)}`),
             method: "GET",
             headers: _headers,
             queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
@@ -194,6 +217,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/CreateClickRequest.d.ts

@@ -0,0 +1,28 @@
+/**
+ * @example
+ *     {
+ *         link_id: "lnk_mtTeeckFa1vMdvDFXretQNs6",
+ *         country: "US",
+ *         device: "desktop",
+ *         page: "https://example.com/pricing?ref=sam",
+ *         referrer: "https://partner.example.com"
+ *     }
+ */
+export interface CreateClickRequest {
+    /** The link that was clicked. The partner and program are taken from it. */
+    link_id?: string;
+    /** The partner who generated the click. Use it when you know the partner but not the link. */
+    partner_id?: string;
+    /** The tracking parameter of the link, e.g. `ref`. Send it with value when all you have is the landing URL. */
+    param?: string;
+    /** The value of the tracking parameter, e.g. `sam` in `?ref=sam`. */
+    value?: string;
+    /** Two-letter ISO country code where the click originated. */
+    country?: string;
+    /** Device type, e.g. `desktop`, `mobile` or `tablet`. */
+    device?: string;
+    /** URL of the page the visitor landed on. */
+    page?: string;
+    /** URL of the referring page. */
+    referrer?: string;
+}

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

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

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/client/requests/index.d.ts

@@ -1,2 +1,3 @@
-export type { GetClicksRequest } from "./GetClicksRequest.js";
+export type { CreateClickRequest } from "./CreateClickRequest.js";
+export type { GetClickRequest } from "./GetClickRequest.js";
 export type { ListClicksRequest } from "./ListClicksRequest.js";

package/dist/api/resources/clicks/types/{CreateClicksResponse.d.ts → CreateClickResponse.d.ts}

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

package/dist/api/resources/clicks/types/{GetClicksResponse.d.ts → GetClickResponse.d.ts}

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

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/clicks/types/index.d.ts

@@ -1,6 +1,5 @@
-export * from "./CreateClicksRequest.js";
-export * from "./CreateClicksResponse.js";
-export * from "./GetClicksResponse.js";
+export * from "./CreateClickResponse.js";
+export * from "./GetClickResponse.js";
 export * from "./ListClicksRequestOrder.js";
 export * from "./ListClicksRequestSort.js";
 export * from "./ListClicksResponse.js";

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

@@ -1,6 +1,5 @@
-export * from "./CreateClicksRequest.js";
-export * from "./CreateClicksResponse.js";
-export * from "./GetClicksResponse.js";
+export * from "./CreateClickResponse.js";
+export * from "./GetClickResponse.js";
 export * from "./ListClicksRequestOrder.js";
 export * from "./ListClicksRequestSort.js";
 export * from "./ListClicksResponse.js";