@usethrottle/api-client 5.4.0 → 5.6.0

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

@@ -260,6 +260,15 @@ export declare class OrdersService {
                      */
                     amount?: number | null;
                     count?: number | null;
+                    schedule?: Array<{
+                        amount?: number;
+                        intervalUnit?: string | null;
+                        intervalCount?: number | null;
+                    }> | null;
+                    /**
+                     * Amount in cents (e.g. 1999 = $19.99)
+                     */
+                    scheduleUnitTotal?: number | null;
                 } | null;
                 /**
                  * Arbitrary key-value metadata
@@ -468,6 +477,15 @@ export declare class OrdersService {
                      */
                     amount?: number | null;
                     count?: number | null;
+                    schedule?: Array<{
+                        amount?: number;
+                        intervalUnit?: string | null;
+                        intervalCount?: number | null;
+                    }> | null;
+                    /**
+                     * Amount in cents (e.g. 1999 = $19.99)
+                     */
+                    scheduleUnitTotal?: number | null;
                 } | null;
                 /**
                  * Arbitrary key-value metadata
@@ -684,6 +702,15 @@ export declare class OrdersService {
                      */
                     amount?: number | null;
                     count?: number | null;
+                    schedule?: Array<{
+                        amount?: number;
+                        intervalUnit?: string | null;
+                        intervalCount?: number | null;
+                    }> | null;
+                    /**
+                     * Amount in cents (e.g. 1999 = $19.99)
+                     */
+                    scheduleUnitTotal?: number | null;
                 } | null;
                 /**
                  * Arbitrary key-value metadata
@@ -934,6 +961,15 @@ export declare class OrdersService {
                      */
                     amount?: number | null;
                     count?: number | null;
+                    schedule?: Array<{
+                        amount?: number;
+                        intervalUnit?: string | null;
+                        intervalCount?: number | null;
+                    }> | null;
+                    /**
+                     * Amount in cents (e.g. 1999 = $19.99)
+                     */
+                    scheduleUnitTotal?: number | null;
                 } | null;
                 /**
                  * Arbitrary key-value metadata
@@ -1131,6 +1167,15 @@ export declare class OrdersService {
                      */
                     amount?: number | null;
                     count?: number | null;
+                    schedule?: Array<{
+                        amount?: number;
+                        intervalUnit?: string | null;
+                        intervalCount?: number | null;
+                    }> | null;
+                    /**
+                     * Amount in cents (e.g. 1999 = $19.99)
+                     */
+                    scheduleUnitTotal?: number | null;
                 } | null;
                 /**
                  * Arbitrary key-value metadata
@@ -1331,6 +1376,15 @@ export declare class OrdersService {
                      */
                     amount?: number | null;
                     count?: number | null;
+                    schedule?: Array<{
+                        amount?: number;
+                        intervalUnit?: string | null;
+                        intervalCount?: number | null;
+                    }> | null;
+                    /**
+                     * Amount in cents (e.g. 1999 = $19.99)
+                     */
+                    scheduleUnitTotal?: number | null;
                 } | null;
                 /**
                  * Arbitrary key-value metadata
@@ -1531,6 +1585,15 @@ export declare class OrdersService {
                      */
                     amount?: number | null;
                     count?: number | null;
+                    schedule?: Array<{
+                        amount?: number;
+                        intervalUnit?: string | null;
+                        intervalCount?: number | null;
+                    }> | null;
+                    /**
+                     * Amount in cents (e.g. 1999 = $19.99)
+                     */
+                    scheduleUnitTotal?: number | null;
                 } | null;
                 /**
                  * Arbitrary key-value metadata
@@ -1732,6 +1795,15 @@ export declare class OrdersService {
                      */
                     amount?: number | null;
                     count?: number | null;
+                    schedule?: Array<{
+                        amount?: number;
+                        intervalUnit?: string | null;
+                        intervalCount?: number | null;
+                    }> | null;
+                    /**
+                     * Amount in cents (e.g. 1999 = $19.99)
+                     */
+                    scheduleUnitTotal?: number | null;
                 } | null;
                 /**
                  * Arbitrary key-value metadata
@@ -1942,6 +2014,15 @@ export declare class OrdersService {
                      */
                     amount?: number | null;
                     count?: number | null;
