@usethrottle/api-client 0.2.0 → 1.0.1

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

@@ -17,9 +17,9 @@ export declare class CartsService {
     }): CancelablePromise<{
         data?: {
             id?: string;
-            merchant_id?: string;
-            store_id?: string | null;
-            customer_id?: string | null;
+            merchantId?: string;
+            storeId?: string | null;
+            customerId?: string | null;
             status?: 'open' | 'checkout' | 'converted' | 'abandoned';
             currency?: string;
             /**
@@ -29,21 +29,63 @@ export declare class CartsService {
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
-            tax_total?: number;
+            taxTotal?: number;
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
-            discount_total?: number;
+            discountTotal?: number;
+            /**
+             * Amount in cents (e.g. 1999 = $19.99)
+             */
+            shippingTotal?: number;
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
             total?: number;
-            discount_code?: string | null;
+            discountCode?: string | null;
+            appliedDiscount?: ({
+                discountId?: string | null;
+                code?: string;
+                type?: 'percentage' | 'fixed_amount';
+                /**
+                 * Amount in cents (e.g. 1999 = $19.99)
+                 */
+                amount?: number;
+                currency?: string;
+                freeShipping?: boolean;
+                validUntil?: string | null;
+                snapshotHash?: string;
+            } | null);
+            selectedShipping?: ({
+                methodId?: string;
+                displayName?: string;
+                /**
+                 * Amount in cents (e.g. 1999 = $19.99)
+                 */
+                rateAmount?: number;
+                currency?: string;
+                carrier?: string;
+                serviceCode?: string;
+                estimatedDeliveryDays?: number;
+            } | null);
+            taxLines?: Array<{
+                id?: string;
+                lineItemId?: string;
+                jurisdictionCode?: string;
+                jurisdictionName?: string | null;
+                taxType?: string;
+                rate?: number;
+                /**
+                 * Amount in cents (e.g. 1999 = $19.99)
+                 */
+                amount?: number;
+                currency?: string | null;
+            }>;
             /**
              * Arbitrary key-value metadata
              */
             metadata?: Record<string, any>;
-            created_at?: string;
+            createdAt?: string;
         };
         meta?: {
             request_id?: string;
@@ -62,9 +104,9 @@ export declare class CartsService {
     static getApiV1Carts(id: string): CancelablePromise<{
         data?: {
             id?: string;
-            merchant_id?: string;
-            store_id?: string | null;
-            customer_id?: string | null;
+            merchantId?: string;
+            storeId?: string | null;
+            customerId?: string | null;
             status?: 'open' | 'checkout' | 'converted' | 'abandoned';
             currency?: string;
             /**
@@ -74,21 +116,63 @@ export declare class CartsService {
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
-            tax_total?: number;
+            taxTotal?: number;
+            /**
+             * Amount in cents (e.g. 1999 = $19.99)
+             */
+            discountTotal?: number;
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
-            discount_total?: number;
+            shippingTotal?: number;
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
             total?: number;
-            discount_code?: string | null;
+            discountCode?: string | null;
+            appliedDiscount?: ({
+                discountId?: string | null;
+                code?: string;
+                type?: 'percentage' | 'fixed_amount';
+                /**
+                 * Amount in cents (e.g. 1999 = $19.99)
+                 */
+                amount?: number;
+                currency?: string;
+                freeShipping?: boolean;
+                validUntil?: string | null;
+                snapshotHash?: string;
+            } | null);
+            selectedShipping?: ({
+                methodId?: string;
+                displayName?: string;
+                /**
+                 * Amount in cents (e.g. 1999 = $19.99)
+                 */
+                rateAmount?: number;
+                currency?: string;
+                carrier?: string;
+                serviceCode?: string;
+                estimatedDeliveryDays?: number;
+            } | null);
+            taxLines?: Array<{
+                id?: string;
+                lineItemId?: string;
+                jurisdictionCode?: string;
+                jurisdictionName?: string | null;
+                taxType?: string;
+                rate?: number;
+                /**
+                 * Amount in cents (e.g. 1999 = $19.99)
+                 */
+                amount?: number;
+                currency?: string | null;
+            }>;
             /**
              * Arbitrary key-value metadata
              */
             metadata?: Record<string, any>;
-            created_at?: string;
+            createdAt?: string;
         };
         meta?: {
             request_id?: string;
@@ -117,9 +201,9 @@ export declare class CartsService {
     }): CancelablePromise<{
         data?: {
             id?: string;
-            merchant_id?: string;
-            store_id?: string | null;
-            customer_id?: string | null;
+            merchantId?: string;
+            storeId?: string | null;
+            customerId?: string | null;
             status?: 'open' | 'checkout' | 'converted' | 'abandoned';
             currency?: string;
             /**
@@ -129,21 +213,63 @@ export declare class CartsService {
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
-            tax_total?: number;
+            taxTotal?: number;
+            /**
+             * Amount in cents (e.g. 1999 = $19.99)
+             */
+            discountTotal?: number;
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
-            discount_total?: number;
+            shippingTotal?: number;
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
             total?: number;
-            discount_code?: string | null;
+            discountCode?: string | null;
+            appliedDiscount?: ({
+                discountId?: string | null;
+                code?: string;
+                type?: 'percentage' | 'fixed_amount';
+                /**
+                 * Amount in cents (e.g. 1999 = $19.99)
+                 */
+                amount?: number;
+                currency?: string;
+                freeShipping?: boolean;
+                validUntil?: string | null;
+                snapshotHash?: string;
+            } | null);
+            selectedShipping?: ({
+                methodId?: string;
+                displayName?: string;
+                /**
+                 * Amount in cents (e.g. 1999 = $19.99)
+                 */
+                rateAmount?: number;
+                currency?: string;
+                carrier?: string;
+                serviceCode?: string;
+                estimatedDeliveryDays?: number;
+            } | null);
+            taxLines?: Array<{
+                id?: string;
+                lineItemId?: string;
+                jurisdictionCode?: string;
+                jurisdictionName?: string | null;
+                taxType?: string;
+                rate?: number;
+                /**
+                 * Amount in cents (e.g. 1999 = $19.99)
+                 */
+                amount?: number;
+                currency?: string | null;
+            }>;
             /**
              * Arbitrary key-value metadata
              */
             metadata?: Record<string, any>;
-            created_at?: string;
+            createdAt?: string;
         };
         meta?: {
             request_id?: string;
@@ -196,6 +322,10 @@ export declare class CartsService {
              * Amount in cents (e.g. 1999 = $19.99)
              */
             total?: number;
+            /**
+             * Arbitrary key-value metadata
+             */
+            metadata?: Record<string, any>;
         };
         meta?: {
             request_id?: string;
@@ -243,6 +373,10 @@ export declare class CartsService {
              * Amount in cents (e.g. 1999 = $19.99)
              */
             total?: number;
+            /**
+             * Arbitrary key-value metadata
+             */
+            metadata?: Record<string, any>;
         };
         meta?: {
             request_id?: string;
@@ -305,9 +439,9 @@ export declare class CartsService {
     }): CancelablePromise<{
         data?: {
             id?: string;
-            merchant_id?: string;
-            store_id?: string | null;
-            customer_id?: string | null;
+            merchantId?: string;
+            storeId?: string | null;
+            customerId?: string | null;
             status?: 'open' | 'checkout' | 'converted' | 'abandoned';
             currency?: string;
             /**
@@ -317,21 +451,63 @@ export declare class CartsService {
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
-            tax_total?: number;
+            taxTotal?: number;
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
-            discount_total?: number;
+            discountTotal?: number;
+            /**
+             * Amount in cents (e.g. 1999 = $19.99)
+             */
+            shippingTotal?: number;
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
             total?: number;
-            discount_code?: string | null;
+            discountCode?: string | null;
+            appliedDiscount?: ({
+                discountId?: string | null;
+                code?: string;
+                type?: 'percentage' | 'fixed_amount';
+                /**
+                 * Amount in cents (e.g. 1999 = $19.99)
+                 */
+                amount?: number;
+                currency?: string;
+                freeShipping?: boolean;
+                validUntil?: string | null;
+                snapshotHash?: string;
+            } | null);
+            selectedShipping?: ({
+                methodId?: string;
+                displayName?: string;
+                /**
+                 * Amount in cents (e.g. 1999 = $19.99)
+                 */
+                rateAmount?: number;
+                currency?: string;
+                carrier?: string;
+                serviceCode?: string;
+                estimatedDeliveryDays?: number;
+            } | null);
+            taxLines?: Array<{
+                id?: string;
+                lineItemId?: string;
+                jurisdictionCode?: string;
+                jurisdictionName?: string | null;
+                taxType?: string;
+                rate?: number;
+                /**
+                 * Amount in cents (e.g. 1999 = $19.99)
+                 */
+                amount?: number;
+                currency?: string | null;
+            }>;
             /**
              * Arbitrary key-value metadata
              */
             metadata?: Record<string, any>;
-            created_at?: string;
+            createdAt?: string;
         };
         meta?: {
             request_id?: string;
@@ -350,9 +526,9 @@ export declare class CartsService {
     static deleteApiV1CartsDiscount(id: string): CancelablePromise<{
         data?: {
             id?: string;
-            merchant_id?: string;
-            store_id?: string | null;
-            customer_id?: string | null;
+            merchantId?: string;
+            storeId?: string | null;
+            customerId?: string | null;
             status?: 'open' | 'checkout' | 'converted' | 'abandoned';
             currency?: string;
             /**
@@ -362,22 +538,462 @@ export declare class CartsService {
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
-            tax_total?: number;
+            taxTotal?: number;
+            /**
+             * Amount in cents (e.g. 1999 = $19.99)
+             */
+            discountTotal?: number;
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
-            discount_total?: number;
+            shippingTotal?: number;
             /**
              * Amount in cents (e.g. 1999 = $19.99)
              */
             total?: number;
-            discount_code?: string | null;
+            discountCode?: string | null;
+            appliedDiscount?: ({
+                discountId?: string | null;
+                code?: string;
+                type?: 'percentage' | 'fixed_amount';
+                /**
+                 * Amount in cents (e.g. 1999 = $19.99)
+                 */
+                amount?: number;
+                currency?: string;
+                freeShipping?: boolean;
+                validUntil?: string | null;
+                snapshotHash?: string;
+            } | null);
+            selectedShipping?: ({
+                methodId?: string;
+                displayName?: string;
+                /**
+                 * Amount in cents (e.g. 1999 = $19.99)
+                 */
+                rateAmount?: number;
+                currency?: string;
+                carrier?: string;
+                serviceCode?: string;
+                estimatedDeliveryDays?: number;
+            } | null);
+            taxLines?: Array<{
+                id?: string;
+                lineItemId?: string;
+                jurisdictionCode?: string;
+                jurisdictionName?: string | null;
+                taxType?: string;
+                rate?: number;
+                /**
+                 * Amount in cents (e.g. 1999 = $19.99)
+                 */
+                amount?: number;
+                currency?: string | null;
+            }>;
             /**
              * Arbitrary key-value metadata
              */
             metadata?: Record<string, any>;
-            created_at?: string;
+            createdAt?: string;
+        };
+        meta?: {
+            request_id?: string;
+            pagination?: {
+                cursor?: string | null;
+                has_more?: boolean;
+            };
+        };
+    }>;
+    /**
+     * Select a shipping method for a cart
+     * @param id
+     * @param requestBody
+     * @returns any Default Response
+     * @throws ApiError
+     */
+    static postApiV1CartsShipping(id: string, requestBody: {
+        methodId: string;
+        displayName: string;
+        /**
+         * Amount in cents (e.g. 1999 = $19.99)
+         */
+        rateAmount: number;
+        currency?: string;
+        carrier?: string;
+        serviceCode?: string;
+        estimatedDeliveryDays?: number;
+    }): CancelablePromise<{
+        data?: {
+            id?: string;
+            merchantId?: string;
+            storeId?: string | null;
+            customerId?: string | null;
+            status?: 'open' | 'checkout' | 'converted' | 'abandoned';
+            currency?: string;
+            /**
+             * Amount in cents (e.g. 1999 = $19.99)
+             */
+            subtotal?: number;
+            /**
+             * Amount in cents (e.g. 1999 = $19.99)
+             */
+            taxTotal?: number;
+            /**
+             * 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;
+            discountCode?: string | null;
+            appliedDiscount?: ({
+                discountId?: string | null;
+                code?: string;
+                type?: 'percentage' | 'fixed_amount';
+                /**
+                 * Amount in cents (e.g. 1999 = $19.99)
+                 */
+                amount?: number;
+                currency?: string;
+                freeShipping?: boolean;
+                validUntil?: string | null;
+                snapshotHash?: string;
+            } | null);
+            selectedShipping?: ({
+                methodId?: string;
+                displayName?: string;
+                /**
+                 * Amount in cents (e.g. 1999 = $19.99)
+                 */
+                rateAmount?: number;
+                currency?: string;
+                carrier?: string;
+                serviceCode?: string;
+                estimatedDeliveryDays?: number;
+            } | null);
+            taxLines?: Array<{
+                id?: string;
+                lineItemId?: string;
+                jurisdictionCode?: string;
+                jurisdictionName?: string | null;
+                taxType?: string;
+                rate?: number;
+                /**
+                 * Amount in cents (e.g. 1999 = $19.99)
+                 */
+                amount?: number;
+                currency?: string | null;
+            }>;
+            /**
+             * Arbitrary key-value metadata
+             */
+            metadata?: Record<string, any>;
+            createdAt?: string;
+        };
+        meta?: {
+            request_id?: string;
+            pagination?: {
+                cursor?: string | null;
+                has_more?: boolean;
+            };
         };
+    }>;
+    /**
+     * Clear the selected shipping method from a cart
+     * @param id
+     * @returns any Default Response
+     * @throws ApiError
+     */
+    static deleteApiV1CartsShipping(id: string): CancelablePromise<{
+        data?: {
+            id?: string;
+            merchantId?: string;
+            storeId?: string | null;
+            customerId?: string | null;
+            status?: 'open' | 'checkout' | 'converted' | 'abandoned';
+            currency?: string;
+            /**
+             * Amount in cents (e.g. 1999 = $19.99)
+             */
+            subtotal?: number;
+            /**
+             * Amount in cents (e.g. 1999 = $19.99)
+             */
+            taxTotal?: number;
+            /**
+             * 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;
+            discountCode?: string | null;
+            appliedDiscount?: ({
+                discountId?: string | null;
+                code?: string;
+                type?: 'percentage' | 'fixed_amount';
+                /**
+                 * Amount in cents (e.g. 1999 = $19.99)
+                 */
+                amount?: number;
+                currency?: string;
+                freeShipping?: boolean;
+                validUntil?: string | null;
+                snapshotHash?: string;
+            } | null);
+            selectedShipping?: ({
+                methodId?: string;
+                displayName?: string;
+                /**
+                 * Amount in cents (e.g. 1999 = $19.99)
+                 */
+                rateAmount?: number;
+                currency?: string;
+                carrier?: string;
+                serviceCode?: string;
+                estimatedDeliveryDays?: number;
+            } | null);
+            taxLines?: Array<{
+                id?: string;
+                lineItemId?: string;
+                jurisdictionCode?: string;
+                jurisdictionName?: string | null;
+                taxType?: string;
+                rate?: number;
+                /**
+                 * Amount in cents (e.g. 1999 = $19.99)
+                 */
+                amount?: number;
+                currency?: string | null;
+            }>;
+            /**
+             * Arbitrary key-value metadata
+             */
+            metadata?: Record<string, any>;
+            createdAt?: string;
+        };
+        meta?: {
+            request_id?: string;
+            pagination?: {
+                cursor?: string | null;
+                has_more?: boolean;
+            };
+        };
+    }>;
+    /**
+     * Replace all tax lines on a cart
+     * @param id
+     * @param requestBody
+     * @returns any Default Response
+     * @throws ApiError
+     */
+    static putApiV1CartsTaxLines(id: string, requestBody: {
+        lines: Array<{
+            lineItemId: string;
+            jurisdictionCode: string;
+            jurisdictionName?: string;
+            taxType: 'sales' | 'vat' | 'gst' | 'pst' | 'hst' | 'service' | 'excise' | 'other';
+            rate: number;
+            amount: number;
+            currency?: string;
+        }>;
+    }): CancelablePromise<{
+        data?: {
+            id?: string;
+            merchantId?: string;
+            storeId?: string | null;
+            customerId?: string | null;
+            status?: 'open' | 'checkout' | 'converted' | 'abandoned';
+            currency?: string;
+            /**
+             * Amount in cents (e.g. 1999 = $19.99)
+             */
+            subtotal?: number;
+            /**
+             * Amount in cents (e.g. 1999 = $19.99)
+             */
+            taxTotal?: number;
+            /**
+             * 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;
+            discountCode?: string | null;
+            appliedDiscount?: ({
+                discountId?: string | null;
+                code?: string;
+                type?: 'percentage' | 'fixed_amount';
+                /**
+                 * Amount in cents (e.g. 1999 = $19.99)
+                 */
+                amount?: number;
+                currency?: string;
+                freeShipping?: boolean;
+                validUntil?: string | null;
+                snapshotHash?: string;
+            } | null);
+            selectedShipping?: ({
+                methodId?: string;
+                displayName?: string;
+                /**
+                 * Amount in cents (e.g. 1999 = $19.99)
+                 */
+                rateAmount?: number;
+                currency?: string;
+                carrier?: string;
+                serviceCode?: string;
+                estimatedDeliveryDays?: number;
+            } | null);
+            taxLines?: Array<{
+                id?: string;
+                lineItemId?: string;
+                jurisdictionCode?: string;
+                jurisdictionName?: string | null;
+                taxType?: string;
+                rate?: number;
+                /**
+                 * Amount in cents (e.g. 1999 = $19.99)
+                 */
+                amount?: number;
+                currency?: string | null;
+            }>;
+            /**
+             * Arbitrary key-value metadata
+             */
+            metadata?: Record<string, any>;
+            createdAt?: string;
+        };
+        meta?: {
+            request_id?: string;
+            pagination?: {
+                cursor?: string | null;
+                has_more?: boolean;
+            };
+        };
+    }>;
+    /**
+     * Clear all tax lines from a cart
+     * @param id
+     * @returns any Default Response
+     * @throws ApiError
+     */
+    static deleteApiV1CartsTaxLines(id: string): CancelablePromise<{
+        data?: {
+            id?: string;
+            merchantId?: string;
+            storeId?: string | null;
+            customerId?: string | null;
+            status?: 'open' | 'checkout' | 'converted' | 'abandoned';
+            currency?: string;
+            /**
+             * Amount in cents (e.g. 1999 = $19.99)
+             */
+            subtotal?: number;
+            /**
+             * Amount in cents (e.g. 1999 = $19.99)
+             */
+            taxTotal?: number;
+            /**
+             * 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;
+            discountCode?: string | null;
+            appliedDiscount?: ({
+                discountId?: string | null;
+                code?: string;
+                type?: 'percentage' | 'fixed_amount';
+                /**
+                 * Amount in cents (e.g. 1999 = $19.99)
+                 */
+                amount?: number;
+                currency?: string;
+                freeShipping?: boolean;
+                validUntil?: string | null;
+                snapshotHash?: string;
+            } | null);
+            selectedShipping?: ({
+                methodId?: string;
+                displayName?: string;
+                /**
+                 * Amount in cents (e.g. 1999 = $19.99)
+                 */
+                rateAmount?: number;
+                currency?: string;
+                carrier?: string;
+                serviceCode?: string;
+                estimatedDeliveryDays?: number;
+            } | null);
+            taxLines?: Array<{
+                id?: string;
+                lineItemId?: string;
+                jurisdictionCode?: string;
+                jurisdictionName?: string | null;
+                taxType?: string;
+                rate?: number;
+                /**
+                 * Amount in cents (e.g. 1999 = $19.99)
+                 */
+                amount?: number;
+                currency?: string | null;
+            }>;
+            /**
+             * Arbitrary key-value metadata
+             */
+            metadata?: Record<string, any>;
+            createdAt?: string;
+        };
+        meta?: {
+            request_id?: string;
+            pagination?: {
+                cursor?: string | null;
+                has_more?: boolean;
+            };
+        };
+    }>;
+    /**
+     * List audit events for a cart
+     * @param id
+     * @param sinceSequence
+     * @param limit
+     * @returns any Default Response
+     * @throws ApiError
+     */
+    static getApiV1CartsEvents(id: string, sinceSequence?: number, limit?: number): CancelablePromise<{
+        data?: Array<{
+            id?: string;
+            cartId?: string;
+            eventType?: string;
+            sequence?: number;
+            payload?: Record<string, any>;
+            actorType?: string;
+            actorId?: string | null;
+            createdAt?: string;
+        }>;
         meta?: {
             request_id?: string;
             pagination?: {