@stigg/typescript 0.1.0-beta.21 → 0.1.0-beta.23

package/src/resources/v1/credits/custom-currencies.ts

@@ -13,15 +13,6 @@ import { path } from '../../../internal/utils/path';
 export class CustomCurrencies extends APIResource {
   /**
    * Creates a new custom currency in the environment.
-   *
-   * @example
-   * ```ts
-   * const customCurrencyResponse =
-   *   await client.v1.credits.customCurrencies.create({
-   *     id: 'id',
-   *     displayName: 'displayName',
-   *   });
-   * ```
    */
   create(params: CustomCurrencyCreateParams, options?: RequestOptions): APIPromise<CustomCurrencyResponse> {
     const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
@@ -40,14 +31,6 @@ export class CustomCurrencies extends APIResource {
 
   /**
    * Updates an existing custom currency. Only the supplied fields are modified.
-   *
-   * @example
-   * ```ts
-   * const customCurrencyResponse =
-   *   await client.v1.credits.customCurrencies.update(
-   *     'currencyId',
-   *   );
-   * ```
    */
   update(
     currencyID: string,
@@ -72,14 +55,6 @@ export class CustomCurrencies extends APIResource {
    * Retrieves a paginated list of custom currencies in the environment. Archived
    * currencies are excluded by default; pass `status=ARCHIVED` (or
    * `status=ACTIVE,ARCHIVED`) to include them.
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const customCurrencyListResponse of client.v1.credits.customCurrencies.list()) {
-   *   // ...
-   * }
-   * ```
    */
   list(
     params: CustomCurrencyListParams | null | undefined = {},
@@ -107,14 +82,6 @@ export class CustomCurrencies extends APIResource {
    * Archives a custom currency. Fails if the currency is still associated with any
    * active plan or addon — use the associated-entities endpoint first to inspect
    * dependencies.
-   *
-   * @example
-   * ```ts
-   * const customCurrencyResponse =
-   *   await client.v1.credits.customCurrencies.archive(
-   *     'currencyId',
-   *   );
-   * ```
    */
   archive(
     currencyID: string,
@@ -137,14 +104,6 @@ export class CustomCurrencies extends APIResource {
   /**
    * Lists the active plans and addons that reference a custom currency. Useful
    * before archiving to inspect dependencies.
-   *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.v1.credits.customCurrencies.listAssociatedEntities(
-   *     'currencyId',
-   *   );
-   * ```
    */
   listAssociatedEntities(
     currencyID: string,
@@ -167,14 +126,6 @@ export class CustomCurrencies extends APIResource {
   /**
    * Restores a previously archived custom currency. Fails if another active currency
    * with the same ID already exists.
-   *
-   * @example
-   * ```ts
-   * const customCurrencyResponse =
-   *   await client.v1.credits.customCurrencies.unarchive(
-   *     'currencyId',
-   *   );
-   * ```
    */
   unarchive(
     currencyID: string,

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

@@ -14,18 +14,6 @@ export class Grants extends APIResource {
   /**
    * Creates a new credit grant for a customer with specified amount, type, and
    * optional billing configuration.
-   *
-   * @example
-   * ```ts
-   * const creditGrantResponse =
-   *   await client.v1.credits.grants.create({
-   *     amount: 0,
-   *     currencyId: 'currencyId',
-   *     customerId: 'customerId',
-   *     displayName: 'displayName',
-   *     grantType: 'PAID',
-   *   });
-   * ```
    */
   create(params: GrantCreateParams, options?: RequestOptions): APIPromise<CreditGrantResponse> {
     const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
@@ -44,16 +32,6 @@ export class Grants extends APIResource {
 
   /**
    * Retrieves a paginated list of credit grants for a customer.
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const grantListResponse of client.v1.credits.grants.list(
-   *   { customerId: 'customerId' },
-   * )) {
-   *   // ...
-   * }
-   * ```
    */
   list(
     params: GrantListParams,
@@ -76,12 +54,6 @@ export class Grants extends APIResource {
   /**
    * Voids an existing credit grant, preventing further consumption of the remaining
    * credits.
-   *
-   * @example
-   * ```ts
-   * const creditGrantResponse =
-   *   await client.v1.credits.grants.void('x');
-   * ```
    */
   void(
     id: string,

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

@@ -40,13 +40,6 @@ export class Customers extends APIResource {
   /**
    * Retrieves a customer by their unique identifier, including billing information
    * and subscription status.
-   *
-   * @example
-   * ```ts
-   * const customerResponse = await client.v1.customers.retrieve(
-   *   'x',
-   * );
-   * ```
    */
   retrieve(
     id: string,
@@ -69,13 +62,6 @@ export class Customers extends APIResource {
   /**
    * Updates an existing customer's properties such as name, email, and billing
    * information.
-   *
-   * @example
-   * ```ts
-   * const customerResponse = await client.v1.customers.update(
-   *   'x',
-   * );
-   * ```
    */
   update(id: string, params: CustomerUpdateParams, options?: RequestOptions): APIPromise<CustomerResponse> {
     const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
@@ -94,14 +80,6 @@ export class Customers extends APIResource {
 
   /**
    * Retrieves a paginated list of customers in the environment.
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const customerListResponse of client.v1.customers.list()) {
-   *   // ...
-   * }
-   * ```
    */
   list(
     params: CustomerListParams | null | undefined = {},
@@ -124,13 +102,6 @@ export class Customers extends APIResource {
   /**
    * Archives a customer, preventing new subscriptions. Optionally cancels existing
    * subscriptions.
-   *
-   * @example
-   * ```ts
-   * const customerResponse = await client.v1.customers.archive(
-   *   'x',
-   * );
-   * ```
    */
   archive(
     id: string,
@@ -159,13 +130,6 @@ export class Customers extends APIResource {
    * mechanisms, and low-latency guarantees. It is not recommended for hot-path
    * entitlement checks. For production use, consider using the Stigg Node Server SDK
    * with caching or the Sidecar for low-latency cached responses.
-   *
-   * @example
-   * ```ts
-   * const response = await client.v1.customers.checkEntitlement(
-   *   'x',
-   * );
-   * ```
    */
   checkEntitlement(
     id: string,
@@ -189,19 +153,6 @@ export class Customers extends APIResource {
   /**
    * Imports multiple customers in bulk. Used for migrating customer data from
    * external systems.
-   *
-   * @example
-   * ```ts
-   * const response = await client.v1.customers.import({
-   *   customers: [
-   *     {
-   *       id: 'id',
-   *       email: 'dev@stainless.com',
-   *       name: 'name',
-   *     },
-   *   ],
-   * });
-   * ```
    */
   import(params: CustomerImportParams, options?: RequestOptions): APIPromise<CustomerImportResponse> {
     const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
@@ -220,16 +171,6 @@ export class Customers extends APIResource {
 
   /**
    * Retrieves a paginated list of resources within the same customer.
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const customerListResourcesResponse of client.v1.customers.listResources(
-   *   'x',
-   * )) {
-   *   // ...
-   * }
-   * ```
    */
   listResources(
     id: string,
@@ -257,12 +198,6 @@ export class Customers extends APIResource {
   /**
    * Creates a new customer and optionally provisions an initial subscription in a
    * single operation.
-   *
-   * @example
-   * ```ts
-   * const customerResponse =
-   *   await client.v1.customers.provision({ id: 'id' });
-   * ```
    */
   provision(params: CustomerProvisionParams, options?: RequestOptions): APIPromise<CustomerResponse> {
     const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
@@ -287,12 +222,6 @@ export class Customers extends APIResource {
    * mechanisms, and low-latency guarantees. It is not recommended for hot-path
    * entitlement checks. For production use, consider using the Stigg Node Server SDK
    * with caching or the Sidecar for low-latency cached responses.
-   *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.v1.customers.retrieveEntitlements('x');
-   * ```
    */
   retrieveEntitlements(
     id: string,
@@ -315,12 +244,6 @@ export class Customers extends APIResource {
 
   /**
    * Restores an archived customer, allowing them to create new subscriptions again.
-   *
-   * @example
-   * ```ts
-   * const customerResponse =
-   *   await client.v1.customers.unarchive('x');
-   * ```
    */
   unarchive(
     id: string,

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

@@ -11,15 +11,6 @@ import { path } from '../../../internal/utils/path';
 export class Integrations extends APIResource {
   /**
    * Retrieves a specific integration for a customer by integration ID.
-   *
-   * @example
-   * ```ts
-   * const customerIntegrationResponse =
-   *   await client.v1.customers.integrations.retrieve(
-   *     'integrationId',
-   *     { id: 'id' },
-   *   );
-   * ```
    */
   retrieve(
     integrationID: string,
@@ -42,15 +33,6 @@ export class Integrations extends APIResource {
   /**
    * Updates a customer's integration link, such as changing the synced external
    * entity ID.
-   *
-   * @example
-   * ```ts
-   * const customerIntegrationResponse =
-   *   await client.v1.customers.integrations.update(
-   *     'integrationId',
-   *     { id: 'id', syncedEntityId: 'syncedEntityId' },
-   *   );
-   * ```
    */
   update(
     integrationID: string,
@@ -74,16 +56,6 @@ export class Integrations extends APIResource {
   /**
    * Retrieves a paginated list of a customer's external integrations (billing, CRM,
    * etc.).
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const integrationListResponse of client.v1.customers.integrations.list(
-   *   'x',
-   * )) {
-   *   // ...
-   * }
-   * ```
    */
   list(
     id: string,
@@ -111,16 +83,6 @@ export class Integrations extends APIResource {
   /**
    * Links a customer to an external integration by specifying the vendor and
    * external entity ID.
-   *
-   * @example
-   * ```ts
-   * const customerIntegrationResponse =
-   *   await client.v1.customers.integrations.link('x', {
-   *     id: 'id',
-   *     syncedEntityId: 'syncedEntityId',
-   *     vendorIdentifier: 'AUTH0',
-   *   });
-   * ```
    */
   link(
     id: string,
@@ -143,15 +105,6 @@ export class Integrations extends APIResource {
 
   /**
    * Removes the link between a customer and an external integration.
-   *
-   * @example
-   * ```ts
-   * const customerIntegrationResponse =
-   *   await client.v1.customers.integrations.unlink(
-   *     'integrationId',
-   *     { id: 'id' },
-   *   );
-   * ```
    */
   unlink(
     integrationID: string,

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

@@ -14,16 +14,6 @@ export class PaymentMethod extends APIResource {
   /**
    * Attaches a payment method to a customer for billing. Required for paid
    * subscriptions when integrated with a billing provider.
-   *
-   * @example
-   * ```ts
-   * const customerResponse =
-   *   await client.v1.customers.paymentMethod.attach('x', {
-   *     integrationId: 'integrationId',
-   *     paymentMethodId: 'paymentMethodId',
-   *     vendorIdentifier: 'AUTH0',
-   *   });
-   * ```
    */
   attach(
     id: string,
@@ -47,12 +37,6 @@ export class PaymentMethod extends APIResource {
   /**
    * Removes the payment method from a customer. Ensure active paid subscriptions
    * have an alternative payment method.
-   *
-   * @example
-   * ```ts
-   * const customerResponse =
-   *   await client.v1.customers.paymentMethod.detach('x');
-   * ```
    */
   detach(
     id: string,

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

@@ -14,38 +14,6 @@ export class PromotionalEntitlements extends APIResource {
   /**
    * Grants promotional entitlements to a customer, providing feature access outside
    * their subscription. Entitlements can be time-limited or permanent.
-   *
-   * @example
-   * ```ts
-   * const promotionalEntitlement =
-   *   await client.v1.customers.promotionalEntitlements.create(
-   *     'x',
-   *     {
-   *       promotionalEntitlements: [
-   *         {
-   *           customEndDate: '2019-12-27T18:11:19.117Z',
-   *           enumValues: ['string'],
-   *           featureId: 'featureId',
-   *           hasSoftLimit: true,
-   *           hasUnlimitedUsage: true,
-   *           isVisible: true,
-   *           monthlyResetPeriodConfiguration: {
-   *             accordingTo: 'SubscriptionStart',
-   *           },
-   *           period: '1 week',
-   *           resetPeriod: 'YEAR',
-   *           usageLimit: -9007199254740991,
-   *           weeklyResetPeriodConfiguration: {
-   *             accordingTo: 'SubscriptionStart',
-   *           },
-   *           yearlyResetPeriodConfiguration: {
-   *             accordingTo: 'SubscriptionStart',
-   *           },
-   *         },
-   *       ],
-   *     },
-   *   );
-   * ```
    */
   create(
     id: string,
@@ -68,16 +36,6 @@ export class PromotionalEntitlements extends APIResource {
 
   /**
    * Retrieves a paginated list of a customer's promotional entitlements.
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const promotionalEntitlementListResponse of client.v1.customers.promotionalEntitlements.list(
-   *   'x',
-   * )) {
-   *   // ...
-   * }
-   * ```
    */
   list(
     id: string,
@@ -105,15 +63,6 @@ export class PromotionalEntitlements extends APIResource {
   /**
    * Revokes a previously granted promotional entitlement from a customer for a
    * specific feature.
-   *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.v1.customers.promotionalEntitlements.revoke(
-   *     'featureId',
-   *     { id: 'id' },
-   *   );
-   * ```
    */
   revoke(
     featureID: string,

package/src/resources/v1/events/data-export/data-export.ts

@@ -5,10 +5,12 @@ import * as DestinationsAPI from './destinations';
 import {
   DestinationCreateParams,
   DestinationCreateResponse,
+  DestinationDeleteParams,
   DestinationDeleteResponse,
   Destinations,
 } from './destinations';
 import { APIPromise } from '../../../../core/api-promise';
+import { buildHeaders } from '../../../../internal/headers';
 import { RequestOptions } from '../../../../internal/request-options';
 
 export class DataExport extends APIResource {
@@ -17,37 +19,45 @@ export class DataExport extends APIResource {
   /**
    * Mint a scoped JWT for the FE embedded SDK. Lazy-creates the DATA_EXPORT
    * integration if needed.
-   *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.v1.events.dataExport.mintScopedToken({
-   *     applicationOrigin: 'x',
-   *   });
-   * ```
    */
   mintScopedToken(
-    body: DataExportMintScopedTokenParams,
+    params: DataExportMintScopedTokenParams,
     options?: RequestOptions,
   ): APIPromise<DataExportMintScopedTokenResponse> {
-    return this._client.post('/api/v1/data-export/scoped-token', { body, ...options });
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
+    return this._client.post('/api/v1/data-export/scoped-token', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 
   /**
    * Trigger a sync for one destination or all destinations under the provider
    * entity.
-   *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.v1.events.dataExport.triggerSync();
-   * ```
    */
   triggerSync(
-    body: DataExportTriggerSyncParams,
+    params: DataExportTriggerSyncParams,
     options?: RequestOptions,
   ): APIPromise<DataExportTriggerSyncResponse> {
-    return this._client.post('/api/v1/data-export/sync', { body, ...options });
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
+    return this._client.post('/api/v1/data-export/sync', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 }
 
@@ -134,21 +144,47 @@ export namespace DataExportTriggerSyncResponse {
 
 export interface DataExportMintScopedTokenParams {
   /**
-   * FE origin the resulting JWT is bound to (provider-side anti-fraud)
+   * Body param: FE origin the resulting JWT is bound to (provider-side anti-fraud)
    */
   applicationOrigin: string;
 
   /**
-   * Pin the token to a specific warehouse connect flow
+   * Body param: Pin the token to a specific warehouse connect flow
    */
   destinationType?: string;
+
+  /**
+   * Header param: Account ID — optional when authenticating with a user JWT (Bearer
+   * token); falls back to the user's first membership. Ignored for API-key auth.
+   */
+  'X-ACCOUNT-ID'?: string;
+
+  /**
+   * Header param: Environment ID — required when authenticating with a user JWT
+   * (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
+   * intrinsic to the key).
+   */
+  'X-ENVIRONMENT-ID'?: string;
 }
 
 export interface DataExportTriggerSyncParams {
   /**
-   * Provider destination ID to sync. Omit to sync all destinations.
+   * Body param: Provider destination ID to sync. Omit to sync all destinations.
    */
   destinationId?: string;
+
+  /**
+   * Header param: Account ID — optional when authenticating with a user JWT (Bearer
+   * token); falls back to the user's first membership. Ignored for API-key auth.
+   */
+  'X-ACCOUNT-ID'?: string;
+
+  /**
+   * Header param: Environment ID — required when authenticating with a user JWT
+   * (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
+   * intrinsic to the key).
+   */
+  'X-ENVIRONMENT-ID'?: string;
 }
 
 DataExport.Destinations = Destinations;
@@ -166,5 +202,6 @@ export declare namespace DataExport {
     type DestinationCreateResponse as DestinationCreateResponse,
     type DestinationDeleteResponse as DestinationDeleteResponse,
     type DestinationCreateParams as DestinationCreateParams,
+    type DestinationDeleteParams as DestinationDeleteParams,
   };
 }