@usehercules/sdk 1.11.0 → 1.12.1

package/resources/{beta/commerce → commerce}/commerce.d.mts

@@ -1,23 +1,37 @@
-import { APIResource } from "../../../core/resource.mjs";
+import { APIResource } from "../../core/resource.mjs";
 import * as CouponsAPI from "./coupons.mjs";
 import { Coupon, CouponCreateParams, CouponListParams, CouponUpdateParams, Coupons, CouponsCursorIDPage } from "./coupons.mjs";
-import * as CustomersAPI from "./customers.mjs";
-import { Customer, CustomerAddress, CustomerBillingPortalParams, CustomerBillingPortalResponse, CustomerCreateParams, CustomerGetResponse, CustomerListParams, CustomerUpdateParams, Customers, CustomersCursorIDPage } from "./customers.mjs";
 import * as FeaturesAPI from "./features.mjs";
 import { Feature, FeatureCreateParams, FeatureListParams, FeatureUpdateParams, Features, FeaturesCursorIDPage } from "./features.mjs";
+import * as SubscriptionGroupsAPI from "./subscription-groups.mjs";
+import { SubscriptionGroups } from "./subscription-groups.mjs";
+import * as CustomersAPI from "./customers/customers.mjs";
+import { Customer, CustomerAddress, CustomerBillingPortalParams, CustomerBillingPortalResponse, CustomerCreateParams, CustomerGetResponse, CustomerListParams, CustomerUpdateParams, Customers, CustomersCursorIDPage } from "./customers/customers.mjs";
 import * as ProductsAPI from "./products/products.mjs";
 import { Product, ProductCreateParams, ProductListParams, ProductUpdateParams, Products, ProductsCursorIDPage } from "./products/products.mjs";
-import { APIPromise } from "../../../core/api-promise.mjs";
-import { RequestOptions } from "../../../internal/request-options.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+/**
+ * Commerce APIs are currently in beta.
+ */
 export declare class Commerce extends APIResource {
     customers: CustomersAPI.Customers;
     products: ProductsAPI.Products;
     coupons: CouponsAPI.Coupons;
     features: FeaturesAPI.Features;
+    subscriptionGroups: SubscriptionGroupsAPI.SubscriptionGroups;
     /**
      * Cancels a customer's subscription. By default, the subscription remains active
      * until the end of the current billing period. Set cancellation_timing to
      * 'immediate' to cancel immediately.
+     *
+     * @example
+     * ```ts
+     * const response = await client.commerce.cancel({
+     *   customer_id: 'cus_1234567890',
+     *   subscription_id: 'sub_1234567890',
+     * });
+     * ```
      */
     cancel(body: CommerceCancelParams, options?: RequestOptions): APIPromise<CommerceCancelResponse>;
     /**
@@ -25,12 +39,29 @@ export declare class Commerce extends APIResource {
      * features in your app based on the customer's active subscription and the
      * entitlements attached to their product. Hercules recommends calling this before
      * allowing access to premium features.
+     *
+     * @example
+     * ```ts
+     * const response = await client.commerce.check({
+     *   customer_id: 'cus_1234567890',
+     *   resource_id: 'feat_1234567890',
+     * });
+     * ```
      */
     check(body: CommerceCheckParams, options?: RequestOptions): APIPromise<CommerceCheckResponse>;
     /**
      * Creates a checkout session for a customer to subscribe to a product. Returns a
      * URL to redirect the customer to for payment. After successful payment, the
      * customer is subscribed to the product and gains access to its entitlements.
+     *
+     * @example
+     * ```ts
+     * const response = await client.commerce.checkout({
+     *   customer_id: 'cus_1234567890',
+     *   line_items: [{ variant_id: 'var_1234567890' }],
+     *   success_url: 'https://example.com',
+     * });
+     * ```
      */
     checkout(body: CommerceCheckoutParams, options?: RequestOptions): APIPromise<CommerceCheckoutResponse>;
 }