+                    schedule?: Array<{
+                        amount?: number;
+                        intervalUnit?: string | null;
+                        intervalCount?: number | null;
+                    }> | null;
+                    /**
+                     * Amount in cents (e.g. 1999 = $19.99)
+                     */
+                    scheduleUnitTotal?: number | null;
                 } | null;
                 /**
                  * Arbitrary key-value metadata
@@ -2142,6 +2223,15 @@ export declare class OrdersService {
                      */
                     amount?: number | null;
                     count?: number | null;
+                    schedule?: Array<{
+                        amount?: number;
+                        intervalUnit?: string | null;
+                        intervalCount?: number | null;
+                    }> | null;
+                    /**
+                     * Amount in cents (e.g. 1999 = $19.99)
+                     */
+                    scheduleUnitTotal?: number | null;
                 } | null;
                 /**
                  * Arbitrary key-value metadata
@@ -2348,6 +2438,15 @@ export declare class OrdersService {
                      */
                     amount?: number | null;
                     count?: number | null;
+                    schedule?: Array<{
+                        amount?: number;
+                        intervalUnit?: string | null;
+                        intervalCount?: number | null;
+                    }> | null;
+                    /**
+                     * Amount in cents (e.g. 1999 = $19.99)
+                     */
+                    scheduleUnitTotal?: number | null;
                 } | null;
                 /**
                  * Arbitrary key-value metadata
@@ -2548,6 +2647,15 @@ export declare class OrdersService {
                      */
                     amount?: number | null;
                     count?: number | null;
+                    schedule?: Array<{
+                        amount?: number;
+                        intervalUnit?: string | null;
+                        intervalCount?: number | null;
+                    }> | null;
+                    /**
+                     * Amount in cents (e.g. 1999 = $19.99)
+                     */
+                    scheduleUnitTotal?: number | null;
                 } | null;
                 /**
                  * Arbitrary key-value metadata
@@ -2745,6 +2853,15 @@ export declare class OrdersService {
                      */
                     amount?: number | null;
                     count?: number | null;
+                    schedule?: Array<{
+                        amount?: number;
+                        intervalUnit?: string | null;
+                        intervalCount?: number | null;
+                    }> | null;
+                    /**
+                     * Amount in cents (e.g. 1999 = $19.99)
+                     */
+                    scheduleUnitTotal?: number | null;
                 } | null;
                 /**
                  * Arbitrary key-value metadata
@@ -3006,6 +3123,15 @@ export declare class OrdersService {
                      */
                     amount?: number | null;
                     count?: number | null;
