@stigg/typescript 0.1.0-alpha.25 → 0.1.0-alpha.27

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

@@ -1,6 +1,17 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../../core/resource';
+import * as IntegrationsAPI from './integrations';
+import {
+  IntegrationLinkParams,
+  IntegrationListParams,
+  IntegrationListResponse,
+  IntegrationListResponsesMyCursorIDPage,
+  IntegrationRetrieveParams,
+  IntegrationUnlinkParams,
+  IntegrationUpdateParams,
+  Integrations,
+} from './integrations';
 import * as PaymentMethodAPI from './payment-method';
 import { PaymentMethod, PaymentMethodAttachParams } from './payment-method';
 import * as PromotionalEntitlementsAPI from './promotional-entitlements';
@@ -23,6 +34,7 @@ export class Customers extends APIResource {
   paymentMethod: PaymentMethodAPI.PaymentMethod = new PaymentMethodAPI.PaymentMethod(this._client);
   promotionalEntitlements: PromotionalEntitlementsAPI.PromotionalEntitlements =
     new PromotionalEntitlementsAPI.PromotionalEntitlements(this._client);
+  integrations: IntegrationsAPI.Integrations = new IntegrationsAPI.Integrations(this._client);
 
   /**
    * Retrieves a customer by their unique identifier, including billing information
@@ -116,6 +128,106 @@ export type CustomerListResponsesMyCursorIDPage = MyCursorIDPage<CustomerListRes
 
 export type CustomerListResourcesResponsesMyCursorIDPage = MyCursorIDPage<CustomerListResourcesResponse>;
 
+/**
+ * Response object
+ */
+export interface CustomerIntegrationResponse {
+  /**
+   * External billing or CRM integration link
+   */
+  data: CustomerIntegrationResponse.Data;
+}
+
+export namespace CustomerIntegrationResponse {
+  /**
+   * External billing or CRM integration link
+   */
+  export interface Data {
+    /**
+     * 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?:
+      | Data.SyncRevisionPriceBillingData
+      | Data.SyncRevisionBillingData
+      | Data.SyncRevisionMarketplaceData
+      | null;
+  }
+
+  export namespace Data {
+    /**
+     * 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;
+    }
+  }
+}
+
 /**
  * Response object
  */
@@ -2732,9 +2844,11 @@ export interface CustomerRetrieveEntitlementsParams {
 
 Customers.PaymentMethod = PaymentMethod;
 Customers.PromotionalEntitlements = PromotionalEntitlements;
+Customers.Integrations = Integrations;
 
 export declare namespace Customers {
   export {
+    type CustomerIntegrationResponse as CustomerIntegrationResponse,
     type CustomerResponse as CustomerResponse,
     type CustomerListResponse as CustomerListResponse,
     type CustomerImportResponse as CustomerImportResponse,
@@ -2762,4 +2876,15 @@ export declare namespace Customers {
     type PromotionalEntitlementListParams as PromotionalEntitlementListParams,
     type PromotionalEntitlementRevokeParams as PromotionalEntitlementRevokeParams,
   };
+
+  export {
+    Integrations as Integrations,
+    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/index.ts

@@ -2,6 +2,7 @@
 
 export {
   Customers,
+  type CustomerIntegrationResponse,
   type CustomerResponse,
   type CustomerListResponse,
   type CustomerImportResponse,
@@ -16,6 +17,16 @@ export {
   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,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/index.ts

@@ -23,6 +23,7 @@ export {
 } from './coupons';
 export {
   Customers,
+  type CustomerIntegrationResponse,
   type CustomerResponse,
   type CustomerListResponse,
   type CustomerImportResponse,

package/src/resources/v1/v1.ts

@@ -57,6 +57,7 @@ import * as CustomersAPI from './customers/customers';
 import {
   CustomerImportParams,
   CustomerImportResponse,
+  CustomerIntegrationResponse,
   CustomerListParams,
   CustomerListResourcesParams,
   CustomerListResourcesResponse,
@@ -130,6 +131,7 @@ V1.Products = Products;
 export declare namespace V1 {
   export {
     Customers as Customers,
+    type CustomerIntegrationResponse as CustomerIntegrationResponse,
     type CustomerResponse as CustomerResponse,
     type CustomerListResponse as CustomerListResponse,
     type CustomerImportResponse as CustomerImportResponse,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.1.0-alpha.25'; // x-release-please-version
+export const VERSION = '0.1.0-alpha.27'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.1.0-alpha.25";
+export declare const VERSION = "0.1.0-alpha.27";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.1.0-alpha.25";
+export declare const VERSION = "0.1.0-alpha.27";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.1.0-alpha.25'; // x-release-please-version
+exports.VERSION = '0.1.0-alpha.27'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.1.0-alpha.25'; // x-release-please-version
+export const VERSION = '0.1.0-alpha.27'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map