@usehercules/sdk 1.7.0 → 1.8.0

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

@@ -0,0 +1,407 @@
+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<CustomerCreateResponse>;
+    /**
+     * 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<CustomerUpdateResponse>;
+    /**
+     * 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<CustomerListResponsesCursorIDPage, CustomerListResponse>;
+    /**
+     * 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<CustomerGetResponse>;
+}
+export type CustomerListResponsesCursorIDPage = CursorIDPage<CustomerListResponse>;
+/**
+ * A billable customer. Represents the entity in your app that will be
+ * charged—typically a user, organization, or project.
+ */
+export interface CustomerCreateResponse {
+    /**
+     * Unique identifier for the topic subscription
+     */
+    id: string;
+    /**
+     * Timestamp when the customer was created
+     */
+    created: string;
+    /**
+     * The customer's billing address
+     */
+    address?: CustomerCreateResponse.Address | 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;
+}
+export declare namespace CustomerCreateResponse {
+    /**
+     * The customer's billing address
+     */
+    interface Address {
+        /**
+         * 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;
+    }
+}
+/**
+ * A billable customer. Represents the entity in your app that will be
+ * charged—typically a user, organization, or project.
+ */
+export interface CustomerUpdateResponse {
+    /**
+     * Unique identifier for the topic subscription
+     */
+    id: string;
+    /**
+     * Timestamp when the customer was created
+     */
+    created: string;
+    /**
+     * The customer's billing address
+     */
+    address?: CustomerUpdateResponse.Address | 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;
+}
+export declare namespace CustomerUpdateResponse {
+    /**
+     * The customer's billing address
+     */
+    interface Address {
+        /**
+         * 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;
+    }
+}
+/**
+ * A billable customer. Represents the entity in your app that will be
+ * charged—typically a user, organization, or project.
+ */
+export interface CustomerListResponse {
+    /**
+     * Unique identifier for the topic subscription
+     */
+    id: string;
+    /**
+     * Timestamp when the customer was created
+     */
+    created: string;
+    /**
+     * The customer's billing address
+     */
+    address?: CustomerListResponse.Address | 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;
+}
+export declare namespace CustomerListResponse {
+    /**
+     * The customer's billing address
+     */
+    interface Address {
+        /**
+         * 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;
+}
+/**
+ * A billable customer. Represents the entity in your app that will be
+ * charged—typically a user, organization, or project.
+ */
+export interface CustomerGetResponse {
+    /**
+     * Unique identifier for the topic subscription
+     */
+    id: string;
+    /**
+     * Timestamp when the customer was created
+     */
+    created: string;
+    /**
+     * The customer's billing address
+     */
+    address?: CustomerGetResponse.Address | 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;
+}
+export declare namespace CustomerGetResponse {
+    /**
+     * The customer's billing address
+     */
+    interface Address {
+        /**
+         * 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;
+    }
+}
+export interface CustomerCreateParams {
+    /**
+     * Optional custom ID for the customer. If not provided, one will be generated.
+     */
+    id?: string;
+    /**
+     * The customer's billing address
+     */
+    address?: CustomerCreateParams.Address;
+    /**
+     * 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 declare namespace CustomerCreateParams {
+    /**
+     * The customer's billing address
+     */
+    interface Address {
+        /**
+         * 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;
+    }
+}
+export interface CustomerUpdateParams {
+    /**
+     * The customer's billing address
+     */
+    address?: CustomerUpdateParams.Address;
+    /**
+     * 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 declare namespace CustomerUpdateParams {
+    /**
+     * The customer's billing address
+     */
+    interface Address {
+        /**
+         * 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;
+    }
+}
+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 CustomerCreateResponse as CustomerCreateResponse, type CustomerUpdateResponse as CustomerUpdateResponse, type CustomerListResponse as CustomerListResponse, type CustomerBillingPortalResponse as CustomerBillingPortalResponse, type CustomerGetResponse as CustomerGetResponse, type CustomerListResponsesCursorIDPage as CustomerListResponsesCursorIDPage, type CustomerCreateParams as CustomerCreateParams, type CustomerUpdateParams as CustomerUpdateParams, type CustomerListParams as CustomerListParams, type CustomerBillingPortalParams as CustomerBillingPortalParams, };
+}
+//# sourceMappingURL=customers.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"customers.d.mts","sourceRoot":"","sources":["../../../src/resources/beta/commerce/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,CACJ,IAAI,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;;OAGG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;;OAGG;IACH,IAAI,CACF,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iCAAiC,EAAE,oBAAoB,CAAC;IAOvE;;;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,mBAAmB,CAAC;CAGnF;AAED,MAAM,MAAM,iCAAiC,GAAG,YAAY,CAAC,oBAAoB,CAAC,CAAC;AAEnF;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,sBAAsB,CAAC,OAAO,GAAG,IAAI,CAAC;IAEhD;;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,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,sBAAsB,CAAC,OAAO,GAAG,IAAI,CAAC;IAEhD;;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,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,oBAAoB,CAAC,OAAO,GAAG,IAAI,CAAC;IAE9C;;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,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,mBAAmB,CAAC,OAAO,GAAG,IAAI,CAAC;IAE7C;;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,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,OAAO,CAAC,EAAE,oBAAoB,CAAC,OAAO,CAAC;IAEvC;;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,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,OAAO,CAAC,EAAE,oBAAoB,CAAC,OAAO,CAAC;IAEvC;;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,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB;CACF;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,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;CACH"}