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

package/src/resources/v1/usage.ts

@@ -0,0 +1,283 @@
+// 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 { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Usage extends APIResource {
+  /**
+   * Get usage history
+   */
+  history(
+    featureID: string,
+    params: UsageHistoryParams,
+    options?: RequestOptions,
+  ): APIPromise<UsageHistoryResponse> {
+    const { customerId, ...query } = params;
+    return this._client.get(path`/api/v1/usage/${customerId}/history/${featureID}`, { query, ...options });
+  }
+
+  /**
+   * Report usage measurements
+   */
+  report(body: UsageReportParams, options?: RequestOptions): APIPromise<UsageReportResponse> {
+    return this._client.post('/api/v1/usage', { body, ...options });
+  }
+}
+
+/**
+ * Response object
+ */
+export interface UsageHistoryResponse {
+  /**
+   * Historical usage time series
+   */
+  data: UsageHistoryResponse.Data;
+}
+
+export namespace UsageHistoryResponse {
+  /**
+   * Historical usage time series
+   */
+  export interface Data {
+    /**
+     * Markers for events that affecting feature usage
+     */
+    markers: Array<Data.Marker>;
+
+    /**
+     * Series of usage history
+     */
+    series: Array<Data.Series>;
+  }
+
+  export namespace Data {
+    /**
+     * Usage reset or change marker
+     */
+    export interface Marker {
+      /**
+       * Timestamp of the marker
+       */
+      timestamp: string;
+
+      /**
+       * Type of marker for a usage history point
+       */
+      type: 'PERIODIC_RESET' | 'SUBSCRIPTION_CHANGE_RESET';
+    }
+
+    /**
+     * Usage data points with tags
+     */
+    export interface Series {
+      /**
+       * Points in the usage history series
+       */
+      points: Array<Series.Point>;
+
+      /**
+       * Tags for the usage history series
+       */
+      tags: Array<Series.Tag>;
+    }
+
+    export namespace Series {
+      /**
+       * Single usage data point
+       */
+      export interface Point {
+        /**
+         * Indicates whether there was usage reset in this point, see `markers` for details
+         */
+        isResetPoint: boolean;
+
+        /**
+         * Timestamp of the usage history point
+         */
+        timestamp: string;
+
+        /**
+         * Value of the usage history point
+         */
+        value: number;
+      }
+
+      /**
+       * Grouping tag key-value
+       */
+      export interface Tag {
+        /**
+         * Key of the tag
+         */
+        key: string;
+
+        /**
+         * Value of the tag
+         */
+        value: string;
+      }
+    }
+  }
+}
+
+/**
+ * Response containing reported usage measurements with current usage values,
+ * period information, and reset dates for each measurement.
+ */
+export interface UsageReportResponse {
+  /**
+   * Array of usage measurements with current values and period info
+   */
+  data: Array<UsageReportResponse.Data>;
+}
+
+export namespace UsageReportResponse {
+  /**
+   * Recorded usage with period info
+   */
+  export interface Data {
+    /**
+     * Unique identifier for the entity
+     */
+    id: string;
+
+    /**
+     * Timestamp of when the record was created
+     */
+    createdAt: string;
+
+    /**
+     * Customer id
+     */
+    customerId: string;
+
+    /**
+     * Feature id
+     */
+    featureId: string;
+
+    /**
+     * Timestamp
+     */
+    timestamp: string;
+
+    /**
+     * The usage measurement record
+     */
+    value: number;
+
+    /**
+     * The current measured usage value
+     */
+    currentUsage?: number | null;
+
+    /**
+     * The date when the next usage reset will occur
+     */
+    nextResetDate?: string | null;
+
+    /**
+     * Resource id
+     */
+    resourceId?: string | null;
+
+    /**
+     * The end date of the usage period in which this measurement resides (for
+     * entitlements with a reset period)
+     */
+    usagePeriodEnd?: string | null;
+
+    /**
+     * The start date of the usage period in which this measurement resides (for
+     * entitlements with a reset period)
+     */
+    usagePeriodStart?: string | null;
+  }
+}
+
+export interface UsageHistoryParams {
+  /**
+   * Path param: Customer id
+   */
+  customerId: string;
+
+  /**
+   * Query param: The start date of the range
+   */
+  startDate: string;
+
+  /**
+   * Query param: The end date of the range
+   */
+  endDate?: string;
+
+  /**
+   * Query param
+   */
+  groupBy?: string;
+
+  /**
+   * Query param: Resource id
+   */
+  resourceId?: string | null;
+}
+
+export interface UsageReportParams {
+  /**
+   * A list of usage reports to be submitted in bulk
+   */
+  usages: Array<UsageReportParams.Usage>;
+}
+
+export namespace UsageReportParams {
+  /**
+   * Single usage measurement
+   */
+  export interface Usage {
+    /**
+     * Customer id
+     */
+    customerId: string;
+
+    /**
+     * Feature id
+     */
+    featureId: string;
+
+    /**
+     * The value to report for usage
+     */
+    value: number;
+
+    /**
+     * Timestamp of when the record was created
+     */
+    createdAt?: string;
+
+    /**
+     * Additional dimensions for the usage report
+     */
+    dimensions?: { [key: string]: string | number | boolean };
+
+    /**
+     * Resource id
+     */
+    resourceId?: string | null;
+
+    /**
+     * The method by which the usage value should be updated
+     */
+    updateBehavior?: 'DELTA' | 'SET';
+  }
+}
+
+export declare namespace Usage {
+  export {
+    type UsageHistoryResponse as UsageHistoryResponse,
+    type UsageReportResponse as UsageReportResponse,
+    type UsageHistoryParams as UsageHistoryParams,
+    type UsageReportParams as UsageReportParams,
+  };
+}

