@tolt/api 0.6.1 → 1.0.0

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

@@ -11,11 +11,14 @@ export declare class PromotionCodesClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<PromotionCodesClient.Options>;
     constructor(options: PromotionCodesClient.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}
@@ -23,76 +26,94 @@ export declare class PromotionCodesClient {
      * @example
      *     await client.promotionCodes.list()
      */
-    list(request?: ToltApi.ListPromotionCodesRequest, requestOptions?: PromotionCodesClient.RequestOptions): core.HttpResponsePromise<ToltApi.ListPromotionCodesResponse>;
-    private __list;
+    list(request?: ToltApi.ListPromotionCodesRequest, requestOptions?: PromotionCodesClient.RequestOptions): Promise<core.Page<ToltApi.PromotionCode, ToltApi.ListPromotionCodesResponse>>;
     /**
-     * @param {ToltApi.CreatePromotionCodesRequest} request
+     * 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.CreatePromotionCodeRequest} 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: ToltApi.CreatePromotionCodesRequest, requestOptions?: PromotionCodesClient.RequestOptions): core.HttpResponsePromise<ToltApi.CreatePromotionCodesResponse>;
+    create(request: ToltApi.CreatePromotionCodeRequest, requestOptions?: PromotionCodesClient.RequestOptions): core.HttpResponsePromise<ToltApi.CreatePromotionCodeResponse>;
     private __create;
     /**
-     * @param {ToltApi.GetPromotionCodesRequest} request
+     * Gets a promotion code by ID, with its discount type and value and the partner, group or program it belongs to.
+     *
+     * @param {ToltApi.GetPromotionCodeRequest} 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: ToltApi.GetPromotionCodesRequest, requestOptions?: PromotionCodesClient.RequestOptions): core.HttpResponsePromise<ToltApi.GetPromotionCodesResponse>;
+    get(request: ToltApi.GetPromotionCodeRequest, requestOptions?: PromotionCodesClient.RequestOptions): core.HttpResponsePromise<ToltApi.GetPromotionCodeResponse>;
     private __get;
     /**
-     * @param {ToltApi.UpdatePromotionCodesRequest} request
+     * Updates a promotion code's code, discount type or value.
+     *
+     * @param {ToltApi.UpdatePromotionCodeRequest} 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: ToltApi.UpdatePromotionCodesRequest, requestOptions?: PromotionCodesClient.RequestOptions): core.HttpResponsePromise<ToltApi.UpdatePromotionCodesResponse>;
+    update(request: ToltApi.UpdatePromotionCodeRequest, requestOptions?: PromotionCodesClient.RequestOptions): core.HttpResponsePromise<ToltApi.UpdatePromotionCodeResponse>;
     private __update;
     /**
-     * @param {ToltApi.DeletePromotionCodesRequest} request
+     * Deletes a promotion code, so customers who use it afterwards are no longer attributed through it.
+     *
+     * @param {ToltApi.DeletePromotionCodeRequest} 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: ToltApi.DeletePromotionCodesRequest, requestOptions?: PromotionCodesClient.RequestOptions): core.HttpResponsePromise<ToltApi.DeletePromotionCodesResponse>;
+    delete(request: ToltApi.DeletePromotionCodeRequest, requestOptions?: PromotionCodesClient.RequestOptions): core.HttpResponsePromise<ToltApi.DeletePromotionCodeResponse>;
     private __delete;
 }

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}
@@ -24,80 +27,101 @@ export class PromotionCodesClient {
      * @example
      *     await client.promotionCodes.list()
      */
-    list(request = {}, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__list(request, requestOptions));
-    }
-    async __list(request = {}, requestOptions) {
-        const { limit, order, sort, starting_after: startingAfter, ending_before: endingBefore, created_after: createdAfter, created_before: createdBefore, updated_after: updatedAfter, updated_before: updatedBefore, program_id: programId, 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_ != null ? type_ : undefined,
-            search,
-        };
-        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/promotion-codes"),
-            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, 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_ != null ? type_ : undefined,
+                search,
+            };
+            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/promotion-codes"),
+                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/promotion-codes");
+            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/promotion-codes");
+        });
+        const dataWithRawResponse = await list(request).withRawResponse();
+        return new core.Page({
+            response: dataWithRawResponse.data,
+            rawResponse: dataWithRawResponse.rawResponse,
+            hasNextPage: (response) => response?.next_cursor != null &&
+                !(typeof response?.next_cursor === "string" && response?.next_cursor === ""),
+            getItems: (response) => response?.data ?? [],
+            loadPage: (response) => {
+                return list(core.setObjectProperty(request, "starting_after", response?.next_cursor));
+            },
+        });
     }
     /**
-     * @param {ToltApi.CreatePromotionCodesRequest} request
+     * 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.CreatePromotionCodeRequest} 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 +133,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",
@@ -117,7 +141,7 @@ export class PromotionCodesClient {
             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,
@@ -131,6 +155,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 +172,21 @@ export class PromotionCodesClient {
         return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v2/promotion-codes");
     }
     /**
-     * @param {ToltApi.GetPromotionCodesRequest} request
+     * Gets a promotion code by ID, with its discount type and value and the partner, group or program it belongs to.
+     *
+     * @param {ToltApi.GetPromotionCodeRequest} 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 +199,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, errors.ToltApiError)}`),
             method: "GET",
             headers: _headers,
             queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
@@ -187,6 +218,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 +233,26 @@ export class PromotionCodesClient {
         return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v2/promotion-codes/{id}");
     }
     /**
-     * @param {ToltApi.UpdatePromotionCodesRequest} request
+     * Updates a promotion code's code, discount type or value.
+     *
+     * @param {ToltApi.UpdatePromotionCodeRequest} 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 +265,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, errors.ToltApiError)}`),
             method: "PUT",
             headers: _headers,
             contentType: "application/json",
@@ -249,6 +289,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 +306,21 @@ export class PromotionCodesClient {
         return handleNonStatusCodeError(_response.error, _response.rawResponse, "PUT", "/v2/promotion-codes/{id}");
     }
     /**
-     * @param {ToltApi.DeletePromotionCodesRequest} request
+     * Deletes a promotion code, so customers who use it afterwards are no longer attributed through it.
+     *
+     * @param {ToltApi.DeletePromotionCodeRequest} 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 +333,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, errors.ToltApiError)}`),
             method: "DELETE",
             headers: _headers,
             queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
@@ -305,6 +352,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/CreatePromotionCodeRequest.d.ts

@@ -0,0 +1,27 @@
+/**
+ * @example
+ *     {
+ *         code: "SAM20",
+ *         type: "percentage",
+ *         value: "20",
+ *         partner_id: "part_NLYzgNKuSuASvrvoxNtau6SY"
+ *     }
+ */
+export interface CreatePromotionCodeRequest {
+    /** 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?: CreatePromotionCodeRequest.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 CreatePromotionCodeRequest {
+    /** Whether value is a percent off or a fixed amount off. */
+    const Type: {
+        readonly Fixed: "fixed";
+        readonly Percentage: "percentage";
+    };
+    type Type = (typeof Type)[keyof typeof Type];
+}

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

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

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

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

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

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

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/UpdatePromotionCodeRequest.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @example
+ *     {
+ *         id: "promo_gTCAUsWfdmN2GuCVRaHWNRan",
+ *         code: "SAM20",
+ *         type: "percentage",
+ *         value: "20"
+ *     }
+ */
+export interface UpdatePromotionCodeRequest {
+    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?: UpdatePromotionCodeRequest.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 UpdatePromotionCodeRequest {
+    /** Whether value is a percent off or a fixed amount off. */
+    const Type: {
+        readonly Fixed: "fixed";
+        readonly Percentage: "percentage";
+    };
+    type Type = (typeof Type)[keyof typeof Type];
+}

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

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

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

@@ -1,5 +1,5 @@
-export { CreatePromotionCodesRequest } from "./CreatePromotionCodesRequest.js";
-export type { DeletePromotionCodesRequest } from "./DeletePromotionCodesRequest.js";
-export type { GetPromotionCodesRequest } from "./GetPromotionCodesRequest.js";
+export { CreatePromotionCodeRequest } from "./CreatePromotionCodeRequest.js";
+export type { DeletePromotionCodeRequest } from "./DeletePromotionCodeRequest.js";
+export type { GetPromotionCodeRequest } from "./GetPromotionCodeRequest.js";
 export type { ListPromotionCodesRequest } from "./ListPromotionCodesRequest.js";
-export { UpdatePromotionCodesRequest } from "./UpdatePromotionCodesRequest.js";
+export { UpdatePromotionCodeRequest } from "./UpdatePromotionCodeRequest.js";

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

@@ -1,2 +1,2 @@
-export { CreatePromotionCodesRequest } from "./CreatePromotionCodesRequest.js";
-export { UpdatePromotionCodesRequest } from "./UpdatePromotionCodesRequest.js";
+export { CreatePromotionCodeRequest } from "./CreatePromotionCodeRequest.js";
+export { UpdatePromotionCodeRequest } from "./UpdatePromotionCodeRequest.js";

package/dist/api/resources/promotionCodes/types/{CreatePromotionCodesResponse.d.ts → CreatePromotionCodeResponse.d.ts}

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

package/dist/api/resources/promotionCodes/types/{DeletePromotionCodesResponse.d.ts → DeletePromotionCodeResponse.d.ts}

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

package/dist/api/resources/promotionCodes/types/{GetPromotionCodesResponse.d.ts → GetPromotionCodeResponse.d.ts}

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