stripe 22.3.0 → 22.4.0-alpha.2

package/esm/resources/DelegatedCheckout/OrderEvents.d.ts

@@ -0,0 +1,128 @@
+export interface OrderEvent {
+    /**
+     * Unique identifier for the object.
+     */
+    id: string;
+    /**
+     * String representing the object's type. Objects of the same type share the same value.
+     */
+    object: 'delegated_checkout.order_event';
+    /**
+     * The adjustment details for this order event.
+     */
+    adjustment: OrderEvent.Adjustment | null;
+    /**
+     * Time at which the object was created. Measured in seconds since the Unix epoch.
+     */
+    created: number;
+    /**
+     * The fulfillment details for this order event.
+     */
+    fulfillment: OrderEvent.Fulfillment | null;
+    /**
+     * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+     */
+    livemode: boolean;
+    /**
+     * Time at which this event occurred. Measured in seconds since the Unix epoch.
+     */
+    occurred_at: number;
+    /**
+     * The delegated checkout order associated with this order event.
+     */
+    order: string;
+    /**
+     * The requested session associated with this order event.
+     */
+    requested_session: string;
+    /**
+     * The type of order event.
+     */
+    type: OrderEvent.Type;
+}
+export declare namespace OrderEvent {
+    interface Adjustment {
+        /**
+         * The amount associated with the adjustment.
+         */
+        amount: number | null;
+        /**
+         * The currency associated with the adjustment amount.
+         */
+        currency: string | null;
+        /**
+         * The description of the adjustment.
+         */
+        description: string;
+        /**
+         * The line items associated with the adjustment.
+         */
+        line_items: Array<Adjustment.LineItem> | null;
+        /**
+         * The status of the adjustment.
+         */
+        status: Adjustment.Status;
+        /**
+         * The type of adjustment.
+         */
+        type: Adjustment.Type;
+    }
+    interface Fulfillment {
+        /**
+         * The carrier for the fulfillment.
+         */
+        carrier: string | null;
+        /**
+         * Time at which the fulfillment was delivered. Measured in seconds since the Unix epoch.
+         */
+        delivered_at: number | null;
+        /**
+         * The line items associated with the fulfillment.
+         */
+        line_items: Array<Fulfillment.LineItem>;
+        /**
+         * Time at which the fulfillment shipped. Measured in seconds since the Unix epoch.
+         */
+        shipped_at: number | null;
+        /**
+         * The status of the fulfillment.
+         */
+        status: Fulfillment.Status;
+        /**
+         * The tracking number for the fulfillment.
+         */
+        tracking_number: string | null;
+        /**
+         * The tracking URL for the fulfillment.
+         */
+        tracking_url: string | null;
+    }
+    type Type = 'adjustment' | 'fulfillment';
+    namespace Adjustment {
+        interface LineItem {
+            /**
+             * The line item key.
+             */
+            key: string;
+            /**
+             * The quantity associated with the order event.
+             */
+            quantity: number;
+        }
+        type Status = 'completed' | 'failed' | 'pending';
+        type Type = 'cancellation' | 'credit' | 'dispute' | 'original_payment_refund' | 'return' | 'store_credit_refund';
+    }
+    namespace Fulfillment {
+        interface LineItem {
+            /**
+             * The line item key.
+             */
+            key: string;
+            /**
+             * The quantity associated with the order event.
+             */
+            quantity: number;
+        }
+        type Status = 'confirmed' | 'delivered' | 'fulfilled' | 'pending' | 'returned' | 'shipped';
+    }
+}

package/esm/resources/DelegatedCheckout/OrderEvents.js

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec
+export {};
+//# sourceMappingURL=OrderEvents.js.map

package/esm/resources/DelegatedCheckout/OrderEvents.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OrderEvents.js","sourceRoot":"","sources":["../../../src/resources/DelegatedCheckout/OrderEvents.ts"],"names":[],"mappings":"AAAA,uCAAuC"}

package/esm/resources/DelegatedCheckout/Orders.d.ts

