@stigg/typescript 0.1.0-alpha.8 → 0.1.0-beta.1

package/src/resources/v1/customers/index.ts

@@ -2,18 +2,33 @@
 
 export {
   Customers,
+  type CustomerIntegrationResponse,
   type CustomerResponse,
   type CustomerListResponse,
+  type CustomerCheckEntitlementResponse,
   type CustomerImportResponse,
   type CustomerListResourcesResponse,
+  type CustomerRetrieveEntitlementsResponse,
   type CustomerUpdateParams,
   type CustomerListParams,
+  type CustomerCheckEntitlementParams,
   type CustomerImportParams,
   type CustomerListResourcesParams,
   type CustomerProvisionParams,
+  type CustomerRetrieveEntitlementsParams,
   type CustomerListResponsesMyCursorIDPage,
   type CustomerListResourcesResponsesMyCursorIDPage,
 } from './customers';
+export {
+  Integrations,
+  type IntegrationListResponse,
+  type IntegrationRetrieveParams,
+  type IntegrationUpdateParams,
+  type IntegrationListParams,
+  type IntegrationLinkParams,
+  type IntegrationUnlinkParams,
+  type IntegrationListResponsesMyCursorIDPage,
+} from './integrations';
 export { PaymentMethod, type PaymentMethodAttachParams } from './payment-method';
 export {
   PromotionalEntitlements,

package/src/resources/v1/customers/integrations.ts

@@ -0,0 +1,252 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as CustomersAPI from './customers';
+import { APIPromise } from '../../../core/api-promise';
+import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from '../../../core/pagination';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class Integrations extends APIResource {
+  /**
+   * Retrieves a specific integration for a customer by integration ID.
+   */
+  retrieve(
+    integrationID: string,
+    params: IntegrationRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<CustomersAPI.CustomerIntegrationResponse> {
+    const { id } = params;
+    return this._client.get(path`/api/v1/customers/${id}/integrations/${integrationID}`, options);
+  }
+
+  /**
+   * Updates a customer's integration link, such as changing the synced external
+   * entity ID.
+   */
+  update(
+    integrationID: string,
+    params: IntegrationUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<CustomersAPI.CustomerIntegrationResponse> {
+    const { id, ...body } = params;
+    return this._client.patch(path`/api/v1/customers/${id}/integrations/${integrationID}`, {
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * Retrieves a paginated list of a customer's external integrations (billing, CRM,
+   * etc.).
+   */
+  list(
+    id: string,
+    query: IntegrationListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<IntegrationListResponsesMyCursorIDPage, IntegrationListResponse> {
+    return this._client.getAPIList(
+      path`/api/v1/customers/${id}/integrations`,
+      MyCursorIDPage<IntegrationListResponse>,
+      { query, ...options },
+    );
+  }
+
+  /**
+   * Links a customer to an external integration by specifying the vendor and
+   * external entity ID.
+   */
+  link(
+    id: string,
+    body: IntegrationLinkParams,
+    options?: RequestOptions,
+  ): APIPromise<CustomersAPI.CustomerIntegrationResponse> {
+    return this._client.post(path`/api/v1/customers/${id}/integrations`, { body, ...options });
+  }
+
+  /**
+   * Removes the link between a customer and an external integration.
+   */
+  unlink(
+    integrationID: string,
+    params: IntegrationUnlinkParams,
+    options?: RequestOptions,
+  ): APIPromise<CustomersAPI.CustomerIntegrationResponse> {
+    const { id } = params;
+    return this._client.delete(path`/api/v1/customers/${id}/integrations/${integrationID}`, options);
+  }
+}
+
+export type IntegrationListResponsesMyCursorIDPage = MyCursorIDPage<IntegrationListResponse>;
+
+/**
+ * External billing or CRM integration link
+ */
+export interface IntegrationListResponse {
+  /**
+   * Integration details
+   */
+  id: string;
+
+  /**
+   * Synced entity id
+   */
+  syncedEntityId: string | null;
+
+  /**
+   * The vendor identifier of integration
+   */
+  vendorIdentifier:
+    | 'AUTH0'
+    | 'ZUORA'
+    | 'STRIPE'
+    | 'HUBSPOT'
+    | 'AWS_MARKETPLACE'
+    | 'SNOWFLAKE'
+    | 'SALESFORCE'
+    | 'BIG_QUERY'
+    | 'OPEN_FGA'
+    | 'APP_STORE';
+
+  /**
+   * Price billing sync revision data containing billing ID, link URL, and price
+   * group package billing ID
+   */
+  syncData?:
+    | IntegrationListResponse.SyncRevisionPriceBillingData
+    | IntegrationListResponse.SyncRevisionBillingData
+    | IntegrationListResponse.SyncRevisionMarketplaceData
+    | null;
+}
+
+export namespace IntegrationListResponse {
+  /**
+   * Price billing sync revision data containing billing ID, link URL, and price
+   * group package billing ID
+   */
+  export interface SyncRevisionPriceBillingData {
+    /**
+     * Billing integration id
+     */
+    billingId: string;
+
+    /**
+     * Billing integration url
+     */
+    billingLinkUrl: string;
+
+    /**
+     * Price group package billing id
+     */
+    priceGroupPackageBillingId: string;
+  }
+
+  /**
+   * Billing sync revision data containing billing ID and link URL
+   */
+  export interface SyncRevisionBillingData {
+    /**
+     * Billing integration id
+     */
+    billingId: string;
+
+    /**
+     * Billing integration url
+     */
+    billingLinkUrl: string;
+  }
+
+  /**
+   * Marketplace sync revision data containing dimensions
+   */
+  export interface SyncRevisionMarketplaceData {
+    /**
+     * Dimensions of the marketplace sync revision
+     */
+    dimensions: string;
+  }
+}
+
+export interface IntegrationRetrieveParams {
+  /**
+   * Customer slug
+   */
+  id: string;
+}
+
+export interface IntegrationUpdateParams {
+  /**
+   * Path param: Customer slug
+   */
+  id: string;
+
+  /**
+   * Body param: Synced entity id
+   */
+  syncedEntityId: string | null;
+}
+
+export interface IntegrationListParams extends MyCursorIDPageParams {
+  /**
+   * Filter by vendor identifier. Supports comma-separated values for multiple
+   * vendors (e.g., STRIPE,HUBSPOT)
+   */
+  vendorIdentifier?: Array<
+    | 'AUTH0'
+    | 'ZUORA'
+    | 'STRIPE'
+    | 'HUBSPOT'
+    | 'AWS_MARKETPLACE'
+    | 'SNOWFLAKE'
+    | 'SALESFORCE'
+    | 'BIG_QUERY'
+    | 'OPEN_FGA'
+    | 'APP_STORE'
+  >;
+}
+
+export interface IntegrationLinkParams {
+  /**
+   * Integration details
+   */
+  id: string;
+
+  /**
+   * Synced entity id
+   */
+  syncedEntityId: string;
+
+  /**
+   * The vendor identifier of integration
+   */
+  vendorIdentifier:
+    | 'AUTH0'
+    | 'ZUORA'
+    | 'STRIPE'
+    | 'HUBSPOT'
+    | 'AWS_MARKETPLACE'
+    | 'SNOWFLAKE'
+    | 'SALESFORCE'
+    | 'BIG_QUERY'
+    | 'OPEN_FGA'
+    | 'APP_STORE';
+}
+
+export interface IntegrationUnlinkParams {
+  /**
+   * Customer slug
+   */
+  id: string;
+}
+
+export declare namespace Integrations {
+  export {
+    type IntegrationListResponse as IntegrationListResponse,
+    type IntegrationListResponsesMyCursorIDPage as IntegrationListResponsesMyCursorIDPage,
+    type IntegrationRetrieveParams as IntegrationRetrieveParams,
+    type IntegrationUpdateParams as IntegrationUpdateParams,
+    type IntegrationListParams as IntegrationListParams,
+    type IntegrationLinkParams as IntegrationLinkParams,
+    type IntegrationUnlinkParams as IntegrationUnlinkParams,
+  };
+}

package/src/resources/v1/customers/payment-method.ts

@@ -6,6 +6,9 @@ import { APIPromise } from '../../../core/api-promise';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
+/**
+ * Operations related to customers
+ */
 export class PaymentMethod extends APIResource {
   /**
    * Attaches a payment method to a customer for billing. Required for paid

package/src/resources/v1/customers/promotional-entitlements.ts

@@ -6,6 +6,9 @@ import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from '../../..
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
+/**
+ * Operations related to promotional entitlements
+ */
 export class PromotionalEntitlements extends APIResource {
   /**
    * Grants promotional entitlements to a customer, providing feature access outside
@@ -619,7 +622,7 @@ export interface PromotionalEntitlementListParams extends MyCursorIDPageParams {
    * Filter by promotional entitlement status. Supports comma-separated values for
    * multiple statuses
    */
-  status?: string;
+  status?: Array<'Active' | 'Expired' | 'Paused'>;
 }
 
 export namespace PromotionalEntitlementListParams {

package/src/resources/v1/events/credits/credits.ts

@@ -0,0 +1,402 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../core/resource';
+import * as CustomCurrenciesAPI from './custom-currencies';
+import {
+  CustomCurrencies,
+  CustomCurrencyArchiveResponse,
+  CustomCurrencyCreateParams,
+  CustomCurrencyCreateResponse,
+  CustomCurrencyListAssociatedEntitiesResponse,
+  CustomCurrencyListParams,
+  CustomCurrencyListResponse,
+  CustomCurrencyListResponsesMyCursorIDPage,
+  CustomCurrencyUnarchiveResponse,
+  CustomCurrencyUpdateParams,
+  CustomCurrencyUpdateResponse,
+} from './custom-currencies';
+import * as GrantsAPI from './grants';
+import {
+  CreditGrantResponse,
+  GrantCreateParams,
+  GrantListParams,
+  GrantListResponse,
+  GrantListResponsesMyCursorIDPage,
+  Grants,
+} from './grants';
+import { APIPromise } from '../../../../core/api-promise';
+import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from '../../../../core/pagination';
+import { RequestOptions } from '../../../../internal/request-options';
+
+export class Credits extends APIResource {
+  grants: GrantsAPI.Grants = new GrantsAPI.Grants(this._client);
+  customCurrencies: CustomCurrenciesAPI.CustomCurrencies = new CustomCurrenciesAPI.CustomCurrencies(
+    this._client,
+  );
+
+  /**
+   * Retrieves the automatic recharge configuration for a customer and currency.
+   * Returns default settings if no configuration exists.
+   */
+  getAutoRecharge(
+    query: CreditGetAutoRechargeParams,
+    options?: RequestOptions,
+  ): APIPromise<CreditGetAutoRechargeResponse> {
+    return this._client.get('/api/v1/credits/auto-recharge', { query, ...options });
+  }
+
+  /**
+   * Retrieves credit usage time-series data for a customer, grouped by feature, over
+   * a specified time range.
+   */
+  getUsage(query: CreditGetUsageParams, options?: RequestOptions): APIPromise<CreditGetUsageResponse> {
+    return this._client.get('/api/v1/credits/usage', { query, ...options });
+  }
+
+  /**
+   * Retrieves a paginated list of credit ledger events for a customer.
+   */
+  listLedger(
+    query: CreditListLedgerParams,
+    options?: RequestOptions,
+  ): PagePromise<CreditListLedgerResponsesMyCursorIDPage, CreditListLedgerResponse> {
+    return this._client.getAPIList('/api/v1/credits/ledger', MyCursorIDPage<CreditListLedgerResponse>, {
+      query,
+      ...options,
+    });
+  }
+}
+
+export type CreditListLedgerResponsesMyCursorIDPage = MyCursorIDPage<CreditListLedgerResponse>;
+
+/**
+ * Response object
+ */
+export interface CreditGetAutoRechargeResponse {
+  /**
+   * Automatic recharge configuration for a customer and currency
+   */
+  data: CreditGetAutoRechargeResponse.Data;
+}
+
+export namespace CreditGetAutoRechargeResponse {
+  /**
+   * Automatic recharge configuration for a customer and currency
+   */
+  export interface Data {
+    /**
+     * The unique configuration ID
+     */
+    id: string | null;
+
+    /**
+     * Timestamp of when the record was created
+     */
+    createdAt: string | null;
+
+    /**
+     * The currency ID for this configuration
+     */
+    currencyId: string;
+
+    /**
+     * The customer ID this configuration belongs to
+     */
+    customerId: string;
+
+    /**
+     * Expiration period for auto-recharge grants (1_MONTH or 1_YEAR)
+     */
+    grantExpirationPeriod: '1_MONTH' | '1_YEAR';
+
+    /**
+     * Whether automatic recharge is enabled
+     */
+    isEnabled: boolean;
+
+    /**
+     * Maximum monthly spend limit for automatic recharges
+     */
+    maxSpendLimit: number | null;
+
+    /**
+     * The target credit balance to recharge to
+     */
+    targetBalance: number;
+
+    /**
+     * The threshold type (CREDIT_AMOUNT or DOLLAR_AMOUNT)
+     */
+    thresholdType: 'CREDIT_AMOUNT' | 'DOLLAR_AMOUNT';
+
+    /**
+     * The threshold value that triggers a recharge
+     */
+    thresholdValue: number;
+
+    /**
+     * Timestamp of when the record was last updated
+     */
+    updatedAt: string | null;
+  }
+}
+
+/**
+ * Response object
+ */
+export interface CreditGetUsageResponse {
+  /**
+   * Credit usage data grouped by feature with time-series points
+   */
+  data: CreditGetUsageResponse.Data;
+}
+
+export namespace CreditGetUsageResponse {
+  /**
+   * Credit usage data grouped by feature with time-series points
+   */
+  export interface Data {
+    /**
+     * The custom currency used for credit measurement
+     */
+    currency: Data.Currency | null;
+
+    /**
+     * Credit usage series grouped by feature
+     */
+    series: Array<Data.Series>;
+  }
+
+  export namespace Data {
+    /**
+     * The custom currency used for credit measurement
+     */
+    export interface Currency {
+      /**
+       * The currency identifier
+       */
+      currencyId: string;
+
+      /**
+       * The display name of the currency
+       */
+      displayName: string;
+
+      /**
+       * Plural unit label
+       */
+      plural: string | null;
+
+      /**
+       * Singular unit label
+       */
+      singular: string | null;
+
+      /**
+       * The currency symbol
+       */
+      symbol: string | null;
+    }
+
+    /**
+     * Credit usage data for a single feature
+     */
+    export interface Series {
+      /**
+       * The feature ID
+       */
+      featureId: string;
+
+      /**
+       * The display name of the feature
+       */
+      featureName: string;
+
+      /**
+       * Time-series data points for this feature
+       */
+      points: Array<Series.Point>;
+
+      /**
+       * Total credits consumed by this feature in the time range
+       */
+      totalCredits: number;
+    }
+
+    export namespace Series {
+      /**
+       * A single data point in the credit usage time series
+       */
+      export interface Point {
+        /**
+         * The timestamp of the data point
+         */
+        timestamp: string;
+
+        /**
+         * The credit usage value at this point
+         */
+        value: number;
+      }
+    }
+  }
+}
+
+/**
+ * A credit ledger event representing a change to credit balance
+ */
+export interface CreditListLedgerResponse {
+  /**
+   * The credit amount for this event
+   */
+  amount: number;
+
+  /**
+   * The credit currency ID
+   */
+  creditCurrencyId: string;
+
+  /**
+   * The credit grant ID associated with this event
+   */
+  creditGrantId: string;
+
+  /**
+   * The customer ID this event belongs to
+   */
+  customerId: string;
+
+  /**
+   * The unique event identifier
+   */
+  eventId: string | null;
+
+  /**
+   * The type of credit event
+   */
+  eventType:
+    | 'CREDITS_GRANTED'
+    | 'CREDITS_EXPIRED'
+    | 'CREDITS_CONSUMED'
+    | 'CREDITS_VOIDED'
+    | 'CREDITS_UPDATED'
+    | 'CREDITS_CONSUMPTION_TRANSFER_SOURCE'
+    | 'CREDITS_CONSUMPTION_TRANSFER_TARGET';
+
+  /**
+   * The feature ID associated with this event
+   */
+  featureId: string | null;
+
+  /**
+   * The resource ID this event is scoped to
+   */
+  resourceId: string | null;
+
+  /**
+   * The timestamp when the event occurred
+   */
+  timestamp: string;
+}
+
+export interface CreditGetAutoRechargeParams {
+  /**
+   * Filter by currency ID (required)
+   */
+  currencyId: string;
+
+  /**
+   * Filter by customer ID (required)
+   */
+  customerId: string;
+}
+
+export interface CreditGetUsageParams {
+  /**
+   * Filter by customer ID (required)
+   */
+  customerId: string;
+
+  /**
+   * Filter by currency ID
+   */
+  currencyId?: string;
+
+  /**
+   * End date for the credit usage time range (ISO 8601). Defaults to now when
+   * startDate is provided
+   */
+  endDate?: string;
+
+  /**
+   * Filter by resource ID
+   */
+  resourceId?: string;
+
+  /**
+   * Start date for the credit usage time range (ISO 8601). Takes precedence over
+   * timeRange when provided
+   */
+  startDate?: string;
+
+  /**
+   * Time range for usage data (LAST_DAY, LAST_WEEK, LAST_MONTH, LAST_YEAR). Defaults
+   * to LAST_MONTH
+   */
+  timeRange?: 'LAST_DAY' | 'LAST_WEEK' | 'LAST_MONTH' | 'LAST_YEAR';
+}
+
+export interface CreditListLedgerParams extends MyCursorIDPageParams {
+  /**
+   * Filter by customer ID (required)
+   */
+  customerId: string;
+
+  /**
+   * Filter by currency ID
+   */
+  currencyId?: string;
+
+  /**
+   * Filter by resource ID
+   */
+  resourceId?: string;
+}
+
+Credits.Grants = Grants;
+Credits.CustomCurrencies = CustomCurrencies;
+
+export declare namespace Credits {
+  export {
+    type CreditGetAutoRechargeResponse as CreditGetAutoRechargeResponse,
+    type CreditGetUsageResponse as CreditGetUsageResponse,
+    type CreditListLedgerResponse as CreditListLedgerResponse,
+    type CreditListLedgerResponsesMyCursorIDPage as CreditListLedgerResponsesMyCursorIDPage,
+    type CreditGetAutoRechargeParams as CreditGetAutoRechargeParams,
+    type CreditGetUsageParams as CreditGetUsageParams,
+    type CreditListLedgerParams as CreditListLedgerParams,
+  };
+
+  export {
+    Grants as Grants,
+    type CreditGrantResponse as CreditGrantResponse,
+    type GrantListResponse as GrantListResponse,
+    type GrantListResponsesMyCursorIDPage as GrantListResponsesMyCursorIDPage,
+    type GrantCreateParams as GrantCreateParams,
+    type GrantListParams as GrantListParams,
+  };
+
+  export {
+    CustomCurrencies as CustomCurrencies,
+    type CustomCurrencyCreateResponse as CustomCurrencyCreateResponse,
+    type CustomCurrencyUpdateResponse as CustomCurrencyUpdateResponse,
+    type CustomCurrencyListResponse as CustomCurrencyListResponse,
+    type CustomCurrencyArchiveResponse as CustomCurrencyArchiveResponse,
+    type CustomCurrencyListAssociatedEntitiesResponse as CustomCurrencyListAssociatedEntitiesResponse,
+    type CustomCurrencyUnarchiveResponse as CustomCurrencyUnarchiveResponse,
+    type CustomCurrencyListResponsesMyCursorIDPage as CustomCurrencyListResponsesMyCursorIDPage,
+    type CustomCurrencyCreateParams as CustomCurrencyCreateParams,
+    type CustomCurrencyUpdateParams as CustomCurrencyUpdateParams,
+    type CustomCurrencyListParams as CustomCurrencyListParams,
+  };
+}