checkout-intents 0.1.0 → 0.3.0

package/resources/checkout-intents.mjs

@@ -0,0 +1,244 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { path } from "../internal/utils/path.mjs";
+import { sleep } from "../internal/utils/sleep.mjs";
+import { buildHeaders } from "../internal/headers.mjs";
+export 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, 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(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(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(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 = 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 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);
+    }
+}
+//# sourceMappingURL=checkout-intents.mjs.map

package/resources/checkout-intents.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"checkout-intents.mjs","sourceRoot":"","sources":["../src/resources/checkout-intents.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,IAAI,EAAE;OACR,EAAE,KAAK,EAAE;OACT,EAAE,YAAY,EAAE;AAiBvB,MAAM,OAAO,uBAAwB,SAAQ,WAAW;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,IAAI,CAAA,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,IAAI,CAAA,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,IAAI,CAAA,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,YAAY,CAAC;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,KAAK,CAAC,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"}

package/resources/index.d.mts

@@ -1,3 +1,3 @@
-export { API } from "./api/api.mjs";
-export { Health, type HealthCheckResponse } from "./health.mjs";
+export { Brands, type BrandRetrieveResponse } from "./brands.mjs";
+export { CheckoutIntentsResource, type BaseCheckoutIntent, type Buyer, type CheckoutIntent, type Money, type Offer, type PaymentMethod, type VariantSelection, type CheckoutIntentCreateParams, type CheckoutIntentAddPaymentParams, type CheckoutIntentConfirmParams, } from "./checkout-intents.mjs";
 //# sourceMappingURL=index.d.mts.map

package/resources/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"OAEO,EAAE,GAAG,EAAE;OACP,EAAE,MAAM,EAAE,KAAK,mBAAmB,EAAE"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"OAEO,EAAE,MAAM,EAAE,KAAK,qBAAqB,EAAE;OACtC,EACL,uBAAuB,EACvB,KAAK,kBAAkB,EACvB,KAAK,KAAK,EACV,KAAK,cAAc,EACnB,KAAK,KAAK,EACV,KAAK,KAAK,EACV,KAAK,aAAa,EAClB,KAAK,gBAAgB,EACrB,KAAK,0BAA0B,EAC/B,KAAK,8BAA8B,EACnC,KAAK,2BAA2B,GACjC"}

package/resources/index.d.ts

@@ -1,3 +1,3 @@
-export { API } from "./api/api.js";
-export { Health, type HealthCheckResponse } from "./health.js";
+export { Brands, type BrandRetrieveResponse } from "./brands.js";
+export { CheckoutIntentsResource, type BaseCheckoutIntent, type Buyer, type CheckoutIntent, type Money, type Offer, type PaymentMethod, type VariantSelection, type CheckoutIntentCreateParams, type CheckoutIntentAddPaymentParams, type CheckoutIntentConfirmParams, } from "./checkout-intents.js";
 //# sourceMappingURL=index.d.ts.map

package/resources/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"OAEO,EAAE,GAAG,EAAE;OACP,EAAE,MAAM,EAAE,KAAK,mBAAmB,EAAE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"OAEO,EAAE,MAAM,EAAE,KAAK,qBAAqB,EAAE;OACtC,EACL,uBAAuB,EACvB,KAAK,kBAAkB,EACvB,KAAK,KAAK,EACV,KAAK,cAAc,EACnB,KAAK,KAAK,EACV,KAAK,KAAK,EACV,KAAK,aAAa,EAClB,KAAK,gBAAgB,EACrB,KAAK,0BAA0B,EAC/B,KAAK,8BAA8B,EACnC,KAAK,2BAA2B,GACjC"}

package/resources/index.js

@@ -1,9 +1,9 @@
 "use strict";
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Health = exports.API = void 0;
-var api_1 = require("./api/api.js");
-Object.defineProperty(exports, "API", { enumerable: true, get: function () { return api_1.API; } });
-var health_1 = require("./health.js");
-Object.defineProperty(exports, "Health", { enumerable: true, get: function () { return health_1.Health; } });
+exports.CheckoutIntentsResource = exports.Brands = void 0;
+var brands_1 = require("./brands.js");
+Object.defineProperty(exports, "Brands", { enumerable: true, get: function () { return brands_1.Brands; } });
+var checkout_intents_1 = require("./checkout-intents.js");
+Object.defineProperty(exports, "CheckoutIntentsResource", { enumerable: true, get: function () { return checkout_intents_1.CheckoutIntentsResource; } });
 //# sourceMappingURL=index.js.map

package/resources/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,oCAAgC;AAAvB,0FAAA,GAAG,OAAA;AACZ,sCAA4D;AAAnD,gGAAA,MAAM,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,sCAA8D;AAArD,gGAAA,MAAM,OAAA;AACf,0DAY4B;AAX1B,2HAAA,uBAAuB,OAAA"}

package/resources/index.mjs

