@usehercules/sdk 1.7.0 → 1.8.0

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

@@ -0,0 +1 @@
+{"version":3,"file":"commerce.d.ts","sourceRoot":"","sources":["../../../src/resources/beta/commerce/commerce.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EACL,kBAAkB,EAClB,oBAAoB,EACpB,iBAAiB,EACjB,gBAAgB,EAChB,kBAAkB,EAClB,+BAA+B,EAC/B,kBAAkB,EAClB,oBAAoB,EACpB,OAAO,EACR;OACM,KAAK,YAAY;OACjB,EACL,2BAA2B,EAC3B,6BAA6B,EAC7B,oBAAoB,EACpB,sBAAsB,EACtB,mBAAmB,EACnB,kBAAkB,EAClB,oBAAoB,EACpB,iCAAiC,EACjC,oBAAoB,EACpB,sBAAsB,EACtB,SAAS,EACV;OACM,KAAK,WAAW;OAChB,EACL,sBAAsB,EACtB,mBAAmB,EACnB,qBAAqB,EACrB,kBAAkB,EAClB,iBAAiB,EACjB,mBAAmB,EACnB,gCAAgC,EAChC,mBAAmB,EACnB,qBAAqB,EACrB,QAAQ,EACT;OACM,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,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;IAEnE;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIhG;;;;;OAKG;IACH,KAAK,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI7F;;;;OAIG;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;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,WAAW,EAAE,cAAc,GAAG,mBAAmB,GAAG,cAAc,GAAG,MAAM,CAAC;IAE5E;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,WAAW,EAAE,MAAM,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;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,oBAAoB,CAAC,EAAE,KAAK,GAAG,WAAW,GAAG,OAAO,CAAC;IAErD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,mBAAmB,GAAG,MAAM,GAAG,gBAAgB,CAAC;IAErE;;;OAGG;IACH,cAAc,CAAC,EAAE,KAAK,GAAG,iBAAiB,CAAC;IAE3C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAMD,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,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,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,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,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,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}

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

@@ -1,23 +1,20 @@
 "use strict";
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Pay = void 0;
+exports.Commerce = void 0;
 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 EntitlementsAPI = tslib_1.__importStar(require("./entitlements.js"));
-const entitlements_1 = require("./entitlements.js");
 const ProductsAPI = tslib_1.__importStar(require("./products/products.js"));
 const products_1 = require("./products/products.js");
-class Pay extends resource_1.APIResource {
+class Commerce extends resource_1.APIResource {
     constructor() {
         super(...arguments);
         this.customers = new CustomersAPI.Customers(this._client);
         this.products = new ProductsAPI.Products(this._client);
-        this.entitlements = new EntitlementsAPI.Entitlements(this._client);
         this.coupons = new CouponsAPI.Coupons(this._client);
     }
     /**
@@ -26,7 +23,7 @@ class Pay extends resource_1.APIResource {
      * 'immediate' to cancel immediately.
      */
     cancel(body, options) {
-        return this._client.post('/v1/pay/cancel', { body, ...options });
+        return this._client.post('/v1/commerce/cancel', { body, ...options });
     }
     /**
      * Verifies if a customer has access to a specific feature. Use this to gate
@@ -35,7 +32,7 @@ class Pay extends resource_1.APIResource {
      * allowing access to premium features.
      */
     check(body, options) {
-        return this._client.post('/v1/pay/check', { body, ...options });
+        return this._client.post('/v1/commerce/check', { body, ...options });
     }
     /**
      * Creates a checkout session for a customer to subscribe to a product. Returns a
@@ -43,12 +40,11 @@ class Pay extends resource_1.APIResource {
      * customer is subscribed to the product and gains access to its entitlements.
      */
     checkout(body, options) {
-        return this._client.post('/v1/pay/checkout', { body, ...options });
+        return this._client.post('/v1/commerce/checkout', { body, ...options });
     }
 }
-exports.Pay = Pay;
-Pay.Customers = customers_1.Customers;
-Pay.Products = products_1.Products;
-Pay.Entitlements = entitlements_1.Entitlements;
-Pay.Coupons = coupons_1.Coupons;
-//# sourceMappingURL=pay.js.map
+exports.Commerce = Commerce;
+Commerce.Customers = customers_1.Customers;
+Commerce.Products = products_1.Products;
+Commerce.Coupons = coupons_1.Coupons;
+//# sourceMappingURL=commerce.js.map

package/resources/beta/commerce/commerce.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"commerce.js","sourceRoot":"","sources":["../../../src/resources/beta/commerce/commerce.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,wDAAqD;AACrD,iEAAwC;AACxC,0CAUmB;AACnB,qEAA4C;AAC5C,8CAYqB;AACrB,4EAAmD;AACnD,qDAW6B;AAI7B,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;IA6BrE,CAAC;IA3BC;;;;OAIG;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;;;;;OAKG;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;;;;OAIG;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;AAhCD,4BAgCC;AAiMD,QAAQ,CAAC,SAAS,GAAG,qBAAS,CAAC;AAC/B,QAAQ,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AAC7B,QAAQ,CAAC,OAAO,GAAG,iBAAO,CAAC"}

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

@@ -4,16 +4,13 @@ import * as CouponsAPI from "./coupons.mjs";
 import { Coupons, } from "./coupons.mjs";
 import * as CustomersAPI from "./customers.mjs";
 import { Customers, } from "./customers.mjs";
-import * as EntitlementsAPI from "./entitlements.mjs";
-import { Entitlements, } from "./entitlements.mjs";
 import * as ProductsAPI from "./products/products.mjs";
 import { Products, } from "./products/products.mjs";
-export class Pay extends APIResource {
+export class Commerce extends APIResource {
     constructor() {
         super(...arguments);
         this.customers = new CustomersAPI.Customers(this._client);
         this.products = new ProductsAPI.Products(this._client);
-        this.entitlements = new EntitlementsAPI.Entitlements(this._client);
         this.coupons = new CouponsAPI.Coupons(this._client);
     }
     /**
@@ -22,7 +19,7 @@ export class Pay extends APIResource {
      * 'immediate' to cancel immediately.
      */
     cancel(body, options) {
-        return this._client.post('/v1/pay/cancel', { body, ...options });
+        return this._client.post('/v1/commerce/cancel', { body, ...options });
     }
     /**
      * Verifies if a customer has access to a specific feature. Use this to gate
@@ -31,7 +28,7 @@ export class Pay extends APIResource {
      * allowing access to premium features.
      */
     check(body, options) {
-        return this._client.post('/v1/pay/check', { body, ...options });
+        return this._client.post('/v1/commerce/check', { body, ...options });
     }
     /**
      * Creates a checkout session for a customer to subscribe to a product. Returns a
@@ -39,11 +36,10 @@ export class Pay extends APIResource {
      * customer is subscribed to the product and gains access to its entitlements.
      */
     checkout(body, options) {
-        return this._client.post('/v1/pay/checkout', { body, ...options });
+        return this._client.post('/v1/commerce/checkout', { body, ...options });
     }
 }
-Pay.Customers = Customers;
-Pay.Products = Products;
-Pay.Entitlements = Entitlements;
-Pay.Coupons = Coupons;
-//# sourceMappingURL=pay.mjs.map
+Commerce.Customers = Customers;
+Commerce.Products = Products;
+Commerce.Coupons = Coupons;
+//# sourceMappingURL=commerce.mjs.map

package/resources/beta/commerce/commerce.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"commerce.mjs","sourceRoot":"","sources":["../../../src/resources/beta/commerce/commerce.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EASL,OAAO,GACR;OACM,KAAK,YAAY;OACjB,EAWL,SAAS,GACV;OACM,KAAK,WAAW;OAChB,EAUL,QAAQ,GACT;AAID,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;IA6BrE,CAAC;IA3BC;;;;OAIG;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;;;;;OAKG;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;;;;OAIG;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;AAiMD,QAAQ,CAAC,SAAS,GAAG,SAAS,CAAC;AAC/B,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAC;AAC7B,QAAQ,CAAC,OAAO,GAAG,OAAO,CAAC"}

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

@@ -0,0 +1,333 @@
+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.
+     */
+    create(body: CouponCreateParams, options?: RequestOptions): APIPromise<CouponCreateResponse>;
+    /**
+     * Updates an existing coupon. Use this to modify the display name or deactivate
+     * the coupon. Discount amounts and codes cannot be changed after creation.
+     */
+    update(couponID: string, body?: CouponUpdateParams | null | undefined, options?: RequestOptions): APIPromise<CouponUpdateResponse>;
+    /**
+     * Retrieves a paginated list of all coupons. Coupons provide discounts that
+     * customers can apply during checkout using a promo code.
+     */
+    list(query?: CouponListParams | null | undefined, options?: RequestOptions): PagePromise<CouponListResponsesCursorIDPage, CouponListResponse>;
+    /**
+     * 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.
+     */
+    get(couponID: string, options?: RequestOptions): APIPromise<CouponGetResponse>;
+}
+export type CouponListResponsesCursorIDPage = CursorIDPage<CouponListResponse>;
+/**
+ * A discount coupon that customers can apply during checkout using a promo code
+ */
+export interface CouponCreateResponse {
+    /**
+     * Unique identifier for the topic subscription
+     */
+    id: string;
+    /**
+     * Whether the coupon is currently active and can be redeemed
+     */
+    active: boolean;
+    /**
+     * The promo code customers enter to apply the discount
+     */
+    code: string;
+    /**
+     * Timestamp when the coupon was created
+     */
+    created: string;
+    /**
+     * How long the discount applies: once (first payment only), repeating (for
+     * duration_in_months), or forever
+     */
+    duration: 'once' | 'repeating' | 'forever';
+    /**
+     * Number of times this coupon has been successfully redeemed
+     */
+    times_redeemed: number;
+    /**
+     * Fixed discount amount in the smallest currency unit (e.g., cents). Mutually
+     * exclusive with percent_off.
+     */
+    amount_off?: number | null;
+    /**
+     * Three-letter ISO currency code for amount_off discounts
+     */
+    currency?: string | null;
+    /**
+     * Number of months the discount applies when duration is 'repeating'
+     */
+    duration_in_months?: number | null;
+    /**
+     * Maximum number of times this coupon can be redeemed across all customers
+     */
+    max_redemptions?: number | null;
+    /**
+     * Display name for the coupon (shown to customers)
+     */
+    name?: string | null;
+    /**
+     * Percentage discount (1-100). Mutually exclusive with amount_off.
+     */
+    percent_off?: number | null;
+    /**
+     * Expiration date after which the coupon can no longer be redeemed
+     */
+    redeem_by?: string | null;
+}
+/**
+ * A discount coupon that customers can apply during checkout using a promo code
+ */
+export interface CouponUpdateResponse {
+    /**
+     * Unique identifier for the topic subscription
+     */
+    id: string;
+    /**
+     * Whether the coupon is currently active and can be redeemed
+     */
+    active: boolean;
+    /**
+     * The promo code customers enter to apply the discount
+     */
+    code: string;
+    /**
+     * Timestamp when the coupon was created
+     */
+    created: string;
+    /**
+     * How long the discount applies: once (first payment only), repeating (for
+     * duration_in_months), or forever
+     */
+    duration: 'once' | 'repeating' | 'forever';
+    /**
+     * Number of times this coupon has been successfully redeemed
+     */
+    times_redeemed: number;
+    /**
+     * Fixed discount amount in the smallest currency unit (e.g., cents). Mutually
+     * exclusive with percent_off.
+     */
+    amount_off?: number | null;
+    /**
+     * Three-letter ISO currency code for amount_off discounts
+     */
+    currency?: string | null;
+    /**
+     * Number of months the discount applies when duration is 'repeating'
+     */
+    duration_in_months?: number | null;
+    /**
+     * Maximum number of times this coupon can be redeemed across all customers
+     */
+    max_redemptions?: number | null;
+    /**
+     * Display name for the coupon (shown to customers)
+     */
+    name?: string | null;
+    /**
+     * Percentage discount (1-100). Mutually exclusive with amount_off.
+     */
+    percent_off?: number | null;
+    /**
+     * Expiration date after which the coupon can no longer be redeemed
+     */
+    redeem_by?: string | null;
+}
+/**
+ * A discount coupon that customers can apply during checkout using a promo code
+ */
+export interface CouponListResponse {
+    /**
+     * Unique identifier for the topic subscription
+     */
+    id: string;
+    /**
+     * Whether the coupon is currently active and can be redeemed
+     */
+    active: boolean;
+    /**
+     * The promo code customers enter to apply the discount
+     */
+    code: string;
+    /**
+     * Timestamp when the coupon was created
+     */
+    created: string;
+    /**
+     * How long the discount applies: once (first payment only), repeating (for
+     * duration_in_months), or forever
+     */
+    duration: 'once' | 'repeating' | 'forever';
+    /**
+     * Number of times this coupon has been successfully redeemed
+     */
+    times_redeemed: number;
+    /**
+     * Fixed discount amount in the smallest currency unit (e.g., cents). Mutually
+     * exclusive with percent_off.
+     */
+    amount_off?: number | null;
+    /**
+     * Three-letter ISO currency code for amount_off discounts
+     */
+    currency?: string | null;
+    /**
+     * Number of months the discount applies when duration is 'repeating'
+     */
+    duration_in_months?: number | null;
+    /**
+     * Maximum number of times this coupon can be redeemed across all customers
+     */
+    max_redemptions?: number | null;
+    /**
+     * Display name for the coupon (shown to customers)
+     */
+    name?: string | null;
+    /**
+     * Percentage discount (1-100). Mutually exclusive with amount_off.
+     */
+    percent_off?: number | null;
+    /**
+     * Expiration date after which the coupon can no longer be redeemed
+     */
+    redeem_by?: string | null;
+}
+/**
+ * A discount coupon that customers can apply during checkout using a promo code
+ */
+export interface CouponGetResponse {
+    /**
+     * Unique identifier for the topic subscription
+     */
+    id: string;
+    /**
+     * Whether the coupon is currently active and can be redeemed
+     */
+    active: boolean;
+    /**
+     * The promo code customers enter to apply the discount
+     */
+    code: string;
+    /**
+     * Timestamp when the coupon was created
+     */
+    created: string;
+    /**
+     * How long the discount applies: once (first payment only), repeating (for
+     * duration_in_months), or forever
+     */
+    duration: 'once' | 'repeating' | 'forever';
+    /**
+     * Number of times this coupon has been successfully redeemed
+     */
+    times_redeemed: number;
+    /**
+     * Fixed discount amount in the smallest currency unit (e.g., cents). Mutually
+     * exclusive with percent_off.
+     */
+    amount_off?: number | null;
+    /**
+     * Three-letter ISO currency code for amount_off discounts
+     */
+    currency?: string | null;
+    /**
+     * Number of months the discount applies when duration is 'repeating'
+     */
+    duration_in_months?: number | null;
+    /**
+     * Maximum number of times this coupon can be redeemed across all customers
+     */
+    max_redemptions?: number | null;
+    /**
+     * Display name for the coupon (shown to customers)
+     */
+    name?: string | null;
+    /**
+     * Percentage discount (1-100). Mutually exclusive with amount_off.
+     */
+    percent_off?: number | null;
+    /**
+     * Expiration date after which the coupon can no longer be redeemed
+     */
+    redeem_by?: string | null;
+}
+export interface CouponCreateParams {
+    /**
+     * The promo code customers will enter to apply the discount
+     */
+    code: string;
+    /**
+     * Optional custom ID for the coupon. If not provided, one will be generated.
+     */
+    id?: string;
+    /**
+     * Fixed discount in the smallest currency unit (e.g., cents). Mutually exclusive
+     * with percent_off.
+     */
+    amount_off?: number;
+    /**
+     * Three-letter ISO currency code for amount_off discounts
+     */
+    currency?: string;
+    /**
+     * How long the discount applies: once (first payment only), repeating (for
+     * duration_in_months), or forever
+     */
+    duration?: 'once' | 'repeating' | 'forever';
+    /**
+     * Number of months the discount applies when duration is 'repeating'
+     */
+    duration_in_months?: number;
+    /**
+     * Maximum number of times this coupon can be redeemed
+     */
+    max_redemptions?: number;
+    /**
+     * Display name for the coupon (shown to customers)
+     */
+    name?: string;
+    /**
+     * Percentage discount (1-100). Mutually exclusive with amount_off.
+     */
+    percent_off?: number;
+    /**
+     * Expiration date after which the coupon can no longer be redeemed
+     */
+    redeem_by?: string;
+}
+export interface CouponUpdateParams {
+    /**
+     * Whether the coupon is active and can be redeemed
+     */
+    active?: boolean;
+    /**
+     * Display name for the coupon
+     */
+    name?: string;
+}
+export interface CouponListParams extends CursorIDPageParams {
+    /**
+     * Filter by active status
+     */
+    active?: boolean;
+}
+export declare namespace Coupons {
+    export { type CouponCreateResponse as CouponCreateResponse, type CouponUpdateResponse as CouponUpdateResponse, type CouponListResponse as CouponListResponse, type CouponGetResponse as CouponGetResponse, type CouponListResponsesCursorIDPage as CouponListResponsesCursorIDPage, type CouponCreateParams as CouponCreateParams, type CouponUpdateParams as CouponUpdateParams, type CouponListParams as CouponListParams, };
+}
+//# sourceMappingURL=coupons.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"coupons.d.mts","sourceRoot":"","sources":["../../../src/resources/beta/commerce/coupons.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,WAAW,EAAE;OAEtD,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAI5F;;;OAGG;IACH,MAAM,CACJ,QAAQ,EAAE,MAAM,EAChB,IAAI,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAInC;;;OAGG;IACH,IAAI,CACF,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,+BAA+B,EAAE,kBAAkB,CAAC;IAOnE;;;OAGG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOpE;;;OAGG;IACH,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;CAG/E;AAED,MAAM,MAAM,+BAA+B,GAAG,YAAY,CAAC,kBAAkB,CAAC,CAAC;AAE/E;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;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;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;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;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;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;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;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;;OAEG;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,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}