@usethrottle/api-client 5.16.0 → 5.18.0

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

@@ -1,5 +1,115 @@
 import type { CancelablePromise } from '../core/CancelablePromise.js';
 export declare class OrdersService {
+    /**
+     * Internal notes on this order, newest first (at most 100). Only your team sees them: no buyer page, email or webhook payload includes a note.
+     * @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 getApiV1OrdersNotes(id: string, xThrottleEnvironmentId?: string): CancelablePromise<{
+        data?: Array<{
+            id: string;
+            body: string;
+            createdAt: string;
+            /**
+             * The team member who wrote it; null when an API key wrote it or the member was removed.
+             */
+            authorMemberId: string | null;
+            /**
+             * The author's workspace email, when `authorMemberId` is set.
+             */
+            authorEmail: string | null;
+        }>;
+        meta?: {
+            /**
+             * `req_<uuid>`, or a client-supplied id matching `^[A-Za-z0-9_-]{8,128}$`.
+             */
+            requestId?: string;
+            pagination?: {
+                cursor?: string | null;
+                hasMore?: boolean;
+            };
+        };
+    }>;
+    /**
+     * Add an internal note to this order. Notes cannot be edited or deleted.
+     * @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 postApiV1OrdersNotes(id: string, requestBody: {
+        /**
+         * The note, 1–5000 characters.
+         */
+        body: string;
+    }, xThrottleEnvironmentId?: string): CancelablePromise<{
+        data?: {
+            id: string;
+            body: string;
+            createdAt: string;
+            /**
+             * The team member who wrote it; null when an API key wrote it or the member was removed.
+             */
+            authorMemberId: string | null;
+            /**
+             * The author's workspace email, when `authorMemberId` is set.
+             */
+            authorEmail: string | null;
+        };
+        meta?: {
+            /**
+             * `req_<uuid>`, or a client-supplied id matching `^[A-Za-z0-9_-]{8,128}$`.
+             */
+            requestId?: string;
+            pagination?: {
+                cursor?: string | null;
+                hasMore?: boolean;
+            };
+        };
+    }>;
+    /**
+     * Convert a cart into a draft order (status=draft) stamped metadata.createdVia=dashboard. Requires the application:orders:write permission for dashboard members. Collect payment for the order afterwards.
+     * @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 postApiV1OrdersFromCart(requestBody: {
+        cartId: string;
+    }, xThrottleEnvironmentId?: string): CancelablePromise<{
+        /**
+         * The created draft order
+         */
+        data?: {
+            id?: string;
+            orderNumber?: string;
+            status?: 'draft';
+            currency?: string;
+            /**
+             * In cents
+             */
+            subtotal?: number;
+            /**
+             * In cents
+             */
+            total?: number;
+            cartId?: string;
+            createdAt?: string;
+        };
+        meta?: {
+            /**
+             * `req_<uuid>`, or a client-supplied id matching `^[A-Za-z0-9_-]{8,128}$`.
+             */
+            requestId?: string;
+            pagination?: {
+                cursor?: string | null;
+                hasMore?: boolean;
+            };
+        };
+    }>;
     /**
      * Create a new order (draft)
      * @param requestBody
@@ -9,6 +119,9 @@ export declare class OrdersService {
      */
     static postApiV1Orders(requestBody: {
         customerId?: string;
+        /**
+         * ISO currency code. Omit it to use the store's currency. Must be enabled for the store, else `422 currency_not_enabled`; in production a non-USD code is `422 currency_not_available_in_production`.
+         */
         currency?: string;
         source?: 'web' | 'mobile' | 'pos' | 'api';
         billingAddress?: {
@@ -3734,6 +3847,120 @@ export declare class OrdersService {
             };
         };
     }>;
+    /**
+     * Create a 7-day payment link (a hosted checkout session) for a draft order built with `POST /orders/from-cart`, and email it to the customer unless `send` is false. Replaces, and cancels, any link the order already has. An API key needs both `orders:write` and `checkout_sessions:write`.
+     * @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 postApiV1OrdersPaymentLink(id: string, requestBody: {
+        /**
+         * Email the link to the order's customer (default true). `false` creates and returns it only.
+         */
+        send?: boolean;
+    }, xThrottleEnvironmentId?: string): CancelablePromise<{
+        data?: {
+            sessionId?: string;
+            /**
+             * The hosted checkout URL the customer pays at.
+             */
+            url?: string;
+            sentAt?: string;
+            expiresAt?: string;
+            /**
+             * The address the link was emailed to; null when it was not emailed.
+             */
+            emailedTo?: string | null;
+        };
+        meta?: {
+            /**
+             * `req_<uuid>`, or a client-supplied id matching `^[A-Za-z0-9_-]{8,128}$`.
+             */
+            requestId?: string;
+            pagination?: {
+                cursor?: string | null;
+                hasMore?: boolean;
+            };
+        };
+    }>;
+    /**
+     * Cancel the payment link of an order so it can no longer be paid. An API key needs both `orders:write` and `checkout_sessions:write`.
+     * @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 void
+     * @throws ApiError
+     */
+    static deleteApiV1OrdersPaymentLink(id: string, xThrottleEnvironmentId?: string): CancelablePromise<void>;
+    /**
+     * Issue a Net-N invoice for a draft order built with `POST /orders/from-cart`, accepting the Invoice Terms on the buyer's behalf, and move the order to processing. Cancels any payment link first. Requires an active Invoice Terms connector. An API key needs both `payments:write` and `orders:write`.
+     * @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 postApiV1OrdersInvoiceOnTerms(id: string, requestBody: {
+        /**
+         * Net-N days for this invoice (0 = due on issue). Omit to use the customer's terms, then the application default.
+         */
+        netDays?: number;
+        /**
+         * Recorded as the accepting company on the terms acceptance.
+         */
+        companyName: string;
+        billingEmail: string;
+    }, xThrottleEnvironmentId?: string): CancelablePromise<{
+        data?: {
+            id?: string;
+            orderId?: string;
+            processor?: string;
+            processorTransactionId?: string | null;
+            processorResponse?: any | null;
+            /**
+             * Amount in cents (e.g. 1999 = $19.99)
+             */
+            amount?: number;
+            /**
+             * Amount actually captured. May be less than `amount` on a partial capture; null until captured.
+             */
+            capturedAmount?: number | null;
+            currency?: string;
+            status?: 'pending' | 'authorized' | 'processing' | 'captured' | 'failed' | 'voided' | 'expired' | 'refunded' | 'partially_refunded';
+            errorCode?: string | null;
+            /**
+             * Why the payment failed. For a manually-marked failure this is the reason the merchant gave.
+             */
+            errorMessage?: string | null;
+            method?: 'card' | 'bank_transfer' | 'wallet' | 'cash' | 'cheque' | 'external' | 'manual' | 'net30';
+            netN?: number;
+            netNSource?: 'customer_override' | 'cart_override' | 'global_default';
+            authorizedAt?: string | null;
+            capturedAt?: string | null;
+            voidedAt?: string | null;
+            disputed?: boolean;
+            disputeReason?: string | null;
+            disputeOpenedAt?: string | null;
+            disputeOutcome?: 'won' | 'lost';
+            disputeClosedAt?: string | null;
+            /**
+             * Arbitrary key-value metadata
+             */
+            metadata?: Record<string, any>;
+            createdAt?: string;
+        };
+        meta?: {
+            /**
+             * `req_<uuid>`, or a client-supplied id matching `^[A-Za-z0-9_-]{8,128}$`.
+             */
+            requestId?: string;
+            pagination?: {
+                cursor?: string | null;
+                hasMore?: boolean;
+            };
+        };
+    }>;
     /**
      * Add, update, or remove line items on an order. On a captured order the total delta is charged (increase) or refunded (decrease) automatically; on an order with an outstanding Net-N invoice, the invoice amount takes the delta instead.
      * @param id
@@ -4050,75 +4277,5 @@ export declare class OrdersService {
             }>;
         };
     }>;
-    /**
-     * Internal notes on this order, newest first (at most 100). Only your team sees them: no buyer page, email or webhook payload includes a note.
-     * @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 getApiV1OrdersNotes(id: string, xThrottleEnvironmentId?: string): CancelablePromise<{
-        data?: Array<{
-            id: string;
-            body: string;
-            createdAt: string;
-            /**
-             * The team member who wrote it; null when an API key wrote it or the member was removed.
-             */
-            authorMemberId: string | null;
-            /**
-             * The author's workspace email, when `authorMemberId` is set.
-             */
-            authorEmail: string | null;
-        }>;
-        meta?: {
-            /**
-             * `req_<uuid>`, or a client-supplied id matching `^[A-Za-z0-9_-]{8,128}$`.
-             */
-            requestId?: string;
-            pagination?: {
-                cursor?: string | null;
-                hasMore?: boolean;
-            };
-        };
-    }>;
-    /**
-     * Add an internal note to this order. Notes cannot be edited or deleted.
-     * @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 postApiV1OrdersNotes(id: string, requestBody: {
-        /**
-         * The note, 1–5000 characters.
-         */
-        body: string;
-    }, xThrottleEnvironmentId?: string): CancelablePromise<{
-        data?: {
-            id: string;
-            body: string;
-            createdAt: string;
-            /**
-             * The team member who wrote it; null when an API key wrote it or the member was removed.
-             */
-            authorMemberId: string | null;
-            /**
-             * The author's workspace email, when `authorMemberId` is set.
-             */
-            authorEmail: string | null;
-        };
-        meta?: {
-            /**
-             * `req_<uuid>`, or a client-supplied id matching `^[A-Za-z0-9_-]{8,128}$`.
-             */
-            requestId?: string;
-            pagination?: {
-                cursor?: string | null;
-                hasMore?: boolean;
-            };
-        };
-    }>;
 }
 //# sourceMappingURL=OrdersService.d.ts.map