package/src/resources/v1/v1.ts

@@ -3,291 +3,121 @@
 import { APIResource } from '../../core/resource';
 import * as CouponsAPI from './coupons';
 import {
+  Coupon,
   CouponCreateParams,
-  CouponCreateResponse,
   CouponListParams,
   CouponListResponse,
   CouponListResponsesMyCursorIDPage,
-  CouponRetrieveResponse,
   Coupons,
 } from './coupons';
+import * as EventsAPI from './events';
+import { EventReportParams, EventReportResponse, Events } from './events';
+import * as UsageAPI from './usage';
+import {
+  Usage,
+  UsageHistoryParams,
+  UsageHistoryResponse,
+  UsageReportParams,
+  UsageReportResponse,
+} from './usage';
 import * as CustomersAPI from './customers/customers';
 import {
-  CustomerCreateParams,
+  CustomerImportParams,
+  CustomerImportResponse,
   CustomerListParams,
   CustomerListResponse,
   CustomerListResponsesMyCursorIDPage,
+  CustomerProvisionParams,
   CustomerResponse,
   CustomerUpdateParams,
   Customers,
 } from './customers/customers';
 import * as SubscriptionsAPI from './subscriptions/subscriptions';
 import {
-  SubscriptionCreateParams,
-  SubscriptionCreateResponse,
+  Subscription,
+  SubscriptionCancelParams,
   SubscriptionDelegateParams,
-  SubscriptionDelegateResponse,
+  SubscriptionImportParams,
+  SubscriptionImportResponse,
   SubscriptionListParams,
   SubscriptionListResponse,
   SubscriptionListResponsesMyCursorIDPage,
   SubscriptionMigrateParams,
-  SubscriptionMigrateResponse,
   SubscriptionPreviewParams,
   SubscriptionPreviewResponse,
-  SubscriptionRetrieveResponse,
+  SubscriptionProvisionParams,
+  SubscriptionProvisionResponse,
   SubscriptionTransferParams,
-  SubscriptionTransferResponse,
+  SubscriptionUpdateParams,
   Subscriptions,
 } from './subscriptions/subscriptions';
