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

package/src/resources/v1/features.ts

@@ -3,6 +3,7 @@
 import { APIResource } from '../../core/resource';
 import { APIPromise } from '../../core/api-promise';
 import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from '../../core/pagination';
+import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
@@ -12,51 +13,170 @@ import { path } from '../../internal/utils/path';
 export class Features extends APIResource {
   /**
    * Archives a feature, preventing it from being used in new entitlements.
-   */
-  archiveFeature(id: string, options?: RequestOptions): APIPromise<Feature> {
-    return this._client.post(path`/api/v1/features/${id}/archive`, options);
+   *
+   * @example
+   * ```ts
+   * const feature = await client.v1.features.archiveFeature(
+   *   'x',
+   * );
+   * ```
+   */
+  archiveFeature(
+    id: string,
+    params: FeatureArchiveFeatureParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Feature> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params ?? {};
+    return this._client.post(path`/api/v1/features/${id}/archive`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 
   /**
    * Creates a new feature with the specified type, metering, and configuration.
-   */
-  createFeature(body: FeatureCreateFeatureParams, options?: RequestOptions): APIPromise<Feature> {
-    return this._client.post('/api/v1/features', { body, ...options });
+   *
+   * @example
+   * ```ts
+   * const feature = await client.v1.features.createFeature({
+   *   id: 'id',
+   *   displayName: 'displayName',
+   *   featureType: 'BOOLEAN',
+   * });
+   * ```
+   */
+  createFeature(params: FeatureCreateFeatureParams, options?: RequestOptions): APIPromise<Feature> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
+    return this._client.post('/api/v1/features', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 
   /**
    * Retrieves a paginated list of features in the environment.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const featureListFeaturesResponse of client.v1.features.listFeatures()) {
+   *   // ...
+   * }
+   * ```
    */
   listFeatures(
-    query: FeatureListFeaturesParams | null | undefined = {},
+    params: FeatureListFeaturesParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<FeatureListFeaturesResponsesMyCursorIDPage, FeatureListFeaturesResponse> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...query } = params ?? {};
     return this._client.getAPIList('/api/v1/features', MyCursorIDPage<FeatureListFeaturesResponse>, {
       query,
       ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
     });
   }
 
   /**
    * Retrieves a feature by its unique identifier.
-   */
-  retrieveFeature(id: string, options?: RequestOptions): APIPromise<Feature> {
-    return this._client.get(path`/api/v1/features/${id}`, options);
+   *
+   * @example
+   * ```ts
+   * const feature = await client.v1.features.retrieveFeature(
+   *   'x',
+   * );
+   * ```
+   */
+  retrieveFeature(
+    id: string,
+    params: FeatureRetrieveFeatureParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Feature> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params ?? {};
+    return this._client.get(path`/api/v1/features/${id}`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 
   /**
    * Restores an archived feature, allowing it to be used in entitlements again.
-   */
-  unarchiveFeature(id: string, options?: RequestOptions): APIPromise<Feature> {
-    return this._client.post(path`/api/v1/features/${id}/unarchive`, options);
+   *
+   * @example
+   * ```ts
+   * const feature = await client.v1.features.unarchiveFeature(
+   *   'x',
+   * );
+   * ```
+   */
+  unarchiveFeature(
+    id: string,
+    params: FeatureUnarchiveFeatureParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Feature> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params ?? {};
+    return this._client.post(path`/api/v1/features/${id}/unarchive`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 
   /**
    * Updates an existing feature's properties such as display name, description, and
    * configuration.
-   */
-  updateFeature(id: string, body: FeatureUpdateFeatureParams, options?: RequestOptions): APIPromise<Feature> {
-    return this._client.patch(path`/api/v1/features/${id}`, { body, ...options });
+   *
+   * @example
+   * ```ts
+   * const feature = await client.v1.features.updateFeature('x');
+   * ```
+   */
+  updateFeature(
+    id: string,
+    params: FeatureUpdateFeatureParams,
+    options?: RequestOptions,
+  ): APIPromise<Feature> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
+    return this._client.patch(path`/api/v1/features/${id}`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 }
 
@@ -292,61 +412,89 @@ export namespace FeatureListFeaturesResponse {
   }
 }
 
+export interface FeatureArchiveFeatureParams {
+  /**
+   * 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;
+
+  /**
+   * 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 FeatureCreateFeatureParams {
   /**
-   * The unique identifier for the feature
+   * Body param: The unique identifier for the feature
    */
   id: string;
 
   /**
-   * The display name for the feature
+   * Body param: The display name for the feature
    */
   displayName: string;
 
   /**
-   * The type of the feature
+   * Body param: The type of the feature
    */
   featureType: 'BOOLEAN' | 'NUMBER' | 'ENUM';
 
   /**
-   * The description for the feature
+   * Body param: The description for the feature
    */
   description?: string;
 
   /**
-   * The configuration data for the feature
+   * Body param: The configuration data for the feature
    */
   enumConfiguration?: Array<FeatureCreateFeatureParams.EnumConfiguration>;
 
   /**
-   * The status of the feature
+   * Body param: The status of the feature
    */
   featureStatus?: 'NEW' | 'SUSPENDED' | 'ACTIVE';
 
   /**
-   * The units for the feature
+   * Body param: The units for the feature
    */
   featureUnits?: string;
 
   /**
-   * The plural units for the feature
+   * Body param: The plural units for the feature
    */
   featureUnitsPlural?: string;
 
   /**
-   * The additional metadata for the feature
+   * Body param: The additional metadata for the feature
    */
   metadata?: { [key: string]: string };
 
   /**
-   * The meter type for the feature
+   * Body param: The meter type for the feature
    */
   meterType?: 'None' | 'FLUCTUATING' | 'INCREMENTAL';
 
   /**
-   * Unit transformation to be applied to the reported usage
+   * Body param: Unit transformation to be applied to the reported usage
    */
   unitTransformation?: FeatureCreateFeatureParams.UnitTransformation | null;
+
+  /**
+   * 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 namespace FeatureCreateFeatureParams {
@@ -390,29 +538,45 @@ export namespace FeatureCreateFeatureParams {
 
 export interface FeatureListFeaturesParams extends MyCursorIDPageParams {
   /**
-   * Filter by entity ID
+   * Query param: Filter by entity ID
    */
   id?: string;
 
   /**
-   * Filter by creation date using range operators: gt, gte, lt, lte
+   * Query param: Filter by creation date using range operators: gt, gte, lt, lte
    */
   createdAt?: FeatureListFeaturesParams.CreatedAt;
 
   /**
-   * Filter by feature type. Supports comma-separated values for multiple types
+   * Query param: Filter by feature type. Supports comma-separated values for
+   * multiple types
    */
   featureType?: Array<'BOOLEAN' | 'NUMBER' | 'ENUM'>;
 
   /**
-   * Filter by meter type. Supports comma-separated values for multiple types
+   * Query param: Filter by meter type. Supports comma-separated values for multiple
+   * types
    */
   meterType?: Array<'None' | 'FLUCTUATING' | 'INCREMENTAL'>;
 
   /**
-   * Filter by feature status. Supports comma-separated values for multiple statuses
+   * Query param: Filter by feature status. Supports comma-separated values for
+   * multiple statuses
    */
   status?: Array<'NEW' | 'SUSPENDED' | 'ACTIVE'>;
+
+  /**
+   * 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 namespace FeatureListFeaturesParams {
@@ -442,43 +606,89 @@ export namespace FeatureListFeaturesParams {
   }
 }
 
+export interface FeatureRetrieveFeatureParams {
+  /**
+   * 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;
+
+  /**
+   * 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 FeatureUnarchiveFeatureParams {
+  /**
+   * 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;
+
+  /**
+   * 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 FeatureUpdateFeatureParams {
   /**
-   * The description for the feature
+   * Body param: The description for the feature
    */
   description?: string;
 
   /**
-   * The display name for the feature
+   * Body param: The display name for the feature
    */
   displayName?: string;
 
   /**
-   * The configuration data for the feature
+   * Body param: The configuration data for the feature
    */
   enumConfiguration?: Array<FeatureUpdateFeatureParams.EnumConfiguration>;
 
   /**
-   * The units for the feature
+   * Body param: The units for the feature
    */
   featureUnits?: string;
 
   /**
-   * The plural units for the feature
+   * Body param: The plural units for the feature
    */
   featureUnitsPlural?: string;
 
   /**
-   * The additional metadata for the feature
+   * Body param: The additional metadata for the feature
    */
   metadata?: { [key: string]: string };
 
+  /**
+   * Body param
+   */
   meter?: FeatureUpdateFeatureParams.Meter;
 
   /**
-   * Unit transformation to be applied to the reported usage
+   * Body param: Unit transformation to be applied to the reported usage
    */
   unitTransformation?: FeatureUpdateFeatureParams.UnitTransformation | null;
+
+  /**
+   * 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 namespace FeatureUpdateFeatureParams {
@@ -576,8 +786,11 @@ export declare namespace Features {
     type Feature as Feature,
     type FeatureListFeaturesResponse as FeatureListFeaturesResponse,
     type FeatureListFeaturesResponsesMyCursorIDPage as FeatureListFeaturesResponsesMyCursorIDPage,
+    type FeatureArchiveFeatureParams as FeatureArchiveFeatureParams,
     type FeatureCreateFeatureParams as FeatureCreateFeatureParams,
     type FeatureListFeaturesParams as FeatureListFeaturesParams,
+    type FeatureRetrieveFeatureParams as FeatureRetrieveFeatureParams,
+    type FeatureUnarchiveFeatureParams as FeatureUnarchiveFeatureParams,
     type FeatureUpdateFeatureParams as FeatureUpdateFeatureParams,
   };
 }

package/src/resources/v1/index.ts

@@ -4,27 +4,38 @@ export {
   Addons,
   type Addon,
   type AddonListResponse,
+  type AddonListChargesResponse,
   type AddonPublishResponse,
   type AddonRemoveDraftResponse,
   type AddonCreateParams,
+  type AddonRetrieveParams,
   type AddonUpdateParams,
   type AddonListParams,
+  type AddonArchiveParams,
+  type AddonCreateDraftParams,
+  type AddonListChargesParams,
   type AddonPublishParams,
+  type AddonRemoveDraftParams,
   type AddonListResponsesMyCursorIDPage,
+  type AddonListChargesResponsesMyCursorIDPage,
 } from './addons/index';
 export {
   Coupons,
   type Coupon,
   type CouponListResponse,
   type CouponCreateParams,
+  type CouponRetrieveParams,
   type CouponListParams,
+  type CouponArchiveCouponParams,
   type CouponUpdateCouponParams,
   type CouponListResponsesMyCursorIDPage,
 } from './coupons';
 export {
   Credits,
+  type CreditGetAutoRechargeResponse,
   type CreditGetUsageResponse,
   type CreditListLedgerResponse,
+  type CreditGetAutoRechargeParams,
   type CreditGetUsageParams,
   type CreditListLedgerParams,
   type CreditListLedgerResponsesMyCursorIDPage,
@@ -38,23 +49,29 @@ export {
   type CustomerImportResponse,
   type CustomerListResourcesResponse,
   type CustomerRetrieveEntitlementsResponse,
+  type CustomerRetrieveParams,
   type CustomerUpdateParams,
   type CustomerListParams,
+  type CustomerArchiveParams,
   type CustomerCheckEntitlementParams,
   type CustomerImportParams,
   type CustomerListResourcesParams,
   type CustomerProvisionParams,
   type CustomerRetrieveEntitlementsParams,
+  type CustomerUnarchiveParams,
   type CustomerListResponsesMyCursorIDPage,
   type CustomerListResourcesResponsesMyCursorIDPage,
 } from './customers/index';
-export { Events, type EventReportResponse, type EventReportParams } from './events';
+export { Events, type EventReportResponse, type EventReportParams } from './events/index';
 export {
   Features,
   type Feature,
   type FeatureListFeaturesResponse,
+  type FeatureArchiveFeatureParams,
   type FeatureCreateFeatureParams,
   type FeatureListFeaturesParams,
+  type FeatureRetrieveFeatureParams,
+  type FeatureUnarchiveFeatureParams,
   type FeatureUpdateFeatureParams,
   type FeatureListFeaturesResponsesMyCursorIDPage,
 } from './features';
@@ -62,21 +79,33 @@ export {
   Plans,
   type Plan,
   type PlanListResponse,
+  type PlanListChargesResponse,
+  type PlanListOverageChargesResponse,
   type PlanPublishResponse,
   type PlanRemoveDraftResponse,
   type PlanCreateParams,
+  type PlanRetrieveParams,
   type PlanUpdateParams,
   type PlanListParams,
+  type PlanArchiveParams,
+  type PlanCreateDraftParams,
+  type PlanListChargesParams,
+  type PlanListOverageChargesParams,
   type PlanPublishParams,
+  type PlanRemoveDraftParams,
   type PlanListResponsesMyCursorIDPage,
+  type PlanListChargesResponsesMyCursorIDPage,
+  type PlanListOverageChargesResponsesMyCursorIDPage,
 } from './plans/index';
 export {
   Products,
   type Product,
   type ProductListProductsResponse,
+  type ProductArchiveProductParams,
   type ProductCreateProductParams,
   type ProductDuplicateProductParams,
   type ProductListProductsParams,
+  type ProductUnarchiveProductParams,
   type ProductUpdateProductParams,
   type ProductListProductsResponsesMyCursorIDPage,
 } from './products';
@@ -87,6 +116,7 @@ export {
   type SubscriptionImportResponse,
   type SubscriptionPreviewResponse,
   type SubscriptionProvisionResponse,
+  type SubscriptionRetrieveParams,
   type SubscriptionUpdateParams,
   type SubscriptionListParams,
   type SubscriptionCancelParams,