@@ -56,23 +87,13 @@ export interface CommerceCancelResponse {
     canceled_at?: string | null;
 }
 /**
- * Check resource access response. Indicates whether access is granted and through
- * what means.
+ * Check resource access response.
  */
 export interface CommerceCheckResponse {
-    /**
-     * How the customer has access: through a subscription, one-time purchase, manual
-     * grant, or no access
-     */
-    access_type: 'subscription' | 'one_time_purchase' | 'manual_grant' | 'none';
     /**
      * Whether the customer has access to the resource
      */
     has_access: boolean;
-    /**
-     * The resource ID that was checked
-     */
-    resource_id: string;
 }
 /**
  * Checkout response. For new customers, returns a checkout URL. For existing
@@ -165,11 +186,6 @@ export interface CommerceCheckoutParams {
      * URL to redirect on success
      */
     success_url: string;
-    /**
-     * Optional custom ID for the subscription or payment. If not provided, one will be
-     * generated.
-     */
-    id?: string;
     /**
      * URL to redirect on cancel
      */
@@ -222,5 +238,6 @@ export declare namespace Commerce {
     export { Products as Products, type Product as Product, type ProductsCursorIDPage as ProductsCursorIDPage, type ProductCreateParams as ProductCreateParams, type ProductUpdateParams as ProductUpdateParams, type ProductListParams as ProductListParams, };
     export { Coupons as Coupons, type Coupon as Coupon, type CouponsCursorIDPage as CouponsCursorIDPage, type CouponCreateParams as CouponCreateParams, type CouponUpdateParams as CouponUpdateParams, type CouponListParams as CouponListParams, };
     export { Features as Features, type Feature as Feature, type FeaturesCursorIDPage as FeaturesCursorIDPage, type FeatureCreateParams as FeatureCreateParams, type FeatureUpdateParams as FeatureUpdateParams, type FeatureListParams as FeatureListParams, };
+    export { SubscriptionGroups as SubscriptionGroups };
 }
 //# sourceMappingURL=commerce.d.mts.map

package/resources/commerce/commerce.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"commerce.d.mts","sourceRoot":"","sources":["../../src/resources/commerce/commerce.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EACL,MAAM,EACN,kBAAkB,EAClB,gBAAgB,EAChB,kBAAkB,EAClB,OAAO,EACP,mBAAmB,EACpB;OACM,KAAK,WAAW;OAChB,EACL,OAAO,EACP,mBAAmB,EACnB,iBAAiB,EACjB,mBAAmB,EACnB,QAAQ,EACR,oBAAoB,EACrB;OACM,KAAK,qBAAqB;OAC1B,EAAE,kBAAkB,EAAE;OACtB,KAAK,YAAY;OACjB,EACL,QAAQ,EACR,eAAe,EACf,2BAA2B,EAC3B,6BAA6B,EAC7B,oBAAoB,EACpB,mBAAmB,EACnB,kBAAkB,EAClB,oBAAoB,EACpB,SAAS,EACT,qBAAqB,EACtB;OACM,KAAK,WAAW;OAChB,EACL,OAAO,EACP,mBAAmB,EACnB,iBAAiB,EACjB,mBAAmB,EACnB,QAAQ,EACR,oBAAoB,EACrB;OACM,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC,SAAS,EAAE,YAAY,CAAC,SAAS,CAA4C;IAC7E,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IACnE,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,kBAAkB,EAAE,qBAAqB,CAAC,kBAAkB,CAE1D;IAEF;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIhG;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI7F;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAGvG;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,mBAAmB,EAAE,WAAW,GAAG,uBAAuB,CAAC;IAE3D;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,MAAM,EAAE,UAAU,GAAG,QAAQ,CAAC;IAE9B;;;OAGG;IACH,IAAI,CAAC,EAAE,cAAc,GAAG,SAAS,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,YAAY,CAAC,EAAE,wBAAwB,CAAC,YAAY,GAAG,IAAI,CAAC;IAE5D;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,mBAAmB,CAAC,EAAE,WAAW,GAAG,uBAAuB,CAAC;CAC7D;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,sBAAsB,CAAC,QAAQ,CAAC,CAAC;IAEnD;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,aAAa,CAAC,EAAE,WAAW,GAAG,eAAe,CAAC;IAE9C;;;OAGG;IACH,2BAA2B,CAAC,EAAE,WAAW,GAAG,eAAe,CAAC;IAE5D;;;OAGG;IACH,uBAAuB,CAAC,EAAE,WAAW,GAAG,eAAe,CAAC;IAExD;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,iBAAiB,CAAC;CAC7D;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,QAAQ;QACvB;;;WAGG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;CACF;AAQD,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;IAEF,OAAO,EACL,SAAS,IAAI,SAAS,EACtB,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EAAE,kBAAkB,IAAI,kBAAkB,EAAE,CAAC;CACrD"}

