checkout-intents 0.1.0 → 0.3.0

package/resources/checkout-intents.d.ts

@@ -0,0 +1,320 @@
+import { APIResource } from "../core/resource.js";
+import * as CheckoutIntentsAPI from "./checkout-intents.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+/**
+ * Options for polling operations.
+ */
+export interface PollOptions {
+    /**
+     * The interval in milliseconds between polling attempts.
+     */
+    pollIntervalMs?: number;
+    /**
+     * The maximum number of polling attempts before timing out.
+     */
+    maxAttempts?: number;
+}
+export declare class CheckoutIntentsResource extends APIResource {
+    /**
+     * Create a checkout intent with the given request body.
+     *
+     * @example
+     * ```ts
+     * const checkoutIntent = await client.checkoutIntents.create({
+     *   buyer: {
+     *     address1: '123 Main St',
+     *     city: 'New York',
+     *     country: 'United States',
+     *     email: 'john.doe@example.com',
+     *     firstName: 'John',
+     *     lastName: 'Doe',
+     *     phone: '+1234567890',
+     *     postalCode: '10001',
+     *     province: 'NY',
+     *   },
+     *   productUrl: 'productUrl',
+     *   quantity: 1,
+     * });
+     * ```
+     */
+    create(body: CheckoutIntentCreateParams, options?: RequestOptions): APIPromise<CheckoutIntent>;
+    /**
+     * Retrieve a checkout intent by id
+     *
+     * Returns checkout intent information if the lookup succeeds.
+     *
+     * @example
+     * ```ts
+     * const checkoutIntent =
+     *   await client.checkoutIntents.retrieve('id');
+     * ```
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<CheckoutIntent>;
+    /**
+     * Add payment details to a checkout intent
+     *
+     * @example
+     * ```ts
+     * const checkoutIntent =
+     *   await client.checkoutIntents.addPayment('id', {
+     *     paymentMethod: {
+     *       stripeToken: 'tok_1RkrWWHGDlstla3f1Fc7ZrhH',
+     *       type: 'stripe_token',
+     *     },
+     *   });
+     * ```
+     */
+    addPayment(id: string, body: CheckoutIntentAddPaymentParams, options?: RequestOptions): APIPromise<CheckoutIntent>;
+    /**
+     * Confirm a checkout intent with provided payment information
+     *
+     * Confirm means we have buyer's name, address and payment info, so we can move
+     * forward to place the order.
+     *
+     * @example
+     * ```ts
+     * const checkoutIntent = await client.checkoutIntents.confirm(
+     *   'id',
+     *   {
+     *     paymentMethod: {
+     *       stripeToken: 'tok_1RkrWWHGDlstla3f1Fc7ZrhH',
+     *       type: 'stripe_token',
+     *     },
+     *   },
+     * );
+     * ```
+     */
+    confirm(id: string, body: CheckoutIntentConfirmParams, options?: RequestOptions): APIPromise<CheckoutIntent>;
+    /**
+     * A helper to poll a checkout intent until a specific condition is met.
+     *
+     * @example
+     * ```ts
+     * // Poll until completed or failed
+     * const checkoutIntent = await client.checkoutIntents.pollUntil(
+     *   'id',
+     *   (intent) => intent.state === 'completed' || intent.state === 'failed'
+     * );
+     * ```
+     */
+    private pollUntil;
+    /**
+     * A helper to poll a checkout intent until it reaches a completed state
+     * (completed or failed).
+     *
+     * @example
+     * ```ts
+     * const checkoutIntent = await client.checkoutIntents.pollUntilCompleted('id');
+     * if (checkoutIntent.state === 'completed') {
+     *   console.log('Order placed successfully!');
+     * } else if (checkoutIntent.state === 'failed') {
+     *   console.log('Order failed:', checkoutIntent.failureReason);
+     * }
+     * ```
+     */
+    pollUntilCompleted(id: string, options?: RequestOptions & PollOptions): Promise<CheckoutIntent.CompletedCheckoutIntent | CheckoutIntent.FailedCheckoutIntent>;
+    /**
+     * A helper to poll a checkout intent until it's ready for confirmation
+     * (awaiting_confirmation state) or has failed. This is typically used after
+     * creating a checkout intent to wait for the offer to be retrieved from the merchant.
+     *
+     * The intent can reach awaiting_confirmation (success - ready to confirm) or failed
+     * (offer retrieval failed). Always check the state after polling.
+     *
+     * @example
+     * ```ts
+     * const intent = await client.checkoutIntents.pollUntilAwaitingConfirmation('id');
+     *
+     * if (intent.state === 'awaiting_confirmation') {
+     *   // Review the offer before confirming
+     *   console.log('Total:', intent.offer.cost.total);
+     * } else if (intent.state === 'failed') {
+     *   // Handle failure (e.g., offer retrieval failed, product out of stock)
+     *   console.log('Failed:', intent.failureReason);
+     * }
+     * ```
+     */
+    pollUntilAwaitingConfirmation(id: string, options?: RequestOptions & PollOptions): Promise<CheckoutIntent.AwaitingConfirmationCheckoutIntent | CheckoutIntent.FailedCheckoutIntent>;
+    /**
+     * A helper to create a checkout intent and poll until it's ready for confirmation.
+     * This follows the Rye documented flow: create → poll until awaiting_confirmation.
+     *
+     * After this method completes, you should review the offer (pricing, shipping, taxes)
+     * with the user before calling confirm().
+     *
+     * @example
+     * ```ts
+     * // Phase 1: Create and wait for offer
+     * const intent = await client.checkoutIntents.createAndPoll({
+     *   buyer: {
+     *     address1: '123 Main St',
+     *     city: 'New York',
+     *     country: 'United States',
+     *     email: 'john.doe@example.com',
+     *     firstName: 'John',
+     *     lastName: 'Doe',
+     *     phone: '+1234567890',
+     *     postalCode: '10001',
+     *     province: 'NY',
+     *   },
+     *   productUrl: 'https://example.com/product',
+     *   quantity: 1,
+     * });
+     *
+     * // Review the offer with the user
+     * console.log('Total:', intent.offer.cost.total);
+     *
+     * // Phase 2: Confirm with payment
+     * const completed = await client.checkoutIntents.confirmAndPoll(intent.id, {
+     *   paymentMethod: { type: 'stripe_token', stripeToken: 'tok_visa' }
+     * });
+     * ```
+     */
+    createAndPoll(body: CheckoutIntentCreateParams, options?: RequestOptions & PollOptions): Promise<CheckoutIntent.AwaitingConfirmationCheckoutIntent | CheckoutIntent.FailedCheckoutIntent>;
+    /**
+     * A helper to confirm a checkout intent and poll until it reaches a completed state
+     * (completed or failed).
+     *
+     * @example
+     * ```ts
+     * const checkoutIntent = await client.checkoutIntents.confirmAndPoll(
+     *   'id',
+     *   {
+     *     paymentMethod: {
+     *       stripeToken: 'tok_1RkrWWHGDlstla3f1Fc7ZrhH',
+     *       type: 'stripe_token',
+     *     },
+     *   }
+     * );
+     *
+     * if (checkoutIntent.state === 'completed') {
+     *   console.log('Order placed successfully!');
+     * } else if (checkoutIntent.state === 'failed') {
+     *   console.log('Order failed:', checkoutIntent.failureReason);
+     * }
+     * ```
+     */
+    confirmAndPoll(id: string, body: CheckoutIntentConfirmParams, options?: RequestOptions & PollOptions): Promise<CheckoutIntent.CompletedCheckoutIntent | CheckoutIntent.FailedCheckoutIntent>;
+}
+export interface BaseCheckoutIntent {
+    id: string;
+    buyer: Buyer;
+    createdAt: string;
+    productUrl: string;
+    quantity: number;
+    variantSelections?: Array<VariantSelection>;
+}
+export interface Buyer {
+    address1: string;
+    city: string;
+    country: string;
+    email: string;
+    firstName: string;
+    lastName: string;
+    phone: string;
+    postalCode: string;
+    province: string;
+    address2?: string;
+}
+export type CheckoutIntent = CheckoutIntent.RetrievingOfferCheckoutIntent | CheckoutIntent.AwaitingConfirmationCheckoutIntent | CheckoutIntent.PlacingOrderCheckoutIntent | CheckoutIntent.CompletedCheckoutIntent | CheckoutIntent.FailedCheckoutIntent;
+export declare namespace CheckoutIntent {
+    interface RetrievingOfferCheckoutIntent extends CheckoutIntentsAPI.BaseCheckoutIntent {
+        state: 'retrieving_offer';
+    }
+    interface AwaitingConfirmationCheckoutIntent extends CheckoutIntentsAPI.BaseCheckoutIntent {
+        offer: CheckoutIntentsAPI.Offer;
+        state: 'awaiting_confirmation';
+        paymentMethod?: CheckoutIntentsAPI.PaymentMethod;
+    }
+    interface PlacingOrderCheckoutIntent extends CheckoutIntentsAPI.BaseCheckoutIntent {
+        offer: CheckoutIntentsAPI.Offer;
+        paymentMethod: CheckoutIntentsAPI.PaymentMethod;
+        state: 'placing_order';
+    }
+    interface CompletedCheckoutIntent extends CheckoutIntentsAPI.BaseCheckoutIntent {
+        offer: CheckoutIntentsAPI.Offer;
+        paymentMethod: CheckoutIntentsAPI.PaymentMethod;
+        state: 'completed';
+    }
+    interface FailedCheckoutIntent extends CheckoutIntentsAPI.BaseCheckoutIntent {
+        failureReason: FailedCheckoutIntent.FailureReason;
+        state: 'failed';
+        offer?: CheckoutIntentsAPI.Offer;
+        paymentMethod?: CheckoutIntentsAPI.PaymentMethod;
+    }
+    namespace FailedCheckoutIntent {
+        interface FailureReason {
+            code: 'checkout_intent_expired' | 'payment_failed' | 'insufficient_stock' | 'product_out_of_stock' | 'offer_retrieval_failed' | 'order_placement_failed' | 'developer_not_found' | 'missing_shipping_method' | 'unsupported_currency' | 'unsupported_store_no_guest_checkout';
+            message: string;
+        }
+    }
+}
+export interface Money {
+    amountSubunits: number;
+    currencyCode: string;
+}
+export interface Offer {
+    cost: Offer.Cost;
+    shipping: Offer.Shipping;
+}
+export declare namespace Offer {
+    interface Cost {
+        subtotal: CheckoutIntentsAPI.Money;
+        total: CheckoutIntentsAPI.Money;
+        discount?: CheckoutIntentsAPI.Money;
+        shipping?: CheckoutIntentsAPI.Money;
+        tax?: CheckoutIntentsAPI.Money;
+    }
+    interface Shipping {
+        availableOptions: Array<Shipping.AvailableOption>;
+        selectedOptionId?: string;
+    }
+    namespace Shipping {
+        interface AvailableOption {
+            id: string;
+            cost: CheckoutIntentsAPI.Money;
+        }
+    }
+}
+export type PaymentMethod = PaymentMethod.StripeTokenPaymentMethod | PaymentMethod.BasisTheoryPaymentMethod | PaymentMethod.NekudaPaymentMethod;
+export declare namespace PaymentMethod {
+    interface StripeTokenPaymentMethod {
+        stripeToken: string;
+        type: 'stripe_token';
+    }
+    interface BasisTheoryPaymentMethod {
+        basisTheoryToken: string;
+        type: 'basis_theory_token';
+    }
+    interface NekudaPaymentMethod {
+        nekudaUserId: string;
+        type: 'nekuda_token';
+        /**
+         * Construct a type with a set of properties K of type T
+         */
+        nekudaMandateData?: {
+            [key: string]: string | number;
+        };
+    }
+}
+export interface VariantSelection {
+    label: string;
+    value: string | number;
+}
+export interface CheckoutIntentCreateParams {
+    buyer: Buyer;
+    productUrl: string;
+    quantity: number;
+    variantSelections?: Array<VariantSelection>;
+}
+export interface CheckoutIntentAddPaymentParams {
+    paymentMethod: PaymentMethod;
+}
+export interface CheckoutIntentConfirmParams {
+    paymentMethod: PaymentMethod;
+}
+export declare namespace CheckoutIntentsResource {
+    export { type BaseCheckoutIntent as BaseCheckoutIntent, type Buyer as Buyer, type CheckoutIntent as CheckoutIntent, type Money as Money, type Offer as Offer, type PaymentMethod as PaymentMethod, type PollOptions as PollOptions, type VariantSelection as VariantSelection, type CheckoutIntentCreateParams as CheckoutIntentCreateParams, type CheckoutIntentAddPaymentParams as CheckoutIntentAddPaymentParams, type CheckoutIntentConfirmParams as CheckoutIntentConfirmParams, };
+}
+//# sourceMappingURL=checkout-intents.d.ts.map

