@usehercules/sdk 1.1.0

package/src/internal/utils/path.ts

@@ -0,0 +1,88 @@
+import { HerculesError } from '../../core/error';
+
+/**
+ * Percent-encode everything that isn't safe to have in a path without encoding safe chars.
+ *
+ * Taken from https://datatracker.ietf.org/doc/html/rfc3986#section-3.3:
+ * > unreserved  = ALPHA / DIGIT / "-" / "." / "_" / "~"
+ * > sub-delims  = "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "="
+ * > pchar       = unreserved / pct-encoded / sub-delims / ":" / "@"
+ */
+export function encodeURIPath(str: string) {
+  return str.replace(/[^A-Za-z0-9\-._~!$&'()*+,;=:@]+/g, encodeURIComponent);
+}
+
+const EMPTY = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.create(null));
+
+export const createPathTagFunction = (pathEncoder = encodeURIPath) =>
+  function path(statics: readonly string[], ...params: readonly unknown[]): string {
+    // If there are no params, no processing is needed.
+    if (statics.length === 1) return statics[0]!;
+
+    let postPath = false;
+    const invalidSegments = [];
+    const path = statics.reduce((previousValue, currentValue, index) => {
+      if (/[?#]/.test(currentValue)) {
+        postPath = true;
+      }
+      const value = params[index];
+      let encoded = (postPath ? encodeURIComponent : pathEncoder)('' + value);
+      if (
+        index !== params.length &&
+        (value == null ||
+          (typeof value === 'object' &&
+            // handle values from other realms
+            value.toString ===
+              Object.getPrototypeOf(Object.getPrototypeOf((value as any).hasOwnProperty ?? EMPTY) ?? EMPTY)
+                ?.toString))
+      ) {
+        encoded = value + '';
+        invalidSegments.push({
+          start: previousValue.length + currentValue.length,
+          length: encoded.length,
+          error: `Value of type ${Object.prototype.toString
+            .call(value)
+            .slice(8, -1)} is not a valid path parameter`,
+        });
+      }
+      return previousValue + currentValue + (index === params.length ? '' : encoded);
+    }, '');
+
+    const pathOnly = path.split(/[?#]/, 1)[0]!;
+    const invalidSegmentPattern = /(?<=^|\/)(?:\.|%2e){1,2}(?=\/|$)/gi;
+    let match;
+
+    // Find all invalid segments
+    while ((match = invalidSegmentPattern.exec(pathOnly)) !== null) {
+      invalidSegments.push({
+        start: match.index,
+        length: match[0].length,
+        error: `Value "${match[0]}" can\'t be safely passed as a path parameter`,
+      });
+    }
+
+    invalidSegments.sort((a, b) => a.start - b.start);
+
+    if (invalidSegments.length > 0) {
+      let lastEnd = 0;
+      const underline = invalidSegments.reduce((acc, segment) => {
+        const spaces = ' '.repeat(segment.start - lastEnd);
+        const arrows = '^'.repeat(segment.length);
+        lastEnd = segment.start + segment.length;
+        return acc + spaces + arrows;
+      }, '');
+
+      throw new HerculesError(
+        `Path parameters result in path with invalid segments:\n${invalidSegments
+          .map((e) => e.error)
+          .join('\n')}\n${path}\n${underline}`,
+      );
+    }
+
+    return path;
+  };
+
+/**
+ * URI-encodes path params and ensures no unsafe /./ or /../ path segments are introduced.
+ */
+export const path = /* @__PURE__ */ createPathTagFunction(encodeURIPath);

package/src/internal/utils/sleep.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export const sleep = (ms: number) => new Promise<void>((resolve) => setTimeout(resolve, ms));

package/src/internal/utils/uuid.ts

@@ -0,0 +1,17 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+/**
+ * https://stackoverflow.com/a/2117523
+ */
+export let uuid4 = function () {
+  const { crypto } = globalThis as any;
+  if (crypto?.randomUUID) {
+    uuid4 = crypto.randomUUID.bind(crypto);
+    return crypto.randomUUID();
+  }
+  const u8 = new Uint8Array(1);
+  const randomByte = crypto ? () => crypto.getRandomValues(u8)[0]! : () => (Math.random() * 0xff) & 0xff;
+  return '10000000-1000-4000-8000-100000000000'.replace(/[018]/g, (c) =>
+    (+c ^ (randomByte() & (15 >> (+c / 4)))).toString(16),
+  );
+};

package/src/internal/utils/values.ts

@@ -0,0 +1,105 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { HerculesError } from '../../core/error';
+
+// https://url.spec.whatwg.org/#url-scheme-string
+const startsWithSchemeRegexp = /^[a-z][a-z0-9+.-]*:/i;
+
+export const isAbsoluteURL = (url: string): boolean => {
+  return startsWithSchemeRegexp.test(url);
+};
+
+export let isArray = (val: unknown): val is unknown[] => ((isArray = Array.isArray), isArray(val));
+export let isReadonlyArray = isArray as (val: unknown) => val is readonly unknown[];
+
+/** Returns an object if the given value isn't an object, otherwise returns as-is */
+export function maybeObj(x: unknown): object {
+  if (typeof x !== 'object') {
+    return {};
+  }
+
+  return x ?? {};
+}
+
+// https://stackoverflow.com/a/34491287
+export function isEmptyObj(obj: Object | null | undefined): boolean {
+  if (!obj) return true;
+  for (const _k in obj) return false;
+  return true;
+}
+
+// https://eslint.org/docs/latest/rules/no-prototype-builtins
+export function hasOwn<T extends object = object>(obj: T, key: PropertyKey): key is keyof T {
+  return Object.prototype.hasOwnProperty.call(obj, key);
+}
+
+export function isObj(obj: unknown): obj is Record<string, unknown> {
+  return obj != null && typeof obj === 'object' && !Array.isArray(obj);
+}
+
+export const ensurePresent = <T>(value: T | null | undefined): T => {
+  if (value == null) {
+    throw new HerculesError(`Expected a value to be given but received ${value} instead.`);
+  }
+
+  return value;
+};
+
+export const validatePositiveInteger = (name: string, n: unknown): number => {
+  if (typeof n !== 'number' || !Number.isInteger(n)) {
+    throw new HerculesError(`${name} must be an integer`);
+  }
+  if (n < 0) {
+    throw new HerculesError(`${name} must be a positive integer`);
+  }
+  return n;
+};
+
+export const coerceInteger = (value: unknown): number => {
+  if (typeof value === 'number') return Math.round(value);
+  if (typeof value === 'string') return parseInt(value, 10);
+
+  throw new HerculesError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
+};
+
+export const coerceFloat = (value: unknown): number => {
+  if (typeof value === 'number') return value;
+  if (typeof value === 'string') return parseFloat(value);
+
+  throw new HerculesError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
+};
+
+export const coerceBoolean = (value: unknown): boolean => {
+  if (typeof value === 'boolean') return value;
+  if (typeof value === 'string') return value === 'true';
+  return Boolean(value);
+};
+
+export const maybeCoerceInteger = (value: unknown): number | undefined => {
+  if (value == null) {
+    return undefined;
+  }
+  return coerceInteger(value);
+};
+
+export const maybeCoerceFloat = (value: unknown): number | undefined => {
+  if (value == null) {
+    return undefined;
+  }
+  return coerceFloat(value);
+};
+
+export const maybeCoerceBoolean = (value: unknown): boolean | undefined => {
+  if (value == null) {
+    return undefined;
+  }
+  return coerceBoolean(value);
+};
+
+export const safeJSON = (text: string) => {
+  try {
+    return JSON.parse(text);
+  } catch (err) {
+    return undefined;
+  }
+};

package/src/internal/utils.ts

@@ -0,0 +1,8 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './utils/values';
+export * from './utils/base64';
+export * from './utils/env';
+export * from './utils/log';
+export * from './utils/uuid';
+export * from './utils/sleep';

package/src/lib/.keep

@@ -0,0 +1,4 @@
+File generated from our OpenAPI spec by Stainless.
+
+This directory can be used to store custom files to expand the SDK.
+It is ignored by Stainless code generation and its content (other than this keep file) won't be touched.

package/src/pagination.ts

@@ -0,0 +1,2 @@
+/** @deprecated Import from ./core/pagination instead */
+export * from './core/pagination';

package/src/resource.ts

@@ -0,0 +1,2 @@
+/** @deprecated Import from ./core/resource instead */
+export * from './core/resource';

package/src/resources/beta/beta.ts

@@ -0,0 +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 {
+  SubscriptionCancelParams,
+  SubscriptionCancelResponse,
+  SubscriptionCheckParams,
+  SubscriptionCheckResponse,
+  SubscriptionCheckoutParams,
+  SubscriptionCheckoutResponse,
+  Subscriptions,
+} from './subscriptions/subscriptions';
+
+export class Beta extends APIResource {
+  subscriptions: SubscriptionsAPI.Subscriptions = new SubscriptionsAPI.Subscriptions(this._client);
+}
+
+Beta.Subscriptions = Subscriptions;
+
+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,
+  };
+}

package/src/resources/beta/index.ts

@@ -0,0 +1,12 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Beta } from './beta';
+export {
+  Subscriptions,
+  type SubscriptionCancelResponse,
+  type SubscriptionCheckResponse,
+  type SubscriptionCheckoutResponse,
+  type SubscriptionCancelParams,
+  type SubscriptionCheckParams,
+  type SubscriptionCheckoutParams,
+} from './subscriptions/index';

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

@@ -0,0 +1,221 @@
+// 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 {
+  /**
+   * Create Coupon
+   */
+  create(body: CouponCreateParams, options?: RequestOptions): APIPromise<Coupon> {
+    return this._client.post('/v1/subscriptions/coupons', { body, ...options });
+  }
+
+  /**
+   * Update Coupon
+   */
+  update(
+    couponID: string,
+    body: CouponUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Coupon> {
+    return this._client.patch(path`/v1/subscriptions/coupons/${couponID}`, { body, ...options });
+  }
+
+  /**
+   * List Coupons
+   */
+  list(
+    query: CouponListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<CouponsCursorIDPage, Coupon> {
+    return this._client.getAPIList('/v1/subscriptions/coupons', CursorIDPage<Coupon>, { query, ...options });
+  }
+
+  /**
+   * Delete Coupon
+   */
+  delete(couponID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/v1/subscriptions/coupons/${couponID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Get Coupon
+   */
+  get(couponID: string, options?: RequestOptions): APIPromise<Coupon> {
+    return this._client.get(path`/v1/subscriptions/coupons/${couponID}`, options);
+  }
+
+  /**
+   * Validate Promo Code
+   */
+  validate(body: CouponValidateParams, options?: RequestOptions): APIPromise<CouponValidateResponse> {
+    return this._client.post('/v1/subscriptions/coupons/validate', { body, ...options });
+  }
+}
+
+export type CouponsCursorIDPage = CursorIDPage<Coupon>;
+
+/**
+ * A coupon/promo code for discounts
+ */
+export interface Coupon {
+  /**
+   * An id for a data item
+   */
+  id: string;
+
+  active: boolean;
+
+  /**
+   * The promo code
+   */
+  code: string;
+
+  created: string;
+
+  duration: 'once' | 'repeating' | 'forever';
+
+  /**
+   * Number of times this coupon has been redeemed
+   */
+  times_redeemed: number;
+
+  /**
+   * Fixed amount discount in cents
+   */
+  amount_off?: number | null;
+
+  /**
+   * Currency for amount_off
+   */
+  currency?: string | null;
+
+  /**
+   * Number of months for repeating duration
+   */
+  duration_in_months?: number | null;
+
+  /**
+   * Maximum number of times this coupon can be redeemed
+   */
+  max_redemptions?: number | null;
+
+  name?: string | null;
+
+  /**
+   * Percentage discount (1-100)
+   */
+  percent_off?: number | null;
+
+  /**
+   * Date after which the coupon can no longer be redeemed
+   */
+  redeem_by?: string | null;
+}
+
+/**
+ * Validate promo code response
+ */
+export interface CouponValidateResponse {
+  /**
+   * Whether the promo code is valid
+   */
+  valid: boolean;
+
+  /**
+   * A coupon/promo code for discounts
+   */
+  coupon?: Coupon | null;
+
+  /**
+   * Error message if invalid
+   */
+  error?: string | null;
+}
+
+export interface CouponCreateParams {
+  /**
+   * The promo code customers will enter
+   */
+  code: string;
+
+  /**
+   * Fixed amount discount in cents
+   */
+  amount_off?: number;
+
+  /**
+   * Currency for amount_off
+   */
+  currency?: string;
+
+  duration?: 'once' | 'repeating' | 'forever';
+
+  /**
+   * Number of months for repeating duration
+   */
+  duration_in_months?: number;
+
+  /**
+   * Maximum number of redemptions
+   */
+  max_redemptions?: number;
+
+  /**
+   * Display name for the coupon
+   */
+  name?: string;
+
+  /**
+   * Percentage discount (1-100)
+   */
+  percent_off?: number;
+
+  /**
+   * Expiration date for the coupon
+   */
+  redeem_by?: string;
+}
+
+export interface CouponUpdateParams {
+  /**
+   * Whether the coupon is active
+   */
+  active?: boolean;
+
+  /**
+   * Display name for the coupon
+   */
+  name?: string;
+}
+
+export interface CouponListParams extends CursorIDPageParams {
+  active?: boolean;
+}
+
+export interface CouponValidateParams {
+  /**
+   * The promo code to validate
+   */
+  code: string;
+}
+
+export declare namespace Coupons {
+  export {
+    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/customers.ts

@@ -0,0 +1,168 @@
+// 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 {
+  /**
+   * Create Customer
+   */
+  create(body: CustomerCreateParams | null | undefined = {}, options?: RequestOptions): APIPromise<Customer> {
+    return this._client.post('/v1/subscriptions/customers', { body, ...options });
+  }
+
+  /**
+   * Update Customer
+   */
+  update(
+    customerID: string,
+    body: CustomerUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Customer> {
+    return this._client.patch(path`/v1/subscriptions/customers/${customerID}`, { body, ...options });
+  }
+
+  /**
+   * List Customers
+   */
+  list(
+    query: CustomerListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<CustomersCursorIDPage, Customer> {
+    return this._client.getAPIList('/v1/subscriptions/customers', CursorIDPage<Customer>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Delete Customer
+   */
+  delete(customerID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/v1/subscriptions/customers/${customerID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Open Customer Portal
+   */
+  billingPortal(
+    customerID: string,
+    body: CustomerBillingPortalParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CustomerBillingPortalResponse> {
+    return this._client.post(path`/v1/subscriptions/customers/${customerID}/billing_portal`, {
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * Get Customer
+   */
+  get(customerID: string, options?: RequestOptions): APIPromise<Customer> {
+    return this._client.get(path`/v1/subscriptions/customers/${customerID}`, options);
+  }
+}
+
+export type CustomersCursorIDPage = CursorIDPage<Customer>;
+
+/**
+ * A subscription customer
+ */
+export interface Customer {
+  /**
+   * An id for a data item
+   */
+  id: string;
+
+  created: string;
+
+  /**
+   * Customer billing address
+   */
+  address?: CustomerAddress | null;
+
+  email?: string | null;
+
+  name?: string | null;
+
+  phone?: string | null;
+
+  stripe_id?: string | null;
+}
+
+/**
+ * Customer billing address
+ */
+export interface CustomerAddress {
+  city?: string | null;
+
+  country?: string | null;
+
+  line1?: string | null;
+
+  line2?: string | null;
+
+  postal_code?: string | null;
+
+  state?: string | null;
+}
+
+/**
+ * Billing portal session URL
+ */
+export interface CustomerBillingPortalResponse {
+  url: string;
+}
+
+export interface CustomerCreateParams {
+  /**
+   * Customer billing address
+   */
+  address?: CustomerAddress;
+
+  email?: string;
+
+  name?: string;
+
+  phone?: string;
+}
+
+export interface CustomerUpdateParams {
+  /**
+   * Customer billing address
+   */
+  address?: CustomerAddress;
+
+  email?: string;
+
+  name?: string;
+
+  phone?: string;
+}
+
+export interface CustomerListParams extends CursorIDPageParams {}
+
+export interface CustomerBillingPortalParams {
+  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,
+  };
+}