@usethrottle/api-client 2.18.0 → 3.2.0

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

@@ -79,6 +79,10 @@ export declare class OrdersService {
              * Product image. Accepts an absolute http(s) URL or a relative path (e.g. "/images/x.png"); relative paths are resolved against the application storefront base URL (PUT /v1/embed-config { storefrontBaseUrl }, falling back to the first allowedOrigin).
              */
             imageUrl?: string;
+            /**
+             * What this item needs before it counts as delivered. Omit to resolve from `type` and `metadata`. `digital` and `access_grant` are delivered automatically on payment capture; `none` means there is nothing to deliver.
+             */
+            deliveryMethod?: 'shipment' | 'digital' | 'access_grant' | 'service' | 'in_person' | 'custom' | 'none';
             /**
              * Arbitrary key-value metadata
              */
@@ -91,10 +95,15 @@ export declare class OrdersService {
             discountId?: string | null;
             discountCode?: string | null;
             orderNumber?: string;
-            status?: 'draft' | 'pending' | 'processing' | 'partially_fulfilled' | 'completed' | 'cancelled' | 'closed';
+            status?: 'draft' | 'pending' | 'processing' | 'partially_fulfilled' | 'fulfilled' | 'cancelled' | 'closed';
+            displayStatus?: string;
+            fulfillmentSummary?: {
+                itemsTotal?: number;
+                itemsFulfilled?: number;
+                itemsRemaining?: number;
+            } | null;
             type?: 'one_time' | 'recurring' | 'mixed';
             paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided';
-            fulfillmentStatus?: 'unfulfilled' | 'partially_fulfilled' | 'fulfilled' | 'not_applicable';
             source?: 'web' | 'mobile' | 'pos' | 'api' | 'subscription_engine';
             currency?: string;
             /**
@@ -119,6 +128,13 @@ export declare class OrdersService {
              * Amount in cents (e.g. 1999 = $19.99)
              */
             total?: number;
+            /**
+             * Amount in cents (e.g. 1999 = $19.99)
+             */
+            compAmount?: number;
+            compReason?: string | null;
+            compedAt?: string | null;
+            compedBy?: string | null;
             /**
              * Arbitrary key-value metadata
              */
@@ -167,7 +183,11 @@ export declare class OrdersService {
                 email?: string;
                 firstName?: string | null;
                 lastName?: string | null;
+                company?: string | null;
             } | null;
+            cancelledAt?: string | null;
+            completedAt?: string | null;
+            closedAt?: string | null;
             createdAt?: string;
             updatedAt?: string;
         };
@@ -190,22 +210,28 @@ export declare class OrdersService {
      * @param source
      * @param q Search order id, number, source, status, or metadata.
      * @param customerId
+     * @param subscriptionId Return only the orders this subscription billed (exact match on the order metadata `subscription_id` pointer). Covers renewals, plan-change charges and the signup order.
      * @param createdAfter ISO 8601 lower bound on creation time, EXCLUSIVE (created_at > value).
      * @param createdBefore ISO 8601 upper bound on creation time, EXCLUSIVE (created_at < value).
      * @returns any Default Response
      * @throws ApiError
      */
-    static getApiV1Orders(xThrottleEnvironmentId?: string, cursor?: string, limit?: number, status?: 'draft' | 'pending' | 'processing' | 'partially_fulfilled' | 'completed' | 'cancelled' | 'closed', paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided', type?: 'one_time' | 'recurring' | 'mixed', source?: 'web' | 'mobile' | 'pos' | 'api' | 'subscription_engine', q?: string, customerId?: string, createdAfter?: string, createdBefore?: string): CancelablePromise<{
+    static getApiV1Orders(xThrottleEnvironmentId?: string, cursor?: string, limit?: number, status?: 'draft' | 'pending' | 'processing' | 'partially_fulfilled' | 'fulfilled' | 'cancelled' | 'closed', paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided', type?: 'one_time' | 'recurring' | 'mixed', source?: 'web' | 'mobile' | 'pos' | 'api' | 'subscription_engine', q?: string, customerId?: string, subscriptionId?: string, createdAfter?: string, createdBefore?: string): CancelablePromise<{
         data?: Array<{
             id?: string;
             workspaceId?: string;
             discountId?: string | null;
             discountCode?: string | null;
             orderNumber?: string;
-            status?: 'draft' | 'pending' | 'processing' | 'partially_fulfilled' | 'completed' | 'cancelled' | 'closed';
+            status?: 'draft' | 'pending' | 'processing' | 'partially_fulfilled' | 'fulfilled' | 'cancelled' | 'closed';
+            displayStatus?: string;
+            fulfillmentSummary?: {
+                itemsTotal?: number;
+                itemsFulfilled?: number;
+                itemsRemaining?: number;
+            } | null;
             type?: 'one_time' | 'recurring' | 'mixed';
             paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided';
-            fulfillmentStatus?: 'unfulfilled' | 'partially_fulfilled' | 'fulfilled' | 'not_applicable';
             source?: 'web' | 'mobile' | 'pos' | 'api' | 'subscription_engine';
             currency?: string;
             /**
@@ -230,6 +256,13 @@ export declare class OrdersService {
              * Amount in cents (e.g. 1999 = $19.99)
              */
             total?: number;
+            /**
+             * Amount in cents (e.g. 1999 = $19.99)
+             */
+            compAmount?: number;
+            compReason?: string | null;
+            compedAt?: string | null;
+            compedBy?: string | null;
             /**
              * Arbitrary key-value metadata
              */
@@ -278,7 +311,11 @@ export declare class OrdersService {
                 email?: string;
                 firstName?: string | null;
                 lastName?: string | null;
+                company?: string | null;
             } | null;
+            cancelledAt?: string | null;
+            completedAt?: string | null;
+            closedAt?: string | null;
             createdAt?: string;
             updatedAt?: string;
         }>;
@@ -311,10 +348,15 @@ export declare class OrdersService {
             discountId?: string | null;
             discountCode?: string | null;
             orderNumber?: string;
-            status?: 'draft' | 'pending' | 'processing' | 'partially_fulfilled' | 'completed' | 'cancelled' | 'closed';
+            status?: 'draft' | 'pending' | 'processing' | 'partially_fulfilled' | 'fulfilled' | 'cancelled' | 'closed';
+            displayStatus?: string;
+            fulfillmentSummary?: {
+                itemsTotal?: number;
+                itemsFulfilled?: number;
+                itemsRemaining?: number;
+            } | null;
             type?: 'one_time' | 'recurring' | 'mixed';
             paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided';
-            fulfillmentStatus?: 'unfulfilled' | 'partially_fulfilled' | 'fulfilled' | 'not_applicable';
             source?: 'web' | 'mobile' | 'pos' | 'api' | 'subscription_engine';
             currency?: string;
             /**
@@ -339,6 +381,13 @@ export declare class OrdersService {
              * Amount in cents (e.g. 1999 = $19.99)
              */
             total?: number;
+            /**
+             * Amount in cents (e.g. 1999 = $19.99)
+             */
+            compAmount?: number;
+            compReason?: string | null;
+            compedAt?: string | null;
+            compedBy?: string | null;
             /**
              * Arbitrary key-value metadata
              */
@@ -387,7 +436,11 @@ export declare class OrdersService {
                 email?: string;
                 firstName?: string | null;
                 lastName?: string | null;
+                company?: string | null;
             } | null;
+            cancelledAt?: string | null;
+            completedAt?: string | null;
+            closedAt?: string | null;
             createdAt?: string;
             updatedAt?: string;
         };
@@ -458,10 +511,15 @@ export declare class OrdersService {
             discountId?: string | null;
             discountCode?: string | null;
             orderNumber?: string;
-            status?: 'draft' | 'pending' | 'processing' | 'partially_fulfilled' | 'completed' | 'cancelled' | 'closed';
+            status?: 'draft' | 'pending' | 'processing' | 'partially_fulfilled' | 'fulfilled' | 'cancelled' | 'closed';
+            displayStatus?: string;
+            fulfillmentSummary?: {
+                itemsTotal?: number;
+                itemsFulfilled?: number;
+                itemsRemaining?: number;
+            } | null;
             type?: 'one_time' | 'recurring' | 'mixed';
             paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided';
-            fulfillmentStatus?: 'unfulfilled' | 'partially_fulfilled' | 'fulfilled' | 'not_applicable';
             source?: 'web' | 'mobile' | 'pos' | 'api' | 'subscription_engine';
             currency?: string;
             /**
@@ -486,6 +544,13 @@ export declare class OrdersService {
              * Amount in cents (e.g. 1999 = $19.99)
              */
             total?: number;
+            /**
+             * Amount in cents (e.g. 1999 = $19.99)
+             */
+            compAmount?: number;
+            compReason?: string | null;
+            compedAt?: string | null;
+            compedBy?: string | null;
             /**
              * Arbitrary key-value metadata
              */
@@ -534,7 +599,11 @@ export declare class OrdersService {
                 email?: string;
                 firstName?: string | null;
                 lastName?: string | null;
+                company?: string | null;
             } | null;
+            cancelledAt?: string | null;
+            completedAt?: string | null;
+            closedAt?: string | null;
             createdAt?: string;
             updatedAt?: string;
         };
@@ -560,10 +629,15 @@ export declare class OrdersService {
             discountId?: string | null;
             discountCode?: string | null;
             orderNumber?: string;
-            status?: 'draft' | 'pending' | 'processing' | 'partially_fulfilled' | 'completed' | 'cancelled' | 'closed';
+            status?: 'draft' | 'pending' | 'processing' | 'partially_fulfilled' | 'fulfilled' | 'cancelled' | 'closed';
+            displayStatus?: string;
+            fulfillmentSummary?: {
+                itemsTotal?: number;
+                itemsFulfilled?: number;
+                itemsRemaining?: number;
+            } | null;
             type?: 'one_time' | 'recurring' | 'mixed';
             paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided';
-            fulfillmentStatus?: 'unfulfilled' | 'partially_fulfilled' | 'fulfilled' | 'not_applicable';
             source?: 'web' | 'mobile' | 'pos' | 'api' | 'subscription_engine';
             currency?: string;
             /**
@@ -588,6 +662,13 @@ export declare class OrdersService {
              * Amount in cents (e.g. 1999 = $19.99)
              */
             total?: number;
+            /**
+             * Amount in cents (e.g. 1999 = $19.99)
+             */
+            compAmount?: number;
+            compReason?: string | null;
+            compedAt?: string | null;
+            compedBy?: string | null;
             /**
              * Arbitrary key-value metadata
              */
@@ -636,7 +717,11 @@ export declare class OrdersService {
                 email?: string;
                 firstName?: string | null;
                 lastName?: string | null;
+                company?: string | null;
             } | null;
+            cancelledAt?: string | null;
+            completedAt?: string | null;
+            closedAt?: string | null;
             createdAt?: string;
             updatedAt?: string;
         };
@@ -665,10 +750,15 @@ export declare class OrdersService {
             discountId?: string | null;
             discountCode?: string | null;
             orderNumber?: string;
-            status?: 'draft' | 'pending' | 'processing' | 'partially_fulfilled' | 'completed' | 'cancelled' | 'closed';
+            status?: 'draft' | 'pending' | 'processing' | 'partially_fulfilled' | 'fulfilled' | 'cancelled' | 'closed';
+            displayStatus?: string;
+            fulfillmentSummary?: {
+                itemsTotal?: number;
+                itemsFulfilled?: number;
+                itemsRemaining?: number;
+            } | null;
             type?: 'one_time' | 'recurring' | 'mixed';
             paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided';
-            fulfillmentStatus?: 'unfulfilled' | 'partially_fulfilled' | 'fulfilled' | 'not_applicable';
             source?: 'web' | 'mobile' | 'pos' | 'api' | 'subscription_engine';
             currency?: string;
             /**
@@ -693,6 +783,13 @@ export declare class OrdersService {
              * Amount in cents (e.g. 1999 = $19.99)
              */
             total?: number;
+            /**
+             * Amount in cents (e.g. 1999 = $19.99)
+             */
+            compAmount?: number;
+            compReason?: string | null;
+            compedAt?: string | null;
+            compedBy?: string | null;
             /**
              * Arbitrary key-value metadata
              */
@@ -741,7 +838,11 @@ export declare class OrdersService {
                 email?: string;
                 firstName?: string | null;
                 lastName?: string | null;
+                company?: string | null;
             } | null;
+            cancelledAt?: string | null;
+            completedAt?: string | null;
+            closedAt?: string | null;
             createdAt?: string;
             updatedAt?: string;
         };
@@ -770,10 +871,15 @@ export declare class OrdersService {
             discountId?: string | null;
             discountCode?: string | null;
             orderNumber?: string;
-            status?: 'draft' | 'pending' | 'processing' | 'partially_fulfilled' | 'completed' | 'cancelled' | 'closed';
+            status?: 'draft' | 'pending' | 'processing' | 'partially_fulfilled' | 'fulfilled' | 'cancelled' | 'closed';
+            displayStatus?: string;
+            fulfillmentSummary?: {
+                itemsTotal?: number;
+                itemsFulfilled?: number;
+                itemsRemaining?: number;
+            } | null;
             type?: 'one_time' | 'recurring' | 'mixed';
             paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided';
-            fulfillmentStatus?: 'unfulfilled' | 'partially_fulfilled' | 'fulfilled' | 'not_applicable';
             source?: 'web' | 'mobile' | 'pos' | 'api' | 'subscription_engine';
             currency?: string;
             /**
@@ -798,6 +904,13 @@ export declare class OrdersService {
              * Amount in cents (e.g. 1999 = $19.99)
              */
             total?: number;
+            /**
+             * Amount in cents (e.g. 1999 = $19.99)
+             */
+            compAmount?: number;
+            compReason?: string | null;
+            compedAt?: string | null;
+            compedBy?: string | null;
             /**
              * Arbitrary key-value metadata
              */
@@ -846,7 +959,11 @@ export declare class OrdersService {
                 email?: string;
                 firstName?: string | null;
                 lastName?: string | null;
+                company?: string | null;
             } | null;
+            cancelledAt?: string | null;
+            completedAt?: string | null;
+            closedAt?: string | null;
             createdAt?: string;
             updatedAt?: string;
         };
@@ -876,10 +993,15 @@ export declare class OrdersService {
             discountId?: string | null;
             discountCode?: string | null;
             orderNumber?: string;
-            status?: 'draft' | 'pending' | 'processing' | 'partially_fulfilled' | 'completed' | 'cancelled' | 'closed';
+            status?: 'draft' | 'pending' | 'processing' | 'partially_fulfilled' | 'fulfilled' | 'cancelled' | 'closed';
+            displayStatus?: string;
+            fulfillmentSummary?: {
+                itemsTotal?: number;
+                itemsFulfilled?: number;
+                itemsRemaining?: number;
+            } | null;
             type?: 'one_time' | 'recurring' | 'mixed';
             paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided';
-            fulfillmentStatus?: 'unfulfilled' | 'partially_fulfilled' | 'fulfilled' | 'not_applicable';
             source?: 'web' | 'mobile' | 'pos' | 'api' | 'subscription_engine';
             currency?: string;
             /**
@@ -904,6 +1026,13 @@ export declare class OrdersService {
              * Amount in cents (e.g. 1999 = $19.99)
              */
             total?: number;
+            /**
+             * Amount in cents (e.g. 1999 = $19.99)
+             */
+            compAmount?: number;
+            compReason?: string | null;
+            compedAt?: string | null;
+            compedBy?: string | null;
             /**
              * Arbitrary key-value metadata
              */
@@ -952,7 +1081,11 @@ export declare class OrdersService {
                 email?: string;
                 firstName?: string | null;
                 lastName?: string | null;
+                company?: string | null;
             } | null;
+            cancelledAt?: string | null;
+            completedAt?: string | null;
+            closedAt?: string | null;
             createdAt?: string;
             updatedAt?: string;
             /**
@@ -974,23 +1107,280 @@ export declare class OrdersService {
         };
     }>;
     /**
-     * Complete an order (processing -> completed)
+     * 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.
+     * @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.
+     * @returns any Default Response
+     * @throws ApiError
+     */
+    static postApiV1OrdersStatus(id: string, requestBody: {
+        status: 'draft' | 'pending' | 'processing' | 'partially_fulfilled' | 'fulfilled' | 'cancelled' | 'closed';
+        reason?: string;
+    }, xThrottleEnvironmentId?: string): CancelablePromise<{
+        data?: {
+            id?: string;
+            workspaceId?: string;
+            discountId?: string | null;
+            discountCode?: string | null;
+            orderNumber?: string;
+            status?: 'draft' | 'pending' | 'processing' | 'partially_fulfilled' | 'fulfilled' | 'cancelled' | 'closed';
+            displayStatus?: string;
+            fulfillmentSummary?: {
+                itemsTotal?: number;
+                itemsFulfilled?: number;
+                itemsRemaining?: number;
+            } | null;
+            type?: 'one_time' | 'recurring' | 'mixed';
+            paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided';
+            source?: 'web' | 'mobile' | 'pos' | 'api' | 'subscription_engine';
+            currency?: string;
+            /**
+             * Amount in cents (e.g. 1999 = $19.99)
+             */
+            subtotal?: number;
+            /**
+             * Amount in cents (e.g. 1999 = $19.99)
+             */
+            taxTotal?: number;
+            buyerVatNumber?: string | null;
+            taxReverseCharge?: boolean;
+            /**
+             * Amount in cents (e.g. 1999 = $19.99)
+             */
+            discountTotal?: number;
+            /**
+             * Amount in cents (e.g. 1999 = $19.99)
+             */
+            shippingTotal?: number;
+            /**
+             * Amount in cents (e.g. 1999 = $19.99)
+             */
+            total?: number;
+            /**
+             * Amount in cents (e.g. 1999 = $19.99)
+             */
+            compAmount?: number;
+            compReason?: string | null;
+            compedAt?: string | null;
+            compedBy?: string | null;
+            /**
+             * Arbitrary key-value metadata
+             */
+            metadata?: Record<string, any>;
+            billingAddress?: {
+                firstName?: string;
+                lastName?: string;
+                /**
+                 * Optional. Business name for B2B addresses.
+                 */
+                company?: string;
+                addressLine1?: string;
+                addressLine2?: string;
+                city?: string;
+                stateProvince?: string;
+                postalCode?: string;
+                /**
+                 * ISO 3166-1 alpha-2
+                 */
+                countryCode?: string;
+                phone?: string;
+                email?: string;
+            } | null;
+            shippingAddress?: {
+                firstName?: string;
+                lastName?: string;
+                /**
+                 * Optional. Business name for B2B addresses.
+                 */
+                company?: string;
+                addressLine1?: string;
+                addressLine2?: string;
+                city?: string;
+                stateProvince?: string;
+                postalCode?: string;
+                /**
+                 * ISO 3166-1 alpha-2
+                 */
+                countryCode?: string;
+                phone?: string;
+                email?: string;
+            } | null;
+            customerId?: string | null;
+            customer?: {
+                id?: string;
+                email?: string;
+                firstName?: string | null;
+                lastName?: string | null;
+                company?: string | null;
+            } | null;
+            cancelledAt?: string | null;
+            completedAt?: string | null;
+            closedAt?: string | null;
+            createdAt?: string;
+            updatedAt?: string;
+        };
+        meta?: {
+            requestId?: string;
+            pagination?: {
+                cursor?: string | null;
+                hasMore?: boolean;
+            };
+        };
+    }>;
+    /**
+     * Write off the order's remaining balance. Money already captured stays captured; the buyer is never charged and no processor is contacted. `compAmount` is set to the balance outstanding and `total` drops by the same amount, so `paymentStatus` settles at `captured` and `displayStatus` reads "… · Comped".
+     * @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.
+     * @returns any Default Response
+     * @throws ApiError
+     */
+    static postApiV1OrdersComp(id: string, requestBody: {
+        reason: string;
+    }, xThrottleEnvironmentId?: string): CancelablePromise<{
+        data?: {
+            id?: string;
+            workspaceId?: string;
+            discountId?: string | null;
+            discountCode?: string | null;
+            orderNumber?: string;
+            status?: 'draft' | 'pending' | 'processing' | 'partially_fulfilled' | 'fulfilled' | 'cancelled' | 'closed';
+            displayStatus?: string;
+            fulfillmentSummary?: {
+                itemsTotal?: number;
+                itemsFulfilled?: number;
+                itemsRemaining?: number;
+            } | null;
+            type?: 'one_time' | 'recurring' | 'mixed';
+            paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided';
+            source?: 'web' | 'mobile' | 'pos' | 'api' | 'subscription_engine';
+            currency?: string;
+            /**
+             * Amount in cents (e.g. 1999 = $19.99)
+             */
+            subtotal?: number;
+            /**
+             * Amount in cents (e.g. 1999 = $19.99)
+             */
+            taxTotal?: number;
+            buyerVatNumber?: string | null;
+            taxReverseCharge?: boolean;
+            /**
+             * Amount in cents (e.g. 1999 = $19.99)
+             */
+            discountTotal?: number;
+            /**
+             * Amount in cents (e.g. 1999 = $19.99)
+             */
+            shippingTotal?: number;
+            /**
+             * Amount in cents (e.g. 1999 = $19.99)
+             */
+            total?: number;
+            /**
+             * Amount in cents (e.g. 1999 = $19.99)
+             */
+            compAmount?: number;
+            compReason?: string | null;
+            compedAt?: string | null;
+            compedBy?: string | null;
+            /**
+             * Arbitrary key-value metadata
+             */
+            metadata?: Record<string, any>;
+            billingAddress?: {
+                firstName?: string;
+                lastName?: string;
+                /**
+                 * Optional. Business name for B2B addresses.
+                 */
+                company?: string;
+                addressLine1?: string;
+                addressLine2?: string;
+                city?: string;
+                stateProvince?: string;
+                postalCode?: string;
+                /**
+                 * ISO 3166-1 alpha-2
+                 */
+                countryCode?: string;
+                phone?: string;
+                email?: string;
+            } | null;
+            shippingAddress?: {
+                firstName?: string;
+                lastName?: string;
+                /**
+                 * Optional. Business name for B2B addresses.
+                 */
+                company?: string;
+                addressLine1?: string;
+                addressLine2?: string;
+                city?: string;
+                stateProvince?: string;
+                postalCode?: string;
+                /**
+                 * ISO 3166-1 alpha-2
+                 */
+                countryCode?: string;
+                phone?: string;
+                email?: string;
+            } | null;
+            customerId?: string | null;
+            customer?: {
+                id?: string;
+                email?: string;
+                firstName?: string | null;
+                lastName?: string | null;
+                company?: string | null;
+            } | null;
+            cancelledAt?: string | null;
+            completedAt?: string | null;
+            closedAt?: string | null;
+            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.
+             */
+            paymentActions?: Array<{
+                paymentId?: string;
+                action?: 'void';
+                status?: 'succeeded' | 'failed';
+                error?: string;
+            }>;
+        };
+        meta?: {
+            requestId?: string;
+            pagination?: {
+                cursor?: string | null;
+                hasMore?: boolean;
+            };
+        };
+    }>;
+    /**
+     * Undo a comp. The order owes what it owed again: `compAmount` returns to 0, `total` is restored, and `paymentStatus` falls back out of `captured` on its own. Side effects of the comp are NOT rewound: an authorization voided at the processor cannot be un-voided, so collecting the restored balance needs a new payment, and a tax document voided or returned at the provider needs a manual re-file (`POST /v1/tax-documents/{id}/retry`).
      * @param id
      * @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 postApiV1OrdersComplete(id: string, xThrottleEnvironmentId?: string): CancelablePromise<{
+    static postApiV1OrdersCompReverse(id: string, xThrottleEnvironmentId?: string): CancelablePromise<{
         data?: {
             id?: string;
             workspaceId?: string;
             discountId?: string | null;
             discountCode?: string | null;
             orderNumber?: string;
-            status?: 'draft' | 'pending' | 'processing' | 'partially_fulfilled' | 'completed' | 'cancelled' | 'closed';
+            status?: 'draft' | 'pending' | 'processing' | 'partially_fulfilled' | 'fulfilled' | 'cancelled' | 'closed';
+            displayStatus?: string;
+            fulfillmentSummary?: {
+                itemsTotal?: number;
+                itemsFulfilled?: number;
+                itemsRemaining?: number;
+            } | null;
             type?: 'one_time' | 'recurring' | 'mixed';
             paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided';
-            fulfillmentStatus?: 'unfulfilled' | 'partially_fulfilled' | 'fulfilled' | 'not_applicable';
             source?: 'web' | 'mobile' | 'pos' | 'api' | 'subscription_engine';
             currency?: string;
             /**
@@ -1015,6 +1405,13 @@ export declare class OrdersService {
              * Amount in cents (e.g. 1999 = $19.99)
              */
             total?: number;
+            /**
+             * Amount in cents (e.g. 1999 = $19.99)
+             */
+            compAmount?: number;
+            compReason?: string | null;
+            compedAt?: string | null;
+            compedBy?: string | null;
             /**
              * Arbitrary key-value metadata
              */
@@ -1063,7 +1460,11 @@ export declare class OrdersService {
                 email?: string;
                 firstName?: string | null;
                 lastName?: string | null;
+                company?: string | null;
             } | null;
+            cancelledAt?: string | null;
+            completedAt?: string | null;
+            closedAt?: string | null;
             createdAt?: string;
             updatedAt?: string;
         };
@@ -1076,7 +1477,33 @@ export declare class OrdersService {
         };
     }>;
     /**
-     * Close a completed order
+     * Append-only record of every status change on this order, oldest first.
+     * @param id
+     * @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 getApiV1OrdersStatusHistory(id: string, xThrottleEnvironmentId?: string): CancelablePromise<{
+        data?: Array<{
+            id?: string;
+            fromStatus?: string | null;
+            toStatus?: string;
+            actorType?: 'user' | 'system' | 'integration';
+            actorId?: string | null;
+            reason?: string | null;
+            source?: 'manual' | 'state_machine' | 'fulfillment' | 'payment' | 'migration';
+            createdAt?: string;
+        }>;
+        meta?: {
+            requestId?: string;
+            pagination?: {
+                cursor?: string | null;
+                hasMore?: boolean;
+            };
+        };
+    }>;
+    /**
+     * Close a fulfilled order (archive it from active views)
      * @param id
      * @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
@@ -1089,10 +1516,15 @@ export declare class OrdersService {
             discountId?: string | null;
             discountCode?: string | null;
             orderNumber?: string;
-            status?: 'draft' | 'pending' | 'processing' | 'partially_fulfilled' | 'completed' | 'cancelled' | 'closed';
+            status?: 'draft' | 'pending' | 'processing' | 'partially_fulfilled' | 'fulfilled' | 'cancelled' | 'closed';
+            displayStatus?: string;
+            fulfillmentSummary?: {
+                itemsTotal?: number;
+                itemsFulfilled?: number;
+                itemsRemaining?: number;
+            } | null;
             type?: 'one_time' | 'recurring' | 'mixed';
             paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided';
-            fulfillmentStatus?: 'unfulfilled' | 'partially_fulfilled' | 'fulfilled' | 'not_applicable';
             source?: 'web' | 'mobile' | 'pos' | 'api' | 'subscription_engine';
             currency?: string;
             /**
@@ -1117,6 +1549,13 @@ export declare class OrdersService {
              * Amount in cents (e.g. 1999 = $19.99)
              */
             total?: number;
+            /**
+             * Amount in cents (e.g. 1999 = $19.99)
+             */
+            compAmount?: number;
+            compReason?: string | null;
+            compedAt?: string | null;
+            compedBy?: string | null;
             /**
              * Arbitrary key-value metadata
              */
@@ -1165,7 +1604,11 @@ export declare class OrdersService {
                 email?: string;
                 firstName?: string | null;
                 lastName?: string | null;
+                company?: string | null;
             } | null;
+            cancelledAt?: string | null;
+            completedAt?: string | null;
+            closedAt?: string | null;
             createdAt?: string;
             updatedAt?: string;
         };
@@ -1246,6 +1689,14 @@ export declare class OrdersService {
             unitPrice: number;
             quantity: number;
             type?: string;
+            /**
+             * What this item needs before it counts as delivered. Omit to resolve from `type` and `metadata`. `digital` and `access_grant` are delivered automatically on payment capture; `none` means there is nothing to deliver.
+             */
+            deliveryMethod?: 'shipment' | 'digital' | 'access_grant' | 'service' | 'in_person' | 'custom' | 'none';
+            /**
+             * Arbitrary key-value metadata
+             */
+            metadata?: Record<string, any>;
         }>;
         update?: Array<{
             lineItemId: string;