@usehercules/sdk 1.2.0 → 1.3.0

package/resources/beta/pay/products/products.mjs

@@ -0,0 +1,52 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../../../core/resource.mjs";
+import * as EntitlementsAPI from "./entitlements.mjs";
+import { Entitlements, } from "./entitlements.mjs";
+import { CursorIDPage } from "../../../../core/pagination.mjs";
+import { path } from "../../../../internal/utils/path.mjs";
+export class Products extends APIResource {
+    constructor() {
+        super(...arguments);
+        this.entitlements = new EntitlementsAPI.Entitlements(this._client);
+    }
+    /**
+     * Creates a new subscription product with a recurring price. Common examples
+     * include Free, Pro, Business, or Teams tiers. After creating a product, attach
+     * entitlements to define which features customers on this product can access.
+     */
+    create(body, options) {
+        return this._client.post('/v1/pay/products', { body, ...options });
+    }
+    /**
+     * Updates an existing product. Use this to modify the product name, description,
+     * or active status. Pricing cannot be changed after creation—create a new product
+     * instead.
+     */
+    update(productID, body = {}, options) {
+        return this._client.patch(path `/v1/pay/products/${productID}`, { body, ...options });
+    }
+    /**
+     * Retrieves a paginated list of subscription products. Products define the pricing
+     * and billing intervals for subscriptions. Each product can have entitlements
+     * attached that grant features to subscribed customers.
+     */
+    list(query = {}, options) {
+        return this._client.getAPIList('/v1/pay/products', (CursorIDPage), { query, ...options });
+    }
+    /**
+     * Archives a product, preventing new subscriptions. Existing subscriptions remain
+     * active. Use this instead of deletion to preserve subscription history.
+     */
+    archive(productID, options) {
+        return this._client.delete(path `/v1/pay/products/${productID}`, options);
+    }
+    /**
+     * Retrieves a product by ID. Returns the product object including pricing details
+     * and status.
+     */
+    get(productID, options) {
+        return this._client.get(path `/v1/pay/products/${productID}`, options);
+    }
+}
+Products.Entitlements = Entitlements;
+//# sourceMappingURL=products.mjs.map

package/resources/beta/pay/products/products.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"products.mjs","sourceRoot":"","sources":["../../../../src/resources/beta/pay/products/products.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,eAAe;OACpB,EAIL,YAAY,GAGb;OAEM,EAAE,YAAY,EAAwC;OAEtD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,QAAS,SAAQ,WAAW;IAAzC;;QACE,iBAAY,GAAiC,IAAI,eAAe,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAmD9F,CAAC;IAjDC;;;;OAIG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;OAIG;IACH,MAAM,CACJ,SAAiB,EACjB,OAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,oBAAoB,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;OAIG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,kBAAkB,EAAE,CAAA,YAAqB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;OAGG;IACH,OAAO,CAAC,SAAiB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,oBAAoB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3E,CAAC;IAED;;;OAGG;IACH,GAAG,CAAC,SAAiB,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,oBAAoB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;CACF;AAuID,QAAQ,CAAC,YAAY,GAAG,YAAY,CAAC"}

package/resources/beta/pay/products.d.mts

@@ -0,0 +1,2 @@
+export * from "./products/index.mjs";
+//# sourceMappingURL=products.d.mts.map

package/resources/beta/pay/products.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"products.d.mts","sourceRoot":"","sources":["../../../src/resources/beta/pay/products.ts"],"names":[],"mappings":""}

package/resources/beta/pay/products.d.ts

@@ -0,0 +1,2 @@
+export * from "./products/index.js";
+//# sourceMappingURL=products.d.ts.map

package/resources/beta/pay/products.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"products.d.ts","sourceRoot":"","sources":["../../../src/resources/beta/pay/products.ts"],"names":[],"mappings":""}

package/resources/beta/{subscriptions/plans.js → pay/products.js}