package/resources/{beta/commerce → commerce}/commerce.d.ts

@@ -1,23 +1,37 @@
-import { APIResource } from "../../../core/resource.js";
+import { APIResource } from "../../core/resource.js";
 import * as CouponsAPI from "./coupons.js";
 import { Coupon, CouponCreateParams, CouponListParams, CouponUpdateParams, Coupons, CouponsCursorIDPage } from "./coupons.js";
-import * as CustomersAPI from "./customers.js";
-import { Customer, CustomerAddress, CustomerBillingPortalParams, CustomerBillingPortalResponse, CustomerCreateParams, CustomerGetResponse, CustomerListParams, CustomerUpdateParams, Customers, CustomersCursorIDPage } from "./customers.js";
 import * as FeaturesAPI from "./features.js";
 import { Feature, FeatureCreateParams, FeatureListParams, FeatureUpdateParams, Features, FeaturesCursorIDPage } from "./features.js";
+import * as SubscriptionGroupsAPI from "./subscription-groups.js";
+import { SubscriptionGroups } from "./subscription-groups.js";
+import * as CustomersAPI from "./customers/customers.js";
+import { Customer, CustomerAddress, CustomerBillingPortalParams, CustomerBillingPortalResponse, CustomerCreateParams, CustomerGetResponse, CustomerListParams, CustomerUpdateParams, Customers, CustomersCursorIDPage } from "./customers/customers.js";
 import * as ProductsAPI from "./products/products.js";
 import { Product, ProductCreateParams, ProductListParams, ProductUpdateParams, Products, ProductsCursorIDPage } from "./products/products.js";
-import { APIPromise } from "../../../core/api-promise.js";
-import { RequestOptions } from "../../../internal/request-options.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+/**
+ * Commerce APIs are currently in beta.
+ */
 export declare class Commerce extends APIResource {
     customers: CustomersAPI.Customers;
     products: ProductsAPI.Products;
     coupons: CouponsAPI.Coupons;
     features: FeaturesAPI.Features;
+    subscriptionGroups: SubscriptionGroupsAPI.SubscriptionGroups;
     /**
      * Cancels a customer's subscription. By default, the subscription remains active
      * until the end of the current billing period. Set cancellation_timing to
      * 'immediate' to cancel immediately.
+     *
+     * @example
+     * ```ts
+     * const response = await client.commerce.cancel({
+     *   customer_id: 'cus_1234567890',
+     *   subscription_id: 'sub_1234567890',
+     * });
+     * ```
      */
     cancel(body: CommerceCancelParams, options?: RequestOptions): APIPromise<CommerceCancelResponse>;
     /**
@@ -25,12 +39,29 @@ export declare class Commerce extends APIResource {
      * features in your app based on the customer's active subscription and the
      * entitlements attached to their product. Hercules recommends calling this before
      * allowing access to premium features.
+     *
+     * @example
+     * ```ts
+     * const response = await client.commerce.check({
+     *   customer_id: 'cus_1234567890',
+     *   resource_id: 'feat_1234567890',
+     * });
+     * ```
      */
     check(body: CommerceCheckParams, options?: RequestOptions): APIPromise<CommerceCheckResponse>;
     /**
      * Creates a checkout session for a customer to subscribe to a product. Returns a
      * URL to redirect the customer to for payment. After successful payment, the
      * customer is subscribed to the product and gains access to its entitlements.
+     *
+     * @example
+     * ```ts
+     * const response = await client.commerce.checkout({
+     *   customer_id: 'cus_1234567890',
+     *   line_items: [{ variant_id: 'var_1234567890' }],
+     *   success_url: 'https://example.com',
+     * });
+     * ```
      */
     checkout(body: CommerceCheckoutParams, options?: RequestOptions): APIPromise<CommerceCheckoutResponse>;
 }
