@stigg/typescript 0.1.0-beta.4 → 0.1.0-beta.41

package/src/resources/v1/subscriptions/usage.ts

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../../../core/resource';
 import { APIPromise } from '../../../core/api-promise';
+import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
@@ -15,18 +16,43 @@ export class Usage extends APIResource {
    */
   chargeUsage(
     id: string,
-    body: UsageChargeUsageParams,
+    params: UsageChargeUsageParams,
     options?: RequestOptions,
   ): APIPromise<UsageChargeUsageResponse> {
-    return this._client.post(path`/api/v1/subscriptions/${id}/usage/charge`, { body, ...options });
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
+    return this._client.post(path`/api/v1/subscriptions/${id}/usage/charge`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 
   /**
    * Triggers a usage sync for a subscription, reporting current usage to the billing
    * provider.
    */
-  sync(id: string, options?: RequestOptions): APIPromise<UsageSyncResponse> {
-    return this._client.post(path`/api/v1/subscriptions/${id}/usage/sync`, options);
+  sync(
+    id: string,
+    params: UsageSyncParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<UsageSyncResponse> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params ?? {};
+    return this._client.post(path`/api/v1/subscriptions/${id}/usage/sync`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 }
 
@@ -115,9 +141,38 @@ export namespace UsageSyncResponse {
 
 export interface UsageChargeUsageParams {
   /**
-   * Cutoff date for usage calculation. If not provided, the current time is used.
+   * Body param: Cutoff date for usage calculation. If not provided, the current time
+   * is used.
    */
   untilDate?: 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 UsageSyncParams {
+  /**
+   * 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 declare namespace Usage {
@@ -125,5 +180,6 @@ export declare namespace Usage {
     type UsageChargeUsageResponse as UsageChargeUsageResponse,
     type UsageSyncResponse as UsageSyncResponse,
     type UsageChargeUsageParams as UsageChargeUsageParams,
+    type UsageSyncParams as UsageSyncParams,
   };
 }

package/src/resources/v1/usage.ts

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../../core/resource';
 import { APIPromise } from '../../core/api-promise';
+import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
@@ -17,16 +18,37 @@ export class Usage extends APIResource {
     params: UsageHistoryParams,
     options?: RequestOptions,
   ): APIPromise<UsageHistoryResponse> {
-    const { customerId, ...query } = params;
-    return this._client.get(path`/api/v1/usage/${customerId}/history/${featureID}`, { query, ...options });
+    const { customerId, 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...query } = params;
+    return this._client.get(path`/api/v1/usage/${customerId}/history/${featureID}`, {
+      query,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 
   /**
    * Reports usage measurements for metered features. The reported usage is used to
    * track, limit, and bill customer consumption.
    */
-  report(body: UsageReportParams, options?: RequestOptions): APIPromise<UsageReportResponse> {
-    return this._client.post('/api/v1/usage', { body, ...options });
+  report(params: UsageReportParams, options?: RequestOptions): APIPromise<UsageReportResponse> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
+    return this._client.post('/api/v1/usage', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 }
 
@@ -172,6 +194,11 @@ export namespace UsageReportResponse {
      */
     value: number;
 
+    /**
+     * Optimistic credit balance for a credit-backed feature
+     */
+    credit?: Data.Credit | null;
+
     /**
      * The current measured usage value
      */
@@ -199,6 +226,51 @@ export namespace UsageReportResponse {
      */
     usagePeriodStart?: string | null;
   }
+
+  export namespace Data {
+    /**
+     * Optimistic credit balance for a credit-backed feature
+     */
+    export interface Credit {
+      /**
+       * The credits this single reportUsage call deducted, in credit units — scoped to
+       * this one measurement (0 for idempotency duplicates). Contrast `currentUsage`,
+       * which is the wallet-wide running total shared across all features on this
+       * currency. Use it to reconcile expected per-call deductions.
+       */
+      consumed: number;
+
+      /**
+       * The credit currency identifier
+       */
+      currencyId: string;
+
+      /**
+       * The wallet's total consumed credits for this currency (optimistic — includes
+       * not-yet-reconciled usage), shared across every feature that draws on the
+       * currency. This is the running balance, not this call's deduction — see
+       * `consumed` for that.
+       */
+      currentUsage: number;
+
+      /**
+       * The grant-version timestamp of this balance, used by the SDK for last-write-wins
+       * reconciliation
+       */
+      timestamp: string;
+
+      /**
+       * The total credits granted
+       */
+      usageLimit: number;
+
+      /**
+       * End of the current credit grant period (when recurring credits reset), if
+       * applicable
+       */
+      usagePeriodEnd?: string | null;
+    }
+  }
 }
 
 export interface UsageHistoryParams {
@@ -226,13 +298,39 @@ export interface UsageHistoryParams {
    * Query param: Resource id
    */
   resourceId?: string | 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 interface UsageReportParams {
   /**
-   * A list of usage reports to be submitted in bulk
+   * Body param: A list of usage reports to be submitted in bulk
    */
   usages: Array<UsageReportParams.Usage>;
+
+  /**
+   * 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 UsageReportParams {
@@ -265,6 +363,11 @@ export namespace UsageReportParams {
      */
     dimensions?: { [key: string]: string | number | boolean };
 
+    /**
+     * Idempotency key
+     */
+    idempotencyKey?: string;
+
     /**
      * Resource id
      */

package/src/resources/v1/v1.ts

@@ -4,33 +4,38 @@ import { APIResource } from '../../core/resource';
 import * as CouponsAPI from './coupons';
 import {
   Coupon,
+  CouponArchiveCouponParams,
   CouponCreateParams,
   CouponListParams,
   CouponListResponse,
   CouponListResponsesMyCursorIDPage,
+  CouponRetrieveParams,
   CouponUpdateCouponParams,
   Coupons,
 } from './coupons';
-import * as EventsAPI from './events';
-import { EventReportParams, EventReportResponse, Events } from './events';
 import * as FeaturesAPI from './features';
 import {
   Feature,
+  FeatureArchiveFeatureParams,
   FeatureCreateFeatureParams,
   FeatureListFeaturesParams,
   FeatureListFeaturesResponse,
   FeatureListFeaturesResponsesMyCursorIDPage,
+  FeatureRetrieveFeatureParams,
+  FeatureUnarchiveFeatureParams,
   FeatureUpdateFeatureParams,
   Features,
 } from './features';
 import * as ProductsAPI from './products';
 import {
   Product,
+  ProductArchiveProductParams,
   ProductCreateProductParams,
   ProductDuplicateProductParams,
   ProductListProductsParams,
   ProductListProductsResponse,
   ProductListProductsResponsesMyCursorIDPage,
+  ProductUnarchiveProductParams,
   ProductUpdateProductParams,
   Products,
 } from './products';
@@ -45,6 +50,8 @@ import {
 import * as AddonsAPI from './addons/addons';
 import {
   Addon,
+  AddonArchiveParams,
+  AddonCreateDraftParams,
   AddonCreateParams,
   AddonListChargesParams,
   AddonListChargesResponse,
@@ -54,7 +61,9 @@ import {
   AddonListResponsesMyCursorIDPage,
   AddonPublishParams,
   AddonPublishResponse,
+  AddonRemoveDraftParams,
   AddonRemoveDraftResponse,
+  AddonRetrieveParams,
   AddonUpdateParams,
   Addons,
 } from './addons/addons';
@@ -71,6 +80,7 @@ import {
 } from './credits/credits';
 import * as CustomersAPI from './customers/customers';
 import {
+  CustomerArchiveParams,
   CustomerCheckEntitlementParams,
   CustomerCheckEntitlementResponse,
   CustomerImportParams,
@@ -86,12 +96,18 @@ import {
   CustomerResponse,
   CustomerRetrieveEntitlementsParams,
   CustomerRetrieveEntitlementsResponse,
+  CustomerRetrieveParams,
+  CustomerUnarchiveParams,
   CustomerUpdateParams,
   Customers,
 } from './customers/customers';
+import * as EventsAPI from './events/events';
+import { EventReportParams, EventReportResponse, Events } from './events/events';
 import * as PlansAPI from './plans/plans';
 import {
   Plan,
+  PlanArchiveParams,
+  PlanCreateDraftParams,
   PlanCreateParams,
   PlanListChargesParams,
   PlanListChargesResponse,
@@ -104,7 +120,9 @@ import {
   PlanListResponsesMyCursorIDPage,
   PlanPublishParams,
   PlanPublishResponse,
+  PlanRemoveDraftParams,
   PlanRemoveDraftResponse,
+  PlanRetrieveParams,
   PlanUpdateParams,
   Plans,
 } from './plans/plans';
@@ -123,6 +141,7 @@ import {
   SubscriptionPreviewResponse,
   SubscriptionProvisionParams,
   SubscriptionProvisionResponse,
+  SubscriptionRetrieveParams,
   SubscriptionTransferParams,
   SubscriptionUpdateParams,
   Subscriptions,
@@ -164,13 +183,16 @@ export declare namespace V1 {
     type CustomerRetrieveEntitlementsResponse as CustomerRetrieveEntitlementsResponse,
     type CustomerListResponsesMyCursorIDPage as CustomerListResponsesMyCursorIDPage,
     type CustomerListResourcesResponsesMyCursorIDPage as CustomerListResourcesResponsesMyCursorIDPage,
+    type CustomerRetrieveParams as CustomerRetrieveParams,
     type CustomerUpdateParams as CustomerUpdateParams,
     type CustomerListParams as CustomerListParams,
+    type CustomerArchiveParams as CustomerArchiveParams,
     type CustomerCheckEntitlementParams as CustomerCheckEntitlementParams,
     type CustomerImportParams as CustomerImportParams,
     type CustomerListResourcesParams as CustomerListResourcesParams,
     type CustomerProvisionParams as CustomerProvisionParams,
     type CustomerRetrieveEntitlementsParams as CustomerRetrieveEntitlementsParams,
+    type CustomerUnarchiveParams as CustomerUnarchiveParams,
   };
 
   export {
@@ -181,6 +203,7 @@ export declare namespace V1 {
     type SubscriptionPreviewResponse as SubscriptionPreviewResponse,
     type SubscriptionProvisionResponse as SubscriptionProvisionResponse,
     type SubscriptionListResponsesMyCursorIDPage as SubscriptionListResponsesMyCursorIDPage,
+    type SubscriptionRetrieveParams as SubscriptionRetrieveParams,
     type SubscriptionUpdateParams as SubscriptionUpdateParams,
     type SubscriptionListParams as SubscriptionListParams,
     type SubscriptionCancelParams as SubscriptionCancelParams,
@@ -198,7 +221,9 @@ export declare namespace V1 {
     type CouponListResponse as CouponListResponse,
     type CouponListResponsesMyCursorIDPage as CouponListResponsesMyCursorIDPage,
     type CouponCreateParams as CouponCreateParams,
+    type CouponRetrieveParams as CouponRetrieveParams,
     type CouponListParams as CouponListParams,
+    type CouponArchiveCouponParams as CouponArchiveCouponParams,
     type CouponUpdateCouponParams as CouponUpdateCouponParams,
   };
 
@@ -224,8 +249,11 @@ export declare namespace V1 {
     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,
   };
 
@@ -239,10 +267,14 @@ export declare namespace V1 {
     type AddonListResponsesMyCursorIDPage as AddonListResponsesMyCursorIDPage,
     type AddonListChargesResponsesMyCursorIDPage as AddonListChargesResponsesMyCursorIDPage,
     type AddonCreateParams as AddonCreateParams,
+    type AddonRetrieveParams as AddonRetrieveParams,
     type AddonUpdateParams as AddonUpdateParams,
     type AddonListParams as AddonListParams,
+    type AddonArchiveParams as AddonArchiveParams,
+    type AddonCreateDraftParams as AddonCreateDraftParams,
     type AddonListChargesParams as AddonListChargesParams,
     type AddonPublishParams as AddonPublishParams,
+    type AddonRemoveDraftParams as AddonRemoveDraftParams,
   };
 
   export {
@@ -257,11 +289,15 @@ export declare namespace V1 {
     type PlanListChargesResponsesMyCursorIDPage as PlanListChargesResponsesMyCursorIDPage,
     type PlanListOverageChargesResponsesMyCursorIDPage as PlanListOverageChargesResponsesMyCursorIDPage,
     type PlanCreateParams as PlanCreateParams,
+    type PlanRetrieveParams as PlanRetrieveParams,
     type PlanUpdateParams as PlanUpdateParams,
     type PlanListParams as PlanListParams,
+    type PlanArchiveParams as PlanArchiveParams,
+    type PlanCreateDraftParams as PlanCreateDraftParams,
     type PlanListChargesParams as PlanListChargesParams,
     type PlanListOverageChargesParams as PlanListOverageChargesParams,
     type PlanPublishParams as PlanPublishParams,
+    type PlanRemoveDraftParams as PlanRemoveDraftParams,
   };
 
   export {
@@ -277,9 +313,11 @@ export declare namespace V1 {
     type Product as Product,
     type ProductListProductsResponse as ProductListProductsResponse,
     type ProductListProductsResponsesMyCursorIDPage as ProductListProductsResponsesMyCursorIDPage,
+    type ProductArchiveProductParams as ProductArchiveProductParams,
     type ProductCreateProductParams as ProductCreateProductParams,
     type ProductDuplicateProductParams as ProductDuplicateProductParams,
     type ProductListProductsParams as ProductListProductsParams,
+    type ProductUnarchiveProductParams as ProductUnarchiveProductParams,
     type ProductUpdateProductParams as ProductUpdateProductParams,
   };
 }