package/resources/checkout-intents.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"checkout-intents.d.ts","sourceRoot":"","sources":["../src/resources/checkout-intents.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,kBAAkB;OACvB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAKzB;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,qBAAa,uBAAwB,SAAQ,WAAW;IACtD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CAAC,IAAI,EAAE,0BAA0B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IAI9F;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IAI1E;;;;;;;;;;;;;OAaG;IACH,UAAU,CACR,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,8BAA8B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC;IAI7B;;;;;;;;;;;;;;;;;;OAkBG;IACH,OAAO,CACL,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC;IAI7B;;;;;;;;;;;OAWG;YACW,SAAS;IAwDvB;;;;;;;;;;;;;OAaG;IACG,kBAAkB,CACtB,EAAE,EAAE,MAAM,EACV,OAAO,CAAC,EAAE,cAAc,GAAG,WAAW,GACrC,OAAO,CAAC,cAAc,CAAC,uBAAuB,GAAG,cAAc,CAAC,oBAAoB,CAAC;IASxF;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,6BAA6B,CACjC,EAAE,EAAE,MAAM,EACV,OAAO,CAAC,EAAE,cAAc,GAAG,WAAW,GACrC,OAAO,CAAC,cAAc,CAAC,kCAAkC,GAAG,cAAc,CAAC,oBAAoB,CAAC;IAWnG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACG,aAAa,CACjB,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,cAAc,GAAG,WAAW,GACrC,OAAO,CAAC,cAAc,CAAC,kCAAkC,GAAG,cAAc,CAAC,oBAAoB,CAAC;IAKnG;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,cAAc,CAClB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,cAAc,GAAG,WAAW,GACrC,OAAO,CAAC,cAAc,CAAC,uBAAuB,GAAG,cAAc,CAAC,oBAAoB,CAAC;CAIzF;AAED,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;IAEX,KAAK,EAAE,KAAK,CAAC;IAEb,SAAS,EAAE,MAAM,CAAC;IAElB,UAAU,EAAE,MAAM,CAAC;IAEnB,QAAQ,EAAE,MAAM,CAAC;IAEjB,iBAAiB,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;CAC7C;AAED,MAAM,WAAW,KAAK;IACpB,QAAQ,EAAE,MAAM,CAAC;IAEjB,IAAI,EAAE,MAAM,CAAC;IAEb,OAAO,EAAE,MAAM,CAAC;IAEhB,KAAK,EAAE,MAAM,CAAC;IAEd,SAAS,EAAE,MAAM,CAAC;IAElB,QAAQ,EAAE,MAAM,CAAC;IAEjB,KAAK,EAAE,MAAM,CAAC;IAEd,UAAU,EAAE,MAAM,CAAC;IAEnB,QAAQ,EAAE,MAAM,CAAC;IAEjB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,cAAc,GACtB,cAAc,CAAC,6BAA6B,GAC5C,cAAc,CAAC,kCAAkC,GACjD,cAAc,CAAC,0BAA0B,GACzC,cAAc,CAAC,uBAAuB,GACtC,cAAc,CAAC,oBAAoB,CAAC;AAExC,yBAAiB,cAAc,CAAC;IAC9B,UAAiB,6BAA8B,SAAQ,kBAAkB,CAAC,kBAAkB;QAC1F,KAAK,EAAE,kBAAkB,CAAC;KAC3B;IAED,UAAiB,kCAAmC,SAAQ,kBAAkB,CAAC,kBAAkB;QAC/F,KAAK,EAAE,kBAAkB,CAAC,KAAK,CAAC;QAEhC,KAAK,EAAE,uBAAuB,CAAC;QAE/B,aAAa,CAAC,EAAE,kBAAkB,CAAC,aAAa,CAAC;KAClD;IAED,UAAiB,0BAA2B,SAAQ,kBAAkB,CAAC,kBAAkB;QACvF,KAAK,EAAE,kBAAkB,CAAC,KAAK,CAAC;QAEhC,aAAa,EAAE,kBAAkB,CAAC,aAAa,CAAC;QAEhD,KAAK,EAAE,eAAe,CAAC;KACxB;IAED,UAAiB,uBAAwB,SAAQ,kBAAkB,CAAC,kBAAkB;QACpF,KAAK,EAAE,kBAAkB,CAAC,KAAK,CAAC;QAEhC,aAAa,EAAE,kBAAkB,CAAC,aAAa,CAAC;QAEhD,KAAK,EAAE,WAAW,CAAC;KACpB;IAED,UAAiB,oBAAqB,SAAQ,kBAAkB,CAAC,kBAAkB;QACjF,aAAa,EAAE,oBAAoB,CAAC,aAAa,CAAC;QAElD,KAAK,EAAE,QAAQ,CAAC;QAEhB,KAAK,CAAC,EAAE,kBAAkB,CAAC,KAAK,CAAC;QAEjC,aAAa,CAAC,EAAE,kBAAkB,CAAC,aAAa,CAAC;KAClD;IAED,UAAiB,oBAAoB,CAAC;QACpC,UAAiB,aAAa;YAC5B,IAAI,EACA,yBAAyB,GACzB,gBAAgB,GAChB,oBAAoB,GACpB,sBAAsB,GACtB,wBAAwB,GACxB,wBAAwB,GACxB,qBAAqB,GACrB,yBAAyB,GACzB,sBAAsB,GACtB,qCAAqC,CAAC;YAE1C,OAAO,EAAE,MAAM,CAAC;SACjB;KACF;CACF;AAED,MAAM,WAAW,KAAK;IACpB,cAAc,EAAE,MAAM,CAAC;IAEvB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,KAAK;IACpB,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC;IAEjB,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC;CAC1B;AAED,yBAAiB,KAAK,CAAC;IACrB,UAAiB,IAAI;QACnB,QAAQ,EAAE,kBAAkB,CAAC,KAAK,CAAC;QAEnC,KAAK,EAAE,kBAAkB,CAAC,KAAK,CAAC;QAEhC,QAAQ,CAAC,EAAE,kBAAkB,CAAC,KAAK,CAAC;QAEpC,QAAQ,CAAC,EAAE,kBAAkB,CAAC,KAAK,CAAC;QAEpC,GAAG,CAAC,EAAE,kBAAkB,CAAC,KAAK,CAAC;KAChC;IAED,UAAiB,QAAQ;QACvB,gBAAgB,EAAE,KAAK,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;QAElD,gBAAgB,CAAC,EAAE,MAAM,CAAC;KAC3B;IAED,UAAiB,QAAQ,CAAC;QACxB,UAAiB,eAAe;YAC9B,EAAE,EAAE,MAAM,CAAC;YAEX,IAAI,EAAE,kBAAkB,CAAC,KAAK,CAAC;SAChC;KACF;CACF;AAED,MAAM,MAAM,aAAa,GACrB,aAAa,CAAC,wBAAwB,GACtC,aAAa,CAAC,wBAAwB,GACtC,aAAa,CAAC,mBAAmB,CAAC;AAEtC,yBAAiB,aAAa,CAAC;IAC7B,UAAiB,wBAAwB;QACvC,WAAW,EAAE,MAAM,CAAC;QAEpB,IAAI,EAAE,cAAc,CAAC;KACtB;IAED,UAAiB,wBAAwB;QACvC,gBAAgB,EAAE,MAAM,CAAC;QAEzB,IAAI,EAAE,oBAAoB,CAAC;KAC5B;IAED,UAAiB,mBAAmB;QAClC,YAAY,EAAE,MAAM,CAAC;QAErB,IAAI,EAAE,cAAc,CAAC;QAErB;;WAEG;QACH,iBAAiB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;KACxD;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAC;IAEd,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,0BAA0B;IACzC,KAAK,EAAE,KAAK,CAAC;IAEb,UAAU,EAAE,MAAM,CAAC;IAEnB,QAAQ,EAAE,MAAM,CAAC;IAEjB,iBAAiB,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;CAC7C;AAED,MAAM,WAAW,8BAA8B;IAC7C,aAAa,EAAE,aAAa,CAAC;CAC9B;AAED,MAAM,WAAW,2BAA2B;IAC1C,aAAa,EAAE,aAAa,CAAC;CAC9B;AAED,MAAM,CAAC,OAAO,WAAW,uBAAuB,CAAC;IAC/C,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}

package/resources/checkout-intents.js

@@ -0,0 +1,248 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CheckoutIntentsResource = void 0;
+const resource_1 = require("../core/resource.js");
+const path_1 = require("../internal/utils/path.js");
+const sleep_1 = require("../internal/utils/sleep.js");
+const headers_1 = require("../internal/headers.js");
+class CheckoutIntentsResource extends resource_1.APIResource {
+    /**
+     * Create a checkout intent with the given request body.
+     *
+     * @example
+     * ```ts
+     * const checkoutIntent = await client.checkoutIntents.create({
+     *   buyer: {
+     *     address1: '123 Main St',
+     *     city: 'New York',
+     *     country: 'United States',
+     *     email: 'john.doe@example.com',
+     *     firstName: 'John',
+     *     lastName: 'Doe',
+     *     phone: '+1234567890',
+     *     postalCode: '10001',
+     *     province: 'NY',
+     *   },
+     *   productUrl: 'productUrl',
+     *   quantity: 1,
+     * });
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/api/v1/checkout-intents', { body, ...options });
+    }
+    /**
+     * Retrieve a checkout intent by id
+     *
+     * Returns checkout intent information if the lookup succeeds.
+     *
+     * @example
+     * ```ts
+     * const checkoutIntent =
+     *   await client.checkoutIntents.retrieve('id');
+     * ```
+     */
+    retrieve(id, options) {
+        return this._client.get((0, path_1.path) `/api/v1/checkout-intents/${id}`, options);
+    }
+    /**
+     * Add payment details to a checkout intent
+     *
+     * @example
+     * ```ts
+     * const checkoutIntent =
+     *   await client.checkoutIntents.addPayment('id', {
+     *     paymentMethod: {
+     *       stripeToken: 'tok_1RkrWWHGDlstla3f1Fc7ZrhH',
+     *       type: 'stripe_token',
+     *     },
+     *   });
+     * ```
+     */
+    addPayment(id, body, options) {
+        return this._client.post((0, path_1.path) `/api/v1/checkout-intents/${id}/payment`, { body, ...options });
+    }
+    /**
+     * Confirm a checkout intent with provided payment information
+     *
+     * Confirm means we have buyer's name, address and payment info, so we can move
+     * forward to place the order.
+     *
+     * @example
+     * ```ts
+     * const checkoutIntent = await client.checkoutIntents.confirm(
+     *   'id',
+     *   {
+     *     paymentMethod: {
+     *       stripeToken: 'tok_1RkrWWHGDlstla3f1Fc7ZrhH',
+     *       type: 'stripe_token',
+     *     },
+     *   },
+     * );
+     * ```
+     */
+    confirm(id, body, options) {
+        return this._client.post((0, path_1.path) `/api/v1/checkout-intents/${id}/confirm`, { body, ...options });
+    }
+    /**
+     * A helper to poll a checkout intent until a specific condition is met.
+     *
+     * @example
+     * ```ts
+     * // Poll until completed or failed
+     * const checkoutIntent = await client.checkoutIntents.pollUntil(
+     *   'id',
+     *   (intent) => intent.state === 'completed' || intent.state === 'failed'
+     * );
+     * ```
+     */
+    async pollUntil(id, condition, options) {
+        const maxAttempts = options?.maxAttempts ?? 120; // Default: 120 attempts
+        const pollIntervalMs = options?.pollIntervalMs ?? 5000; // Default: 5 seconds
+        let attempts = 0;
+        const headers = (0, headers_1.buildHeaders)([
+            options?.headers,
+            {
+                'X-Stainless-Poll-Helper': 'true',
+                'X-Stainless-Custom-Poll-Interval': pollIntervalMs.toString(),
+            },
+        ]);
+        while (attempts < maxAttempts) {
+            const { data: intent, response } = await this.retrieve(id, {
+                ...options,
+                headers: { ...options?.headers, ...headers.values },
+            }).withResponse();
+            // Check if condition is met
+            if (condition(intent)) {
+                return intent;
+            }
+            attempts++;
+            // If we've reached max attempts, throw an error
+            if (attempts >= maxAttempts) {
+                throw new Error(`Polling timeout: condition not met after ${maxAttempts} attempts (${(maxAttempts * pollIntervalMs) / 1000}s)`);
+            }
+            // Check if server suggests a polling interval
+            let sleepInterval = pollIntervalMs;
+            const headerInterval = response.headers.get('retry-after-ms');
+            if (headerInterval) {
+                const headerIntervalMs = parseInt(headerInterval);
+                if (!isNaN(headerIntervalMs)) {
+                    sleepInterval = headerIntervalMs;
+                }
+            }
+            await (0, sleep_1.sleep)(sleepInterval);
+        }
+        // This should never be reached due to the throw above, but TypeScript needs it
+        throw new Error(`Polling timeout: condition not met after ${maxAttempts} attempts`);
+    }
+    /**
+     * A helper to poll a checkout intent until it reaches a completed state
+     * (completed or failed).
+     *
+     * @example
+     * ```ts
+     * const checkoutIntent = await client.checkoutIntents.pollUntilCompleted('id');
+     * if (checkoutIntent.state === 'completed') {
+     *   console.log('Order placed successfully!');
+     * } else if (checkoutIntent.state === 'failed') {
+     *   console.log('Order failed:', checkoutIntent.failureReason);
+     * }
+     * ```
+     */
+    async pollUntilCompleted(id, options) {
+        return this.pollUntil(id, (intent) => intent.state === 'completed' || intent.state === 'failed', options);
+    }
+    /**
+     * A helper to poll a checkout intent until it's ready for confirmation
+     * (awaiting_confirmation state) or has failed. This is typically used after
+     * creating a checkout intent to wait for the offer to be retrieved from the merchant.
+     *
+     * The intent can reach awaiting_confirmation (success - ready to confirm) or failed
+     * (offer retrieval failed). Always check the state after polling.
+     *
+     * @example
+     * ```ts
+     * const intent = await client.checkoutIntents.pollUntilAwaitingConfirmation('id');
+     *
+     * if (intent.state === 'awaiting_confirmation') {
+     *   // Review the offer before confirming
+     *   console.log('Total:', intent.offer.cost.total);
+     * } else if (intent.state === 'failed') {
+     *   // Handle failure (e.g., offer retrieval failed, product out of stock)
+     *   console.log('Failed:', intent.failureReason);
+     * }
+     * ```
+     */
+    async pollUntilAwaitingConfirmation(id, options) {
+        return this.pollUntil(id, (intent) => intent.state === 'awaiting_confirmation' || intent.state === 'failed', options);
+    }
+    /**
+     * A helper to create a checkout intent and poll until it's ready for confirmation.
+     * This follows the Rye documented flow: create → poll until awaiting_confirmation.
+     *
+     * After this method completes, you should review the offer (pricing, shipping, taxes)
+     * with the user before calling confirm().
+     *
+     * @example
+     * ```ts
+     * // Phase 1: Create and wait for offer
+     * const intent = await client.checkoutIntents.createAndPoll({
+     *   buyer: {
+     *     address1: '123 Main St',
+     *     city: 'New York',
+     *     country: 'United States',
+     *     email: 'john.doe@example.com',
+     *     firstName: 'John',
+     *     lastName: 'Doe',
+     *     phone: '+1234567890',
+     *     postalCode: '10001',
+     *     province: 'NY',
+     *   },
+     *   productUrl: 'https://example.com/product',
+     *   quantity: 1,
+     * });
+     *
+     * // Review the offer with the user
+     * console.log('Total:', intent.offer.cost.total);
+     *
+     * // Phase 2: Confirm with payment
+     * const completed = await client.checkoutIntents.confirmAndPoll(intent.id, {
+     *   paymentMethod: { type: 'stripe_token', stripeToken: 'tok_visa' }
+     * });
+     * ```
+     */
+    async createAndPoll(body, options) {
+        const intent = await this.create(body, options);
+        return this.pollUntilAwaitingConfirmation(intent.id, options);
+    }
+    /**
+     * A helper to confirm a checkout intent and poll until it reaches a completed state
+     * (completed or failed).
+     *
+     * @example
+     * ```ts
+     * const checkoutIntent = await client.checkoutIntents.confirmAndPoll(
+     *   'id',
+     *   {
+     *     paymentMethod: {
+     *       stripeToken: 'tok_1RkrWWHGDlstla3f1Fc7ZrhH',
+     *       type: 'stripe_token',
+     *     },
+     *   }
+     * );
+     *
+     * if (checkoutIntent.state === 'completed') {
+     *   console.log('Order placed successfully!');
+     * } else if (checkoutIntent.state === 'failed') {
+     *   console.log('Order failed:', checkoutIntent.failureReason);
+     * }
+     * ```
+     */
+    async confirmAndPoll(id, body, options) {
+        const intent = await this.confirm(id, body, options);
+        return this.pollUntilCompleted(intent.id, options);
+    }
+}
+exports.CheckoutIntentsResource = CheckoutIntentsResource;
+//# sourceMappingURL=checkout-intents.js.map

package/resources/checkout-intents.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"checkout-intents.js","sourceRoot":"","sources":["../src/resources/checkout-intents.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,oDAA8C;AAC9C,sDAAgD;AAChD,oDAAmD;AAiBnD,MAAa,uBAAwB,SAAQ,sBAAW;IACtD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CAAC,IAAgC,EAAE,OAAwB;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,4BAA4B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,UAAU,CACR,EAAU,EACV,IAAoC,EACpC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,4BAA4B,EAAE,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,OAAO,CACL,EAAU,EACV,IAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,4BAA4B,EAAE,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;;;;OAWG;IACK,KAAK,CAAC,SAAS,CACrB,EAAU,EACV,SAAkD,EAClD,OAAsC;QAEtC,MAAM,WAAW,GAAG,OAAO,EAAE,WAAW,IAAI,GAAG,CAAC,CAAC,wBAAwB;QACzE,MAAM,cAAc,GAAG,OAAO,EAAE,cAAc,IAAI,IAAI,CAAC,CAAC,qBAAqB;QAC7E,IAAI,QAAQ,GAAG,CAAC,CAAC;QAEjB,MAAM,OAAO,GAAG,IAAA,sBAAY,EAAC;YAC3B,OAAO,EAAE,OAAO;YAChB;gBACE,yBAAyB,EAAE,MAAM;gBACjC,kCAAkC,EAAE,cAAc,CAAC,QAAQ,EAAE;aAC9D;SACF,CAAC,CAAC;QAEH,OAAO,QAAQ,GAAG,WAAW,EAAE,CAAC;YAC9B,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE;gBACzD,GAAG,OAAO;gBACV,OAAO,EAAE,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE;aACpD,CAAC,CAAC,YAAY,EAAE,CAAC;YAElB,4BAA4B;YAC5B,IAAI,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;gBACtB,OAAO,MAAM,CAAC;YAChB,CAAC;YAED,QAAQ,EAAE,CAAC;YAEX,gDAAgD;YAChD,IAAI,QAAQ,IAAI,WAAW,EAAE,CAAC;gBAC5B,MAAM,IAAI,KAAK,CACb,4CAA4C,WAAW,cACrD,CAAC,WAAW,GAAG,cAAc,CAAC,GAAG,IACnC,IAAI,CACL,CAAC;YACJ,CAAC;YAED,8CAA8C;YAC9C,IAAI,aAAa,GAAG,cAAc,CAAC;YACnC,MAAM,cAAc,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;YAC9D,IAAI,cAAc,EAAE,CAAC;gBACnB,MAAM,gBAAgB,GAAG,QAAQ,CAAC,cAAc,CAAC,CAAC;gBAClD,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,EAAE,CAAC;oBAC7B,aAAa,GAAG,gBAAgB,CAAC;gBACnC,CAAC;YACH,CAAC;YAED,MAAM,IAAA,aAAK,EAAC,aAAa,CAAC,CAAC;QAC7B,CAAC;QAED,+EAA+E;QAC/E,MAAM,IAAI,KAAK,CAAC,4CAA4C,WAAW,WAAW,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,kBAAkB,CACtB,EAAU,EACV,OAAsC;QAEtC,OAAO,IAAI,CAAC,SAAS,CACnB,EAAE,EACF,CAAC,MAAM,EAA0F,EAAE,CACjG,MAAM,CAAC,KAAK,KAAK,WAAW,IAAI,MAAM,CAAC,KAAK,KAAK,QAAQ,EAC3D,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,6BAA6B,CACjC,EAAU,EACV,OAAsC;QAEtC,OAAO,IAAI,CAAC,SAAS,CACnB,EAAE,EACF,CACE,MAAM,EAC6F,EAAE,CACrG,MAAM,CAAC,KAAK,KAAK,uBAAuB,IAAI,MAAM,CAAC,KAAK,KAAK,QAAQ,EACvE,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,KAAK,CAAC,aAAa,CACjB,IAAgC,EAChC,OAAsC;QAEtC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAChD,OAAO,IAAI,CAAC,6BAA6B,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,CAAC,cAAc,CAClB,EAAU,EACV,IAAiC,EACjC,OAAsC;QAEtC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QACrD,OAAO,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;CACF;AAtSD,0DAsSC"}