@@ -2,5 +2,5 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("../../../internal/tslib.js");
-tslib_1.__exportStar(require("./plans/index.js"), exports);
-//# sourceMappingURL=plans.js.map
+tslib_1.__exportStar(require("./products/index.js"), exports);
+//# sourceMappingURL=products.js.map

package/resources/beta/pay/products.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"products.js","sourceRoot":"","sources":["../../../src/resources/beta/pay/products.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,8DAAiC"}

package/resources/beta/{subscriptions.mjs → pay/products.mjs}

@@ -1,3 +1,3 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-export * from "./subscriptions/index.mjs";
-//# sourceMappingURL=subscriptions.mjs.map
+export * from "./products/index.mjs";
+//# sourceMappingURL=products.mjs.map

package/resources/beta/pay/products.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"products.mjs","sourceRoot":"","sources":["../../../src/resources/beta/pay/products.ts"],"names":[],"mappings":"AAAA,sFAAsF"}

package/resources/beta/pay.d.mts

@@ -0,0 +1,2 @@
+export * from "./pay/index.mjs";
+//# sourceMappingURL=pay.d.mts.map

package/resources/beta/pay.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pay.d.mts","sourceRoot":"","sources":["../../src/resources/beta/pay.ts"],"names":[],"mappings":""}

package/resources/beta/pay.d.ts

@@ -0,0 +1,2 @@
+export * from "./pay/index.js";
+//# sourceMappingURL=pay.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pay.d.ts","sourceRoot":"","sources":["../../src/resources/beta/pay.ts"],"names":[],"mappings":""}

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

@@ -2,5 +2,5 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("../../internal/tslib.js");
-tslib_1.__exportStar(require("./subscriptions/index.js"), exports);
-//# sourceMappingURL=subscriptions.js.map
+tslib_1.__exportStar(require("./pay/index.js"), exports);
+//# sourceMappingURL=pay.js.map

package/resources/beta/pay.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pay.js","sourceRoot":"","sources":["../../src/resources/beta/pay.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,yDAA4B"}

package/resources/beta/{subscriptions/plans.mjs → pay.mjs}

@@ -1,3 +1,3 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-export * from "./plans/index.mjs";
-//# sourceMappingURL=plans.mjs.map
+export * from "./pay/index.mjs";
+//# sourceMappingURL=pay.mjs.map

package/resources/beta/pay.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"pay.mjs","sourceRoot":"","sources":["../../src/resources/beta/pay.ts"],"names":[],"mappings":"AAAA,sFAAsF"}

package/src/client.ts

@@ -32,13 +32,15 @@ import {
 } from './internal/utils/log';
 import { isEmptyObj } from './internal/utils/values';
 