-import { APIPromise } from '../../core/api-promise';
-import { RequestOptions } from '../../internal/request-options';
 
 export class V1 extends APIResource {
   customers: CustomersAPI.Customers = new CustomersAPI.Customers(this._client);
   subscriptions: SubscriptionsAPI.Subscriptions = new SubscriptionsAPI.Subscriptions(this._client);
   coupons: CouponsAPI.Coupons = new CouponsAPI.Coupons(this._client);
-
-  /**
-   * Report usage events
-   */
-  createEvent(body: V1CreateEventParams, options?: RequestOptions): APIPromise<V1CreateEventResponse> {
-    return this._client.post('/api/v1/events', { body, ...options });
-  }
-
-  /**
-   * 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
-     */
-    id: string;
-
-    /**
-     * Timestamp of when the record was created
-     */
-    createdAt: string;
-
-    /**
-     * Customer id
-     */
-    customerId: string;
-
-    /**
-     * Feature id
-     */
-    featureId: string;
-
-    /**
-     * Timestamp
-     */
-    timestamp: string;
-
-    /**
-     * The usage measurement record
-     */
-    value: number;
-
-    /**
-     * The current measured usage value
-     */
-    currentUsage?: number | null;
-
-    /**
-     * The date when the next usage reset will occur
-     */
-    nextResetDate?: string | null;
-
-    /**
-     * Resource id
-     */
-    resourceId?: string | null;
-
-    /**
-     * The end date of the usage period in which this measurement resides (for
-     * entitlements with a reset period)
-     */
-    usagePeriodEnd?: string | null;
-
-    /**
-     * The start date of the usage period in which this measurement resides (for
-     * entitlements with a reset period)
-     */
-    usagePeriodStart?: string | null;
-  }
-}
-
-export interface V1CreateEventParams {
-  /**
-   * A list of usage events to report
-   */
-  events: Array<V1CreateEventParams.Event>;
-}
-
-export namespace V1CreateEventParams {
-  /**
-   * 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 interface V1CreateUsageParams {
-  /**
-   * A list of usage reports to be submitted in bulk
-   */
-  usages: Array<V1CreateUsageParams.Usage>;
-}
-
-export namespace V1CreateUsageParams {
-  /**
-   * Single usage measurement
-   */
-  export interface Usage {
-    /**
-     * Customer id
-     */
-    customerId: string;
-
-    /**
-     * Feature id
-     */
-    featureId: string;
-
-    /**
-     * The value to report for usage
-     */
-    value: number;
-
-    /**
-     * Timestamp of when the record was created
-     */
-    createdAt?: string;
-
-    /**
-     * Additional dimensions for the usage report
-     */
-    dimensions?: { [key: string]: string | number | boolean };
-
-    /**
-     * Resource id
-     */
-    resourceId?: string | null;
-
-    /**
-     * The method by which the usage value should be updated
-     */
-    updateBehavior?: 'DELTA' | 'SET';
-  }
+  events: EventsAPI.Events = new EventsAPI.Events(this._client);
+  usage: UsageAPI.Usage = new UsageAPI.Usage(this._client);
 }
 
 V1.Customers = Customers;
 V1.Subscriptions = Subscriptions;
 V1.Coupons = Coupons;
