@usethrottle/api-client 5.7.1 → 5.9.0

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

@@ -200,6 +200,33 @@ export declare class OrdersService {
                 amount?: number;
             } | null;
             customerId?: string | null;
+            applicationId?: string;
+            environmentId?: string;
+            cartId?: string | null;
+            /**
+             * The source platform's own order id, for an order that arrived by import; null otherwise.
+             */
+            externalId?: string | null;
+            /**
+             * The source platform's customer id, for an order that arrived by import; null otherwise.
+             */
+            externalCustomerId?: string | null;
+            /**
+             * The import that created this order; null otherwise.
+             */
+            importId?: string | null;
+            /**
+             * The buyer's IP address recorded at checkout.
+             */
+            ipAddress?: string | null;
+            /**
+             * The buyer's user agent recorded at checkout.
+             */
+            userAgent?: string | null;
+            /**
+             * Attribution snapshot copied from the checkout session when the order was created.
+             */
+            clientContext?: Record<string, any> | null;
             subscriptionIds?: Array<string>;
             subscriptionId?: string | null;
             customer?: {
@@ -274,6 +301,13 @@ export declare class OrdersService {
                  * Arbitrary key-value metadata
                  */
                 metadata?: Record<string, any>;
+                workspaceId?: string;
+                applicationId?: string;
+                orderId?: string;
+                cartId?: string | null;
+                position?: number;
+                createdAt?: string;
+                updatedAt?: string;
             }>;
         };
         meta?: {
@@ -417,6 +451,33 @@ export declare class OrdersService {
                 amount?: number;
             } | null;
             customerId?: string | null;
+            applicationId?: string;
+            environmentId?: string;
+            cartId?: string | null;
+            /**
+             * The source platform's own order id, for an order that arrived by import; null otherwise.
+             */
+            externalId?: string | null;
+            /**
+             * The source platform's customer id, for an order that arrived by import; null otherwise.
+             */
+            externalCustomerId?: string | null;
+            /**
+             * The import that created this order; null otherwise.
+             */
+            importId?: string | null;
+            /**
+             * The buyer's IP address recorded at checkout.
+             */
+            ipAddress?: string | null;
+            /**
+             * The buyer's user agent recorded at checkout.
+             */
+            userAgent?: string | null;
+            /**
+             * Attribution snapshot copied from the checkout session when the order was created.
+             */
+            clientContext?: Record<string, any> | null;
             subscriptionIds?: Array<string>;
             subscriptionId?: string | null;
             customer?: {
@@ -491,6 +552,13 @@ export declare class OrdersService {
                  * Arbitrary key-value metadata
                  */
                 metadata?: Record<string, any>;
+                workspaceId?: string;
+                applicationId?: string;
+                orderId?: string;
+                cartId?: string | null;
+                position?: number;
+                createdAt?: string;
+                updatedAt?: string;
             }>;
         }>;
         meta?: {
@@ -642,6 +710,33 @@ export declare class OrdersService {
                 amount?: number;
             } | null;
             customerId?: string | null;
+            applicationId?: string;
+            environmentId?: string;
+            cartId?: string | null;
+            /**
+             * The source platform's own order id, for an order that arrived by import; null otherwise.
+             */
+            externalId?: string | null;
+            /**
+             * The source platform's customer id, for an order that arrived by import; null otherwise.
+             */
+            externalCustomerId?: string | null;
+            /**
+             * The import that created this order; null otherwise.
+             */
+            importId?: string | null;
+            /**
+             * The buyer's IP address recorded at checkout.
+             */
+            ipAddress?: string | null;
+            /**
+             * The buyer's user agent recorded at checkout.
+             */
+            userAgent?: string | null;
+            /**
+             * Attribution snapshot copied from the checkout session when the order was created.
+             */
+            clientContext?: Record<string, any> | null;
             subscriptionIds?: Array<string>;
             subscriptionId?: string | null;
             customer?: {
@@ -716,6 +811,13 @@ export declare class OrdersService {
                  * Arbitrary key-value metadata
                  */
                 metadata?: Record<string, any>;
+                workspaceId?: string;
+                applicationId?: string;
+                orderId?: string;
+                cartId?: string | null;
+                position?: number;
+                createdAt?: string;
+                updatedAt?: string;
             }>;
             /**
              * What this order actually collected, before refunds. Not the same as `total` on a partially-paid order.
@@ -901,6 +1003,33 @@ export declare class OrdersService {
                 amount?: number;
             } | null;
             customerId?: string | null;
+            applicationId?: string;
+            environmentId?: string;
+            cartId?: string | null;
+            /**
+             * The source platform's own order id, for an order that arrived by import; null otherwise.
+             */
+            externalId?: string | null;
+            /**
+             * The source platform's customer id, for an order that arrived by import; null otherwise.
+             */
+            externalCustomerId?: string | null;
+            /**
+             * The import that created this order; null otherwise.
+             */
+            importId?: string | null;
+            /**
+             * The buyer's IP address recorded at checkout.
+             */
+            ipAddress?: string | null;
+            /**
+             * The buyer's user agent recorded at checkout.
+             */
+            userAgent?: string | null;
+            /**
+             * Attribution snapshot copied from the checkout session when the order was created.
+             */
+            clientContext?: Record<string, any> | null;
             subscriptionIds?: Array<string>;
             subscriptionId?: string | null;
             customer?: {
@@ -975,6 +1104,13 @@ export declare class OrdersService {
                  * Arbitrary key-value metadata
                  */
                 metadata?: Record<string, any>;
+                workspaceId?: string;
+                applicationId?: string;
+                orderId?: string;
+                cartId?: string | null;
+                position?: number;
+                createdAt?: string;
+                updatedAt?: string;
             }>;
         };
         meta?: {
@@ -1107,6 +1243,33 @@ export declare class OrdersService {
                 amount?: number;
             } | null;
             customerId?: string | null;
+            applicationId?: string;
+            environmentId?: string;
+            cartId?: string | null;
+            /**
+             * The source platform's own order id, for an order that arrived by import; null otherwise.
+             */
+            externalId?: string | null;
+            /**
+             * The source platform's customer id, for an order that arrived by import; null otherwise.
+             */
+            externalCustomerId?: string | null;
+            /**
+             * The import that created this order; null otherwise.
+             */
+            importId?: string | null;
+            /**
+             * The buyer's IP address recorded at checkout.
+             */
+            ipAddress?: string | null;
+            /**
+             * The buyer's user agent recorded at checkout.
+             */
+            userAgent?: string | null;
+            /**
+             * Attribution snapshot copied from the checkout session when the order was created.
+             */
+            clientContext?: Record<string, any> | null;
             subscriptionIds?: Array<string>;
             subscriptionId?: string | null;
             customer?: {
@@ -1181,6 +1344,13 @@ export declare class OrdersService {
                  * Arbitrary key-value metadata
                  */
                 metadata?: Record<string, any>;
+                workspaceId?: string;
+                applicationId?: string;
+                orderId?: string;
+                cartId?: string | null;
+                position?: number;
+                createdAt?: string;
+                updatedAt?: string;
             }>;
         };
         meta?: {
@@ -1316,6 +1486,33 @@ export declare class OrdersService {
                 amount?: number;
             } | null;
             customerId?: string | null;
+            applicationId?: string;
+            environmentId?: string;
+            cartId?: string | null;
+            /**
+             * The source platform's own order id, for an order that arrived by import; null otherwise.
+             */
+            externalId?: string | null;
+            /**
+             * The source platform's customer id, for an order that arrived by import; null otherwise.
+             */
+            externalCustomerId?: string | null;
+            /**
+             * The import that created this order; null otherwise.
+             */
+            importId?: string | null;
+            /**
+             * The buyer's IP address recorded at checkout.
+             */
+            ipAddress?: string | null;
+            /**
+             * The buyer's user agent recorded at checkout.
+             */
+            userAgent?: string | null;
+            /**
+             * Attribution snapshot copied from the checkout session when the order was created.
+             */
+            clientContext?: Record<string, any> | null;
             subscriptionIds?: Array<string>;
             subscriptionId?: string | null;
             customer?: {
@@ -1390,6 +1587,13 @@ export declare class OrdersService {
                  * Arbitrary key-value metadata
                  */
                 metadata?: Record<string, any>;
+                workspaceId?: string;
+                applicationId?: string;
+                orderId?: string;
+                cartId?: string | null;
+                position?: number;
+                createdAt?: string;
+                updatedAt?: string;
             }>;
         };
         meta?: {
@@ -1525,6 +1729,33 @@ export declare class OrdersService {
                 amount?: number;
             } | null;
             customerId?: string | null;
+            applicationId?: string;
+            environmentId?: string;
+            cartId?: string | null;
+            /**
+             * The source platform's own order id, for an order that arrived by import; null otherwise.
+             */
+            externalId?: string | null;
+            /**
+             * The source platform's customer id, for an order that arrived by import; null otherwise.
+             */
+            externalCustomerId?: string | null;
+            /**
+             * The import that created this order; null otherwise.
+             */
+            importId?: string | null;
+            /**
+             * The buyer's IP address recorded at checkout.
+             */
+            ipAddress?: string | null;
+            /**
+             * The buyer's user agent recorded at checkout.
+             */
+            userAgent?: string | null;
+            /**
+             * Attribution snapshot copied from the checkout session when the order was created.
+             */
+            clientContext?: Record<string, any> | null;
             subscriptionIds?: Array<string>;
             subscriptionId?: string | null;
             customer?: {
@@ -1599,6 +1830,13 @@ export declare class OrdersService {
                  * Arbitrary key-value metadata
                  */
                 metadata?: Record<string, any>;
+                workspaceId?: string;
+                applicationId?: string;
+                orderId?: string;
+                cartId?: string | null;
+                position?: number;
+                createdAt?: string;
+                updatedAt?: string;
             }>;
         };
         meta?: {
@@ -1613,7 +1851,7 @@ export declare class OrdersService {
         };
     }>;
     /**
-     * Cancel an order. Authorized payments are always voided; captured payments are refunded when refundCapturedPayments is true.
+     * Cancel an order. Authorized payments and unpaid Net-N invoices (`method: net30`, status `authorized` or `pending`) are always voided; captured payments are refunded when refundCapturedPayments is true.
      * @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.
@@ -1735,6 +1973,33 @@ export declare class OrdersService {
                 amount?: number;
             } | null;
             customerId?: string | null;
+            applicationId?: string;
+            environmentId?: string;
+            cartId?: string | null;
+            /**
+             * The source platform's own order id, for an order that arrived by import; null otherwise.
+             */
+            externalId?: string | null;
+            /**
+             * The source platform's customer id, for an order that arrived by import; null otherwise.
+             */
+            externalCustomerId?: string | null;
+            /**
+             * The import that created this order; null otherwise.
+             */
+            importId?: string | null;
+            /**
+             * The buyer's IP address recorded at checkout.
+             */
+            ipAddress?: string | null;
+            /**
+             * The buyer's user agent recorded at checkout.
+             */
+            userAgent?: string | null;
+            /**
+             * Attribution snapshot copied from the checkout session when the order was created.
+             */
+            clientContext?: Record<string, any> | null;
             subscriptionIds?: Array<string>;
             subscriptionId?: string | null;
             customer?: {
@@ -1809,9 +2074,16 @@ export declare class OrdersService {
                  * Arbitrary key-value metadata
                  */
                 metadata?: Record<string, any>;
+                workspaceId?: string;
+                applicationId?: string;
+                orderId?: string;
+                cartId?: string | null;
+                position?: number;
+                createdAt?: string;
+                updatedAt?: string;
             }>;
             /**
-             * Payment settlement performed by the cancel: voids of open authorizations (always) and refunds of captured payments (opt-in). Failures never undo the cancel.
+             * Payment settlement performed by the cancel: voids of open authorizations and unpaid Net-N invoices (always) and refunds of captured payments (opt-in). Failures never undo the cancel.
              */
             paymentActions?: Array<{
                 paymentId?: string;
@@ -1832,7 +2104,7 @@ export declare class OrdersService {
         };
     }>;
     /**
-     * Move an order to any lifecycle status. Both directions are allowed — this is the merchant override, not a state-machine step. Side effects already applied are never rewound. Moving to `cancelled` additionally requires the `order_cancellations:write` scope and voids the order's live authorizations, exactly as `POST /orders/{id}/cancel` does; captured payments are left alone.
+     * Move an order to any lifecycle status. Both directions are allowed — this is the merchant override, not a state-machine step. Side effects already applied are never rewound. Moving to `cancelled` additionally requires the `order_cancellations:write` scope and voids the order's live authorizations and unpaid Net-N invoices, exactly as `POST /orders/{id}/cancel` does; captured payments are left alone.
      * @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.
@@ -1954,6 +2226,33 @@ export declare class OrdersService {
                 amount?: number;
             } | null;
             customerId?: string | null;
+            applicationId?: string;
+            environmentId?: string;
+            cartId?: string | null;
+            /**
+             * The source platform's own order id, for an order that arrived by import; null otherwise.
+             */
+            externalId?: string | null;
+            /**
+             * The source platform's customer id, for an order that arrived by import; null otherwise.
+             */
+            externalCustomerId?: string | null;
+            /**
+             * The import that created this order; null otherwise.
+             */
+            importId?: string | null;
+            /**
+             * The buyer's IP address recorded at checkout.
+             */
+            ipAddress?: string | null;
+            /**
+             * The buyer's user agent recorded at checkout.
+             */
+            userAgent?: string | null;
+            /**
+             * Attribution snapshot copied from the checkout session when the order was created.
+             */
+            clientContext?: Record<string, any> | null;
             subscriptionIds?: Array<string>;
             subscriptionId?: string | null;
             customer?: {
@@ -2028,6 +2327,13 @@ export declare class OrdersService {
                  * Arbitrary key-value metadata
                  */
                 metadata?: Record<string, any>;
+                workspaceId?: string;
+                applicationId?: string;
+                orderId?: string;
+                cartId?: string | null;
+                position?: number;
+                createdAt?: string;
+                updatedAt?: string;
             }>;
         };
         meta?: {
@@ -2163,6 +2469,33 @@ export declare class OrdersService {
                 amount?: number;
             } | null;
             customerId?: string | null;
+            applicationId?: string;
+            environmentId?: string;
+            cartId?: string | null;
+            /**
+             * The source platform's own order id, for an order that arrived by import; null otherwise.
+             */
+            externalId?: string | null;
+            /**
+             * The source platform's customer id, for an order that arrived by import; null otherwise.
+             */
+            externalCustomerId?: string | null;
+            /**
+             * The import that created this order; null otherwise.
+             */
+            importId?: string | null;
+            /**
+             * The buyer's IP address recorded at checkout.
+             */
+            ipAddress?: string | null;
+            /**
+             * The buyer's user agent recorded at checkout.
+             */
+            userAgent?: string | null;
+            /**
+             * Attribution snapshot copied from the checkout session when the order was created.
+             */
+            clientContext?: Record<string, any> | null;
             subscriptionIds?: Array<string>;
             subscriptionId?: string | null;
             customer?: {
@@ -2237,6 +2570,13 @@ export declare class OrdersService {
                  * Arbitrary key-value metadata
                  */
                 metadata?: Record<string, any>;
+                workspaceId?: string;
+                applicationId?: string;
+                orderId?: string;
+                cartId?: string | null;
+                position?: number;
+                createdAt?: string;
+                updatedAt?: string;
             }>;
             /**
              * Payment settlement performed by the comp: voids of anything still claiming the waived balance — open authorizations, and unpaid Net-N invoices, whose buyers are also emailed. Captured money is never touched. Failures never undo the comp.
@@ -2378,6 +2718,33 @@ export declare class OrdersService {
                 amount?: number;
             } | null;
             customerId?: string | null;
+            applicationId?: string;
+            environmentId?: string;
+            cartId?: string | null;
+            /**
+             * The source platform's own order id, for an order that arrived by import; null otherwise.
+             */
+            externalId?: string | null;
+            /**
+             * The source platform's customer id, for an order that arrived by import; null otherwise.
+             */
+            externalCustomerId?: string | null;
+            /**
+             * The import that created this order; null otherwise.
+             */
+            importId?: string | null;
+            /**
+             * The buyer's IP address recorded at checkout.
+             */
+            ipAddress?: string | null;
+            /**
+             * The buyer's user agent recorded at checkout.
+             */
+            userAgent?: string | null;
+            /**
+             * Attribution snapshot copied from the checkout session when the order was created.
+             */
+            clientContext?: Record<string, any> | null;
             subscriptionIds?: Array<string>;
             subscriptionId?: string | null;
             customer?: {
@@ -2452,6 +2819,13 @@ export declare class OrdersService {
                  * Arbitrary key-value metadata
                  */
                 metadata?: Record<string, any>;
+                workspaceId?: string;
+                applicationId?: string;
+                orderId?: string;
+                cartId?: string | null;
+                position?: number;
+                createdAt?: string;
+                updatedAt?: string;
             }>;
         };
         meta?: {
@@ -2587,6 +2961,33 @@ export declare class OrdersService {
                 amount?: number;
             } | null;
             customerId?: string | null;
+            applicationId?: string;
+            environmentId?: string;
+            cartId?: string | null;
+            /**
+             * The source platform's own order id, for an order that arrived by import; null otherwise.
+             */
+            externalId?: string | null;
+            /**
+             * The source platform's customer id, for an order that arrived by import; null otherwise.
+             */
+            externalCustomerId?: string | null;
+            /**
+             * The import that created this order; null otherwise.
+             */
+            importId?: string | null;
+            /**
+             * The buyer's IP address recorded at checkout.
+             */
+            ipAddress?: string | null;
+            /**
+             * The buyer's user agent recorded at checkout.
+             */
+            userAgent?: string | null;
+            /**
+             * Attribution snapshot copied from the checkout session when the order was created.
+             */
+            clientContext?: Record<string, any> | null;
             subscriptionIds?: Array<string>;
             subscriptionId?: string | null;
             customer?: {
@@ -2661,6 +3062,13 @@ export declare class OrdersService {
                  * Arbitrary key-value metadata
                  */
                 metadata?: Record<string, any>;
+                workspaceId?: string;
+                applicationId?: string;
+                orderId?: string;
+                cartId?: string | null;
+                position?: number;
+                createdAt?: string;
+                updatedAt?: string;
             }>;
         };
         meta?: {
@@ -2793,6 +3201,33 @@ export declare class OrdersService {
                 amount?: number;
             } | null;
             customerId?: string | null;
+            applicationId?: string;
+            environmentId?: string;
+            cartId?: string | null;
+            /**
+             * The source platform's own order id, for an order that arrived by import; null otherwise.
+             */
+            externalId?: string | null;
+            /**
+             * The source platform's customer id, for an order that arrived by import; null otherwise.
+             */
+            externalCustomerId?: string | null;
+            /**
+             * The import that created this order; null otherwise.
+             */
+            importId?: string | null;
+            /**
+             * The buyer's IP address recorded at checkout.
+             */
+            ipAddress?: string | null;
+            /**
+             * The buyer's user agent recorded at checkout.
+             */
+            userAgent?: string | null;
+            /**
+             * Attribution snapshot copied from the checkout session when the order was created.
+             */
+            clientContext?: Record<string, any> | null;
             subscriptionIds?: Array<string>;
             subscriptionId?: string | null;
             customer?: {
@@ -2867,6 +3302,13 @@ export declare class OrdersService {
                  * Arbitrary key-value metadata
                  */
                 metadata?: Record<string, any>;
+                workspaceId?: string;
+                applicationId?: string;
+                orderId?: string;
+                cartId?: string | null;
+                position?: number;
+                createdAt?: string;
+                updatedAt?: string;
             }>;
         };
         meta?: {
@@ -3063,6 +3505,33 @@ export declare class OrdersService {
                 amount?: number;
             } | null;
             customerId?: string | null;
+            applicationId?: string;
+            environmentId?: string;
+            cartId?: string | null;
+            /**
+             * The source platform's own order id, for an order that arrived by import; null otherwise.
+             */
+            externalId?: string | null;
+            /**
+             * The source platform's customer id, for an order that arrived by import; null otherwise.
+             */
+            externalCustomerId?: string | null;
+            /**
+             * The import that created this order; null otherwise.
+             */
+            importId?: string | null;
+            /**
+             * The buyer's IP address recorded at checkout.
+             */
+            ipAddress?: string | null;
+            /**
+             * The buyer's user agent recorded at checkout.
+             */
+            userAgent?: string | null;
+            /**
+             * Attribution snapshot copied from the checkout session when the order was created.
+             */
+            clientContext?: Record<string, any> | null;
             subscriptionIds?: Array<string>;
             subscriptionId?: string | null;
             customer?: {
@@ -3137,6 +3606,13 @@ export declare class OrdersService {
                  * Arbitrary key-value metadata
                  */
                 metadata?: Record<string, any>;
+                workspaceId?: string;
+                applicationId?: string;
+                orderId?: string;
+                cartId?: string | null;
+                position?: number;
+                createdAt?: string;
+                updatedAt?: string;
             }>;
         };
         meta?: {
@@ -3351,12 +3827,6 @@ export declare class OrdersService {
                 amount?: number;
             } | null;
             customerId?: string | null;
-            subscriptionId?: string | null;
-            cancelledAt?: string | null;
-            completedAt?: string | null;
-            closedAt?: string | null;
-            createdAt?: string;
-            updatedAt?: string;
             applicationId?: string;
             environmentId?: string;
             cartId?: string | null;
@@ -3384,6 +3854,12 @@ export declare class OrdersService {
              * Attribution snapshot copied from the checkout session when the order was created.
              */
             clientContext?: Record<string, any> | null;
+            subscriptionId?: string | null;
+            cancelledAt?: string | null;
+            completedAt?: string | null;
+            closedAt?: string | null;
+            createdAt?: string;
+            updatedAt?: string;
             /**
              * Every line item on the order after the edit, not only the ones changed.
              */