@stigg/typescript 0.1.0-alpha.1 → 0.1.0-alpha.3

package/src/resources/v1/v1.ts

@@ -7,6 +7,7 @@ import {
   CouponCreateResponse,
   CouponListParams,
   CouponListResponse,
+  CouponListResponsesMyCursorIDPage,
   CouponRetrieveResponse,
   Coupons,
 } from './coupons';
@@ -15,6 +16,7 @@ import {
   CustomerCreateParams,
   CustomerListParams,
   CustomerListResponse,
+  CustomerListResponsesMyCursorIDPage,
   CustomerResponse,
   CustomerUpdateParams,
   Customers,
@@ -27,6 +29,7 @@ import {
   SubscriptionDelegateResponse,
   SubscriptionListParams,
   SubscriptionListResponse,
+  SubscriptionListResponsesMyCursorIDPage,
   SubscriptionMigrateParams,
   SubscriptionMigrateResponse,
   SubscriptionPreviewParams,
@@ -45,29 +48,46 @@ export class V1 extends APIResource {
   coupons: CouponsAPI.Coupons = new CouponsAPI.Coupons(this._client);
 
   /**
-   * Create events
+   * Report usage events
    */
   createEvent(body: V1CreateEventParams, options?: RequestOptions): APIPromise<V1CreateEventResponse> {
     return this._client.post('/api/v1/events', { body, ...options });
   }
 
   /**
-   * Create a new Usage
+   * Report usage measurements
    */
   createUsage(body: V1CreateUsageParams, options?: RequestOptions): APIPromise<V1CreateUsageResponse> {
     return this._client.post('/api/v1/usage', { body, ...options });
   }
 }
 
+/**
+ * Response object
+ */
 export interface V1CreateEventResponse {
+  /**
+   * Empty success response confirming that events were successfully ingested and
+   * queued for processing by Stigg's metering system.
+   */
   data: unknown;
 }
 
+/**
+ * Response containing reported usage measurements with current usage values,
+ * period information, and reset dates for each measurement.
+ */
 export interface V1CreateUsageResponse {
+  /**
+   * Array of usage measurements with current values and period info
+   */
   data: Array<V1CreateUsageResponse.Data>;
 }
 
 export namespace V1CreateUsageResponse {
+  /**
+   * Recorded usage with period info
+   */
   export interface Data {
     /**
      * Unique identifier for the entity
@@ -136,6 +156,9 @@ export interface V1CreateEventParams {
 }
 
 export namespace V1CreateEventParams {
+  /**
+   * Raw usage event
+   */
   export interface Event {
     /**
      * Customer id
@@ -177,6 +200,9 @@ export interface V1CreateUsageParams {
 }
 
 export namespace V1CreateUsageParams {
+  /**
+   * Single usage measurement
+   */
   export interface Usage {
     /**
      * Customer id
@@ -201,7 +227,7 @@ export namespace V1CreateUsageParams {
     /**
      * Additional dimensions for the usage report
      */
-    dimensions?: { [key: string]: string };
+    dimensions?: { [key: string]: string | number | boolean };
 
     /**
      * Resource id
@@ -231,6 +257,7 @@ export declare namespace V1 {
     Customers as Customers,
     type CustomerResponse as CustomerResponse,
     type CustomerListResponse as CustomerListResponse,
+    type CustomerListResponsesMyCursorIDPage as CustomerListResponsesMyCursorIDPage,
     type CustomerCreateParams as CustomerCreateParams,
     type CustomerUpdateParams as CustomerUpdateParams,
     type CustomerListParams as CustomerListParams,
@@ -245,6 +272,7 @@ export declare namespace V1 {
     type SubscriptionMigrateResponse as SubscriptionMigrateResponse,
     type SubscriptionPreviewResponse as SubscriptionPreviewResponse,
     type SubscriptionTransferResponse as SubscriptionTransferResponse,
+    type SubscriptionListResponsesMyCursorIDPage as SubscriptionListResponsesMyCursorIDPage,
     type SubscriptionCreateParams as SubscriptionCreateParams,
     type SubscriptionListParams as SubscriptionListParams,
     type SubscriptionDelegateParams as SubscriptionDelegateParams,
@@ -258,6 +286,7 @@ export declare namespace V1 {
     type CouponCreateResponse as CouponCreateResponse,
     type CouponRetrieveResponse as CouponRetrieveResponse,
     type CouponListResponse as CouponListResponse,
+    type CouponListResponsesMyCursorIDPage as CouponListResponsesMyCursorIDPage,
     type CouponCreateParams as CouponCreateParams,
     type CouponListParams as CouponListParams,
   };

package/src/version.ts

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

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.1.0-alpha.1";
+export declare const VERSION = "0.1.0-alpha.3";
 //# 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.1'; // x-release-please-version
+exports.VERSION = '0.1.0-alpha.3'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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