+V1.Events = Events;
+V1.Usage = Usage;
 
 export declare namespace V1 {
-  export {
-    type V1CreateEventResponse as V1CreateEventResponse,
-    type V1CreateUsageResponse as V1CreateUsageResponse,
-    type V1CreateEventParams as V1CreateEventParams,
-    type V1CreateUsageParams as V1CreateUsageParams,
-  };
-
   export {
     Customers as Customers,
     type CustomerResponse as CustomerResponse,
     type CustomerListResponse as CustomerListResponse,
+    type CustomerImportResponse as CustomerImportResponse,
     type CustomerListResponsesMyCursorIDPage as CustomerListResponsesMyCursorIDPage,
-    type CustomerCreateParams as CustomerCreateParams,
     type CustomerUpdateParams as CustomerUpdateParams,
     type CustomerListParams as CustomerListParams,
+    type CustomerImportParams as CustomerImportParams,
+    type CustomerProvisionParams as CustomerProvisionParams,
   };
 
   export {
     Subscriptions as Subscriptions,
-    type SubscriptionCreateResponse as SubscriptionCreateResponse,
-    type SubscriptionRetrieveResponse as SubscriptionRetrieveResponse,
+    type Subscription as Subscription,
     type SubscriptionListResponse as SubscriptionListResponse,
-    type SubscriptionDelegateResponse as SubscriptionDelegateResponse,
-    type SubscriptionMigrateResponse as SubscriptionMigrateResponse,
+    type SubscriptionImportResponse as SubscriptionImportResponse,
     type SubscriptionPreviewResponse as SubscriptionPreviewResponse,
-    type SubscriptionTransferResponse as SubscriptionTransferResponse,
+    type SubscriptionProvisionResponse as SubscriptionProvisionResponse,
     type SubscriptionListResponsesMyCursorIDPage as SubscriptionListResponsesMyCursorIDPage,
-    type SubscriptionCreateParams as SubscriptionCreateParams,
+    type SubscriptionUpdateParams as SubscriptionUpdateParams,
     type SubscriptionListParams as SubscriptionListParams,
+    type SubscriptionCancelParams as SubscriptionCancelParams,
     type SubscriptionDelegateParams as SubscriptionDelegateParams,
+    type SubscriptionImportParams as SubscriptionImportParams,
     type SubscriptionMigrateParams as SubscriptionMigrateParams,
     type SubscriptionPreviewParams as SubscriptionPreviewParams,
+    type SubscriptionProvisionParams as SubscriptionProvisionParams,
     type SubscriptionTransferParams as SubscriptionTransferParams,
   };
 
   export {
     Coupons as Coupons,
-    type CouponCreateResponse as CouponCreateResponse,
-    type CouponRetrieveResponse as CouponRetrieveResponse,
+    type Coupon as Coupon,
     type CouponListResponse as CouponListResponse,
     type CouponListResponsesMyCursorIDPage as CouponListResponsesMyCursorIDPage,
     type CouponCreateParams as CouponCreateParams,
     type CouponListParams as CouponListParams,
   };
+
+  export {
+    Events as Events,
+    type EventReportResponse as EventReportResponse,
+    type EventReportParams as EventReportParams,
+  };
+
+  export {
+    Usage as Usage,
+    type UsageHistoryResponse as UsageHistoryResponse,
+    type UsageReportResponse as UsageReportResponse,
+    type UsageHistoryParams as UsageHistoryParams,
+    type UsageReportParams as UsageReportParams,
+  };
 }

package/src/version.ts

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

package/version.d.mts

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

package/version.d.ts

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

package/version.mjs

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

package/resources/v1/customers/usage.d.mts

@@ -1,4 +0,0 @@
-import { APIResource } from "../../../core/resource.mjs";
-export declare class Usage extends APIResource {
-}
-//# sourceMappingURL=usage.d.mts.map

package/resources/v1/customers/usage.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"usage.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/customers/usage.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;AAEtB,qBAAa,KAAM,SAAQ,WAAW;CAAG"}

package/resources/v1/customers/usage.d.ts

@@ -1,4 +0,0 @@
-import { APIResource } from "../../../core/resource.js";
-export declare class Usage extends APIResource {
-}
-//# sourceMappingURL=usage.d.ts.map

package/resources/v1/customers/usage.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"usage.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/customers/usage.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;AAEtB,qBAAa,KAAM,SAAQ,WAAW;CAAG"}

package/resources/v1/customers/usage.js

@@ -1,9 +0,0 @@
-"use strict";
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Usage = void 0;
-const resource_1 = require("../../../core/resource.js");
-class Usage extends resource_1.APIResource {
-}
-exports.Usage = Usage;
-//# sourceMappingURL=usage.js.map

package/resources/v1/customers/usage.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"usage.js","sourceRoot":"","sources":["../../../src/resources/v1/customers/usage.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAErD,MAAa,KAAM,SAAQ,sBAAW;CAAG;AAAzC,sBAAyC"}

package/resources/v1/customers/usage.mjs

@@ -1,5 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-import { APIResource } from "../../../core/resource.mjs";
-export class Usage extends APIResource {
-}
-//# sourceMappingURL=usage.mjs.map

package/resources/v1/customers/usage.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"usage.mjs","sourceRoot":"","sources":["../../../src/resources/v1/customers/usage.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAEtB,MAAM,OAAO,KAAM,SAAQ,WAAW;CAAG"}

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

@@ -1,5 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-import { APIResource } from '../../../core/resource';
-
-export class Usage extends APIResource {}