@usehercules/sdk 1.2.0 → 1.4.0

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

@@ -0,0 +1,160 @@
+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 Customers extends APIResource {
+    /**
+     * Creates a new billable customer. A customer represents the entity in your app
+     * that will be charged—typically a user, organization, or project. Hercules
+     * recommends creating a customer immediately after creating the corresponding
+     * entity in your app.
+     */
+    create(body?: CustomerCreateParams | null | undefined, options?: RequestOptions): APIPromise<Customer>;
+    /**
+     * Updates an existing customer. Use this to modify contact information or billing
+     * address. Only provided fields are updated; omitted fields remain unchanged.
+     */
+    update(customerID: string, body?: CustomerUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Customer>;
+    /**
+     * Retrieves a paginated list of all customers. Customers are the billable entities
+     * in your app—typically users, organizations, or projects.
+     */
+    list(query?: CustomerListParams | null | undefined, options?: RequestOptions): PagePromise<CustomersCursorIDPage, Customer>;
+    /**
+     * Permanently deletes a customer. This also cancels any active subscriptions. This
+     * action cannot be undone.
+     */
+    delete(customerID: string, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Generates a URL to a hosted billing portal where the customer can view invoices,
+     * update payment methods, and manage billing details. Redirect the customer to the
+     * returned URL.
+     */
+    billingPortal(customerID: string, body?: CustomerBillingPortalParams | null | undefined, options?: RequestOptions): APIPromise<CustomerBillingPortalResponse>;
+    /**
+     * Retrieves a customer by ID. Returns the customer object including contact
+     * information and billing address.
+     */
+    get(customerID: string, options?: RequestOptions): APIPromise<Customer>;
+}
+export type CustomersCursorIDPage = CursorIDPage<Customer>;
+/**
+ * A billable customer. Represents the entity in your app that will be
+ * charged—typically a user, organization, or project.
+ */
+export interface Customer {
+    /**
+     * Unique identifier for the price
+     */
+    id: string;
+    /**
+     * Timestamp when the customer was created
+     */
+    created: string;
+    /**
+     * The customer's billing address
+     */
+    address?: CustomerAddress | null;
+    /**
+     * The customer's email address for receipts and notifications
+     */
+    email?: string | null;
+    /**
+     * The customer's full name
+     */
+    name?: string | null;
+    /**
+     * The customer's phone number
+     */
+    phone?: string | null;
+}
+/**
+ * The customer's billing address
+ */
+export interface CustomerAddress {
+    /**
+     * City name
+     */
+    city?: string | null;
+    /**
+     * Two-letter ISO country code
+     */
+    country?: string | null;
+    /**
+     * Street address line 1
+     */
+    line1?: string | null;
+    /**
+     * Street address line 2 (apartment, suite, etc.)
+     */
+    line2?: string | null;
+    /**
+     * Postal or ZIP code
+     */
+    postal_code?: string | null;
+    /**
+     * State, province, or region
+     */
+    state?: string | null;
+}
+/**
+ * Response containing the billing portal URL
+ */
+export interface CustomerBillingPortalResponse {
+    /**
+     * URL to redirect the customer to for the billing portal
+     */
+    url: string;
+}
+export interface CustomerCreateParams {
+    /**
+     * Optional custom ID for the customer. If not provided, one will be generated.
+     */
+    id?: string;
+    /**
+     * The customer's billing address
+     */
+    address?: CustomerAddress;
+    /**
+     * The customer's email address for receipts and notifications
+     */
+    email?: string;
+    /**
+     * The customer's full name
+     */
+    name?: string;
+    /**
+     * The customer's phone number
+     */
+    phone?: string;
+}
+export interface CustomerUpdateParams {
+    /**
+     * The customer's billing address
+     */
+    address?: CustomerAddress;
+    /**
+     * The customer's email address for receipts and notifications
+     */
+    email?: string;
+    /**
+     * The customer's full name
+     */
+    name?: string;
+    /**
+     * The customer's phone number
+     */
+    phone?: string;
+}
+export interface CustomerListParams extends CursorIDPageParams {
+}
+export interface CustomerBillingPortalParams {
+    /**
+     * URL to redirect the customer to after they exit the billing portal
+     */
+    return_url?: string;
+}
+export declare namespace Customers {
+    export { type Customer as Customer, type CustomerAddress as CustomerAddress, type CustomerBillingPortalResponse as CustomerBillingPortalResponse, type CustomersCursorIDPage as CustomersCursorIDPage, type CustomerCreateParams as CustomerCreateParams, type CustomerUpdateParams as CustomerUpdateParams, type CustomerListParams as CustomerListParams, type CustomerBillingPortalParams as CustomerBillingPortalParams, };
+}
+//# sourceMappingURL=customers.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"customers.d.mts","sourceRoot":"","sources":["../../../src/resources/beta/pay/customers.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,SAAU,SAAQ,WAAW;IACxC;;;;;OAKG;IACH,MAAM,CAAC,IAAI,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAI1G;;;OAGG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,QAAQ,CAAC;IAIvB;;;OAGG;IACH,IAAI,CACF,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qBAAqB,EAAE,QAAQ,CAAC;IAI/C;;;OAGG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOtE;;;;OAIG;IACH,aAAa,CACX,UAAU,EAAE,MAAM,EAClB,IAAI,GAAE,2BAA2B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAI5C;;;OAGG;IACH,GAAG,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;CAGxE;AAED,MAAM,MAAM,qBAAqB,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;AAE3D;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,CAAC;IAE1B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,CAAC;IAE1B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,kBAAmB,SAAQ,kBAAkB;CAAG;AAEjE,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,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;CACH"}

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

@@ -0,0 +1,160 @@
+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 Customers extends APIResource {
+    /**
+     * Creates a new billable customer. A customer represents the entity in your app
+     * that will be charged—typically a user, organization, or project. Hercules
+     * recommends creating a customer immediately after creating the corresponding
+     * entity in your app.
+     */
+    create(body?: CustomerCreateParams | null | undefined, options?: RequestOptions): APIPromise<Customer>;
+    /**
+     * Updates an existing customer. Use this to modify contact information or billing
+     * address. Only provided fields are updated; omitted fields remain unchanged.
+     */
+    update(customerID: string, body?: CustomerUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Customer>;
+    /**
+     * Retrieves a paginated list of all customers. Customers are the billable entities
+     * in your app—typically users, organizations, or projects.
+     */
+    list(query?: CustomerListParams | null | undefined, options?: RequestOptions): PagePromise<CustomersCursorIDPage, Customer>;
+    /**
+     * Permanently deletes a customer. This also cancels any active subscriptions. This
+     * action cannot be undone.
+     */
+    delete(customerID: string, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Generates a URL to a hosted billing portal where the customer can view invoices,
+     * update payment methods, and manage billing details. Redirect the customer to the
+     * returned URL.
+     */
+    billingPortal(customerID: string, body?: CustomerBillingPortalParams | null | undefined, options?: RequestOptions): APIPromise<CustomerBillingPortalResponse>;
+    /**
+     * Retrieves a customer by ID. Returns the customer object including contact
+     * information and billing address.
+     */
+    get(customerID: string, options?: RequestOptions): APIPromise<Customer>;
+}
+export type CustomersCursorIDPage = CursorIDPage<Customer>;
+/**
+ * A billable customer. Represents the entity in your app that will be
+ * charged—typically a user, organization, or project.
+ */
+export interface Customer {
+    /**
+     * Unique identifier for the price
+     */
+    id: string;
+    /**
+     * Timestamp when the customer was created
+     */
+    created: string;
+    /**
+     * The customer's billing address
+     */
+    address?: CustomerAddress | null;
+    /**
+     * The customer's email address for receipts and notifications
+     */
+    email?: string | null;
+    /**
+     * The customer's full name
+     */
+    name?: string | null;
+    /**
+     * The customer's phone number
+     */
+    phone?: string | null;
+}
+/**
+ * The customer's billing address
+ */
+export interface CustomerAddress {
+    /**
+     * City name
+     */
+    city?: string | null;
+    /**
+     * Two-letter ISO country code
+     */
+    country?: string | null;
+    /**
+     * Street address line 1
+     */
+    line1?: string | null;
+    /**
+     * Street address line 2 (apartment, suite, etc.)
+     */
+    line2?: string | null;
+    /**
+     * Postal or ZIP code
+     */
+    postal_code?: string | null;
+    /**
+     * State, province, or region
+     */
+    state?: string | null;
+}
+/**
+ * Response containing the billing portal URL
+ */
+export interface CustomerBillingPortalResponse {
+    /**
+     * URL to redirect the customer to for the billing portal
+     */
+    url: string;
+}
+export interface CustomerCreateParams {
+    /**
+     * Optional custom ID for the customer. If not provided, one will be generated.
+     */
+    id?: string;
+    /**
+     * The customer's billing address
+     */
+    address?: CustomerAddress;
+    /**
+     * The customer's email address for receipts and notifications
+     */
+    email?: string;
+    /**
+     * The customer's full name
+     */
+    name?: string;
+    /**
+     * The customer's phone number
+     */
+    phone?: string;
+}
+export interface CustomerUpdateParams {
+    /**
+     * The customer's billing address
+     */
+    address?: CustomerAddress;
+    /**
+     * The customer's email address for receipts and notifications
+     */
+    email?: string;
+    /**
+     * The customer's full name
+     */
+    name?: string;
+    /**
+     * The customer's phone number
+     */
+    phone?: string;
+}
+export interface CustomerListParams extends CursorIDPageParams {
+}
+export interface CustomerBillingPortalParams {
+    /**
+     * URL to redirect the customer to after they exit the billing portal
+     */
+    return_url?: string;
+}
+export declare namespace Customers {
+    export { type Customer as Customer, type CustomerAddress as CustomerAddress, type CustomerBillingPortalResponse as CustomerBillingPortalResponse, type CustomersCursorIDPage as CustomersCursorIDPage, type CustomerCreateParams as CustomerCreateParams, type CustomerUpdateParams as CustomerUpdateParams, type CustomerListParams as CustomerListParams, type CustomerBillingPortalParams as CustomerBillingPortalParams, };
+}
+//# sourceMappingURL=customers.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"customers.d.ts","sourceRoot":"","sources":["../../../src/resources/beta/pay/customers.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,SAAU,SAAQ,WAAW;IACxC;;;;;OAKG;IACH,MAAM,CAAC,IAAI,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAI1G;;;OAGG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,QAAQ,CAAC;IAIvB;;;OAGG;IACH,IAAI,CACF,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qBAAqB,EAAE,QAAQ,CAAC;IAI/C;;;OAGG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOtE;;;;OAIG;IACH,aAAa,CACX,UAAU,EAAE,MAAM,EAClB,IAAI,GAAE,2BAA2B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAI5C;;;OAGG;IACH,GAAG,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;CAGxE;AAED,MAAM,MAAM,qBAAqB,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;AAE3D;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,CAAC;IAE1B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,CAAC;IAE1B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,kBAAmB,SAAQ,kBAAkB;CAAG;AAEjE,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,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;CACH"}

package/resources/beta/pay/customers.js

@@ -0,0 +1,60 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Customers = void 0;
+const resource_1 = require("../../../core/resource.js");
+const pagination_1 = require("../../../core/pagination.js");
+const headers_1 = require("../../../internal/headers.js");
+const path_1 = require("../../../internal/utils/path.js");
+class Customers extends resource_1.APIResource {
+    /**
+     * Creates a new billable customer. A customer represents the entity in your app
+     * that will be charged—typically a user, organization, or project. Hercules
+     * recommends creating a customer immediately after creating the corresponding
+     * entity in your app.
+     */
+    create(body = {}, options) {
+        return this._client.post('/v1/pay/customers', { body, ...options });
+    }
+    /**
+     * Updates an existing customer. Use this to modify contact information or billing
+     * address. Only provided fields are updated; omitted fields remain unchanged.
+     */
+    update(customerID, body = {}, options) {
+        return this._client.patch((0, path_1.path) `/v1/pay/customers/${customerID}`, { body, ...options });
+    }
+    /**
+     * Retrieves a paginated list of all customers. Customers are the billable entities
+     * in your app—typically users, organizations, or projects.
+     */
+    list(query = {}, options) {
+        return this._client.getAPIList('/v1/pay/customers', (pagination_1.CursorIDPage), { query, ...options });
+    }
+    /**
+     * Permanently deletes a customer. This also cancels any active subscriptions. This
+     * action cannot be undone.
+     */
+    delete(customerID, options) {
+        return this._client.delete((0, path_1.path) `/v1/pay/customers/${customerID}`, {
+            ...options,
+            headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+    /**
+     * Generates a URL to a hosted billing portal where the customer can view invoices,
+     * update payment methods, and manage billing details. Redirect the customer to the
+     * returned URL.
+     */
+    billingPortal(customerID, body = {}, options) {
+        return this._client.post((0, path_1.path) `/v1/pay/customers/${customerID}/billing_portal`, { body, ...options });
+    }
+    /**
+     * Retrieves a customer by ID. Returns the customer object including contact
+     * information and billing address.
+     */
+    get(customerID, options) {
+        return this._client.get((0, path_1.path) `/v1/pay/customers/${customerID}`, options);
+    }
+}
+exports.Customers = Customers;
+//# sourceMappingURL=customers.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"customers.js","sourceRoot":"","sources":["../../../src/resources/beta/pay/customers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAErD,4DAA8F;AAC9F,0DAAyD;AAEzD,0DAAoD;AAEpD,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;OAKG;IACH,MAAM,CAAC,OAAgD,EAAE,EAAE,OAAwB;QACjF,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;OAGG;IACH,MAAM,CACJ,UAAkB,EAClB,OAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,qBAAqB,UAAU,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;OAGG;IACH,IAAI,CACF,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAA,yBAAsB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,UAAkB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,qBAAqB,UAAU,EAAE,EAAE;YAChE,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,aAAa,CACX,UAAkB,EAClB,OAAuD,EAAE,EACzD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,qBAAqB,UAAU,iBAAiB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;IAED;;;OAGG;IACH,GAAG,CAAC,UAAkB,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;CACF;AAjED,8BAiEC"}

package/resources/beta/pay/customers.mjs

@@ -0,0 +1,56 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../../core/resource.mjs";
+import { CursorIDPage } from "../../../core/pagination.mjs";
+import { buildHeaders } from "../../../internal/headers.mjs";
+import { path } from "../../../internal/utils/path.mjs";
+export class Customers extends APIResource {
+    /**
+     * Creates a new billable customer. A customer represents the entity in your app
+     * that will be charged—typically a user, organization, or project. Hercules
+     * recommends creating a customer immediately after creating the corresponding
+     * entity in your app.
+     */
+    create(body = {}, options) {
+        return this._client.post('/v1/pay/customers', { body, ...options });
+    }
+    /**
+     * Updates an existing customer. Use this to modify contact information or billing
+     * address. Only provided fields are updated; omitted fields remain unchanged.
+     */
+    update(customerID, body = {}, options) {
+        return this._client.patch(path `/v1/pay/customers/${customerID}`, { body, ...options });
+    }
+    /**
+     * Retrieves a paginated list of all customers. Customers are the billable entities
+     * in your app—typically users, organizations, or projects.
+     */
+    list(query = {}, options) {
+        return this._client.getAPIList('/v1/pay/customers', (CursorIDPage), { query, ...options });
+    }
+    /**
+     * Permanently deletes a customer. This also cancels any active subscriptions. This
+     * action cannot be undone.
+     */
+    delete(customerID, options) {
+        return this._client.delete(path `/v1/pay/customers/${customerID}`, {
+            ...options,
+            headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+    /**
+     * Generates a URL to a hosted billing portal where the customer can view invoices,
+     * update payment methods, and manage billing details. Redirect the customer to the
+     * returned URL.
+     */
+    billingPortal(customerID, body = {}, options) {
+        return this._client.post(path `/v1/pay/customers/${customerID}/billing_portal`, { body, ...options });
+    }
+    /**
+     * Retrieves a customer by ID. Returns the customer object including contact
+     * information and billing address.
+     */
+    get(customerID, options) {
+        return this._client.get(path `/v1/pay/customers/${customerID}`, options);
+    }
+}
+//# sourceMappingURL=customers.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"customers.mjs","sourceRoot":"","sources":["../../../src/resources/beta/pay/customers.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAwC;OACtD,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;OAKG;IACH,MAAM,CAAC,OAAgD,EAAE,EAAE,OAAwB;QACjF,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;OAGG;IACH,MAAM,CACJ,UAAkB,EAClB,OAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,qBAAqB,UAAU,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;OAGG;IACH,IAAI,CACF,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAA,YAAsB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,UAAkB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,qBAAqB,UAAU,EAAE,EAAE;YAChE,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,aAAa,CACX,UAAkB,EAClB,OAAuD,EAAE,EACzD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,qBAAqB,UAAU,iBAAiB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;IAED;;;OAGG;IACH,GAAG,CAAC,UAAkB,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;CACF"}

package/resources/beta/{subscriptions → pay}/entitlements.d.mts

@@ -4,53 +4,63 @@ import { CursorIDPage, type CursorIDPageParams, PagePromise } from "../../../cor
 import { RequestOptions } from "../../../internal/request-options.mjs";
 export declare class Entitlements extends APIResource {
     /**
-     * Create Entitlement
+     * Creates a new feature entitlement. Entitlements represent features or
+     * capabilities in your app that can be gated by subscription. After creating an
+     * entitlement, attach it to one or more plans to grant access to customers on
+     * those plans.
      */
     create(body: EntitlementCreateParams, options?: RequestOptions): APIPromise<Entitlement>;
     /**
-     * Update Entitlement
+     * Updates an existing entitlement. Use this to modify the name or deactivate the
+     * entitlement.
      */
     update(entitlementID: string, body?: EntitlementUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Entitlement>;
     /**
-     * List Entitlements
+     * Retrieves a paginated list of all entitlements. Entitlements represent features
+     * or capabilities in your app that can be gated by subscription.
      */
     list(query?: EntitlementListParams | null | undefined, options?: RequestOptions): PagePromise<EntitlementsCursorIDPage, Entitlement>;
     /**
-     * Get Entitlement
+     * Retrieves an entitlement by ID. Returns the entitlement object including its
+     * active status.
      */
     get(entitlementID: string, options?: RequestOptions): APIPromise<Entitlement>;
 }
 export type EntitlementsCursorIDPage = CursorIDPage<Entitlement>;
 /**
- * An entitlement that can be attached to products
+ * The entitlement attached to the product
  */
 export interface Entitlement {
     /**
-     * An id for a data item
+     * Unique identifier for the price
      */
     id: string;
+    /**
+     * Whether the entitlement is active and can be attached to products
+     */
     active: boolean;
-    livemode: boolean;
-    lookup_key: string;
+    /**
+     * Display name for the entitlement (e.g., API Access, Premium Support)
+     */
     name: string;
 }
 export interface EntitlementCreateParams {
     /**
-     * A unique key to identify the entitlement in your system
+     * Display name for the entitlement (e.g., API Access, Premium Support)
      */
-    lookup_key: string;
+    name: string;
     /**
-     * The name of the entitlement
+     * Optional custom ID for the entitlement. If not provided, one will be generated.
      */
-    name: string;
+    id?: string;
 }
 export interface EntitlementUpdateParams {
     /**
-     * Whether the entitlement is active
+     * Whether the entitlement is active. Deactivating removes it from access checks.
      */
     active?: boolean;
     /**
-     * The name of the entitlement
+     * Display name for the entitlement
      */
     name?: string;
 }
@@ -58,11 +68,7 @@ export interface EntitlementListParams extends CursorIDPageParams {
     /**
      * Filter by archived status
      */
-    archived?: boolean;
-    /**
-     * Filter by lookup key
-     */
-    lookup_key?: string;
+    archived?: 'true' | 'false';
 }
 export declare namespace Entitlements {
     export { type Entitlement as Entitlement, type EntitlementsCursorIDPage as EntitlementsCursorIDPage, type EntitlementCreateParams as EntitlementCreateParams, type EntitlementUpdateParams as EntitlementUpdateParams, type EntitlementListParams as EntitlementListParams, };

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

@@ -0,0 +1 @@
+{"version":3,"file":"entitlements.d.mts","sourceRoot":"","sources":["../../../src/resources/beta/pay/entitlements.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,YAAa,SAAQ,WAAW;IAC3C;;;;;OAKG;IACH,MAAM,CAAC,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,WAAW,CAAC;IAIxF;;;OAGG;IACH,MAAM,CACJ,aAAa,EAAE,MAAM,EACrB,IAAI,GAAE,uBAAuB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,WAAW,CAAC;IAI1B;;;OAGG;IACH,IAAI,CACF,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,wBAAwB,EAAE,WAAW,CAAC;IAIrD;;;OAGG;IACH,GAAG,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,WAAW,CAAC;CAG9E;AAED,MAAM,MAAM,wBAAwB,GAAG,YAAY,CAAC,WAAW,CAAC,CAAC;AAEjE;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,qBAAsB,SAAQ,kBAAkB;IAC/D;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CAC7B;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}

package/resources/beta/{subscriptions → pay}/entitlements.d.ts

@@ -4,53 +4,63 @@ import { CursorIDPage, type CursorIDPageParams, PagePromise } from "../../../cor
 import { RequestOptions } from "../../../internal/request-options.js";
 export declare class Entitlements extends APIResource {
     /**
-     * Create Entitlement
+     * Creates a new feature entitlement. Entitlements represent features or
+     * capabilities in your app that can be gated by subscription. After creating an
+     * entitlement, attach it to one or more plans to grant access to customers on
+     * those plans.
      */
     create(body: EntitlementCreateParams, options?: RequestOptions): APIPromise<Entitlement>;
     /**
-     * Update Entitlement
+     * Updates an existing entitlement. Use this to modify the name or deactivate the
+     * entitlement.
      */
     update(entitlementID: string, body?: EntitlementUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Entitlement>;
     /**
-     * List Entitlements
+     * Retrieves a paginated list of all entitlements. Entitlements represent features
+     * or capabilities in your app that can be gated by subscription.
      */
     list(query?: EntitlementListParams | null | undefined, options?: RequestOptions): PagePromise<EntitlementsCursorIDPage, Entitlement>;
     /**
-     * Get Entitlement
+     * Retrieves an entitlement by ID. Returns the entitlement object including its
+     * active status.
      */
     get(entitlementID: string, options?: RequestOptions): APIPromise<Entitlement>;
 }
 export type EntitlementsCursorIDPage = CursorIDPage<Entitlement>;
 /**
- * An entitlement that can be attached to products
+ * The entitlement attached to the product
  */
 export interface Entitlement {
     /**
-     * An id for a data item
+     * Unique identifier for the price
      */
     id: string;
+    /**
+     * Whether the entitlement is active and can be attached to products
+     */
     active: boolean;
-    livemode: boolean;
-    lookup_key: string;
+    /**
+     * Display name for the entitlement (e.g., API Access, Premium Support)
+     */
     name: string;
 }
 export interface EntitlementCreateParams {
     /**
-     * A unique key to identify the entitlement in your system
+     * Display name for the entitlement (e.g., API Access, Premium Support)
      */
-    lookup_key: string;
+    name: string;
     /**
-     * The name of the entitlement
+     * Optional custom ID for the entitlement. If not provided, one will be generated.
      */
-    name: string;
+    id?: string;
 }
 export interface EntitlementUpdateParams {
     /**
-     * Whether the entitlement is active
+     * Whether the entitlement is active. Deactivating removes it from access checks.
      */
     active?: boolean;
     /**
-     * The name of the entitlement
+     * Display name for the entitlement
      */
     name?: string;
 }
@@ -58,11 +68,7 @@ export interface EntitlementListParams extends CursorIDPageParams {
     /**
      * Filter by archived status
      */
-    archived?: boolean;
-    /**
-     * Filter by lookup key
-     */
-    lookup_key?: string;
+    archived?: 'true' | 'false';
 }
 export declare namespace Entitlements {
     export { type Entitlement as Entitlement, type EntitlementsCursorIDPage as EntitlementsCursorIDPage, type EntitlementCreateParams as EntitlementCreateParams, type EntitlementUpdateParams as EntitlementUpdateParams, type EntitlementListParams as EntitlementListParams, };

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

@@ -0,0 +1 @@
+{"version":3,"file":"entitlements.d.ts","sourceRoot":"","sources":["../../../src/resources/beta/pay/entitlements.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,YAAa,SAAQ,WAAW;IAC3C;;;;;OAKG;IACH,MAAM,CAAC,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,WAAW,CAAC;IAIxF;;;OAGG;IACH,MAAM,CACJ,aAAa,EAAE,MAAM,EACrB,IAAI,GAAE,uBAAuB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,WAAW,CAAC;IAI1B;;;OAGG;IACH,IAAI,CACF,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,wBAAwB,EAAE,WAAW,CAAC;IAIrD;;;OAGG;IACH,GAAG,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,WAAW,CAAC;CAG9E;AAED,MAAM,MAAM,wBAAwB,GAAG,YAAY,CAAC,WAAW,CAAC,CAAC;AAEjE;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,qBAAsB,SAAQ,kBAAkB;IAC/D;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CAC7B;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}