@stigg/typescript 0.1.0-beta.1 → 0.1.0-beta.10

package/src/resources/v1/{events/credits → credits}/credits.ts

@@ -1,19 +1,16 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../../../core/resource';
+import { APIResource } from '../../../core/resource';
 import * as CustomCurrenciesAPI from './custom-currencies';
 import {
   CustomCurrencies,
-  CustomCurrencyArchiveResponse,
   CustomCurrencyCreateParams,
-  CustomCurrencyCreateResponse,
   CustomCurrencyListAssociatedEntitiesResponse,
   CustomCurrencyListParams,
   CustomCurrencyListResponse,
   CustomCurrencyListResponsesMyCursorIDPage,
-  CustomCurrencyUnarchiveResponse,
+  CustomCurrencyResponse,
   CustomCurrencyUpdateParams,
-  CustomCurrencyUpdateResponse,
 } from './custom-currencies';
 import * as GrantsAPI from './grants';
 import {
@@ -24,9 +21,9 @@ import {
   GrantListResponsesMyCursorIDPage,
   Grants,
 } from './grants';
-import { APIPromise } from '../../../../core/api-promise';
-import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from '../../../../core/pagination';
-import { RequestOptions } from '../../../../internal/request-options';
+import { APIPromise } from '../../../core/api-promise';
+import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from '../../../core/pagination';
+import { RequestOptions } from '../../../internal/request-options';
 
 export class Credits extends APIResource {
   grants: GrantsAPI.Grants = new GrantsAPI.Grants(this._client);
@@ -203,14 +200,14 @@ export namespace CreditGetUsageResponse {
      */
     export interface Series {
       /**
-       * The feature ID
+       * The feature ID; null when grouping by dimensions only
        */
-      featureId: string;
+      featureId: string | null;
 
       /**
-       * The display name of the feature
+       * The display name of the feature; null when grouping by dimensions only
        */
-      featureName: string;
+      featureName: string | null;
 
       /**
        * Time-series data points for this feature
@@ -221,6 +218,11 @@ export namespace CreditGetUsageResponse {
        * Total credits consumed by this feature in the time range
        */
       totalCredits: number;
+
+      /**
+       * Dimension key/value pairs identifying this series when groupBy is applied
+       */
+      tags?: Array<Series.Tag>;
     }
 
     export namespace Series {
@@ -238,6 +240,21 @@ export namespace CreditGetUsageResponse {
          */
         value: number;
       }
+
+      /**
+       * Dimension key/value pair identifying a credit usage series
+       */
+      export interface Tag {
+        /**
+         * The dimension key
+         */
+        key: string;
+
+        /**
+         * The dimension value for this series
+         */
+        value: string;
+      }
     }
   }
 }
@@ -328,6 +345,12 @@ export interface CreditGetUsageParams {
    */
   endDate?: string;
 
+  /**
+   * Comma-separated list of feature dimension keys to group usage series by (up to
+   * 3). Each key matches /^[a-zA-Z0-9_$-]+$/
+   */
+  groupBy?: string;
+
   /**
    * Filter by resource ID
    */
@@ -388,12 +411,9 @@ export declare namespace Credits {
 
   export {
     CustomCurrencies as CustomCurrencies,
-    type CustomCurrencyCreateResponse as CustomCurrencyCreateResponse,
-    type CustomCurrencyUpdateResponse as CustomCurrencyUpdateResponse,
+    type CustomCurrencyResponse as CustomCurrencyResponse,
     type CustomCurrencyListResponse as CustomCurrencyListResponse,
-    type CustomCurrencyArchiveResponse as CustomCurrencyArchiveResponse,
     type CustomCurrencyListAssociatedEntitiesResponse as CustomCurrencyListAssociatedEntitiesResponse,
-    type CustomCurrencyUnarchiveResponse as CustomCurrencyUnarchiveResponse,
     type CustomCurrencyListResponsesMyCursorIDPage as CustomCurrencyListResponsesMyCursorIDPage,
     type CustomCurrencyCreateParams as CustomCurrencyCreateParams,
     type CustomCurrencyUpdateParams as CustomCurrencyUpdateParams,

package/src/resources/v1/{events/credits → credits}/custom-currencies.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../../../core/resource';
-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';
+import { APIResource } from '../../../core/resource';
+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';
 
 /**
  * Operations related to custom currencies
@@ -13,10 +13,7 @@ export class CustomCurrencies extends APIResource {
   /**
    * Creates a new custom currency in the environment.
    */
-  create(
-    body: CustomCurrencyCreateParams,
-    options?: RequestOptions,
-  ): APIPromise<CustomCurrencyCreateResponse> {
+  create(body: CustomCurrencyCreateParams, options?: RequestOptions): APIPromise<CustomCurrencyResponse> {
     return this._client.post('/api/v1/credits/custom-currencies', { body, ...options });
   }
 
@@ -27,7 +24,7 @@ export class CustomCurrencies extends APIResource {
     currencyID: string,
     body: CustomCurrencyUpdateParams,
     options?: RequestOptions,
-  ): APIPromise<CustomCurrencyUpdateResponse> {
+  ): APIPromise<CustomCurrencyResponse> {
     return this._client.patch(path`/api/v1/credits/custom-currencies/${currencyID}`, { body, ...options });
   }
 
@@ -52,7 +49,7 @@ export class CustomCurrencies extends APIResource {
    * active plan or addon — use the associated-entities endpoint first to inspect
    * dependencies.
    */
-  archive(currencyID: string, options?: RequestOptions): APIPromise<CustomCurrencyArchiveResponse> {
+  archive(currencyID: string, options?: RequestOptions): APIPromise<CustomCurrencyResponse> {
     return this._client.post(path`/api/v1/credits/custom-currencies/${currencyID}/archive`, options);
   }
 
@@ -74,7 +71,7 @@ export class CustomCurrencies extends APIResource {
    * Restores a previously archived custom currency. Fails if another active currency
    * with the same ID already exists.
    */
-  unarchive(currencyID: string, options?: RequestOptions): APIPromise<CustomCurrencyUnarchiveResponse> {
+  unarchive(currencyID: string, options?: RequestOptions): APIPromise<CustomCurrencyResponse> {
     return this._client.post(path`/api/v1/credits/custom-currencies/${currencyID}/unarchive`, options);
   }
 }
@@ -84,93 +81,14 @@ export type CustomCurrencyListResponsesMyCursorIDPage = MyCursorIDPage<CustomCur
 /**
  * Response object
  */
-export interface CustomCurrencyCreateResponse {
+export interface CustomCurrencyResponse {
   /**
    * A custom currency used to denominate credit-based entitlements and pricing
    */
-  data: CustomCurrencyCreateResponse.Data;
+  data: CustomCurrencyResponse.Data;
 }
 
-export namespace CustomCurrencyCreateResponse {
-  /**
-   * A custom currency used to denominate credit-based entitlements and pricing
-   */
-  export interface Data {
-    /**
-     * The unique identifier for the custom currency
-     */
-    id: string;
-
-    /**
-     * Timestamp of when the record was deleted
-     */
-    archivedAt: string | null;
-
-    /**
-     * Timestamp of when the record was created
-     */
-    createdAt: string;
-
-    /**
-     * Description of the currency
-     */
-    description: string | null;
-
-    /**
-     * The display name of the custom currency
-     */
-    displayName: string;
-
-    /**
-     * Metadata associated with the entity
-     */
-    metadata: { [key: string]: string };
-
-    /**
-     * The symbol used to represent the custom currency
-     */
-    symbol: string | null;
-
-    /**
-     * Singular and plural unit labels for a custom currency
-     */
-    units: Data.Units | null;
-
-    /**
-     * Timestamp of when the record was last updated
-     */
-    updatedAt: string;
-  }
-
-  export namespace Data {
-    /**
-     * Singular and plural unit labels for a custom currency
-     */
-    export interface Units {
-      /**
-       * Plural form of the unit label
-       */
-      plural: string | null;
-
-      /**
-       * Singular form of the unit label
-       */
-      singular: string | null;
-    }
-  }
-}
-
-/**
- * Response object
- */
-export interface CustomCurrencyUpdateResponse {
-  /**
-   * A custom currency used to denominate credit-based entitlements and pricing
-   */
-  data: CustomCurrencyUpdateResponse.Data;
-}
-
-export namespace CustomCurrencyUpdateResponse {
+export namespace CustomCurrencyResponse {
   /**
    * A custom currency used to denominate credit-based entitlements and pricing
    */
@@ -306,85 +224,6 @@ export namespace CustomCurrencyListResponse {
   }
 }
 
-/**
- * Response object
- */
-export interface CustomCurrencyArchiveResponse {
-  /**
-   * A custom currency used to denominate credit-based entitlements and pricing
-   */
-  data: CustomCurrencyArchiveResponse.Data;
-}
-
-export namespace CustomCurrencyArchiveResponse {
-  /**
-   * A custom currency used to denominate credit-based entitlements and pricing
-   */
-  export interface Data {
-    /**
-     * The unique identifier for the custom currency
-     */
-    id: string;
-
-    /**
-     * Timestamp of when the record was deleted
-     */
-    archivedAt: string | null;
-
-    /**
-     * Timestamp of when the record was created
-     */
-    createdAt: string;
-
-    /**
-     * Description of the currency
-     */
-    description: string | null;
-
-    /**
-     * The display name of the custom currency
-     */
-    displayName: string;
-
-    /**
-     * Metadata associated with the entity
-     */
-    metadata: { [key: string]: string };
-
-    /**
-     * The symbol used to represent the custom currency
-     */
-    symbol: string | null;
-
-    /**
-     * Singular and plural unit labels for a custom currency
-     */
-    units: Data.Units | null;
-
-    /**
-     * Timestamp of when the record was last updated
-     */
-    updatedAt: string;
-  }
-
-  export namespace Data {
-    /**
-     * Singular and plural unit labels for a custom currency
-     */
-    export interface Units {
-      /**
-       * Plural form of the unit label
-       */
-      plural: string | null;
-
-      /**
-       * Singular form of the unit label
-       */
-      singular: string | null;
-    }
-  }
-}
-
 /**
  * List of entities (plans or addons) that reference a custom currency
  */
@@ -414,85 +253,6 @@ export namespace CustomCurrencyListAssociatedEntitiesResponse {
   }
 }
 
-/**
- * Response object
- */
-export interface CustomCurrencyUnarchiveResponse {
-  /**
-   * A custom currency used to denominate credit-based entitlements and pricing
-   */
-  data: CustomCurrencyUnarchiveResponse.Data;
-}
-
-export namespace CustomCurrencyUnarchiveResponse {
-  /**
-   * A custom currency used to denominate credit-based entitlements and pricing
-   */
-  export interface Data {
-    /**
-     * The unique identifier for the custom currency
-     */
-    id: string;
-
-    /**
-     * Timestamp of when the record was deleted
-     */
-    archivedAt: string | null;
-
-    /**
-     * Timestamp of when the record was created
-     */
-    createdAt: string;
-
-    /**
-     * Description of the currency
-     */
-    description: string | null;
-
-    /**
-     * The display name of the custom currency
-     */
-    displayName: string;
-
-    /**
-     * Metadata associated with the entity
-     */
-    metadata: { [key: string]: string };
-
-    /**
-     * The symbol used to represent the custom currency
-     */
-    symbol: string | null;
-
-    /**
-     * Singular and plural unit labels for a custom currency
-     */
-    units: Data.Units | null;
-
-    /**
-     * Timestamp of when the record was last updated
-     */
-    updatedAt: string;
-  }
-
-  export namespace Data {
-    /**
-     * Singular and plural unit labels for a custom currency
-     */
-    export interface Units {
-      /**
-       * Plural form of the unit label
-       */
-      plural: string | null;
-
-      /**
-       * Singular form of the unit label
-       */
-      singular: string | null;
-    }
-  }
-}
-
 export interface CustomCurrencyCreateParams {
   /**
    * The unique identifier for the new custom currency
@@ -601,12 +361,9 @@ export interface CustomCurrencyListParams extends MyCursorIDPageParams {
 
 export declare namespace CustomCurrencies {
   export {
-    type CustomCurrencyCreateResponse as CustomCurrencyCreateResponse,
-    type CustomCurrencyUpdateResponse as CustomCurrencyUpdateResponse,
+    type CustomCurrencyResponse as CustomCurrencyResponse,
     type CustomCurrencyListResponse as CustomCurrencyListResponse,
-    type CustomCurrencyArchiveResponse as CustomCurrencyArchiveResponse,
     type CustomCurrencyListAssociatedEntitiesResponse as CustomCurrencyListAssociatedEntitiesResponse,
-    type CustomCurrencyUnarchiveResponse as CustomCurrencyUnarchiveResponse,
     type CustomCurrencyListResponsesMyCursorIDPage as CustomCurrencyListResponsesMyCursorIDPage,
     type CustomCurrencyCreateParams as CustomCurrencyCreateParams,
     type CustomCurrencyUpdateParams as CustomCurrencyUpdateParams,

package/src/resources/v1/{events/credits → credits}/grants.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../../../core/resource';
-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';
+import { APIResource } from '../../../core/resource';
+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';
 
 /**
  * Operations related to credit grants

package/src/resources/v1/{events/credits → credits}/index.ts

@@ -12,12 +12,9 @@ export {
 } from './credits';
 export {
   CustomCurrencies,
-  type CustomCurrencyCreateResponse,
-  type CustomCurrencyUpdateResponse,
+  type CustomCurrencyResponse,
   type CustomCurrencyListResponse,
-  type CustomCurrencyArchiveResponse,
   type CustomCurrencyListAssociatedEntitiesResponse,
-  type CustomCurrencyUnarchiveResponse,
   type CustomCurrencyCreateParams,
   type CustomCurrencyUpdateParams,
   type CustomCurrencyListParams,

package/src/resources/v1/events.ts

@@ -1,3 +1,77 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export * from './events/index';
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+
+/**
+ * Operations related to usage & metering
+ */
+export class Events extends APIResource {
+  /**
+   * Reports raw usage events for event-based metering. Events are ingested
+   * asynchronously and aggregated into usage totals.
+   */
+  report(body: EventReportParams, options?: RequestOptions): APIPromise<EventReportResponse> {
+    return this._client.post('/api/v1/events', { body, ...options });
+  }
+}
+
+/**
+ * Response object
+ */
+export interface EventReportResponse {
+  /**
+   * Empty success response confirming that events were successfully ingested and
+   * queued for processing by Stigg's metering system.
+   */
+  data: unknown;
+}
+
+export interface EventReportParams {
+  /**
+   * A list of usage events to report
+   */
+  events: Array<EventReportParams.Event>;
+}
+
+export namespace EventReportParams {
+  /**
+   * Raw usage event
+   */
+  export interface Event {
+    /**
+     * Customer id
+     */
+    customerId: string;
+
+    /**
+     * The name of the usage event
+     */
+    eventName: string;
+
+    /**
+     * Idempotency key
+     */
+    idempotencyKey: string;
+
+    /**
+     * Dimensions associated with the usage event
+     */
+    dimensions?: { [key: string]: string | number | boolean };
+
+    /**
+     * Resource id
+     */
+    resourceId?: string | null;
+
+    /**
+     * Timestamp
+     */
+    timestamp?: string;
+  }
+}
+
+export declare namespace Events {
+  export { type EventReportResponse as EventReportResponse, type EventReportParams as EventReportParams };
+}

package/src/resources/v1/index.ts

@@ -3,14 +3,17 @@
 export {
   Addons,
   type Addon,
+  type ChargeList,
   type AddonListResponse,
   type AddonPublishResponse,
   type AddonRemoveDraftResponse,
   type AddonCreateParams,
   type AddonUpdateParams,
   type AddonListParams,
+  type AddonListChargesParams,
   type AddonPublishParams,
   type AddonListResponsesMyCursorIDPage,
+  type ChargeListDataMyCursorIDPage,
 } from './addons/index';
 export {
   Coupons,
@@ -21,6 +24,16 @@ export {
   type CouponUpdateCouponParams,
   type CouponListResponsesMyCursorIDPage,
 } from './coupons';
+export {
+  Credits,
+  type CreditGetAutoRechargeResponse,
+  type CreditGetUsageResponse,
+  type CreditListLedgerResponse,
+  type CreditGetAutoRechargeParams,
+  type CreditGetUsageParams,
+  type CreditListLedgerParams,
+  type CreditListLedgerResponsesMyCursorIDPage,
+} from './credits/index';
 export {
   Customers,
   type CustomerIntegrationResponse,
@@ -40,7 +53,7 @@ export {
   type CustomerListResponsesMyCursorIDPage,
   type CustomerListResourcesResponsesMyCursorIDPage,
 } from './customers/index';
-export { Events, type EventReportResponse, type EventReportParams } from './events/index';
+export { Events, type EventReportResponse, type EventReportParams } from './events';
 export {
   Features,
   type Feature,
@@ -59,6 +72,8 @@ export {
   type PlanCreateParams,
   type PlanUpdateParams,
   type PlanListParams,
+  type PlanListChargesParams,
+  type PlanListOverageChargesParams,
   type PlanPublishParams,
   type PlanListResponsesMyCursorIDPage,
 } from './plans/index';

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

@@ -18,6 +18,8 @@ export {
   type PlanCreateParams,
   type PlanUpdateParams,
   type PlanListParams,
+  type PlanListChargesParams,
+  type PlanListOverageChargesParams,
   type PlanPublishParams,
   type PlanListResponsesMyCursorIDPage,
 } from './plans';

package/src/resources/v1/plans/plans.ts

@@ -1,6 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../../core/resource';
+import * as AddonsAPI from '../addons/addons';
+import { ChargeListDataMyCursorIDPage } from '../addons/addons';
 import * as EntitlementsAPI from './entitlements';
 import {
   EntitlementCreateParams,
@@ -69,6 +71,36 @@ export class Plans extends APIResource {
     return this._client.post(path`/api/v1/plans/${id}/draft`, options);
   }
 
+  /**
+   * Retrieves the list of charges configured on a plan.
+   */
+  listCharges(
+    id: string,
+    query: PlanListChargesParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ChargeListDataMyCursorIDPage, AddonsAPI.ChargeList.Data> {
+    return this._client.getAPIList(
+      path`/api/v1/plans/${id}/charges`,
+      MyCursorIDPage<AddonsAPI.ChargeList.Data>,
+      { query, ...options },
+    );
+  }
+
+  /**
+   * Retrieves the list of overage charges configured on a plan.
+   */
+  listOverageCharges(
+    id: string,
+    query: PlanListOverageChargesParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ChargeListDataMyCursorIDPage, AddonsAPI.ChargeList.Data> {
+    return this._client.getAPIList(
+      path`/api/v1/plans/${id}/overage-charges`,
+      MyCursorIDPage<AddonsAPI.ChargeList.Data>,
+      { query, ...options },
+    );
+  }
+
   /**
    * Publishes a draft plan, making it available for use in subscriptions.
    */
@@ -1995,6 +2027,10 @@ export namespace PlanListParams {
   }
 }
 
+export interface PlanListChargesParams extends MyCursorIDPageParams {}
+
+export interface PlanListOverageChargesParams extends MyCursorIDPageParams {}
+
 export interface PlanPublishParams {
   /**
    * The migration type of the package
@@ -2014,6 +2050,8 @@ export declare namespace Plans {
     type PlanCreateParams as PlanCreateParams,
     type PlanUpdateParams as PlanUpdateParams,
     type PlanListParams as PlanListParams,
+    type PlanListChargesParams as PlanListChargesParams,
+    type PlanListOverageChargesParams as PlanListOverageChargesParams,
     type PlanPublishParams as PlanPublishParams,
   };
 
@@ -2027,3 +2065,5 @@ export declare namespace Plans {
     type EntitlementDeleteParams as EntitlementDeleteParams,
   };
 }
+
+export { type ChargeListDataMyCursorIDPage };