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

package/src/resources/v1/events.ts

@@ -1,77 +1,3 @@
 // 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';
-
-/**
- * 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 };
-}
+export * from './events/index';

package/src/resources/v1/features.ts

@@ -12,6 +12,13 @@ import { path } from '../../internal/utils/path';
 export class Features extends APIResource {
   /**
    * Archives a feature, preventing it from being used in new entitlements.
+   *
+   * @example
+   * ```ts
+   * const feature = await client.v1.features.archiveFeature(
+   *   'x',
+   * );
+   * ```
    */
   archiveFeature(id: string, options?: RequestOptions): APIPromise<Feature> {
     return this._client.post(path`/api/v1/features/${id}/archive`, options);
@@ -19,6 +26,15 @@ export class Features extends APIResource {
 
   /**
    * Creates a new feature with the specified type, metering, and configuration.
+   *
+   * @example
+   * ```ts
+   * const feature = await client.v1.features.createFeature({
+   *   id: 'id',
+   *   displayName: 'displayName',
+   *   featureType: 'BOOLEAN',
+   * });
+   * ```
    */
   createFeature(body: FeatureCreateFeatureParams, options?: RequestOptions): APIPromise<Feature> {
     return this._client.post('/api/v1/features', { body, ...options });
@@ -26,6 +42,14 @@ export class Features extends APIResource {
 
   /**
    * 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 = {},
@@ -39,6 +63,13 @@ export class Features extends APIResource {
 
   /**
    * Retrieves a feature by its unique identifier.
+   *
+   * @example
+   * ```ts
+   * const feature = await client.v1.features.retrieveFeature(
+   *   'x',
+   * );
+   * ```
    */
   retrieveFeature(id: string, options?: RequestOptions): APIPromise<Feature> {
     return this._client.get(path`/api/v1/features/${id}`, options);
@@ -46,6 +77,13 @@ export class Features extends APIResource {
 
   /**
    * Restores an archived feature, allowing it to be used in entitlements again.
+   *
+   * @example
+   * ```ts
+   * const feature = await client.v1.features.unarchiveFeature(
+   *   'x',
+   * );
+   * ```
    */
   unarchiveFeature(id: string, options?: RequestOptions): APIPromise<Feature> {
     return this._client.post(path`/api/v1/features/${id}/unarchive`, options);
@@ -54,6 +92,11 @@ export class Features extends APIResource {
   /**
    * Updates an existing feature's properties such as display name, description, and
    * configuration.
+   *
+   * @example
+   * ```ts
+   * const feature = await client.v1.features.updateFeature('x');
+   * ```
    */
   updateFeature(id: string, body: FeatureUpdateFeatureParams, options?: RequestOptions): APIPromise<Feature> {
     return this._client.patch(path`/api/v1/features/${id}`, { body, ...options });

package/src/resources/v1/index.ts

@@ -3,8 +3,8 @@
 export {
   Addons,
   type Addon,
-  type ChargeList,
   type AddonListResponse,
+  type AddonListChargesResponse,
   type AddonPublishResponse,
   type AddonRemoveDraftResponse,
   type AddonCreateParams,
@@ -13,7 +13,7 @@ export {
   type AddonListChargesParams,
   type AddonPublishParams,
   type AddonListResponsesMyCursorIDPage,
-  type ChargeListDataMyCursorIDPage,
+  type AddonListChargesResponsesMyCursorIDPage,
 } from './addons/index';
 export {
   Coupons,
@@ -53,7 +53,7 @@ export {
   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,
@@ -67,6 +67,8 @@ export {
   Plans,
   type Plan,
   type PlanListResponse,
+  type PlanListChargesResponse,
+  type PlanListOverageChargesResponse,
   type PlanPublishResponse,
   type PlanRemoveDraftResponse,
   type PlanCreateParams,
@@ -76,6 +78,8 @@ export {
   type PlanListOverageChargesParams,
   type PlanPublishParams,
   type PlanListResponsesMyCursorIDPage,
+  type PlanListChargesResponsesMyCursorIDPage,
+  type PlanListOverageChargesResponsesMyCursorIDPage,
 } from './plans/index';
 export {
   Products,

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

@@ -8,6 +8,14 @@ import { path } from '../../../internal/utils/path';
 export class Entitlements extends APIResource {
   /**
    * Creates one or more entitlements (feature or credit) on a draft plan.
+   *
+   * @example
+   * ```ts
+   * const entitlement =
+   *   await client.v1.plans.entitlements.create('planId', {
+   *     entitlements: [{ id: 'id', type: 'FEATURE' }],
+   *   });
+   * ```
    */
   create(
     planID: string,
@@ -19,6 +27,15 @@ export class Entitlements extends APIResource {
 
   /**
    * Updates an existing entitlement on a draft plan.
+   *
+   * @example
+   * ```ts
+   * const planEntitlement =
+   *   await client.v1.plans.entitlements.update('id', {
+   *     planId: 'planId',
+   *     type: 'FEATURE',
+   *   });
+   * ```
    */
   update(id: string, params: EntitlementUpdateParams, options?: RequestOptions): APIPromise<PlanEntitlement> {
     const { planId, ...body } = params;
@@ -27,6 +44,12 @@ export class Entitlements extends APIResource {
 
   /**
    * Retrieves a list of entitlements for a plan.
+   *
+   * @example
+   * ```ts
+   * const entitlements =
+   *   await client.v1.plans.entitlements.list('planId');
+   * ```
    */
   list(planID: string, options?: RequestOptions): APIPromise<EntitlementListResponse> {
     return this._client.get(path`/api/v1/plans/${planID}/entitlements`, options);
@@ -34,6 +57,14 @@ export class Entitlements extends APIResource {
 
   /**
    * Deletes an entitlement from a draft plan.
+   *
+   * @example
+   * ```ts
+   * const planEntitlement =
+   *   await client.v1.plans.entitlements.delete('id', {
+   *     planId: 'planId',
+   *   });
+   * ```
    */
   delete(id: string, params: EntitlementDeleteParams, options?: RequestOptions): APIPromise<PlanEntitlement> {
     const { planId } = params;

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

@@ -13,6 +13,8 @@ export {
   Plans,
   type Plan,
   type PlanListResponse,
+  type PlanListChargesResponse,
+  type PlanListOverageChargesResponse,
   type PlanPublishResponse,
   type PlanRemoveDraftResponse,
   type PlanCreateParams,
@@ -22,4 +24,6 @@ export {
   type PlanListOverageChargesParams,
   type PlanPublishParams,
   type PlanListResponsesMyCursorIDPage,
+  type PlanListChargesResponsesMyCursorIDPage,
+  type PlanListOverageChargesResponsesMyCursorIDPage,
 } from './plans';