@@ -1,4 +1,4 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-export { API } from "./api/api.mjs";
-export { Health } from "./health.mjs";
+export { Brands } from "./brands.mjs";
+export { CheckoutIntentsResource, } from "./checkout-intents.mjs";
 //# sourceMappingURL=index.mjs.map

package/resources/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,GAAG,EAAE;OACP,EAAE,MAAM,EAA4B"}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,MAAM,EAA8B;OACtC,EACL,uBAAuB,GAWxB"}

package/src/client.ts

@@ -16,8 +16,20 @@ import * as Errors from './core/error';
 import * as Uploads from './core/uploads';
 import * as API from './resources/index';
 import { APIPromise } from './core/api-promise';
-import { Health, HealthCheckResponse } from './resources/health';
-import { API as ApiapiAPI } from './resources/api/api';
+import { BrandRetrieveResponse, Brands } from './resources/brands';
+import {
+  BaseCheckoutIntent,
+  Buyer,
+  CheckoutIntent,
+  CheckoutIntentAddPaymentParams,
+  CheckoutIntentConfirmParams,
+  CheckoutIntentCreateParams,
+  CheckoutIntentsResource,
+  Money,
+  Offer,
+  PaymentMethod,
+  VariantSelection,
+} from './resources/checkout-intents';
 import { type Fetch } from './internal/builtin-types';
 import { HeadersLike, NullableHeaders, buildHeaders } from './internal/headers';
 import { FinalRequestOptions, RequestOptions } from './internal/request-options';
@@ -31,12 +43,38 @@ import {
 } from './internal/utils/log';
 import { isEmptyObj } from './internal/utils/values';
 