@@ -56,23 +87,13 @@ export interface CommerceCancelResponse {
     canceled_at?: string | null;
 }
 /**
- * Check resource access response. Indicates whether access is granted and through
- * what means.
+ * Check resource access response.
  */
 export interface CommerceCheckResponse {
-    /**
-     * How the customer has access: through a subscription, one-time purchase, manual
-     * grant, or no access
-     */
-    access_type: 'subscription' | 'one_time_purchase' | 'manual_grant' | 'none';
     /**
      * Whether the customer has access to the resource
      */
     has_access: boolean;
-    /**
-     * The resource ID that was checked
-     */
-    resource_id: string;
 }
 /**
  * Checkout response. For new customers, returns a checkout URL. For existing
@@ -165,11 +186,6 @@ export interface CommerceCheckoutParams {
      * URL to redirect on success
      */
     success_url: string;
-    /**
-     * Optional custom ID for the subscription or payment. If not provided, one will be
-     * generated.
-     */
-    id?: string;
     /**
      * URL to redirect on cancel
      */
@@ -222,5 +238,6 @@ export declare namespace Commerce {
     export { Products as Products, type Product as Product, type ProductsCursorIDPage as ProductsCursorIDPage, type ProductCreateParams as ProductCreateParams, type ProductUpdateParams as ProductUpdateParams, type ProductListParams as ProductListParams, };
     export { Coupons as Coupons, type Coupon as Coupon, type CouponsCursorIDPage as CouponsCursorIDPage, type CouponCreateParams as CouponCreateParams, type CouponUpdateParams as CouponUpdateParams, type CouponListParams as CouponListParams, };
     export { Features as Features, type Feature as Feature, type FeaturesCursorIDPage as FeaturesCursorIDPage, type FeatureCreateParams as FeatureCreateParams, type FeatureUpdateParams as FeatureUpdateParams, type FeatureListParams as FeatureListParams, };
+    export { SubscriptionGroups as SubscriptionGroups };
 }
 //# sourceMappingURL=commerce.d.ts.map

package/resources/commerce/commerce.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"commerce.d.ts","sourceRoot":"","sources":["../../src/resources/commerce/commerce.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EACL,MAAM,EACN,kBAAkB,EAClB,gBAAgB,EAChB,kBAAkB,EAClB,OAAO,EACP,mBAAmB,EACpB;OACM,KAAK,WAAW;OAChB,EACL,OAAO,EACP,mBAAmB,EACnB,iBAAiB,EACjB,mBAAmB,EACnB,QAAQ,EACR,oBAAoB,EACrB;OACM,KAAK,qBAAqB;OAC1B,EAAE,kBAAkB,EAAE;OACtB,KAAK,YAAY;OACjB,EACL,QAAQ,EACR,eAAe,EACf,2BAA2B,EAC3B,6BAA6B,EAC7B,oBAAoB,EACpB,mBAAmB,EACnB,kBAAkB,EAClB,oBAAoB,EACpB,SAAS,EACT,qBAAqB,EACtB;OACM,KAAK,WAAW;OAChB,EACL,OAAO,EACP,mBAAmB,EACnB,iBAAiB,EACjB,mBAAmB,EACnB,QAAQ,EACR,oBAAoB,EACrB;OACM,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC,SAAS,EAAE,YAAY,CAAC,SAAS,CAA4C;IAC7E,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IACnE,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,kBAAkB,EAAE,qBAAqB,CAAC,kBAAkB,CAE1D;IAEF;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIhG;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI7F;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAGvG;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,mBAAmB,EAAE,WAAW,GAAG,uBAAuB,CAAC;IAE3D;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,MAAM,EAAE,UAAU,GAAG,QAAQ,CAAC;IAE9B;;;OAGG;IACH,IAAI,CAAC,EAAE,cAAc,GAAG,SAAS,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,YAAY,CAAC,EAAE,wBAAwB,CAAC,YAAY,GAAG,IAAI,CAAC;IAE5D;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,mBAAmB,CAAC,EAAE,WAAW,GAAG,uBAAuB,CAAC;CAC7D;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,sBAAsB,CAAC,QAAQ,CAAC,CAAC;IAEnD;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,aAAa,CAAC,EAAE,WAAW,GAAG,eAAe,CAAC;IAE9C;;;OAGG;IACH,2BAA2B,CAAC,EAAE,WAAW,GAAG,eAAe,CAAC;IAE5D;;;OAGG;IACH,uBAAuB,CAAC,EAAE,WAAW,GAAG,eAAe,CAAC;IAExD;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,iBAAiB,CAAC;CAC7D;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,QAAQ;QACvB;;;WAGG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;CACF;AAQD,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;IAEF,OAAO,EACL,SAAS,IAAI,SAAS,EACtB,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EAAE,kBAAkB,IAAI,kBAAkB,EAAE,CAAC;CACrD"}

