@tolt/api 0.6.1 → 0.7.0

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

@@ -12,11 +12,14 @@ export class PromotionCodesClient {
         this._options = normalizeClientOptionsWithAuth(options);
     }
     /**
+     * Lists promotion codes. Filter by program, partner or type, and page with cursors.
+     *
      * @param {ToltApi.ListPromotionCodesRequest} request
      * @param {PromotionCodesClient.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}
@@ -49,7 +52,7 @@ export class PromotionCodesClient {
         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/promotion-codes"),
+                environments.ToltApiEnvironment.Default, "v2/promotion-codes"),
             method: "GET",
             headers: _headers,
             queryString: core.url
@@ -72,6 +75,8 @@ export class PromotionCodesClient {
                     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:
@@ -85,19 +90,25 @@ export class PromotionCodesClient {
         return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v2/promotion-codes");
     }
     /**
+     * Creates a promotion code for a partner, so customers who use it are credited to them. A partner cannot have the same code twice.
+     *
      * @param {ToltApi.CreatePromotionCodesRequest} request
      * @param {PromotionCodesClient.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.promotionCodes.create({
-     *         code: "code",
-     *         partner_id: "partner_id"
+     *         code: "SAM20",
+     *         type: "percentage",
+     *         value: "20",
+     *         partner_id: "part_NLYzgNKuSuASvrvoxNtau6SY"
      *     })
      */
     create(request, requestOptions) {
@@ -109,7 +120,7 @@ export class PromotionCodesClient {
         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/promotion-codes"),
+                environments.ToltApiEnvironment.Default, "v2/promotion-codes"),
             method: "POST",
             headers: _headers,
             contentType: "application/json",
@@ -131,6 +142,10 @@ export class PromotionCodesClient {
                     throw new ToltApi.BadRequestError(_response.error.body, _response.rawResponse);
                 case 401:
                     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:
@@ -144,18 +159,21 @@ export class PromotionCodesClient {
         return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v2/promotion-codes");
     }
     /**
+     * Gets a promotion code by ID, with its discount type and value and the partner, group or program it belongs to.
+     *
      * @param {ToltApi.GetPromotionCodesRequest} request
      * @param {PromotionCodesClient.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.promotionCodes.get({
-     *         id: "id"
+     *         id: "promo_gTCAUsWfdmN2GuCVRaHWNRan"
      *     })
      */
     get(request, requestOptions) {
@@ -168,7 +186,7 @@ export class PromotionCodesClient {
         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/promotion-codes/${core.url.encodePathParam(id)}`),
+                environments.ToltApiEnvironment.Default, `v2/promotion-codes/${core.url.encodePathParam(id)}`),
             method: "GET",
             headers: _headers,
             queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
@@ -187,6 +205,8 @@ export class PromotionCodesClient {
                     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:
@@ -200,19 +220,26 @@ export class PromotionCodesClient {
         return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v2/promotion-codes/{id}");
     }
     /**
+     * Updates a promotion code's code, discount type or value.
+     *
      * @param {ToltApi.UpdatePromotionCodesRequest} request
      * @param {PromotionCodesClient.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.promotionCodes.update({
-     *         id: "id"
+     *         id: "promo_gTCAUsWfdmN2GuCVRaHWNRan",
+     *         code: "SAM20",
+     *         type: "percentage",
+     *         value: "20"
      *     })
      */
     update(request, requestOptions) {
@@ -225,7 +252,7 @@ export class PromotionCodesClient {
         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/promotion-codes/${core.url.encodePathParam(id)}`),
+                environments.ToltApiEnvironment.Default, `v2/promotion-codes/${core.url.encodePathParam(id)}`),
             method: "PUT",
             headers: _headers,
             contentType: "application/json",
@@ -249,6 +276,10 @@ export class PromotionCodesClient {
                     throw new ToltApi.UnauthorizedError(_response.error.body, _response.rawResponse);
                 case 404:
                     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:
@@ -262,18 +293,21 @@ export class PromotionCodesClient {
         return handleNonStatusCodeError(_response.error, _response.rawResponse, "PUT", "/v2/promotion-codes/{id}");
     }
     /**
+     * Deletes a promotion code, so customers who use it afterwards are no longer attributed through it.
+     *
      * @param {ToltApi.DeletePromotionCodesRequest} request
      * @param {PromotionCodesClient.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.promotionCodes.delete({
-     *         id: "id"
+     *         id: "promo_gTCAUsWfdmN2GuCVRaHWNRan"
      *     })
      */
     delete(request, requestOptions) {
@@ -286,7 +320,7 @@ export class PromotionCodesClient {
         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/promotion-codes/${core.url.encodePathParam(id)}`),
+                environments.ToltApiEnvironment.Default, `v2/promotion-codes/${core.url.encodePathParam(id)}`),
             method: "DELETE",
             headers: _headers,
             queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
@@ -305,6 +339,8 @@ export class PromotionCodesClient {
                     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/promotionCodes/client/requests/CreatePromotionCodesRequest.d.ts

@@ -1,17 +1,24 @@
 /**
  * @example
  *     {
- *         code: "code",
- *         partner_id: "partner_id"
+ *         code: "SAM20",
+ *         type: "percentage",
+ *         value: "20",
+ *         partner_id: "part_NLYzgNKuSuASvrvoxNtau6SY"
  *     }
  */
 export interface CreatePromotionCodesRequest {
+    /** The discount code as customers enter it at checkout. Customers and payments that use it are attributed to the code's partner. A partner cannot have the same code twice, ignoring case. Recording it here does not create it in your billing system. */
     code: string;
+    /** Whether value is a percent off or a fixed amount off. */
     type?: CreatePromotionCodesRequest.Type;
+    /** Size of the discount as a plain decimal: a percent from 0 to 100 for percentage codes ("20" is 20%), or an amount from 0 to 1,000,000 in major units of the program currency for fixed codes ("20" is 20.00). */
     value?: string;
+    /** Id of the partner the code belongs to (part_...), as returned when listing partners. The code is created in that partner's program. */
     partner_id: string;
 }
 export declare namespace CreatePromotionCodesRequest {
+    /** Whether value is a percent off or a fixed amount off. */
     const Type: {
         readonly Fixed: "fixed";
         readonly Percentage: "percentage";

package/dist/api/resources/promotionCodes/client/requests/CreatePromotionCodesRequest.js

@@ -1,6 +1,7 @@
 // This file was auto-generated by Fern from our API Definition.
 export var CreatePromotionCodesRequest;
 (function (CreatePromotionCodesRequest) {
+    /** Whether value is a percent off or a fixed amount off. */
     CreatePromotionCodesRequest.Type = {
         Fixed: "fixed",
         Percentage: "percentage",

package/dist/api/resources/promotionCodes/client/requests/DeletePromotionCodesRequest.d.ts

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

package/dist/api/resources/promotionCodes/client/requests/GetPromotionCodesRequest.d.ts

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

package/dist/api/resources/promotionCodes/client/requests/ListPromotionCodesRequest.d.ts

@@ -4,24 +4,30 @@ import type * as ToltApi from "../../../../index.js";
  *     {}
  */
 export interface ListPromotionCodesRequest {
+    /** How many rows to return in one page. */
     limit?: number;
+    /** Ranking direction: desc puts the most recently created or updated rows first. */
     order?: ToltApi.ListPromotionCodesRequestOrder;
-    /** 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.ListPromotionCodesRequestSort;
     /** Continue after a position: the next_cursor of a previous page, or an item id when sorting by created_at. Cannot be combined with ending_before. */
     starting_after?: string;
     /** Page backward from a position: the prev_cursor of a previous page, or an item id when sorting by created_at. Cannot be combined with starting_after. */
     ending_before?: string;
-    /** Only items created at or after this ISO 8601 time. */
+    /** Start of a window on when items were created: items created at this time or later are included, for example 2026-01-01T00:00:00Z. Leave it out for no lower bound. */
     created_after?: string;
-    /** Only items created before this ISO 8601 time. */
+    /** End of a window on when items were created: only items created before this time are included. Leave it out for no upper bound. */
     created_before?: string;
-    /** Only items updated at or after this ISO 8601 time. Combine with sort=updated_at to sync changes. */
+    /** Only items last changed at or after this moment; with sort=updated_at, use it to fetch what changed since a previous sync. */
     updated_after?: string;
-    /** Only items updated before this ISO 8601 time. */
+    /** Only items last changed before this moment; pair it with updated_after to fetch what changed in a period. */
     updated_before?: string;
+    /** Limit to one program, by its id (prg_...) as returned when listing programs. */
     program_id?: string;
+    /** Limit to one partner, by its id (part_...) as returned when listing partners. */
     partner_id?: string;
+    /** Only codes giving this kind of discount: a fixed amount off or a percentage off. */
     type?: ToltApi.ListPromotionCodesRequestType;
+    /** Text matched anywhere in the code, ignoring case. */
     search?: string;
 }

package/dist/api/resources/promotionCodes/client/requests/UpdatePromotionCodesRequest.d.ts

@@ -1,16 +1,23 @@
 /**
  * @example
  *     {
- *         id: "id"
+ *         id: "promo_gTCAUsWfdmN2GuCVRaHWNRan",
+ *         code: "SAM20",
+ *         type: "percentage",
+ *         value: "20"
  *     }
  */
 export interface UpdatePromotionCodesRequest {
     id: string;
+    /** The discount code as customers enter it at checkout. Customers and payments that use it are attributed to the code's partner. A partner cannot have the same code twice, ignoring case. */
     code?: string;
+    /** Whether value is a percent off or a fixed amount off. */
     type?: UpdatePromotionCodesRequest.Type | null;
+    /** Size of the discount as a plain decimal: a percent from 0 to 100 for percentage codes ("20" is 20%), or an amount from 0 to 1,000,000 in major units of the program currency for fixed codes ("20" is 20.00). null clears it. */
     value?: string | null;
 }
 export declare namespace UpdatePromotionCodesRequest {
+    /** Whether value is a percent off or a fixed amount off. */
     const Type: {
         readonly Fixed: "fixed";
         readonly Percentage: "percentage";

package/dist/api/resources/promotionCodes/client/requests/UpdatePromotionCodesRequest.js

@@ -1,6 +1,7 @@
 // This file was auto-generated by Fern from our API Definition.
 export var UpdatePromotionCodesRequest;
 (function (UpdatePromotionCodesRequest) {
+    /** Whether value is a percent off or a fixed amount off. */
     UpdatePromotionCodesRequest.Type = {
         Fixed: "fixed",
         Percentage: "percentage",

package/dist/api/resources/promotionCodes/types/ListPromotionCodesRequestOrder.d.ts

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

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

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

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

package/dist/api/resources/promotionCodes/types/ListPromotionCodesRequestType.d.ts

@@ -1,3 +1,4 @@
+/** Only codes giving this kind of discount: a fixed amount off or a percentage off. */
 export declare const ListPromotionCodesRequestType: {
     readonly Fixed: "fixed";
     readonly Percentage: "percentage";

package/dist/api/resources/promotionCodes/types/ListPromotionCodesRequestType.js

@@ -1,4 +1,5 @@
 // This file was auto-generated by Fern from our API Definition.
+/** Only codes giving this kind of discount: a fixed amount off or a percentage off. */
 export const ListPromotionCodesRequestType = {
     Fixed: "fixed",
     Percentage: "percentage",

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

@@ -11,11 +11,14 @@ export declare class ReportsClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<ReportsClient.Options>;
     constructor(options: ReportsClient.Options);
     /**
+     * Returns revenue, commission, customer and partner totals for the organization or one program over a date range.
+     *
      * @param {ToltApi.OverviewReportsRequest} request
      * @param {ReportsClient.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}
@@ -26,11 +29,14 @@ export declare class ReportsClient {
     overview(request?: ToltApi.OverviewReportsRequest, requestOptions?: ReportsClient.RequestOptions): core.HttpResponsePromise<ToltApi.OverviewReportsResponse>;
     private __overview;
     /**
+     * Returns one row of revenue, commissions, customers and clicks per partner over a date range, sorted and paged by offset.
+     *
      * @param {ToltApi.PartnersReportsRequest} request
      * @param {ReportsClient.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}
@@ -41,11 +47,14 @@ export declare class ReportsClient {
     partners(request?: ToltApi.PartnersReportsRequest, requestOptions?: ReportsClient.RequestOptions): core.HttpResponsePromise<ToltApi.PartnersReportsResponse>;
     private __partners;
     /**
+     * Returns one row of revenue, commissions, customers and clicks per link over a date range, sorted and paged by offset.
+     *
      * @param {ToltApi.LinksReportsRequest} request
      * @param {ReportsClient.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}
@@ -56,11 +65,14 @@ export declare class ReportsClient {
     links(request?: ToltApi.LinksReportsRequest, requestOptions?: ReportsClient.RequestOptions): core.HttpResponsePromise<ToltApi.LinksReportsResponse>;
     private __links;
     /**
+     * Returns revenue, commissions, customers and clicks per day, week or month over a date range, ready to chart.
+     *
      * @param {ToltApi.TimeseriesReportsRequest} request
      * @param {ReportsClient.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}
@@ -71,11 +83,14 @@ export declare class ReportsClient {
     timeseries(request?: ToltApi.TimeseriesReportsRequest, requestOptions?: ReportsClient.RequestOptions): core.HttpResponsePromise<ToltApi.TimeseriesReportsResponse>;
     private __timeseries;
     /**
+     * Returns how many customers are in each subscription status for the organization or one program.
+     *
      * @param {ToltApi.CustomerStatsReportsRequest} request
      * @param {ReportsClient.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}

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

@@ -11,11 +11,14 @@ export class ReportsClient {
         this._options = normalizeClientOptionsWithAuth(options);
     }
     /**
+     * Returns revenue, commission, customer and partner totals for the organization or one program over a date range.
+     *
      * @param {ToltApi.OverviewReportsRequest} request
      * @param {ReportsClient.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}
@@ -38,7 +41,7 @@ export class ReportsClient {
         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/reports/overview"),
+                environments.ToltApiEnvironment.Default, "v2/reports/overview"),
             method: "GET",
             headers: _headers,
             queryString: core.url
@@ -61,6 +64,8 @@ export class ReportsClient {
                     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:
@@ -74,11 +79,14 @@ export class ReportsClient {
         return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v2/reports/overview");
     }
     /**
+     * Returns one row of revenue, commissions, customers and clicks per partner over a date range, sorted and paged by offset.
+     *
      * @param {ToltApi.PartnersReportsRequest} request
      * @param {ReportsClient.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}
@@ -106,7 +114,7 @@ export class ReportsClient {
         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/reports/partners"),
+                environments.ToltApiEnvironment.Default, "v2/reports/partners"),
             method: "GET",
             headers: _headers,
             queryString: core.url
@@ -129,6 +137,8 @@ export class ReportsClient {
                     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:
@@ -142,11 +152,14 @@ export class ReportsClient {
         return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v2/reports/partners");
     }
     /**
+     * Returns one row of revenue, commissions, customers and clicks per link over a date range, sorted and paged by offset.
+     *
      * @param {ToltApi.LinksReportsRequest} request
      * @param {ReportsClient.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}
@@ -174,7 +187,7 @@ export class ReportsClient {
         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/reports/links"),
+                environments.ToltApiEnvironment.Default, "v2/reports/links"),
             method: "GET",
             headers: _headers,
             queryString: core.url
@@ -197,6 +210,8 @@ export class ReportsClient {
                     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:
@@ -210,11 +225,14 @@ export class ReportsClient {
         return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v2/reports/links");
     }
     /**
+     * Returns revenue, commissions, customers and clicks per day, week or month over a date range, ready to chart.
+     *
      * @param {ToltApi.TimeseriesReportsRequest} request
      * @param {ReportsClient.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}
@@ -239,7 +257,7 @@ export class ReportsClient {
         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/reports/timeseries"),
+                environments.ToltApiEnvironment.Default, "v2/reports/timeseries"),
             method: "GET",
             headers: _headers,
             queryString: core.url
@@ -262,6 +280,8 @@ export class ReportsClient {
                     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:
@@ -275,11 +295,14 @@ export class ReportsClient {
         return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v2/reports/timeseries");
     }
     /**
+     * Returns how many customers are in each subscription status for the organization or one program.
+     *
      * @param {ToltApi.CustomerStatsReportsRequest} request
      * @param {ReportsClient.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}
@@ -302,7 +325,7 @@ export class ReportsClient {
         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/reports/customers"),
+                environments.ToltApiEnvironment.Default, "v2/reports/customers"),
             method: "GET",
             headers: _headers,
             queryString: core.url
@@ -325,6 +348,8 @@ export class ReportsClient {
                     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:

package/dist/api/resources/reports/client/requests/CustomerStatsReportsRequest.d.ts

@@ -3,7 +3,10 @@
  *     {}
  */
 export interface CustomerStatsReportsRequest {
+    /** Limit to one program, by its id (prg_...) as returned when listing programs. */
     program_id?: string;
+    /** Earliest day to include, by the day customers became active. Leave it out for no lower bound. */
     start_date?: string;
+    /** Latest day to include, by the day customers became active; the whole day counts. Leave it out for no upper bound. */
     end_date?: string;
 }

package/dist/api/resources/reports/client/requests/LinksReportsRequest.d.ts

@@ -4,12 +4,20 @@ import type * as ToltApi from "../../../../index.js";
  *     {}
  */
 export interface LinksReportsRequest {
+    /** Limit to one program, by its id (prg_...) as returned when listing programs. */
     program_id?: string;
+    /** Earliest day to include, by creation date (customers by the day they became active). Leave it out for no lower bound. */
     start_date?: string;
+    /** Latest day to include, by creation date (customers by the day they became active); the whole day counts. Leave it out for no upper bound. */
     end_date?: string;
+    /** Only include transactions and commissions in this currency, such as USD; matching ignores case. Rows without their own currency use their program's. */
     currency?: string;
+    /** How many rows to return in one page. */
     limit?: number;
+    /** How many rows to skip before this page begins. */
     offset?: number | null;
+    /** Metric to rank by, computed over the date window. */
     sort?: ToltApi.LinksReportsRequestSort;
+    /** Ranking direction: desc puts the highest values first. */
     order?: ToltApi.LinksReportsRequestOrder;
 }