@@ -0,0 +1,159 @@
+import { StripeResource } from '../../StripeResource.js';
+import { OrderEvent } from './OrderEvents.js';
+import { RequestOptions, Response } from '../../lib.js';
+export declare class OrderResource extends StripeResource {
+    /**
+     * Retrieves a delegated checkout order.
+     */
+    retrieve(id: string, params?: DelegatedCheckout.OrderRetrieveParams, options?: RequestOptions): Promise<Response<Order>>;
+}
+export interface Order {
+    /**
+     * Unique identifier for the object.
+     */
+    id: string;
+    /**
+     * String representing the object's type. Objects of the same type share the same value.
+     */
+    object: 'delegated_checkout.order';
+    /**
+     * Time at which the object was created. Measured in seconds since the Unix epoch.
+     */
+    created: number;
+    /**
+     * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+     */
+    currency: string;
+    /**
+     * The latest order event for this order.
+     */
+    latest_order_event: OrderEvent | null;
+    /**
+     * The line items in this order.
+     */
+    line_items: Array<Order.LineItem>;
+    /**
+     * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+     */
+    livemode: boolean;
+    /**
+     * The permalink URL for this order.
+     */
+    permalink_url: string | null;
+    /**
+     * The requested session associated with this order.
+     */
+    requested_session: string;
+    /**
+     * The seller reference for this order.
+     */
+    seller_reference: string | null;
+    /**
+     * The totals for this order.
+     */
+    totals: Order.Totals | null;
+}
+export declare namespace Order {
+    interface LineItem {
+        /**
+         * The order line item key.
+         */
+        key: string;
+        product_details: LineItem.ProductDetails;
+        quantity: LineItem.Quantity;
+        /**
+         * The SKU ID of the line item.
+         */
+        sku_id: string;
+        /**
+         * The totals for this line item.
+         */
+        totals: LineItem.Totals | null;
+        /**
+         * The line item unit amount.
+         */
+        unit_amount: number;
+    }
+    interface Totals {
+        /**
+         * The discount amount for the order.
+         */
+        discount: number | null;
+        /**
+         * The fulfillment amount for the order.
+         */
+        fulfillment: number | null;
+        /**
+         * The subtotal amount for the order.
+         */
+        subtotal: number | null;
+        /**
+         * The tax amount for the order.
+         */
+        tax: number | null;
+        /**
+         * The total amount for the order.
+         */
+        total: number | null;
+    }
+    namespace LineItem {
+        interface ProductDetails {
+            /**
+             * The item description.
+             */
+            description: string | null;
+            /**
+             * The item images.
+             */
+            images: Array<string> | null;
+            /**
+             * The item title.
+             */
+            title: string;
+        }
+        interface Quantity {
+            /**
+             * The current quantity.
+             */
+            current: number;
+            /**
+             * The ordered quantity.
+             */
+            ordered: number;
+            /**
+             * The shipped quantity.
+             */
+            shipped: number;
+        }
+        interface Totals {
+            /**
+             * The base amount for the line item.
+             */
+            base_amount: number | null;
+            /**
+             * The discount amount for the line item.
+             */
+            discount: number | null;
+            /**
+             * The subtotal amount for the line item.
+             */
+            subtotal: number | null;
+            /**
+             * The tax amount for the line item.
+             */
+            tax: number | null;
+            /**
+             * The total amount for the line item.
+             */
+            total: number | null;
+        }
+    }
+}
+export declare namespace DelegatedCheckout {
+    interface OrderRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+    }
+}

package/esm/resources/DelegatedCheckout/Orders.js

@@ -0,0 +1,11 @@
+// File generated from our OpenAPI spec
+import { StripeResource } from '../../StripeResource.js';
+export class OrderResource extends StripeResource {
+    /**
+     * Retrieves a delegated checkout order.
+     */
+    retrieve(id, params, options) {
+        return this._makeRequest('GET', `/v1/delegated_checkout/orders/${encodeURIComponent(id)}`, params, options);
+    }
+}
+//# sourceMappingURL=Orders.js.map

package/esm/resources/DelegatedCheckout/Orders.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Orders.js","sourceRoot":"","sources":["../../../src/resources/DelegatedCheckout/Orders.ts"],"names":[],"mappings":"AAAA,uCAAuC;AAEvC,OAAO,EAAC,cAAc,EAAC,MAAM,yBAAyB,CAAC;AAIvD,MAAM,OAAO,aAAc,SAAQ,cAAc;IAC/C;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAA8C,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,iCAAiC,kBAAkB,CAAC,EAAE,CAAC,EAAE,EACzD,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF"}