@usehercules/sdk 1.1.0

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

@@ -0,0 +1,113 @@
+// 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 {
+  /**
+   * Create Entitlement
+   */
+  create(body: EntitlementCreateParams, options?: RequestOptions): APIPromise<Entitlement> {
+    return this._client.post('/v1/subscriptions/entitlements', { body, ...options });
+  }
+
+  /**
+   * Update Entitlement
+   */
+  update(
+    entitlementID: string,
+    body: EntitlementUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Entitlement> {
+    return this._client.patch(path`/v1/subscriptions/entitlements/${entitlementID}`, { body, ...options });
+  }
+
+  /**
+   * List Entitlements
+   */
+  list(
+    query: EntitlementListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<EntitlementsCursorIDPage, Entitlement> {
+    return this._client.getAPIList('/v1/subscriptions/entitlements', CursorIDPage<Entitlement>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Get Entitlement
+   */
+  get(entitlementID: string, options?: RequestOptions): APIPromise<Entitlement> {
+    return this._client.get(path`/v1/subscriptions/entitlements/${entitlementID}`, options);
+  }
+}
+
+export type EntitlementsCursorIDPage = CursorIDPage<Entitlement>;
+
+/**
+ * An entitlement that can be attached to products
+ */
+export interface Entitlement {
+  /**
+   * An id for a data item
+   */
+  id: string;
+
+  active: boolean;
+
+  livemode: boolean;
+
+  lookup_key: string;
+
+  name: string;
+}
+
+export interface EntitlementCreateParams {
+  /**
+   * A unique key to identify the entitlement in your system
+   */
+  lookup_key: string;
+
+  /**
+   * The name of the entitlement
+   */
+  name: string;
+}
+
+export interface EntitlementUpdateParams {
+  /**
+   * Whether the entitlement is active
+   */
+  active?: boolean;
+
+  /**
+   * The name of the entitlement
+   */
+  name?: string;
+}
+
+export interface EntitlementListParams extends CursorIDPageParams {
+  /**
+   * Filter by archived status
+   */
+  archived?: boolean;
+
+  /**
+   * Filter by lookup key
+   */
+  lookup_key?: string;
+}
+
+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/subscriptions/index.ts

@@ -0,0 +1,48 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Coupons,
+  type Coupon,
+  type CouponValidateResponse,
+  type CouponCreateParams,
+  type CouponUpdateParams,
+  type CouponListParams,
+  type CouponValidateParams,
+  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 {
+  Plans,
+  type Plan,
+  type PlanCreateParams,
+  type PlanUpdateParams,
+  type PlanListParams,
+  type PlansCursorIDPage,
+} from './plans/index';
+export {
+  Subscriptions,
+  type SubscriptionCancelResponse,
+  type SubscriptionCheckResponse,
+  type SubscriptionCheckoutResponse,
+  type SubscriptionCancelParams,
+  type SubscriptionCheckParams,
+  type SubscriptionCheckoutParams,
+} from './subscriptions';

package/src/resources/beta/subscriptions/plans/entitlements.ts

@@ -0,0 +1,88 @@
+// 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 {
+  /**
+   * List Plan Entitlements
+   */
+  list(
+    planID: string,
+    query: EntitlementListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<PlanEntitlementsCursorIDPage, PlanEntitlement> {
+    return this._client.getAPIList(
+      path`/v1/subscriptions/plans/${planID}/entitlements`,
+      CursorIDPage<PlanEntitlement>,
+      { query, ...options },
+    );
+  }
+
+  /**
+   * Attach Entitlement to Plan
+   */
+  attach(
+    planID: string,
+    body: EntitlementAttachParams,
+    options?: RequestOptions,
+  ): APIPromise<PlanEntitlement> {
+    return this._client.post(path`/v1/subscriptions/plans/${planID}/entitlements`, { body, ...options });
+  }
+
+  /**
+   * Remove Entitlement from Plan
+   */
+  remove(featureID: string, params: EntitlementRemoveParams, options?: RequestOptions): APIPromise<void> {
+    const { plan_id } = params;
+    return this._client.delete(path`/v1/subscriptions/plans/${plan_id}/entitlements/${featureID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export type PlanEntitlementsCursorIDPage = CursorIDPage<PlanEntitlement>;
+
+/**
+ * An entitlement attached to a plan
+ */
+export interface PlanEntitlement {
+  /**
+   * An id for a data item
+   */
+  id: string;
+
+  /**
+   * An entitlement that can be attached to products
+   */
+  entitlement: EntitlementsAPI.Entitlement;
+}
+
+export interface EntitlementListParams extends CursorIDPageParams {}
+
+export interface EntitlementAttachParams {
+  /**
+   * The ID of the entitlement to attach
+   */
+  entitlement: string;
+}
+
+export interface EntitlementRemoveParams {
+  plan_id: string;
+}
+
+export declare namespace Entitlements {
+  export {
+    type PlanEntitlement as PlanEntitlement,
+    type PlanEntitlementsCursorIDPage as PlanEntitlementsCursorIDPage,
+    type EntitlementListParams as EntitlementListParams,
+    type EntitlementAttachParams as EntitlementAttachParams,
+    type EntitlementRemoveParams as EntitlementRemoveParams,
+  };
+}

package/src/resources/beta/subscriptions/plans/index.ts

@@ -0,0 +1,18 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Entitlements,
+  type PlanEntitlement,
+  type EntitlementListParams,
+  type EntitlementAttachParams,
+  type EntitlementRemoveParams,
+  type PlanEntitlementsCursorIDPage,
+} from './entitlements';
+export {
+  Plans,
+  type Plan,
+  type PlanCreateParams,
+  type PlanUpdateParams,
+  type PlanListParams,
+  type PlansCursorIDPage,
+} from './plans';

package/src/resources/beta/subscriptions/plans/plans.ts

@@ -0,0 +1,159 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../core/resource';
+import * as EntitlementsAPI from './entitlements';
+import {
+  EntitlementAttachParams,
+  EntitlementListParams,
+  EntitlementRemoveParams,
+  Entitlements,
+  PlanEntitlement,
+  PlanEntitlementsCursorIDPage,
+} from './entitlements';
+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 Plans extends APIResource {
+  entitlements: EntitlementsAPI.Entitlements = new EntitlementsAPI.Entitlements(this._client);
+
+  /**
+   * Create Plan
+   */
+  create(body: PlanCreateParams, options?: RequestOptions): APIPromise<Plan> {
+    return this._client.post('/v1/subscriptions/plans', { body, ...options });
+  }
+
+  /**
+   * Update Plan
+   */
+  update(
+    planID: string,
+    body: PlanUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Plan> {
+    return this._client.patch(path`/v1/subscriptions/plans/${planID}`, { body, ...options });
+  }
+
+  /**
+   * List Plans
+   */
+  list(
+    query: PlanListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<PlansCursorIDPage, Plan> {
+    return this._client.getAPIList('/v1/subscriptions/plans', CursorIDPage<Plan>, { query, ...options });
+  }
+
+  /**
+   * Archive Plan
+   */
+  archive(planID: string, options?: RequestOptions): APIPromise<Plan> {
+    return this._client.delete(path`/v1/subscriptions/plans/${planID}`, options);
+  }
+
+  /**
+   * Get Plan
+   */
+  get(planID: string, options?: RequestOptions): APIPromise<Plan> {
+    return this._client.get(path`/v1/subscriptions/plans/${planID}`, options);
+  }
+}
+
+export type PlansCursorIDPage = CursorIDPage<Plan>;
+
+/**
+ * A subscription plan
+ */
+export interface Plan {
+  /**
+   * An id for a data item
+   */
+  id: string;
+
+  active: boolean;
+
+  created: string;
+
+  name: string;
+
+  stripe_product_id: string;
+
+  /**
+   * A recurring price for a plan
+   */
+  default_price?: Plan.DefaultPrice | null;
+
+  description?: string | null;
+}
+
+export namespace Plan {
+  /**
+   * A recurring price for a plan
+   */
+  export interface DefaultPrice {
+    /**
+     * An id for a data item
+     */
+    id: string;
+
+    currency: string;
+
+    interval: 'day' | 'week' | 'month' | 'year';
+
+    interval_count: number;
+
+    unit_amount: number | null;
+  }
+}
+
+export interface PlanCreateParams {
+  name: string;
+
+  /**
+   * Amount in cents
+   */
+  unit_amount: number;
+
+  currency?: string;
+
+  description?: string;
+
+  interval?: 'day' | 'week' | 'month' | 'year';
+
+  interval_count?: number;
+}
+
+export interface PlanUpdateParams {
+  active?: boolean;
+
+  description?: string;
+
+  name?: string;
+}
+
+export interface PlanListParams extends CursorIDPageParams {
+  active?: boolean;
+}
+
+Plans.Entitlements = Entitlements;
+
+export declare namespace Plans {
+  export {
+    type Plan as Plan,
+    type PlansCursorIDPage as PlansCursorIDPage,
+    type PlanCreateParams as PlanCreateParams,
+    type PlanUpdateParams as PlanUpdateParams,
+    type PlanListParams as PlanListParams,
+  };
+
+  export {
+    Entitlements as Entitlements,
+    type PlanEntitlement as PlanEntitlement,
+    type PlanEntitlementsCursorIDPage as PlanEntitlementsCursorIDPage,
+    type EntitlementListParams as EntitlementListParams,
+    type EntitlementAttachParams as EntitlementAttachParams,
+    type EntitlementRemoveParams as EntitlementRemoveParams,
+  };
+}

package/src/resources/beta/subscriptions/plans.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './plans/index';

package/src/resources/beta/subscriptions/subscriptions.ts

@@ -0,0 +1,245 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as CouponsAPI from './coupons';
+import {
+  Coupon,
+  CouponCreateParams,
+  CouponListParams,
+  CouponUpdateParams,
+  CouponValidateParams,
+  CouponValidateResponse,
+  Coupons,
+  CouponsCursorIDPage,
+} from './coupons';
+import * as CustomersAPI from './customers';
+import {
+  Customer,
+  CustomerAddress,
+  CustomerBillingPortalParams,
+  CustomerBillingPortalResponse,
+  CustomerCreateParams,
+  CustomerListParams,
+  CustomerUpdateParams,
+  Customers,
+  CustomersCursorIDPage,
+} from './customers';
+import * as EntitlementsAPI from './entitlements';
+import {
+  Entitlement,
+  EntitlementCreateParams,
+  EntitlementListParams,
+  EntitlementUpdateParams,
+  Entitlements,
+  EntitlementsCursorIDPage,
+} from './entitlements';
+import * as PlansAPI from './plans/plans';
+import {
+  Plan,
+  PlanCreateParams,
+  PlanListParams,
+  PlanUpdateParams,
+  Plans,
+  PlansCursorIDPage,
+} from './plans/plans';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+
+export class Subscriptions extends APIResource {
+  customers: CustomersAPI.Customers = new CustomersAPI.Customers(this._client);
+  plans: PlansAPI.Plans = new PlansAPI.Plans(this._client);
+  entitlements: EntitlementsAPI.Entitlements = new EntitlementsAPI.Entitlements(this._client);
+  coupons: CouponsAPI.Coupons = new CouponsAPI.Coupons(this._client);
+
+  /**
+   * Cancel Subscription
+   */
+  cancel(body: SubscriptionCancelParams, options?: RequestOptions): APIPromise<SubscriptionCancelResponse> {
+    return this._client.post('/v1/subscriptions/cancel', { body, ...options });
+  }
+
+  /**
+   * Check Entitlement
+   */
+  check(body: SubscriptionCheckParams, options?: RequestOptions): APIPromise<SubscriptionCheckResponse> {
+    return this._client.post('/v1/subscriptions/check', { body, ...options });
+  }
+
+  /**
+   * Create Checkout Session
+   */
+  checkout(
+    body: SubscriptionCheckoutParams,
+    options?: RequestOptions,
+  ): APIPromise<SubscriptionCheckoutResponse> {
+    return this._client.post('/v1/subscriptions/checkout', { body, ...options });
+  }
+}
+
+/**
+ * Cancel subscription response
+ */
+export interface SubscriptionCancelResponse {
+  /**
+   * The subscription ID
+   */
+  id: string;
+
+  /**
+   * Whether the subscription will cancel at period end
+   */
+  cancel_at_period_end: boolean;
+
+  /**
+   * The subscription status
+   */
+  status: string;
+
+  /**
+   * When the subscription was canceled
+   */
+  canceled_at?: string | null;
+}
+
+/**
+ * Check entitlement response
+ */
+export interface SubscriptionCheckResponse {
+  /**
+   * Whether the customer has the entitlement
+   */
+  has_entitlement: boolean;
+
+  /**
+   * The entitlement lookup key that was checked
+   */
+  lookup_key: string;
+
+  /**
+   * The active entitlement ID if present
+   */
+  entitlement_id?: string | null;
+}
+
+/**
+ * Checkout session response
+ */
+export interface SubscriptionCheckoutResponse {
+  /**
+   * The checkout session ID
+   */
+  id: string;
+
+  /**
+   * The checkout URL to redirect the customer to
+   */
+  url: string;
+}
+
+export interface SubscriptionCancelParams {
+  /**
+   * The customer ID
+   */
+  customer_id: string;
+
+  /**
+   * The subscription ID to cancel
+   */
+  subscription_id: string;
+
+  /**
+   * Whether to cancel at period end or immediately
+   */
+  cancel_at_period_end?: boolean;
+}
+
+export interface SubscriptionCheckParams {
+  /**
+   * The customer ID
+   */
+  customer_id: string;
+
+  /**
+   * The entitlement feature lookup key to check
+   */
+  entitlement_lookup_key: string;
+}
+
+export interface SubscriptionCheckoutParams {
+  /**
+   * The customer ID
+   */
+  customer_id: string;
+
+  /**
+   * The plan ID to subscribe to
+   */
+  plan_id: string;
+
+  /**
+   * URL to redirect on cancel
+   */
+  cancel_url?: string;
+
+  /**
+   * URL to redirect on success
+   */
+  success_url?: string;
+}
+
+Subscriptions.Customers = Customers;
+Subscriptions.Plans = Plans;
+Subscriptions.Entitlements = Entitlements;
+Subscriptions.Coupons = Coupons;
+
+export declare namespace Subscriptions {
+  export {
+    type SubscriptionCancelResponse as SubscriptionCancelResponse,
+    type SubscriptionCheckResponse as SubscriptionCheckResponse,
+    type SubscriptionCheckoutResponse as SubscriptionCheckoutResponse,
+    type SubscriptionCancelParams as SubscriptionCancelParams,
+    type SubscriptionCheckParams as SubscriptionCheckParams,
+    type SubscriptionCheckoutParams as SubscriptionCheckoutParams,
+  };
+
+  export {
+    Customers as Customers,
+    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,
+  };
+
+  export {
+    Plans as Plans,
+    type Plan as Plan,
+    type PlansCursorIDPage as PlansCursorIDPage,
+    type PlanCreateParams as PlanCreateParams,
+    type PlanUpdateParams as PlanUpdateParams,
+    type PlanListParams as PlanListParams,
+  };
+
+  export {
+    Entitlements as Entitlements,
+    type Entitlement as Entitlement,
+    type EntitlementsCursorIDPage as EntitlementsCursorIDPage,
+    type EntitlementCreateParams as EntitlementCreateParams,
+    type EntitlementUpdateParams as EntitlementUpdateParams,
+    type EntitlementListParams as EntitlementListParams,
+  };
+
+  export {
+    Coupons as Coupons,
+    type Coupon as Coupon,
+    type CouponValidateResponse as CouponValidateResponse,
+    type CouponsCursorIDPage as CouponsCursorIDPage,
+    type CouponCreateParams as CouponCreateParams,
+    type CouponUpdateParams as CouponUpdateParams,
+    type CouponListParams as CouponListParams,
+    type CouponValidateParams as CouponValidateParams,
+  };
+}

package/src/resources/beta/subscriptions.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './subscriptions/index';

package/src/resources/beta.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './beta/index';

package/src/resources/index.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Beta } from './beta/beta';

package/src/resources.ts

@@ -0,0 +1 @@
+export * from './resources/index';

package/src/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  // this config is included in the published src directory to prevent TS errors
+  // from appearing when users go to source, and VSCode opens the source .ts file
+  // via declaration maps
+  "include": ["index.ts"],
+  "compilerOptions": {
+    "target": "ES2015",
+    "lib": ["DOM", "DOM.Iterable", "ES2018"],
+    "moduleResolution": "node"
+  }
+}