+export type ApiVersion = '2025-12-09';
+
 export interface ClientOptions {
   /**
    * Defaults to process.env['HERCULES_API_KEY'].
    */
   apiKey?: string | null | undefined;
 
-  apiVersion?: string | undefined;
+  apiVersion: ApiVersion;
 
   /**
    * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
@@ -114,7 +116,7 @@ export interface ClientOptions {
  */
 export class Hercules {
   apiKey: string | null;
-  apiVersion: string;
+  apiVersion: ApiVersion;
 
   baseURL: string;
   maxRetries: number;
@@ -144,9 +146,9 @@ export class Hercules {
   constructor({
     baseURL = readEnv('HERCULES_BASE_URL'),
     apiKey = readEnv('HERCULES_API_KEY') ?? null,
-    apiVersion = '2025-12-09',
+    apiVersion,
     ...opts
-  }: ClientOptions = {}) {
+  }: ClientOptions & { apiVersion: ApiVersion }) {
     const options: ClientOptions = {
       apiKey,
       apiVersion,

package/src/resources/beta/beta.ts

@@ -1,31 +1,31 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
-import * as SubscriptionsAPI from './subscriptions/subscriptions';
+import * as PayAPI from './pay/pay';
 import {
-  SubscriptionCancelParams,
-  SubscriptionCancelResponse,
-  SubscriptionCheckParams,
-  SubscriptionCheckResponse,
-  SubscriptionCheckoutParams,
-  SubscriptionCheckoutResponse,
-  Subscriptions,
-} from './subscriptions/subscriptions';
+  Pay,
+  PayCancelParams,
+  PayCancelResponse,
+  PayCheckParams,
+  PayCheckResponse,
+  PayCheckoutParams,
+  PayCheckoutResponse,
+} from './pay/pay';
 
 export class Beta extends APIResource {
-  subscriptions: SubscriptionsAPI.Subscriptions = new SubscriptionsAPI.Subscriptions(this._client);
+  pay: PayAPI.Pay = new PayAPI.Pay(this._client);
 }
 
-Beta.Subscriptions = Subscriptions;
+Beta.Pay = Pay;
 
 export declare namespace Beta {
   export {
-    Subscriptions as Subscriptions,
-    type SubscriptionCancelResponse as SubscriptionCancelResponse,
-    type SubscriptionCheckResponse as SubscriptionCheckResponse,
-    type SubscriptionCheckoutResponse as SubscriptionCheckoutResponse,
-    type SubscriptionCancelParams as SubscriptionCancelParams,
-    type SubscriptionCheckParams as SubscriptionCheckParams,
-    type SubscriptionCheckoutParams as SubscriptionCheckoutParams,
+    Pay as Pay,
+    type PayCancelResponse as PayCancelResponse,
+    type PayCheckResponse as PayCheckResponse,
+    type PayCheckoutResponse as PayCheckoutResponse,
+    type PayCancelParams as PayCancelParams,
+    type PayCheckParams as PayCheckParams,
+    type PayCheckoutParams as PayCheckoutParams,
   };
 }

package/src/resources/beta/index.ts

@@ -2,11 +2,11 @@
 
 export { Beta } from './beta';
 export {
-  Subscriptions,
-  type SubscriptionCancelResponse,
-  type SubscriptionCheckResponse,
-  type SubscriptionCheckoutResponse,
-  type SubscriptionCancelParams,
-  type SubscriptionCheckParams,
-  type SubscriptionCheckoutParams,
-} from './subscriptions/index';
+  Pay,
+  type PayCancelResponse,
+  type PayCheckResponse,
+  type PayCheckoutResponse,
+  type PayCancelParams,
+  type PayCheckParams,
+  type PayCheckoutParams,
+} from './pay/index';

package/src/resources/beta/pay/coupons.ts

@@ -0,0 +1,218 @@
+// 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 { CursorIDPage, type CursorIDPageParams, PagePromise } from '../../../core/pagination';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export 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<Coupon> {
+    return this._client.post('/v1/pay/coupons', { body, ...options });
+  }
+
+  /**
+   * 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<Coupon> {
+    return this._client.patch(path`/v1/pay/coupons/${couponID}`, { body, ...options });
+  }
+
+  /**
+   * 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<CouponsCursorIDPage, Coupon> {
+    return this._client.getAPIList('/v1/pay/coupons', CursorIDPage<Coupon>, { query, ...options });
+  }
+
+  /**
+   * 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> {
+    return this._client.delete(path`/v1/pay/coupons/${couponID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Retrieves a coupon by ID. Returns the coupon object including discount details
+   * and redemption statistics.
+   */
+  get(couponID: string, options?: RequestOptions): APIPromise<Coupon> {
+    return this._client.get(path`/v1/pay/coupons/${couponID}`, options);
+  }
+}
+
+export type CouponsCursorIDPage = CursorIDPage<Coupon>;
+
+/**
+ * A discount coupon that customers can apply during checkout using a promo code
+ */
+export interface Coupon {
+  /**
+   * Unique identifier for the entitlement
+   */
+  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 Coupon as Coupon,
+    type CouponsCursorIDPage as CouponsCursorIDPage,
+    type CouponCreateParams as CouponCreateParams,
+    type CouponUpdateParams as CouponUpdateParams,
+    type CouponListParams as CouponListParams,
+  };
+}