@tolt/api 0.1.1 → 0.3.0

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

@@ -16,6 +16,7 @@ export class ProgramsClient {
      *
      * @throws {@link ToltApi.BadRequestError}
      * @throws {@link ToltApi.UnauthorizedError}
+     * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
@@ -26,11 +27,17 @@ export class ProgramsClient {
         return core.HttpResponsePromise.fromPromise(this.__listPrograms(request, requestOptions));
     }
     async __listPrograms(request = {}, requestOptions) {
-        const { limit, order, starting_after: startingAfter, search } = request;
+        const { limit, order, sort, starting_after: startingAfter, ending_before: endingBefore, created_after: createdAfter, created_before: createdBefore, updated_after: updatedAfter, updated_before: updatedBefore, search, } = 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,
             search,
         };
         const _authRequest = await this._options.authProvider.getAuthRequest();
@@ -61,6 +68,8 @@ export class ProgramsClient {
                     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,
@@ -77,6 +86,7 @@ export class ProgramsClient {
      *
      * @throws {@link ToltApi.UnauthorizedError}
      * @throws {@link ToltApi.NotFoundError}
+     * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
@@ -114,6 +124,8 @@ export class ProgramsClient {
                     throw new ToltApi.UnauthorizedError(_response.error.body, _response.rawResponse);
                 case 404:
                     throw new ToltApi.NotFoundError(_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,

package/dist/api/resources/programs/client/requests/ListProgramsRequest.d.ts

@@ -6,6 +6,19 @@ import type * as ToltApi from "../../../../index.js";
 export interface ListProgramsRequest {
     limit?: number;
     order?: ToltApi.ListProgramsRequestOrder;
+    /** Column the list is ordered and paged by. */
+    sort?: ToltApi.ListProgramsRequestSort;
+    /** 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. */
+    created_after?: string;
+    /** Only items created before this ISO 8601 time. */
+    created_before?: string;
+    /** Only items updated at or after this ISO 8601 time. Combine with sort=updated_at to sync changes. */
+    updated_after?: string;
+    /** Only items updated before this ISO 8601 time. */
+    updated_before?: string;
     search?: string;
 }

package/dist/api/resources/programs/types/ListProgramsRequestSort.d.ts

@@ -0,0 +1,6 @@
+/** Column the list is ordered and paged by. */
+export declare const ListProgramsRequestSort: {
+    readonly CreatedAt: "created_at";
+    readonly UpdatedAt: "updated_at";
+};
+export type ListProgramsRequestSort = (typeof ListProgramsRequestSort)[keyof typeof ListProgramsRequestSort];

package/dist/api/resources/programs/types/ListProgramsRequestSort.js

@@ -0,0 +1,6 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Column the list is ordered and paged by. */
+export const ListProgramsRequestSort = {
+    CreatedAt: "created_at",
+    UpdatedAt: "updated_at",
+};

package/dist/api/resources/programs/types/ListProgramsResponse.d.ts

@@ -4,4 +4,8 @@ export interface ListProgramsResponse {
     message: string;
     data: ToltApi.Program[];
     has_more: boolean;
+    /** Opaque cursor marking the last item on this page. Pass it as starting_after to continue. Null when the page is empty. */
+    next_cursor: string | null;
+    /** Opaque cursor marking the first item on this page. Pass it as ending_before to page backward. Null when the page is empty. */
+    prev_cursor: string | null;
 }

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

@@ -1,3 +1,4 @@
 export * from "./GetProgramResponse.js";
 export * from "./ListProgramsRequestOrder.js";
+export * from "./ListProgramsRequestSort.js";
 export * from "./ListProgramsResponse.js";

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

@@ -1,3 +1,4 @@
 export * from "./GetProgramResponse.js";
 export * from "./ListProgramsRequestOrder.js";
+export * from "./ListProgramsRequestSort.js";
 export * from "./ListProgramsResponse.js";

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

@@ -16,6 +16,7 @@ export declare class PromotionCodesClient {
      *
      * @throws {@link ToltApi.BadRequestError}
      * @throws {@link ToltApi.UnauthorizedError}
+     * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
@@ -30,13 +31,14 @@ export declare class PromotionCodesClient {
      *
      * @throws {@link ToltApi.BadRequestError}
      * @throws {@link ToltApi.UnauthorizedError}
+     * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
      * @example
      *     await client.promotionCodes.createPromotionCode({
      *         code: "code",
-     *         partnerId: "partnerId"
+     *         partner_id: "partner_id"
      *     })
      */
     createPromotionCode(request: ToltApi.CreatePromotionCodeRequest, requestOptions?: PromotionCodesClient.RequestOptions): core.HttpResponsePromise<ToltApi.CreatePromotionCodeResponse>;
@@ -47,6 +49,7 @@ export declare class PromotionCodesClient {
      *
      * @throws {@link ToltApi.UnauthorizedError}
      * @throws {@link ToltApi.NotFoundError}
+     * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
@@ -64,6 +67,7 @@ export declare class PromotionCodesClient {
      * @throws {@link ToltApi.BadRequestError}
      * @throws {@link ToltApi.UnauthorizedError}
      * @throws {@link ToltApi.NotFoundError}
+     * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
@@ -80,6 +84,7 @@ export declare class PromotionCodesClient {
      *
      * @throws {@link ToltApi.UnauthorizedError}
      * @throws {@link ToltApi.NotFoundError}
+     * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *

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

@@ -17,6 +17,7 @@ export class PromotionCodesClient {
      *
      * @throws {@link ToltApi.BadRequestError}
      * @throws {@link ToltApi.UnauthorizedError}
+     * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
@@ -27,11 +28,17 @@ export class PromotionCodesClient {
         return core.HttpResponsePromise.fromPromise(this.__listPromotionCodes(request, requestOptions));
     }
     async __listPromotionCodes(request = {}, requestOptions) {
-        const { limit, order, starting_after: startingAfter, program_id: programId, partner_id: partnerId, type: type_, search, } = 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, type: type_, search, } = 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,
             type: type_,
@@ -65,6 +72,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 429:
+                    throw new ToltApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
                 default:
                     throw new errors.ToltApiError({
                         statusCode: _response.error.statusCode,
@@ -81,13 +90,14 @@ export class PromotionCodesClient {
      *
      * @throws {@link ToltApi.BadRequestError}
      * @throws {@link ToltApi.UnauthorizedError}
+     * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
      * @example
      *     await client.promotionCodes.createPromotionCode({
      *         code: "code",
-     *         partnerId: "partnerId"
+     *         partner_id: "partner_id"
      *     })
      */
     createPromotionCode(request, requestOptions) {
@@ -121,6 +131,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 429:
+                    throw new ToltApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
                 default:
                     throw new errors.ToltApiError({
                         statusCode: _response.error.statusCode,
@@ -137,6 +149,7 @@ export class PromotionCodesClient {
      *
      * @throws {@link ToltApi.UnauthorizedError}
      * @throws {@link ToltApi.NotFoundError}
+     * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
@@ -174,6 +187,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 429:
+                    throw new ToltApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
                 default:
                     throw new errors.ToltApiError({
                         statusCode: _response.error.statusCode,
@@ -191,6 +206,7 @@ export class PromotionCodesClient {
      * @throws {@link ToltApi.BadRequestError}
      * @throws {@link ToltApi.UnauthorizedError}
      * @throws {@link ToltApi.NotFoundError}
+     * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
@@ -233,6 +249,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 429:
+                    throw new ToltApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
                 default:
                     throw new errors.ToltApiError({
                         statusCode: _response.error.statusCode,
@@ -249,6 +267,7 @@ export class PromotionCodesClient {
      *
      * @throws {@link ToltApi.UnauthorizedError}
      * @throws {@link ToltApi.NotFoundError}
+     * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
@@ -286,6 +305,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 429:
+                    throw new ToltApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
                 default:
                     throw new errors.ToltApiError({
                         statusCode: _response.error.statusCode,

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

@@ -2,12 +2,12 @@
  * @example
  *     {
  *         code: "code",
- *         partnerId: "partnerId"
+ *         partner_id: "partner_id"
  *     }
  */
 export interface CreatePromotionCodeRequest {
     code: string;
     type?: string;
     value?: string;
-    partnerId: string;
+    partner_id: string;
 }

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

@@ -6,7 +6,20 @@ import type * as ToltApi from "../../../../index.js";
 export interface ListPromotionCodesRequest {
     limit?: number;
     order?: ToltApi.ListPromotionCodesRequestOrder;
+    /** Column the list is ordered and paged by. */
+    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. */
+    created_after?: string;
+    /** Only items created before this ISO 8601 time. */
+    created_before?: string;
+    /** Only items updated at or after this ISO 8601 time. Combine with sort=updated_at to sync changes. */
+    updated_after?: string;
+    /** Only items updated before this ISO 8601 time. */
+    updated_before?: string;
     program_id?: string;
     partner_id?: string;
     type?: string;

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

@@ -0,0 +1,6 @@
+/** Column the list is ordered and paged by. */
+export declare const ListPromotionCodesRequestSort: {
+    readonly CreatedAt: "created_at";
+    readonly UpdatedAt: "updated_at";
+};
+export type ListPromotionCodesRequestSort = (typeof ListPromotionCodesRequestSort)[keyof typeof ListPromotionCodesRequestSort];

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

@@ -0,0 +1,6 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Column the list is ordered and paged by. */
+export const ListPromotionCodesRequestSort = {
+    CreatedAt: "created_at",
+    UpdatedAt: "updated_at",
+};

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

@@ -4,4 +4,8 @@ export interface ListPromotionCodesResponse {
     message: string;
     data: ToltApi.PromotionCode[];
     has_more: boolean;
+    /** Opaque cursor marking the last item on this page. Pass it as starting_after to continue. Null when the page is empty. */
+    next_cursor: string | null;
+    /** Opaque cursor marking the first item on this page. Pass it as ending_before to page backward. Null when the page is empty. */
+    prev_cursor: string | null;
 }

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

@@ -2,5 +2,6 @@ export * from "./CreatePromotionCodeResponse.js";
 export * from "./DeletePromotionCodeResponse.js";
 export * from "./GetPromotionCodeResponse.js";
 export * from "./ListPromotionCodesRequestOrder.js";
+export * from "./ListPromotionCodesRequestSort.js";
 export * from "./ListPromotionCodesResponse.js";
 export * from "./UpdatePromotionCodeResponse.js";

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

@@ -2,5 +2,6 @@ export * from "./CreatePromotionCodeResponse.js";
 export * from "./DeletePromotionCodeResponse.js";
 export * from "./GetPromotionCodeResponse.js";
 export * from "./ListPromotionCodesRequestOrder.js";
+export * from "./ListPromotionCodesRequestSort.js";
 export * from "./ListPromotionCodesResponse.js";
 export * from "./UpdatePromotionCodeResponse.js";

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

@@ -11,13 +11,12 @@ export declare class ReportsClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<ReportsClient.Options>;
     constructor(options: ReportsClient.Options);
     /**
-     * Aggregate revenue and commission totals (grouped by currency) plus commission, customer, and partner counts for the organization. Supports optional program_id and start_date/end_date filters.
-     *
      * @param {ToltApi.ReportsOverviewRequest} request
      * @param {ReportsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ToltApi.BadRequestError}
      * @throws {@link ToltApi.UnauthorizedError}
+     * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
@@ -26,4 +25,64 @@ export declare class ReportsClient {
      */
     overview(request?: ToltApi.ReportsOverviewRequest, requestOptions?: ReportsClient.RequestOptions): core.HttpResponsePromise<ToltApi.ReportsOverviewResponse>;
     private __overview;
+    /**
+     * @param {ToltApi.ReportsPartnersRequest} request
+     * @param {ReportsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link ToltApi.BadRequestError}
+     * @throws {@link ToltApi.UnauthorizedError}
+     * @throws {@link ToltApi.TooManyRequestsError}
+     * @throws {@link errors.ToltApiError}
+     * @throws {@link errors.ToltApiTimeoutError}
+     *
+     * @example
+     *     await client.reports.partners()
+     */
+    partners(request?: ToltApi.ReportsPartnersRequest, requestOptions?: ReportsClient.RequestOptions): core.HttpResponsePromise<ToltApi.ReportsPartnersResponse>;
+    private __partners;
+    /**
+     * @param {ToltApi.ReportsLinksRequest} request
+     * @param {ReportsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link ToltApi.BadRequestError}
+     * @throws {@link ToltApi.UnauthorizedError}
+     * @throws {@link ToltApi.TooManyRequestsError}
+     * @throws {@link errors.ToltApiError}
+     * @throws {@link errors.ToltApiTimeoutError}
+     *
+     * @example
+     *     await client.reports.links()
+     */
+    links(request?: ToltApi.ReportsLinksRequest, requestOptions?: ReportsClient.RequestOptions): core.HttpResponsePromise<ToltApi.ReportsLinksResponse>;
+    private __links;
+    /**
+     * @param {ToltApi.ReportsTimeseriesRequest} request
+     * @param {ReportsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link ToltApi.BadRequestError}
+     * @throws {@link ToltApi.UnauthorizedError}
+     * @throws {@link ToltApi.TooManyRequestsError}
+     * @throws {@link errors.ToltApiError}
+     * @throws {@link errors.ToltApiTimeoutError}
+     *
+     * @example
+     *     await client.reports.timeseries()
+     */
+    timeseries(request?: ToltApi.ReportsTimeseriesRequest, requestOptions?: ReportsClient.RequestOptions): core.HttpResponsePromise<ToltApi.ReportsTimeseriesResponse>;
+    private __timeseries;
+    /**
+     * @param {ToltApi.ReportsCustomerStatsRequest} request
+     * @param {ReportsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link ToltApi.BadRequestError}
+     * @throws {@link ToltApi.UnauthorizedError}
+     * @throws {@link ToltApi.TooManyRequestsError}
+     * @throws {@link errors.ToltApiError}
+     * @throws {@link errors.ToltApiTimeoutError}
+     *
+     * @example
+     *     await client.reports.customerStats()
+     */
+    customerStats(request?: ToltApi.ReportsCustomerStatsRequest, requestOptions?: ReportsClient.RequestOptions): core.HttpResponsePromise<ToltApi.ReportsCustomerStatsResponse>;
+    private __customerStats;
 }