@usethrottle/api-client 5.17.0 → 5.19.0

package/dist/generated/services/QuotesService.d.ts

@@ -1,4 +1,5 @@
 import type { CancelablePromise } from '../core/CancelablePromise.js';
+import type { CurrencyCode } from '@usethrottle/money';
 export declare class QuotesService {
     /**
      * List quotes with cursor pagination
@@ -24,8 +25,12 @@ export declare class QuotesService {
             buyerReference?: string | null;
             source?: 'dashboard' | 'api' | 'cart' | 'request_form';
             sourceCartId?: string | null;
+            /**
+             * Shipping address (canonical address fields): from the request form, or set by the merchant with `PATCH /quotes/{id}`. Prefilled into checkout on accept when the quote asks for a shipping address.
+             */
+            shippingAddress?: any | null;
             assignedMemberId?: string | null;
-            currency?: string;
+            currency?: CurrencyCode;
             currentRevisionId?: string | null;
             acceptedRevisionId?: string | null;
             acceptedAt?: string | null;
@@ -76,15 +81,18 @@ export declare class QuotesService {
         buyerReference?: string | null;
         source?: 'dashboard' | 'api';
         assignedMemberId?: string | null;
+        /**
+         * ISO currency code, stored uppercased. Omit it to use the store's main currency. Must be one of the store's enabled currencies, else `422 currency_not_enabled` (`422 currency_not_supported` for an unknown code, `422 currency_not_available_in_production` where production does not accept it).
+         */
         currency?: string;
         internalNotes?: string | null;
         items?: Array<{
             type?: 'product' | 'subscription' | 'service' | 'ticket' | 'donation' | 'custom';
             referenceId?: string | null;
             sku?: string | null;
-            name: string;
+            name?: string;
             description?: string | null;
-            unitPrice: number;
+            unitPrice?: number;
             quantity?: number;
             taxAmount?: number;
             discountAmount?: number;
@@ -95,7 +103,7 @@ export declare class QuotesService {
             position?: number;
             metadata?: Record<string, any>;
             /**
-             * Makes this line a subscription (type is forced to subscription). Send interval, or intervalUnit + intervalCount (1 hour to 1 year). totalPayments (2-60) makes it an installment plan; trialDays (0-365) adds a free trial, not combinable with totalPayments. The line unitPrice is what each renewal charges, including after a free trial, so it must be above 0 (400 invalid_line_item). At most 10 per quote, card pay-in-full quotes only (enforced at issue).
+             * Makes this line a subscription (type is forced to subscription). plan is required, except on a catalog-linked line (a SKU-only line, or one carrying metadata.catalogLink), where it defaults to <sku>:<cadence>. Send interval, or intervalUnit + intervalCount (1 hour to 1 year). totalPayments (2-60) makes it an installment plan; trialDays (0-365) adds a free trial, not combinable with totalPayments. The line unitPrice is what each renewal charges, including after a free trial, so it must be above 0 (400 invalid_line_item). At most 10 per quote, card pay-in-full quotes only (enforced at issue).
              */
             recurring?: any | null;
         }>;
@@ -138,8 +146,12 @@ export declare class QuotesService {
                 buyerReference?: string | null;
                 source?: 'dashboard' | 'api' | 'cart' | 'request_form';
                 sourceCartId?: string | null;
+                /**
+                 * Shipping address (canonical address fields): from the request form, or set by the merchant with `PATCH /quotes/{id}`. Prefilled into checkout on accept when the quote asks for a shipping address.
+                 */
+                shippingAddress?: any | null;
                 assignedMemberId?: string | null;
-                currency?: string;
+                currency?: CurrencyCode;
                 currentRevisionId?: string | null;
                 acceptedRevisionId?: string | null;
                 acceptedAt?: string | null;
@@ -267,6 +279,10 @@ export declare class QuotesService {
                 createdAt?: string;
                 updatedAt?: string;
             }>;
+            /**
+             * The quote's currency; the revision and item amounts are minor units of it
+             */
+            currency?: CurrencyCode;
         };
         meta?: {
             /**
@@ -296,8 +312,12 @@ export declare class QuotesService {
             buyerReference?: string | null;
             source?: 'dashboard' | 'api' | 'cart' | 'request_form';
             sourceCartId?: string | null;
+            /**
+             * Shipping address (canonical address fields): from the request form, or set by the merchant with `PATCH /quotes/{id}`. Prefilled into checkout on accept when the quote asks for a shipping address.
+             */
+            shippingAddress?: any | null;
             assignedMemberId?: string | null;
-            currency?: string;
+            currency?: CurrencyCode;
             currentRevisionId?: string | null;
             acceptedRevisionId?: string | null;
             acceptedAt?: string | null;
@@ -449,6 +469,14 @@ export declare class QuotesService {
          * With status 'declined': the reason shown to the buyer.
          */
         declinedReason?: string | null;
+        /**
+         * ISO currency code, stored uppercased. Changeable until the quote's first revision is issued, else `409 quote_currency_locked`; must be one of the environment's enabled currencies, else `422 currency_not_enabled` (`422 currency_not_supported` for an unknown code, `422 currency_not_available_in_production` where production does not accept it). The same currency is a no-op. Changing it flags every typed amount for review (`metadata.amountReview`); `POST /quotes/{id}/issue` answers `422 quote_amounts_need_review` until each is confirmed.
+         */
+        currency?: string;
+        /**
+         * Replaces the whole shipping address. `null` or all blank clears it; otherwise addressLine1, city and countryCode (ISO alpha-2) are required, else `400 invalid_request`. Prefilled into checkout on accept.
+         */
+        shippingAddress?: any | null;
     }, xThrottleEnvironmentId?: string): CancelablePromise<{
         data?: {
             id?: string;
@@ -459,8 +487,12 @@ export declare class QuotesService {
             buyerReference?: string | null;
             source?: 'dashboard' | 'api' | 'cart' | 'request_form';
             sourceCartId?: string | null;
+            /**
+             * Shipping address (canonical address fields): from the request form, or set by the merchant with `PATCH /quotes/{id}`. Prefilled into checkout on accept when the quote asks for a shipping address.
+             */
+            shippingAddress?: any | null;
             assignedMemberId?: string | null;
-            currency?: string;
+            currency?: CurrencyCode;
             currentRevisionId?: string | null;
             acceptedRevisionId?: string | null;
             acceptedAt?: string | null;
@@ -609,6 +641,10 @@ export declare class QuotesService {
                 createdAt?: string;
                 updatedAt?: string;
             }>;
+            /**
+             * The quote's currency; the revision and item amounts are minor units of it
+             */
+            currency?: CurrencyCode;
         };
         meta?: {
             /**
@@ -635,9 +671,9 @@ export declare class QuotesService {
             type?: 'product' | 'subscription' | 'service' | 'ticket' | 'donation' | 'custom';
             referenceId?: string | null;
             sku?: string | null;
-            name: string;
+            name?: string;
             description?: string | null;
-            unitPrice: number;
+            unitPrice?: number;
             quantity?: number;
             taxAmount?: number;
             discountAmount?: number;
@@ -648,7 +684,7 @@ export declare class QuotesService {
             position?: number;
             metadata?: Record<string, any>;
             /**
-             * Makes this line a subscription (type is forced to subscription). Send interval, or intervalUnit + intervalCount (1 hour to 1 year). totalPayments (2-60) makes it an installment plan; trialDays (0-365) adds a free trial, not combinable with totalPayments. The line unitPrice is what each renewal charges, including after a free trial, so it must be above 0 (400 invalid_line_item). At most 10 per quote, card pay-in-full quotes only (enforced at issue).
+             * Makes this line a subscription (type is forced to subscription). plan is required, except on a catalog-linked line (a SKU-only line, or one carrying metadata.catalogLink), where it defaults to <sku>:<cadence>. Send interval, or intervalUnit + intervalCount (1 hour to 1 year). totalPayments (2-60) makes it an installment plan; trialDays (0-365) adds a free trial, not combinable with totalPayments. The line unitPrice is what each renewal charges, including after a free trial, so it must be above 0 (400 invalid_line_item). At most 10 per quote, card pay-in-full quotes only (enforced at issue).
              */
             recurring?: any | null;
         }>;
@@ -785,6 +821,10 @@ export declare class QuotesService {
                 createdAt?: string;
                 updatedAt?: string;
             }>;
+            /**
+             * The quote's currency; the revision and item amounts are minor units of it
+             */
+            currency?: CurrencyCode;
         };
         meta?: {
             /**
@@ -798,7 +838,7 @@ export declare class QuotesService {
         };
     }>;
     /**
-     * Freeze the working revision, supersede the prior one, and propose the quote
+     * Freeze the working revision, supersede the prior one, and propose the quote. Answers `422 quote_amounts_need_review` with `details.pending` (each `{ kind: 'item', position, name }`, `{ kind: 'shippingFlatAmount' }` or `{ kind: 'depositAmount' }`) while an amount typed in another currency is unconfirmed (`metadata.amountReview`: `{ fromCurrency }` on an item, `{ fromCurrency, fields, fieldFrom }` on the revision).
      * @param id
      * @param requestBody
      * @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
@@ -816,8 +856,12 @@ export declare class QuotesService {
                 buyerReference?: string | null;
                 source?: 'dashboard' | 'api' | 'cart' | 'request_form';
                 sourceCartId?: string | null;
+                /**
+                 * Shipping address (canonical address fields): from the request form, or set by the merchant with `PATCH /quotes/{id}`. Prefilled into checkout on accept when the quote asks for a shipping address.
+                 */
+                shippingAddress?: any | null;
                 assignedMemberId?: string | null;
-                currency?: string;
+                currency?: CurrencyCode;
                 currentRevisionId?: string | null;
                 acceptedRevisionId?: string | null;
                 acceptedAt?: string | null;
@@ -945,6 +989,10 @@ export declare class QuotesService {
                 createdAt?: string;
                 updatedAt?: string;
             }>;
+            /**
+             * The quote's currency; the revision and item amounts are minor units of it
+             */
+            currency?: CurrencyCode;
         };
         meta?: {
             /**
@@ -976,8 +1024,12 @@ export declare class QuotesService {
                 buyerReference?: string | null;
                 source?: 'dashboard' | 'api' | 'cart' | 'request_form';
                 sourceCartId?: string | null;
+                /**
+                 * Shipping address (canonical address fields): from the request form, or set by the merchant with `PATCH /quotes/{id}`. Prefilled into checkout on accept when the quote asks for a shipping address.
+                 */
+                shippingAddress?: any | null;
                 assignedMemberId?: string | null;
-                currency?: string;
+                currency?: CurrencyCode;
                 currentRevisionId?: string | null;
                 acceptedRevisionId?: string | null;
                 acceptedAt?: string | null;
@@ -1074,8 +1126,12 @@ export declare class QuotesService {
                 buyerReference?: string | null;
                 source?: 'dashboard' | 'api' | 'cart' | 'request_form';
                 sourceCartId?: string | null;
+                /**
+                 * Shipping address (canonical address fields): from the request form, or set by the merchant with `PATCH /quotes/{id}`. Prefilled into checkout on accept when the quote asks for a shipping address.
+                 */
+                shippingAddress?: any | null;
                 assignedMemberId?: string | null;
-                currency?: string;
+                currency?: CurrencyCode;
                 currentRevisionId?: string | null;
                 acceptedRevisionId?: string | null;
                 acceptedAt?: string | null;
@@ -1203,6 +1259,10 @@ export declare class QuotesService {
                 createdAt?: string;
                 updatedAt?: string;
             }>;
+            /**
+             * The quote's currency; the revision and item amounts are minor units of it
+             */
+            currency?: CurrencyCode;
         };
         meta?: {
             /**
@@ -1245,8 +1305,12 @@ export declare class QuotesService {
                 buyerReference?: string | null;
                 source?: 'dashboard' | 'api' | 'cart' | 'request_form';
                 sourceCartId?: string | null;
+                /**
+                 * Shipping address (canonical address fields): from the request form, or set by the merchant with `PATCH /quotes/{id}`. Prefilled into checkout on accept when the quote asks for a shipping address.
+                 */
+                shippingAddress?: any | null;
                 assignedMemberId?: string | null;
-                currency?: string;
+                currency?: CurrencyCode;
                 currentRevisionId?: string | null;
                 acceptedRevisionId?: string | null;
                 acceptedAt?: string | null;
@@ -1297,7 +1361,7 @@ export declare class QuotesService {
             quoteNumber?: string;
             status?: 'in_progress' | 'ready' | 'being_revised' | 'accepted' | 'ordered' | 'declined' | 'expired';
             buyerReference?: string | null;
-            currency?: string;
+            currency?: CurrencyCode;
             expiresAt?: string | null;
             currentRevision?: any | null;
             revisionHistory?: Array<{
@@ -1324,6 +1388,7 @@ export declare class QuotesService {
                     id?: string;
                     type?: string;
                     sku?: string | null;
+                    linkedSku?: string | null;
                     name?: string;
                     description?: string | null;
                     unitPrice?: number;
@@ -1380,7 +1445,7 @@ export declare class QuotesService {
                 quoteNumber?: string;
                 status?: 'in_progress' | 'ready' | 'being_revised' | 'accepted' | 'ordered' | 'declined' | 'expired';
                 buyerReference?: string | null;
-                currency?: string;
+                currency?: CurrencyCode;
                 expiresAt?: string | null;
                 currentRevision?: any | null;
                 revisionHistory?: Array<{
@@ -1407,6 +1472,7 @@ export declare class QuotesService {
                         id?: string;
                         type?: string;
                         sku?: string | null;
+                        linkedSku?: string | null;
                         name?: string;
                         description?: string | null;
                         unitPrice?: number;
@@ -1499,7 +1565,7 @@ export declare class QuotesService {
             quoteNumber?: string;
             status?: 'in_progress' | 'ready' | 'being_revised' | 'accepted' | 'ordered' | 'declined' | 'expired';
             buyerReference?: string | null;
-            currency?: string;
+            currency?: CurrencyCode;
             expiresAt?: string | null;
             currentRevision?: any | null;
             revisionHistory?: Array<{
@@ -1526,6 +1592,7 @@ export declare class QuotesService {
                     id?: string;
                     type?: string;
                     sku?: string | null;
+                    linkedSku?: string | null;
                     name?: string;
                     description?: string | null;
                     unitPrice?: number;
@@ -1585,7 +1652,7 @@ export declare class QuotesService {
             quoteNumber?: string;
             status?: 'in_progress' | 'ready' | 'being_revised' | 'accepted' | 'ordered' | 'declined' | 'expired';
             buyerReference?: string | null;
-            currency?: string;
+            currency?: CurrencyCode;
             expiresAt?: string | null;
             currentRevision?: any | null;
             revisionHistory?: Array<{
@@ -1612,6 +1679,7 @@ export declare class QuotesService {
                     id?: string;
                     type?: string;
                     sku?: string | null;
+                    linkedSku?: string | null;
                     name?: string;
                     description?: string | null;
                     unitPrice?: number;
@@ -1678,7 +1746,7 @@ export declare class QuotesService {
                 quoteNumber?: string;
                 status?: 'in_progress' | 'ready' | 'being_revised' | 'accepted' | 'ordered' | 'declined' | 'expired';
                 buyerReference?: string | null;
-                currency?: string;
+                currency?: CurrencyCode;
                 expiresAt?: string | null;
                 currentRevision?: any | null;
                 revisionHistory?: Array<{
@@ -1705,6 +1773,7 @@ export declare class QuotesService {
                         id?: string;
                         type?: string;
                         sku?: string | null;
+                        linkedSku?: string | null;
                         name?: string;
                         description?: string | null;
                         unitPrice?: number;
@@ -1799,6 +1868,10 @@ export declare class QuotesService {
         fields?: {
             companyName?: boolean;
             phone?: boolean;
+            /**
+             * Ask for a shipping address (default false)
+             */
+            shippingAddress?: boolean;
             buyerReference?: boolean;
             /**
              * Item rows on the hosted form (default true)
@@ -1900,6 +1973,10 @@ export declare class QuotesService {
         fields?: {
             companyName?: boolean;
             phone?: boolean;
+            /**
+             * Ask for a shipping address (default false)
+             */
+            shippingAddress?: boolean;
             buyerReference?: boolean;
             /**
              * Item rows on the hosted form (default true)
@@ -1997,9 +2074,17 @@ export declare class QuotesService {
             introText?: string | null;
             successMessage?: string | null;
             redirectUrl?: string | null;
+            /**
+             * The currency the request's quote is created in (the store's main currency); a target price is typed in it
+             */
+            currency?: CurrencyCode | null;
             fields?: {
                 companyName?: boolean;
                 phone?: boolean;
+                /**
+                 * Ask for a shipping address (default false)
+                 */
+                shippingAddress?: boolean;
                 buyerReference?: boolean;
                 lineItems?: boolean;
                 targetPrice?: boolean;
@@ -2048,6 +2133,10 @@ export declare class QuotesService {
          * A cart the buyer already filled; its lines join the request. Resolved inside the form's own application + environment.
          */
         cartId?: string | null;
+        /**
+         * Optional. All blank = none; otherwise addressLine1, city and countryCode are required. Stored on the quote; added to the address book only for a customer this request created.
+         */
+        shippingAddress?: any | null;
         /**
          * Honeypot — must be empty
          */
@@ -2072,6 +2161,145 @@ export declare class QuotesService {
             };
         };
     }>;
+    /**
+     * Is the Product Catalog available for quotes
+     * Whether the Product Catalog extension is installed, active and reachable for signed lookups in this environment. Reads Throttle's database only. Requires `quotes:write` (API keys) or `application:quotes:write` (dashboard users). The application and environment come from the caller, never from the request. Responses carry `Cache-Control: no-store` and `Server-Timing: catalog;dur=<ms>` (time spent calling the Product Catalog; 0 when no call was made).
+     * @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
+     * @returns any Default Response
+     * @throws ApiError
+     */
+    static getApiV1QuoteCatalogStatus(xThrottleEnvironmentId?: string): CancelablePromise<{
+        data?: {
+            available: boolean;
+        };
+        meta?: {
+            /**
+             * `req_<uuid>`, or a client-supplied id matching `^[A-Za-z0-9_-]{8,128}$`.
+             */
+            requestId?: string;
+            pagination?: {
+                cursor?: string | null;
+                hasMore?: boolean;
+            };
+        };
+    }>;
+    /**
+     * Search the Product Catalog for quote lines
+     * Search active catalog variants by exact SKU, SKU fragment or text, priced in `currency` for `customerId`. Answers `{ rows, installationId }`, or `{ rows: [], available: false }` when the catalog is not available. Requires `quotes:write` (API keys) or `application:quotes:write` (dashboard users). The application and environment come from the caller, never from the request. Responses carry `Cache-Control: no-store` and `Server-Timing: catalog;dur=<ms>` (time spent calling the Product Catalog; 0 when no call was made).
+     * @param q Search text, 2–100 characters once trimmed.
+     * @param currency ISO 4217 code; one of the environment's currency and extra cart currencies (case-insensitive).
+     * @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
+     * @param customerId Prices for this customer (customer-group pricing). Must be a customer of this environment.
+     * @param limit Rows to answer, 1–20 (default 8).
+     * @returns any Default Response
+     * @throws ApiError
+     */
+    static getApiV1QuoteCatalogSearch(q: string, currency: string, xThrottleEnvironmentId?: string, customerId?: string, limit?: number): CancelablePromise<{
+        data?: {
+            rows: Array<{
+                sku: string;
+                variantId: string;
+                productHandle: string;
+                productTitle: string;
+                name: string;
+                optionValues: Array<string>;
+                description: string | null;
+                imageUrl: string | null;
+                /**
+                 * Unit price in minor units; null when the variant has no price in `currency`.
+                 */
+                priceMinor: number | null;
+                currency: CurrencyCode;
+                priceKind: 'list' | 'sale' | 'group' | null;
+                taxCode: string | null;
+                stockStatus: 'in_stock' | 'out_of_stock' | 'backorder';
+                minQuantity: number | null;
+                maxQuantity: number | null;
+            }>;
+            /**
+             * The Product Catalog installation that answered; a catalog-linked line's `catalogLink.installationId`. Absent when the catalog is not available.
+             */
+            installationId?: string;
+            /**
+             * Present (false) only when the catalog is not available.
+             */
+            available?: boolean;
+        };
+        meta?: {
+            /**
+             * `req_<uuid>`, or a client-supplied id matching `^[A-Za-z0-9_-]{8,128}$`.
+             */
+            requestId?: string;
+            pagination?: {
+                cursor?: string | null;
+                hasMore?: boolean;
+            };
+        };
+    }>;
+    /**
+     * Look up quote lines by SKU in the Product Catalog
+     * Answers `{ lines, installationId }`: one entry per requested SKU, in request order; duplicates are allowed and each is answered. SKUs are matched trimmed; an empty SKU or one over 255 characters is `NOT_FOUND`. Requires `quotes:write` (API keys) or `application:quotes:write` (dashboard users). The application and environment come from the caller, never from the request. Responses carry `Cache-Control: no-store` and `Server-Timing: catalog;dur=<ms>` (time spent calling the Product Catalog; 0 when no call was made).
+     * @param requestBody
+     * @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
+     * @returns any Default Response
+     * @throws ApiError
+     */
+    static postApiV1QuoteCatalogLines(requestBody: {
+        skus: Array<string>;
+        /**
+         * ISO 4217 code; one of the environment's currency and extra cart currencies (case-insensitive).
+         */
+        currency: string;
+        /**
+         * Prices for this customer (customer-group pricing). Must be a customer of this environment.
+         */
+        customerId?: string | null;
+    }, xThrottleEnvironmentId?: string): CancelablePromise<{
+        data?: {
+            lines: Array<{
+                /**
+                 * The SKU exactly as requested.
+                 */
+                sku: string;
+                ok: boolean;
+                row?: {
+                    sku: string;
+                    variantId: string;
+                    productHandle: string;
+                    productTitle: string;
+                    name: string;
+                    optionValues: Array<string>;
+                    description: string | null;
+                    imageUrl: string | null;
+                    /**
+                     * Unit price in minor units; null when the variant has no price in `currency`.
+                     */
+                    priceMinor: number | null;
+                    currency: CurrencyCode;
+                    priceKind: 'list' | 'sale' | 'group' | null;
+                    taxCode: string | null;
+                    stockStatus: 'in_stock' | 'out_of_stock' | 'backorder';
+                    minQuantity: number | null;
+                    maxQuantity: number | null;
+                };
+                code?: 'NOT_FOUND';
+            }>;
+            /**
+             * The Product Catalog installation that answered; a catalog-linked line's `catalogLink.installationId`.
+             */
+            installationId: string;
+        };
+        meta?: {
+            /**
+             * `req_<uuid>`, or a client-supplied id matching `^[A-Za-z0-9_-]{8,128}$`.
+             */
+            requestId?: string;
+            pagination?: {
+                cursor?: string | null;
+                hasMore?: boolean;
+            };
+        };
+    }>;
     /**
      * Get quote notification settings for an application
      * @param applicationId