package/resources/{beta/commerce → commerce}/commerce.js

@@ -2,16 +2,21 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Commerce = void 0;
-const tslib_1 = require("../../../internal/tslib.js");
-const resource_1 = require("../../../core/resource.js");
+const tslib_1 = require("../../internal/tslib.js");
+const resource_1 = require("../../core/resource.js");
 const CouponsAPI = tslib_1.__importStar(require("./coupons.js"));
 const coupons_1 = require("./coupons.js");
-const CustomersAPI = tslib_1.__importStar(require("./customers.js"));
-const customers_1 = require("./customers.js");
 const FeaturesAPI = tslib_1.__importStar(require("./features.js"));
 const features_1 = require("./features.js");
+const SubscriptionGroupsAPI = tslib_1.__importStar(require("./subscription-groups.js"));
+const subscription_groups_1 = require("./subscription-groups.js");
+const CustomersAPI = tslib_1.__importStar(require("./customers/customers.js"));
+const customers_1 = require("./customers/customers.js");
 const ProductsAPI = tslib_1.__importStar(require("./products/products.js"));
 const products_1 = require("./products/products.js");
+/**
+ * Commerce APIs are currently in beta.
+ */
 class Commerce extends resource_1.APIResource {
     constructor() {
         super(...arguments);
@@ -19,11 +24,20 @@ class Commerce extends resource_1.APIResource {
         this.products = new ProductsAPI.Products(this._client);
         this.coupons = new CouponsAPI.Coupons(this._client);
         this.features = new FeaturesAPI.Features(this._client);
+        this.subscriptionGroups = new SubscriptionGroupsAPI.SubscriptionGroups(this._client);
     }
     /**
      * Cancels a customer's subscription. By default, the subscription remains active
      * until the end of the current billing period. Set cancellation_timing to
      * 'immediate' to cancel immediately.
+     *
+     * @example
+     * ```ts
+     * const response = await client.commerce.cancel({
+     *   customer_id: 'cus_1234567890',
+     *   subscription_id: 'sub_1234567890',
+     * });
+     * ```
      */
     cancel(body, options) {
         return this._client.post('/v1/commerce/cancel', { body, ...options });
@@ -33,6 +47,14 @@ class Commerce extends resource_1.APIResource {
      * features in your app based on the customer's active subscription and the
      * entitlements attached to their product. Hercules recommends calling this before
      * allowing access to premium features.
+     *
+     * @example
+     * ```ts
+     * const response = await client.commerce.check({
+     *   customer_id: 'cus_1234567890',
+     *   resource_id: 'feat_1234567890',
+     * });
+     * ```
      */
     check(body, options) {
         return this._client.post('/v1/commerce/check', { body, ...options });
@@ -41,6 +63,15 @@ class Commerce extends resource_1.APIResource {
      * Creates a checkout session for a customer to subscribe to a product. Returns a
      * URL to redirect the customer to for payment. After successful payment, the
      * customer is subscribed to the product and gains access to its entitlements.
+     *
+     * @example
+     * ```ts
+     * const response = await client.commerce.checkout({
+     *   customer_id: 'cus_1234567890',
+     *   line_items: [{ variant_id: 'var_1234567890' }],
+     *   success_url: 'https://example.com',
+     * });
+     * ```
      */
     checkout(body, options) {
         return this._client.post('/v1/commerce/checkout', { body, ...options });
@@ -51,4 +82,5 @@ Commerce.Customers = customers_1.Customers;
 Commerce.Products = products_1.Products;
 Commerce.Coupons = coupons_1.Coupons;
 Commerce.Features = features_1.Features;
+Commerce.SubscriptionGroups = subscription_groups_1.SubscriptionGroups;
 //# sourceMappingURL=commerce.js.map

package/resources/commerce/commerce.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"commerce.js","sourceRoot":"","sources":["../../src/resources/commerce/commerce.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,iEAAwC;AACxC,0CAOmB;AACnB,mEAA0C;AAC1C,4CAOoB;AACpB,wFAA+D;AAC/D,kEAA2D;AAC3D,+EAAsD;AACtD,wDAW+B;AAC/B,4EAAmD;AACnD,qDAO6B;AAI7B;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IAAzC;;QACE,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,uBAAkB,GAA6C,IAAI,qBAAqB,CAAC,kBAAkB,CACzG,IAAI,CAAC,OAAO,CACb,CAAC;IAsDJ,CAAC;IApDC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,IAAyB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,IAA4B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;CACF;AA7DD,4BA6DC;AAuMD,QAAQ,CAAC,SAAS,GAAG,qBAAS,CAAC;AAC/B,QAAQ,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AAC7B,QAAQ,CAAC,OAAO,GAAG,iBAAO,CAAC;AAC3B,QAAQ,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AAC7B,QAAQ,CAAC,kBAAkB,GAAG,wCAAkB,CAAC"}

package/resources/{beta/commerce → commerce}/commerce.mjs

@@ -1,13 +1,18 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-import { APIResource } from "../../../core/resource.mjs";
+import { APIResource } from "../../core/resource.mjs";
 import * as CouponsAPI from "./coupons.mjs";
 import { Coupons, } from "./coupons.mjs";
-import * as CustomersAPI from "./customers.mjs";
-import { Customers, } from "./customers.mjs";
 import * as FeaturesAPI from "./features.mjs";
 import { Features, } from "./features.mjs";
+import * as SubscriptionGroupsAPI from "./subscription-groups.mjs";
+import { SubscriptionGroups } from "./subscription-groups.mjs";
+import * as CustomersAPI from "./customers/customers.mjs";
+import { Customers, } from "./customers/customers.mjs";
 import * as ProductsAPI from "./products/products.mjs";
 import { Products, } from "./products/products.mjs";
+/**
+ * Commerce APIs are currently in beta.
+ */
 export class Commerce extends APIResource {
     constructor() {
         super(...arguments);
@@ -15,11 +20,20 @@ export class Commerce extends APIResource {
         this.products = new ProductsAPI.Products(this._client);
         this.coupons = new CouponsAPI.Coupons(this._client);
         this.features = new FeaturesAPI.Features(this._client);
+        this.subscriptionGroups = new SubscriptionGroupsAPI.SubscriptionGroups(this._client);
     }
     /**
      * Cancels a customer's subscription. By default, the subscription remains active
      * until the end of the current billing period. Set cancellation_timing to
      * 'immediate' to cancel immediately.
+     *
+     * @example
+     * ```ts
+     * const response = await client.commerce.cancel({
+     *   customer_id: 'cus_1234567890',
+     *   subscription_id: 'sub_1234567890',
+     * });
+     * ```
      */
     cancel(body, options) {
         return this._client.post('/v1/commerce/cancel', { body, ...options });
@@ -29,6 +43,14 @@ export class Commerce extends APIResource {
      * features in your app based on the customer's active subscription and the
      * entitlements attached to their product. Hercules recommends calling this before
      * allowing access to premium features.
+     *
+     * @example
+     * ```ts
+     * const response = await client.commerce.check({
+     *   customer_id: 'cus_1234567890',
+     *   resource_id: 'feat_1234567890',
+     * });
+     * ```
      */
     check(body, options) {
         return this._client.post('/v1/commerce/check', { body, ...options });
@@ -37,6 +59,15 @@ export class Commerce extends APIResource {
      * Creates a checkout session for a customer to subscribe to a product. Returns a
      * URL to redirect the customer to for payment. After successful payment, the
      * customer is subscribed to the product and gains access to its entitlements.
+     *
+     * @example
+     * ```ts
+     * const response = await client.commerce.checkout({
+     *   customer_id: 'cus_1234567890',
+     *   line_items: [{ variant_id: 'var_1234567890' }],
+     *   success_url: 'https://example.com',
+     * });
+     * ```
      */
     checkout(body, options) {
         return this._client.post('/v1/commerce/checkout', { body, ...options });
@@ -46,4 +77,5 @@ Commerce.Customers = Customers;
 Commerce.Products = Products;
 Commerce.Coupons = Coupons;
 Commerce.Features = Features;
+Commerce.SubscriptionGroups = SubscriptionGroups;
 //# sourceMappingURL=commerce.mjs.map

package/resources/commerce/commerce.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"commerce.mjs","sourceRoot":"","sources":["../../src/resources/commerce/commerce.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EAKL,OAAO,GAER;OACM,KAAK,WAAW;OAChB,EAKL,QAAQ,GAET;OACM,KAAK,qBAAqB;OAC1B,EAAE,kBAAkB,EAAE;OACtB,KAAK,YAAY;OACjB,EASL,SAAS,GAEV;OACM,KAAK,WAAW;OAChB,EAKL,QAAQ,GAET;AAID;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IAAzC;;QACE,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,uBAAkB,GAA6C,IAAI,qBAAqB,CAAC,kBAAkB,CACzG,IAAI,CAAC,OAAO,CACb,CAAC;IAsDJ,CAAC;IApDC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,IAAyB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,IAA4B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;CACF;AAuMD,QAAQ,CAAC,SAAS,GAAG,SAAS,CAAC;AAC/B,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAC;AAC7B,QAAQ,CAAC,OAAO,GAAG,OAAO,CAAC;AAC3B,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAC;AAC7B,QAAQ,CAAC,kBAAkB,GAAG,kBAAkB,CAAC"}

package/resources/{beta/commerce → commerce}/coupons.d.mts

@@ -1,32 +1,56 @@
-import { APIResource } from "../../../core/resource.mjs";
-import { APIPromise } from "../../../core/api-promise.mjs";
-import { CursorIDPage, type CursorIDPageParams, PagePromise } from "../../../core/pagination.mjs";
-import { RequestOptions } from "../../../internal/request-options.mjs";
+import { APIResource } from "../../core/resource.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { CursorIDPage, type CursorIDPageParams, PagePromise } from "../../core/pagination.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
 export declare class Coupons extends APIResource {
     /**
      * Creates a discount coupon with a promo code. Coupons can offer percentage or
      * fixed-amount discounts and can be limited by redemption count or expiration
      * date. Customers can apply coupons during checkout.
+     *
+     * @example
+     * ```ts
+     * const coupon = await client.commerce.coupons.create({
+     *   code: 'LAUNCH20',
+     * });
+     * ```
      */
     create(body: CouponCreateParams, options?: RequestOptions): APIPromise<Coupon>;
     /**
      * Updates an existing coupon. Use this to modify the display name or deactivate
      * the coupon. Discount amounts and codes cannot be changed after creation.
+     *
+     * @example
+     * ```ts
+     * const coupon = await client.commerce.coupons.update(
+     *   'coupon_1234567890',
+     * );
+     * ```
      */
     update(couponID: string, body?: CouponUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Coupon>;
     /**
      * Retrieves a paginated list of all coupons. Coupons provide discounts that
      * customers can apply during checkout using a promo code.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const coupon of client.commerce.coupons.list()) {
+     *   // ...
+     * }
+     * ```
      */
     list(query?: CouponListParams | null | undefined, options?: RequestOptions): PagePromise<CouponsCursorIDPage, Coupon>;
-    /**
-     * Permanently deletes a coupon. The promo code can no longer be used. Existing
-     * discounts applied to active subscriptions are not affected.
-     */
-    delete(couponID: string, options?: RequestOptions): APIPromise<void>;
     /**
      * Retrieves a coupon by ID. Returns the coupon object including discount details
      * and redemption statistics.
+     *
+     * @example
+     * ```ts
+     * const coupon = await client.commerce.coupons.get(
+     *   'coupon_1234567890',
+     * );
+     * ```
      */
     get(couponID: string, options?: RequestOptions): APIPromise<Coupon>;
 }
@@ -36,7 +60,7 @@ export type CouponsCursorIDPage = CursorIDPage<Coupon>;
  */
 export interface Coupon {
     /**
-     * Unique identifier for the topic subscription
+     * Unique identifier for the coupon
      */
     id: string;
     /**

package/resources/commerce/coupons.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"coupons.d.mts","sourceRoot":"","sources":["../../src/resources/commerce/coupons.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,WAAW,EAAE;OACtD,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAI9E;;;;;;;;;;OAUG;IACH,MAAM,CACJ,QAAQ,EAAE,MAAM,EAChB,IAAI,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC;IAIrB;;;;;;;;;;;OAWG;IACH,IAAI,CACF,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mBAAmB,EAAE,MAAM,CAAC;IAI3C;;;;;;;;;;OAUG;IACH,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;CAGpE;AAED,MAAM,MAAM,mBAAmB,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;AAEvD;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,QAAQ,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS,CAAC;IAE3C;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS,CAAC;IAE5C;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,gBAAiB,SAAQ,kBAAkB;IAC1D;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}

package/resources/{beta/commerce → commerce}/coupons.d.ts

@@ -1,32 +1,56 @@
-import { APIResource } from "../../../core/resource.js";
-import { APIPromise } from "../../../core/api-promise.js";
-import { CursorIDPage, type CursorIDPageParams, PagePromise } from "../../../core/pagination.js";
-import { RequestOptions } from "../../../internal/request-options.js";
+import { APIResource } from "../../core/resource.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { CursorIDPage, type CursorIDPageParams, PagePromise } from "../../core/pagination.js";
+import { RequestOptions } from "../../internal/request-options.js";
 export declare class Coupons extends APIResource {
     /**
      * Creates a discount coupon with a promo code. Coupons can offer percentage or
      * fixed-amount discounts and can be limited by redemption count or expiration
      * date. Customers can apply coupons during checkout.
+     *
+     * @example
+     * ```ts
+     * const coupon = await client.commerce.coupons.create({
+     *   code: 'LAUNCH20',
+     * });
+     * ```
      */
     create(body: CouponCreateParams, options?: RequestOptions): APIPromise<Coupon>;
     /**
      * Updates an existing coupon. Use this to modify the display name or deactivate
      * the coupon. Discount amounts and codes cannot be changed after creation.
+     *
+     * @example
+     * ```ts
+     * const coupon = await client.commerce.coupons.update(
+     *   'coupon_1234567890',
+     * );
+     * ```
      */
     update(couponID: string, body?: CouponUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Coupon>;
     /**
      * Retrieves a paginated list of all coupons. Coupons provide discounts that
      * customers can apply during checkout using a promo code.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const coupon of client.commerce.coupons.list()) {
+     *   // ...
+     * }
+     * ```
      */
     list(query?: CouponListParams | null | undefined, options?: RequestOptions): PagePromise<CouponsCursorIDPage, Coupon>;
-    /**
-     * Permanently deletes a coupon. The promo code can no longer be used. Existing
-     * discounts applied to active subscriptions are not affected.
-     */
-    delete(couponID: string, options?: RequestOptions): APIPromise<void>;
     /**
      * Retrieves a coupon by ID. Returns the coupon object including discount details
      * and redemption statistics.
+     *
+     * @example
+     * ```ts
+     * const coupon = await client.commerce.coupons.get(
+     *   'coupon_1234567890',
+     * );
+     * ```
      */
     get(couponID: string, options?: RequestOptions): APIPromise<Coupon>;
 }
@@ -36,7 +60,7 @@ export type CouponsCursorIDPage = CursorIDPage<Coupon>;
  */
 export interface Coupon {
     /**
-     * Unique identifier for the topic subscription
+     * Unique identifier for the coupon
      */
     id: string;
     /**

package/resources/commerce/coupons.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"coupons.d.ts","sourceRoot":"","sources":["../../src/resources/commerce/coupons.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,WAAW,EAAE;OACtD,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAI9E;;;;;;;;;;OAUG;IACH,MAAM,CACJ,QAAQ,EAAE,MAAM,EAChB,IAAI,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC;IAIrB;;;;;;;;;;;OAWG;IACH,IAAI,CACF,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mBAAmB,EAAE,MAAM,CAAC;IAI3C;;;;;;;;;;OAUG;IACH,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;CAGpE;AAED,MAAM,MAAM,mBAAmB,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;AAEvD;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,QAAQ,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS,CAAC;IAE3C;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS,CAAC;IAE5C;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,gBAAiB,SAAQ,kBAAkB;IAC1D;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}