+const environments = {
+  staging: 'https://staging.api.rye.com/',
+  production: 'https://api.rye.com/',
+};
+type Environment = keyof typeof environments;
+
+/**
+ * Extracts the environment from a Rye API key.
+ * API keys follow the format: RYE/{environment}-{key}
+ * @param apiKey - The API key to parse
+ * @returns The extracted environment ('staging' or 'production'), or null if the format doesn't match
+ */
+function extractEnvironmentFromApiKey(apiKey: string): Environment | null {
+  const match = apiKey.match(/^RYE\/(staging|production)-/);
+  return match ? (match[1] as Environment) : null;
+}
+
 export interface ClientOptions {
   /**
-   * Rye API key. Format: `Bearer <RYE_API_KEY>`
+   * Rye API key. Format: `RYE/{environment}-abcdef`
    */
   apiKey?: string | undefined;
 
+  /**
+   * Specifies the environment to use for the API.
+   *
+   * Each environment maps to a different base URL:
+   * - `staging` corresponds to `https://staging.api.rye.com/`
+   * - `production` corresponds to `https://api.rye.com/`
+   */
+  environment?: Environment | undefined;
+
   /**
    * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
    *
@@ -128,6 +166,7 @@ export class CheckoutIntents {
    * API Client for interfacing with the Checkout Intents API.
    *
    * @param {string | undefined} [opts.apiKey=process.env['CHECKOUT_INTENTS_API_KEY'] ?? undefined]
+   * @param {Environment} [opts.environment=staging] - Specifies the environment URL to use for the API.
    * @param {string} [opts.baseURL=process.env['CHECKOUT_INTENTS_BASE_URL'] ?? https://staging.api.rye.com/] - Override the default base URL for the API.
    * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
    * @param {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls.
@@ -147,13 +186,31 @@ export class CheckoutIntents {
       );
     }
 
+    // Auto-infer environment from API key
+    const inferredEnvironment = extractEnvironmentFromApiKey(apiKey);
+
+    // Validate environment option matches API key (if both provided)
+    if (opts.environment && inferredEnvironment && opts.environment !== inferredEnvironment) {
+      throw new Errors.CheckoutIntentsError(
+        `Environment mismatch: API key is for '${inferredEnvironment}' environment but 'environment' option is set to '${opts.environment}'. Please use an API key that matches your desired environment or omit the 'environment' option to auto-detect from the API key (only auto-detectable with the RYE/{environment}-abcdef api key format).`,
+      );
+    }
+
     const options: ClientOptions = {
       apiKey,
       ...opts,
-      baseURL: baseURL || `https://staging.api.rye.com/`,
+      baseURL,
+      // Use provided environment, or infer from API key, or default to staging
+      environment: opts.environment ?? inferredEnvironment ?? 'staging',
     };
 
-    this.baseURL = options.baseURL!;
+    if (baseURL && opts.environment) {
+      throw new Errors.CheckoutIntentsError(
+        'Ambiguous URL; The `baseURL` option (or CHECKOUT_INTENTS_BASE_URL env var) and the `environment` option are given. If you want to use the environment you must pass baseURL: null',
+      );
+    }
+
+    this.baseURL = options.baseURL || environments[options.environment || 'staging'];
     this.timeout = options.timeout ?? CheckoutIntents.DEFAULT_TIMEOUT /* 1 minute */;
     this.logger = options.logger ?? console;
     const defaultLogLevel = 'warn';
@@ -179,7 +236,8 @@ export class CheckoutIntents {
   withOptions(options: Partial<ClientOptions>): this {
     const client = new (this.constructor as any as new (props: ClientOptions) => typeof this)({
       ...this._options,
-      baseURL: this.baseURL,
+      environment: options.environment ? options.environment : undefined,
+      baseURL: options.environment ? undefined : this.baseURL,
       maxRetries: this.maxRetries,
       timeout: this.timeout,
       logger: this.logger,
@@ -196,7 +254,7 @@ export class CheckoutIntents {
    * Check whether the base URL is set to its default.
    */
   #baseURLOverridden(): boolean {
-    return this.baseURL !== 'https://staging.api.rye.com/';
+    return this.baseURL !== environments[this._options.environment || 'staging'];
   }
 
   protected defaultQuery(): Record<string, string | undefined> | undefined {
@@ -715,17 +773,29 @@ export class CheckoutIntents {
 
   static toFile = Uploads.toFile;
 
-  health: API.Health = new API.Health(this);
-  api: API.API = new API.API(this);
+  checkoutIntents: API.CheckoutIntentsResource = new API.CheckoutIntentsResource(this);
+  brands: API.Brands = new API.Brands(this);
 }
 
-CheckoutIntents.Health = Health;
-CheckoutIntents.API = ApiapiAPI;
+CheckoutIntents.CheckoutIntentsResource = CheckoutIntentsResource;
+CheckoutIntents.Brands = Brands;
 
 export declare namespace CheckoutIntents {
   export type RequestOptions = Opts.RequestOptions;
 
-  export { Health as Health, type HealthCheckResponse as HealthCheckResponse };
-
-  export { ApiapiAPI as API };
+  export {
+    CheckoutIntentsResource as CheckoutIntentsResource,
+    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 VariantSelection as VariantSelection,
+    type CheckoutIntentCreateParams as CheckoutIntentCreateParams,
+    type CheckoutIntentAddPaymentParams as CheckoutIntentAddPaymentParams,
+    type CheckoutIntentConfirmParams as CheckoutIntentConfirmParams,
+  };
+
+  export { Brands as Brands, type BrandRetrieveResponse as BrandRetrieveResponse };
 }

package/src/internal/to-file.ts

@@ -73,7 +73,7 @@ export type ToFileInput =
 
 /**
  * Helper for creating a {@link File} to pass to an SDK upload method from a variety of different data formats
- * @param value the raw content of the file.  Can be an {@link Uploadable}, {@link BlobLikePart}, or {@link AsyncIterable} of {@link BlobLikePart}s
+ * @param value the raw content of the file. Can be an {@link Uploadable}, BlobLikePart, or AsyncIterable of BlobLikeParts
  * @param {string=} name the name of the file. If omitted, toFile will try to determine a file name from bits if possible
  * @param {Object=} options additional properties
  * @param {string=} options.type the MIME type of the content

package/src/internal/utils/values.ts

@@ -76,21 +76,21 @@ export const coerceBoolean = (value: unknown): boolean => {
 };
 
 export const maybeCoerceInteger = (value: unknown): number | undefined => {
-  if (value === undefined) {
+  if (value == null) {
     return undefined;
   }
   return coerceInteger(value);
 };
 
 export const maybeCoerceFloat = (value: unknown): number | undefined => {
-  if (value === undefined) {
+  if (value == null) {
     return undefined;
   }
   return coerceFloat(value);
 };
 
 export const maybeCoerceBoolean = (value: unknown): boolean | undefined => {
-  if (value === undefined) {
+  if (value == null) {
     return undefined;
   }
   return coerceBoolean(value);

package/src/resources/{api/v1/brands.ts → brands.ts}

@@ -1,23 +1,23 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../../core/resource';
-import { APIPromise } from '../../../core/api-promise';
-import { RequestOptions } from '../../../internal/request-options';
-import { path } from '../../../internal/utils/path';
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
 
 export class Brands extends APIResource {
   /**
    * Retrieve brand information by domain name
    *
-   * Look up a brand by its domain name (e.g. "aloyoga.com"). Returns brand
-   * information including the marketplace type if the lookup succeeds.
+   * Look up a brand by its domain name (e.g. "aloyoga.com" or "www.amazon.com").
+   * Returns brand information including the marketplace type if the lookup succeeds.
    */
-  retrieveByDomain(domain: string, options?: RequestOptions): APIPromise<BrandRetrieveByDomainResponse> {
+  retrieve(domain: string, options?: RequestOptions): APIPromise<BrandRetrieveResponse> {
     return this._client.get(path`/api/v1/brands/domain/${domain}`, options);
   }
 }
 
-export interface BrandRetrieveByDomainResponse {
+export interface BrandRetrieveResponse {
   /**
    * A unique identifier for the brand.
    */
@@ -36,5 +36,5 @@ export interface BrandRetrieveByDomainResponse {
 }
 
 export declare namespace Brands {
-  export { type BrandRetrieveByDomainResponse as BrandRetrieveByDomainResponse };
+  export { type BrandRetrieveResponse as BrandRetrieveResponse };
 }