+                    schedule?: Array<{
+                        amount?: number;
+                        intervalUnit?: string | null;
+                        intervalCount?: number | null;
+                    }> | null;
+                    /**
+                     * Amount in cents (e.g. 1999 = $19.99)
+                     */
+                    scheduleUnitTotal?: number | null;
                 } | null;
                 /**
                  * Arbitrary key-value metadata
@@ -3091,7 +3217,7 @@ export declare class OrdersService {
      * @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
+     * @returns any The edit was applied and any money delta settled.
      * @throws ApiError
      */
     static patchApiV1OrdersLineItems(id: string, requestBody: {
@@ -3116,6 +3242,250 @@ export declare class OrdersService {
             unitPrice?: number;
         }>;
         remove?: Array<string>;
-    }, xThrottleEnvironmentId?: string): CancelablePromise<any>;
+    }, xThrottleEnvironmentId?: string): CancelablePromise<{
+        /**
+         * The order as stored after the edit, with every line item, the money settled for it, and any tax warnings.
+         */
+        data: {
+            id: string;
+            workspaceId?: string;
+            discountId?: string | null;
+            discountCode?: string | null;
+            orderNumber?: string;
+            status?: 'draft' | 'pending' | 'processing' | 'partially_fulfilled' | 'fulfilled' | 'cancelled' | 'closed';
+            type?: 'one_time' | 'recurring' | 'mixed';
+            paymentStatus?: 'pending' | 'authorized' | 'captured' | 'partially_paid' | 'partially_refunded' | 'refunded' | 'failed' | 'voided' | 'processing' | 'disputed' | 'expired';
+            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;
+            taxProviderMessages?: Array<{
+                summary?: string;
+                details?: string;
+                citationCode?: string;
+                refersTo?: string;
+                severity?: string;
+                source?: string;
+                lineNumbers?: Array<string>;
+                lineItemIds?: Array<string>;
+            }>;
+            /**
+             * 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;
+            /**
+             * Balance written off. A credit against the order, not a re-pricing of it: `total` is unchanged, and what the buyer owes is `total - compAmount`.
+             */
+            compAmount?: number;
+            compReason?: string | null;
+            compedAt?: string | null;
+            compedBy?: string | null;
+            onHold?: boolean;
+            holdReason?: string | null;
+            heldAt?: string | null;
+            heldBy?: string | null;
+            notes?: 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;
+            shippingMethod?: {
+                methodId?: string;
+                displayName?: string;
+                carrier?: string | null;
+                serviceCode?: string | null;
+                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;
+            /**
+             * 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;
+            /**
+             * Every line item on the order after the edit, not only the ones changed.
+             */
+            items: Array<{
+                id?: string;
+                type?: 'product' | 'subscription' | 'service' | 'ticket' | 'donation' | 'custom' | 'usage';
+                referenceId?: string | null;
+                name?: string;
+                description?: string | null;
+                /**
+                 * Amount in cents (e.g. 1999 = $19.99)
+                 */
+                unitPrice?: number;
+                quantity?: number;
+                /**
+                 * Amount in cents (e.g. 1999 = $19.99)
+                 */
+                subtotal?: number;
+                /**
+                 * Amount in cents (e.g. 1999 = $19.99)
+                 */
+                taxAmount?: number;
+                /**
+                 * Amount in cents (e.g. 1999 = $19.99)
+                 */
+                discountAmount?: number;
+                /**
+                 * Amount in cents (e.g. 1999 = $19.99)
+                 */
+                total?: number;
+                imageUrl?: string | null;
+                deliveryMethod?: 'shipment' | 'digital' | 'access_grant' | 'service' | 'in_person' | 'custom' | 'none';
+                subscriptionId?: string | null;
+                /**
+                 * Subscription terms. A merchant-declared subscription line carries `plan`; the plan line Throttle adds for a session `recurring` intent carries only the cadence and `count`. `amount` is the renewal unit price, set only on a trial line (whose `unitPrice` is 0).
+                 */
+                recurring?: {
+                    plan?: string;
+                    planName?: string | null;
+                    interval?: string;
+                    intervalUnit?: string | null;
+                    intervalCount?: number | null;
+                    totalPayments?: number | null;
+                    trialDays?: number;
+                    /**
+                     * Amount in cents (e.g. 1999 = $19.99)
+                     */
+                    amount?: number | null;
+                    count?: number | null;
+                } | null;
+                /**
+                 * Arbitrary key-value metadata
+                 */
+                metadata?: Record<string, any>;
+                workspaceId?: string;
+                applicationId?: string;
+                orderId?: string;
+                cartId?: string | null;
+                position?: number;
+                createdAt?: string;
+                updatedAt?: string;
+            }>;
+            /**
+             * The money the edit settled.
+             */
+            adjustment: {
+                /**
+                 * Change in what the buyer owes, in minor units. On an order with a captured payment a positive delta was charged to the stored card and a negative one refunded; otherwise no money moved.
+                 */
+                delta: number;
+                /**
+                 * The order total before the edit, in minor units.
+                 */
+                previousTotal: number;
+                /**
+                 * The order total after the edit, in minor units.
+                 */
+                newTotal: number;
+                /**
+                 * The payment that charged a positive delta; null when nothing was charged.
+                 */
+                chargedPaymentId?: string | null;
+                /**
+                 * The payment a negative delta was refunded on; null when nothing was refunded.
+                 */
+                refundedPaymentId?: string | null;
+                /**
+                 * Set when refunding a negative delta failed. The line items were still changed; retry the refund from the order.
+                 */
+                refundError?: {
+                    code?: string;
+                    message?: string;
+                } | null;
+            };
+            /**
+             * Present only when there is something to report. Notes from re-quoting tax with the tax provider (`taxMode: "app_based"`, e.g. Avalara) under the lenient tax fallback policy: `provider_fallback` (the provider could not answer, so your native tax rules priced the edit), `tax_address_missing` (there is no address to tax from, so no tax was charged), `tax_zero_from_provider` (the provider returned no tax for the address). Under the strict policy the same failures refuse the edit instead (503 / 422).
+             */
+            warnings?: Array<{
+                code: string;
+                message: string;
+            }>;
+        };
+    }>;
 }
 //# sourceMappingURL=OrdersService.d.ts.map