@stigg/typescript 0.1.0-alpha.3 → 0.1.0-alpha.30

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

@@ -2,12 +2,39 @@
 
 export {
   Customers,
+  type CustomerIntegrationResponse,
   type CustomerResponse,
   type CustomerListResponse,
-  type CustomerCreateParams,
+  type CustomerImportResponse,
+  type CustomerListResourcesResponse,
+  type CustomerRetrieveEntitlementsResponse,
   type CustomerUpdateParams,
   type CustomerListParams,
+  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 { Usage } from './usage';
+export {
+  PromotionalEntitlements,
+  type PromotionalEntitlementCreateResponse,
+  type PromotionalEntitlementListResponse,
+  type PromotionalEntitlementRevokeResponse,
+  type PromotionalEntitlementCreateParams,
+  type PromotionalEntitlementListParams,
+  type PromotionalEntitlementRevokeParams,
+  type PromotionalEntitlementListResponsesMyCursorIDPage,
+} from './promotional-entitlements';

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

@@ -0,0 +1,241 @@
+// 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?: string;
+}
+
+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,9 +6,13 @@ 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 {
   /**
-   * Attach payment method
+   * Attaches a payment method to a customer for billing. Required for paid
+   * subscriptions when integrated with a billing provider.
    */
   attach(
     id: string,
@@ -19,7 +23,8 @@ export class PaymentMethod extends APIResource {
   }
 
   /**
-   * Detach payment method
+   * Removes the payment method from a customer. Ensure active paid subscriptions
+   * have an alternative payment method.
    */
   detach(id: string, options?: RequestOptions): APIPromise<CustomersAPI.CustomerResponse> {
     return this._client.delete(path`/api/v1/customers/${id}/payment-method`, options);