@usehercules/sdk 1.7.0 → 1.8.0

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

@@ -1,229 +0,0 @@
-// 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 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> {
-    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: string,
-    body: CustomerUpdateParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<Customer> {
-    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: CustomerListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<CustomersCursorIDPage, Customer> {
-    return this._client.getAPIList('/v1/pay/customers', CursorIDPage<Customer>, { query, ...options });
-  }
-
-  /**
-   * Permanently deletes a customer. This also cancels any active subscriptions. This
-   * action cannot be undone.
-   */
-  delete(customerID: string, options?: RequestOptions): APIPromise<void> {
-    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: string,
-    body: CustomerBillingPortalParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<CustomerBillingPortalResponse> {
-    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: string, options?: RequestOptions): APIPromise<Customer> {
-    return this._client.get(path`/v1/pay/customers/${customerID}`, options);
-  }
-}
-
-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 topic subscription
-   */
-  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,
-  };
-}

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

@@ -1,113 +0,0 @@
-// 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 { RequestOptions } from '../../../internal/request-options';
-import { path } from '../../../internal/utils/path';
-
-export class Entitlements extends APIResource {
-  /**
-   * 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> {
-    return this._client.post('/v1/pay/entitlements', { body, ...options });
-  }
-
-  /**
-   * 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> {
-    return this._client.patch(path`/v1/pay/entitlements/${entitlementID}`, { body, ...options });
-  }
-
-  /**
-   * 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> {
-    return this._client.getAPIList('/v1/pay/entitlements', CursorIDPage<Entitlement>, { query, ...options });
-  }
-
-  /**
-   * Retrieves an entitlement by ID. Returns the entitlement object including its
-   * active status.
-   */
-  get(entitlementID: string, options?: RequestOptions): APIPromise<Entitlement> {
-    return this._client.get(path`/v1/pay/entitlements/${entitlementID}`, options);
-  }
-}
-
-export type EntitlementsCursorIDPage = CursorIDPage<Entitlement>;
-
-/**
- * The entitlement attached to the product
- */
-export interface Entitlement {
-  /**
-   * Unique identifier for the topic subscription
-   */
-  id: string;
-
-  /**
-   * Whether the entitlement is active and can be attached to products
-   */
-  active: boolean;
-
-  /**
-   * Display name for the entitlement (e.g., API Access, Premium Support)
-   */
-  name: string;
-}
-
-export interface EntitlementCreateParams {
-  /**
-   * Display name for the entitlement (e.g., API Access, Premium Support)
-   */
-  name: string;
-
-  /**
-   * Optional custom ID for the entitlement. If not provided, one will be generated.
-   */
-  id?: string;
-}
-
-export interface EntitlementUpdateParams {
-  /**
-   * Whether the entitlement is active. Deactivating removes it from access checks.
-   */
-  active?: boolean;
-
-  /**
-   * Display name for the entitlement
-   */
-  name?: string;
-}
-
-export interface EntitlementListParams extends CursorIDPageParams {
-  /**
-   * Filter by archived status
-   */
-  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/src/resources/beta/pay/index.ts

@@ -1,46 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-export {
-  Coupons,
-  type Coupon,
-  type CouponCreateParams,
-  type CouponUpdateParams,
-  type CouponListParams,
-  type CouponsCursorIDPage,
-} from './coupons';
-export {
-  Customers,
-  type Customer,
-  type CustomerAddress,
-  type CustomerBillingPortalResponse,
-  type CustomerCreateParams,
-  type CustomerUpdateParams,
-  type CustomerListParams,
-  type CustomerBillingPortalParams,
-  type CustomersCursorIDPage,
-} from './customers';
-export {
-  Entitlements,
-  type Entitlement,
-  type EntitlementCreateParams,
-  type EntitlementUpdateParams,
-  type EntitlementListParams,
-  type EntitlementsCursorIDPage,
-} from './entitlements';
-export {
-  Pay,
-  type PayCancelResponse,
-  type PayCheckResponse,
-  type PayCheckoutResponse,
-  type PayCancelParams,
-  type PayCheckParams,
-  type PayCheckoutParams,
-} from './pay';
-export {
-  Products,
-  type Product,
-  type ProductCreateParams,
-  type ProductUpdateParams,
-  type ProductListParams,
-  type ProductsCursorIDPage,
-} from './products/index';

package/src/resources/beta/pay/products/entitlements.ts

@@ -1,93 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-import { APIResource } from '../../../../core/resource';
-import * as EntitlementsAPI from '../entitlements';
-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 Entitlements extends APIResource {
-  /**
-   * Retrieves all entitlements attached to a product. These entitlements define the
-   * features that customers subscribed to this product can access.
-   */
-  list(
-    productID: string,
-    query: EntitlementListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<ProductEntitlementsCursorIDPage, ProductEntitlement> {
-    return this._client.getAPIList(
-      path`/v1/pay/products/${productID}/entitlements`,
-      CursorIDPage<ProductEntitlement>,
-      { query, ...options },
-    );
-  }
-
-  /**
-   * Attaches an entitlement to a product. All customers subscribed to this product
-   * will gain access to the attached feature. Hercules recommends attaching
-   * entitlements when creating or updating products to keep feature access in sync.
-   */
-  attach(
-    productID: string,
-    body: EntitlementAttachParams,
-    options?: RequestOptions,
-  ): APIPromise<ProductEntitlement> {
-    return this._client.post(path`/v1/pay/products/${productID}/entitlements`, { body, ...options });
-  }
-
-  /**
-   * Removes an entitlement from a product. Customers subscribed to this product will
-   * lose access to the feature. Existing subscriptions are affected immediately.
-   */
-  remove(featureID: string, params: EntitlementRemoveParams, options?: RequestOptions): APIPromise<void> {
-    const { product_id } = params;
-    return this._client.delete(path`/v1/pay/products/${product_id}/entitlements/${featureID}`, {
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
-  }
-}
-
-export type ProductEntitlementsCursorIDPage = CursorIDPage<ProductEntitlement>;
-
-/**
- * An entitlement attached to a product. All customers subscribed to the product
- * gain access to this entitlement.
- */
-export interface ProductEntitlement {
-  /**
-   * Unique identifier for the topic subscription
-   */
-  id: string;
-
-  /**
-   * The entitlement attached to the product
-   */
-  entitlement: EntitlementsAPI.Entitlement;
-}
-
-export interface EntitlementListParams extends CursorIDPageParams {}
-
-export interface EntitlementAttachParams {
-  /**
-   * The ID of the entitlement to attach to the product
-   */
-  entitlement: string;
-}
-
-export interface EntitlementRemoveParams {
-  product_id: string;
-}
-
-export declare namespace Entitlements {
-  export {
-    type ProductEntitlement as ProductEntitlement,
-    type ProductEntitlementsCursorIDPage as ProductEntitlementsCursorIDPage,
-    type EntitlementListParams as EntitlementListParams,
-    type EntitlementAttachParams as EntitlementAttachParams,
-    type EntitlementRemoveParams as EntitlementRemoveParams,
-  };
-}

package/src/resources/beta/pay/products/index.ts

@@ -1,28 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-export {
-  Entitlements,
-  type ProductEntitlement,
-  type EntitlementListParams,
-  type EntitlementAttachParams,
-  type EntitlementRemoveParams,
-  type ProductEntitlementsCursorIDPage,
-} from './entitlements';
-export {
-  Products,
-  type Product,
-  type ProductCreateParams,
-  type ProductUpdateParams,
-  type ProductListParams,
-  type ProductsCursorIDPage,
-} from './products';
-export {
-  Variants,
-  type Variant,
-  type VariantCreateParams,
-  type VariantUpdateParams,
-  type VariantListParams,
-  type VariantArchiveParams,
-  type VariantGetParams,
-  type VariantsCursorIDPage,
-} from './variants';