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

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

@@ -39,13 +39,6 @@ export class Customers extends APIResource {
   /**
    * Retrieves a customer by their unique identifier, including billing information
    * and subscription status.
-   *
-   * @example
-   * ```ts
-   * const customerResponse = await client.v1.customers.retrieve(
-   *   'x',
-   * );
-   * ```
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<CustomerResponse> {
     return this._client.get(path`/api/v1/customers/${id}`, options);
@@ -54,13 +47,6 @@ export class Customers extends APIResource {
   /**
    * Updates an existing customer's properties such as name, email, and billing
    * information.
-   *
-   * @example
-   * ```ts
-   * const customerResponse = await client.v1.customers.update(
-   *   'x',
-   * );
-   * ```
    */
   update(id: string, body: CustomerUpdateParams, options?: RequestOptions): APIPromise<CustomerResponse> {
     return this._client.patch(path`/api/v1/customers/${id}`, { body, ...options });
@@ -68,14 +54,6 @@ export class Customers extends APIResource {
 
   /**
    * Retrieves a paginated list of customers in the environment.
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const customerListResponse of client.v1.customers.list()) {
-   *   // ...
-   * }
-   * ```
    */
   list(
     query: CustomerListParams | null | undefined = {},
@@ -90,13 +68,6 @@ export class Customers extends APIResource {
   /**
    * Archives a customer, preventing new subscriptions. Optionally cancels existing
    * subscriptions.
-   *
-   * @example
-   * ```ts
-   * const customerResponse = await client.v1.customers.archive(
-   *   'x',
-   * );
-   * ```
    */
   archive(id: string, options?: RequestOptions): APIPromise<CustomerResponse> {
     return this._client.post(path`/api/v1/customers/${id}/archive`, options);
@@ -111,13 +82,6 @@ export class Customers extends APIResource {
    * mechanisms, and low-latency guarantees. It is not recommended for hot-path
    * entitlement checks. For production use, consider using the Stigg Node Server SDK
    * with caching or the Sidecar for low-latency cached responses.
-   *
-   * @example
-   * ```ts
-   * const response = await client.v1.customers.checkEntitlement(
-   *   'x',
-   * );
-   * ```
    */
   checkEntitlement(
     id: string,
@@ -130,19 +94,6 @@ export class Customers extends APIResource {
   /**
    * Imports multiple customers in bulk. Used for migrating customer data from
    * external systems.
-   *
-   * @example
-   * ```ts
-   * const response = await client.v1.customers.import({
-   *   customers: [
-   *     {
-   *       id: 'id',
-   *       email: 'dev@stainless.com',
-   *       name: 'name',
-   *     },
-   *   ],
-   * });
-   * ```
    */
   import(body: CustomerImportParams, options?: RequestOptions): APIPromise<CustomerImportResponse> {
     return this._client.post('/api/v1/customers/import', { body, ...options });
@@ -150,16 +101,6 @@ export class Customers extends APIResource {
 
   /**
    * Retrieves a paginated list of resources within the same customer.
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const customerListResourcesResponse of client.v1.customers.listResources(
-   *   'x',
-   * )) {
-   *   // ...
-   * }
-   * ```
    */
   listResources(
     id: string,
@@ -176,12 +117,6 @@ export class Customers extends APIResource {
   /**
    * Creates a new customer and optionally provisions an initial subscription in a
    * single operation.
-   *
-   * @example
-   * ```ts
-   * const customerResponse =
-   *   await client.v1.customers.provision({ id: 'id' });
-   * ```
    */
   provision(body: CustomerProvisionParams, options?: RequestOptions): APIPromise<CustomerResponse> {
     return this._client.post('/api/v1/customers', { body, ...options });
@@ -195,12 +130,6 @@ export class Customers extends APIResource {
    * mechanisms, and low-latency guarantees. It is not recommended for hot-path
    * entitlement checks. For production use, consider using the Stigg Node Server SDK
    * with caching or the Sidecar for low-latency cached responses.
-   *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.v1.customers.retrieveEntitlements('x');
-   * ```
    */
   retrieveEntitlements(
     id: string,
@@ -212,12 +141,6 @@ export class Customers extends APIResource {
 
   /**
    * Restores an archived customer, allowing them to create new subscriptions again.
-   *
-   * @example
-   * ```ts
-   * const customerResponse =
-   *   await client.v1.customers.unarchive('x');
-   * ```
    */
   unarchive(id: string, options?: RequestOptions): APIPromise<CustomerResponse> {
     return this._client.post(path`/api/v1/customers/${id}/unarchive`, options);

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

@@ -10,15 +10,6 @@ import { path } from '../../../internal/utils/path';
 export class Integrations extends APIResource {
   /**
    * Retrieves a specific integration for a customer by integration ID.
-   *
-   * @example
-   * ```ts
-   * const customerIntegrationResponse =
-   *   await client.v1.customers.integrations.retrieve(
-   *     'integrationId',
-   *     { id: 'id' },
-   *   );
-   * ```
    */
   retrieve(
     integrationID: string,
@@ -32,15 +23,6 @@ export class Integrations extends APIResource {
   /**
    * Updates a customer's integration link, such as changing the synced external
    * entity ID.
-   *
-   * @example
-   * ```ts
-   * const customerIntegrationResponse =
-   *   await client.v1.customers.integrations.update(
-   *     'integrationId',
-   *     { id: 'id', syncedEntityId: 'syncedEntityId' },
-   *   );
-   * ```
    */
   update(
     integrationID: string,
@@ -57,16 +39,6 @@ export class Integrations extends APIResource {
   /**
    * Retrieves a paginated list of a customer's external integrations (billing, CRM,
    * etc.).
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const integrationListResponse of client.v1.customers.integrations.list(
-   *   'x',
-   * )) {
-   *   // ...
-   * }
-   * ```
    */
   list(
     id: string,
@@ -83,16 +55,6 @@ export class Integrations extends APIResource {
   /**
    * Links a customer to an external integration by specifying the vendor and
    * external entity ID.
-   *
-   * @example
-   * ```ts
-   * const customerIntegrationResponse =
-   *   await client.v1.customers.integrations.link('x', {
-   *     id: 'id',
-   *     syncedEntityId: 'syncedEntityId',
-   *     vendorIdentifier: 'AUTH0',
-   *   });
-   * ```
    */
   link(
     id: string,
@@ -104,15 +66,6 @@ export class Integrations extends APIResource {
 
   /**
    * Removes the link between a customer and an external integration.
-   *
-   * @example
-   * ```ts
-   * const customerIntegrationResponse =
-   *   await client.v1.customers.integrations.unlink(
-   *     'integrationId',
-   *     { id: 'id' },
-   *   );
-   * ```
    */
   unlink(
     integrationID: string,

package/src/resources/v1/customers/payment-method.ts

@@ -13,16 +13,6 @@ export class PaymentMethod extends APIResource {
   /**
    * Attaches a payment method to a customer for billing. Required for paid
    * subscriptions when integrated with a billing provider.
-   *
-   * @example
-   * ```ts
-   * const customerResponse =
-   *   await client.v1.customers.paymentMethod.attach('x', {
-   *     integrationId: 'integrationId',
-   *     paymentMethodId: 'paymentMethodId',
-   *     vendorIdentifier: 'AUTH0',
-   *   });
-   * ```
    */
   attach(
     id: string,
@@ -35,12 +25,6 @@ export class PaymentMethod extends APIResource {
   /**
    * Removes the payment method from a customer. Ensure active paid subscriptions
    * have an alternative payment method.
-   *
-   * @example
-   * ```ts
-   * const customerResponse =
-   *   await client.v1.customers.paymentMethod.detach('x');
-   * ```
    */
   detach(id: string, options?: RequestOptions): APIPromise<CustomersAPI.CustomerResponse> {
     return this._client.delete(path`/api/v1/customers/${id}/payment-method`, options);

package/src/resources/v1/customers/promotional-entitlements.ts

@@ -13,38 +13,6 @@ export class PromotionalEntitlements extends APIResource {
   /**
    * Grants promotional entitlements to a customer, providing feature access outside
    * their subscription. Entitlements can be time-limited or permanent.
-   *
-   * @example
-   * ```ts
-   * const promotionalEntitlement =
-   *   await client.v1.customers.promotionalEntitlements.create(
-   *     'x',
-   *     {
-   *       promotionalEntitlements: [
-   *         {
-   *           customEndDate: '2019-12-27T18:11:19.117Z',
-   *           enumValues: ['string'],
-   *           featureId: 'featureId',
-   *           hasSoftLimit: true,
-   *           hasUnlimitedUsage: true,
-   *           isVisible: true,
-   *           monthlyResetPeriodConfiguration: {
-   *             accordingTo: 'SubscriptionStart',
-   *           },
-   *           period: '1 week',
-   *           resetPeriod: 'YEAR',
-   *           usageLimit: -9007199254740991,
-   *           weeklyResetPeriodConfiguration: {
-   *             accordingTo: 'SubscriptionStart',
-   *           },
-   *           yearlyResetPeriodConfiguration: {
-   *             accordingTo: 'SubscriptionStart',
-   *           },
-   *         },
-   *       ],
-   *     },
-   *   );
-   * ```
    */
   create(
     id: string,
@@ -56,16 +24,6 @@ export class PromotionalEntitlements extends APIResource {
 
   /**
    * Retrieves a paginated list of a customer's promotional entitlements.
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const promotionalEntitlementListResponse of client.v1.customers.promotionalEntitlements.list(
-   *   'x',
-   * )) {
-   *   // ...
-   * }
-   * ```
    */
   list(
     id: string,
@@ -82,15 +40,6 @@ export class PromotionalEntitlements extends APIResource {
   /**
    * Revokes a previously granted promotional entitlement from a customer for a
    * specific feature.
-   *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.v1.customers.promotionalEntitlements.revoke(
-   *     'featureId',
-   *     { id: 'id' },
-   *   );
-   * ```
    */
   revoke(
     featureID: string,

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/features.ts

@@ -12,13 +12,6 @@ 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);
@@ -26,15 +19,6 @@ 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 });
@@ -42,14 +26,6 @@ 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 = {},
@@ -63,13 +39,6 @@ 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);
@@ -77,13 +46,6 @@ 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);
@@ -92,11 +54,6 @@ 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

@@ -53,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,

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

@@ -8,14 +8,6 @@ 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,
@@ -27,15 +19,6 @@ 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;
@@ -44,12 +27,6 @@ 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);
@@ -57,14 +34,6 @@ 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/plans.ts

@@ -24,15 +24,6 @@ export class Plans extends APIResource {
 
   /**
    * Creates a new plan in draft status.
-   *
-   * @example
-   * ```ts
-   * const plan = await client.v1.plans.create({
-   *   id: 'id',
-   *   displayName: 'displayName',
-   *   productId: 'productId',
-   * });
-   * ```
    */
   create(body: PlanCreateParams, options?: RequestOptions): APIPromise<Plan> {
     return this._client.post('/api/v1/plans', { body, ...options });
@@ -41,11 +32,6 @@ export class Plans extends APIResource {
   /**
    * Retrieves a plan by its unique identifier, including entitlements and pricing
    * details.
-   *
-   * @example
-   * ```ts
-   * const plan = await client.v1.plans.retrieve('x');
-   * ```
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<Plan> {
     return this._client.get(path`/api/v1/plans/${id}`, options);
@@ -54,11 +40,6 @@ export class Plans extends APIResource {
   /**
    * Updates an existing plan's properties such as display name, description, and
    * metadata.
-   *
-   * @example
-   * ```ts
-   * const plan = await client.v1.plans.update('x');
-   * ```
    */
   update(id: string, body: PlanUpdateParams, options?: RequestOptions): APIPromise<Plan> {
     return this._client.patch(path`/api/v1/plans/${id}`, { body, ...options });
@@ -66,14 +47,6 @@ export class Plans extends APIResource {
 
   /**
    * Retrieves a paginated list of plans in the environment.
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const planListResponse of client.v1.plans.list()) {
-   *   // ...
-   * }
-   * ```
    */
   list(
     query: PlanListParams | null | undefined = {},
@@ -84,11 +57,6 @@ export class Plans extends APIResource {
 
   /**
    * Archives a plan, preventing it from being used in new subscriptions.
-   *
-   * @example
-   * ```ts
-   * const plan = await client.v1.plans.archive('x');
-   * ```
    */
   archive(id: string, options?: RequestOptions): APIPromise<Plan> {
     return this._client.post(path`/api/v1/plans/${id}/archive`, options);
@@ -96,11 +64,6 @@ export class Plans extends APIResource {
 
   /**
    * Creates a draft version of an existing plan for modification before publishing.
-   *
-   * @example
-   * ```ts
-   * const plan = await client.v1.plans.createDraft('x');
-   * ```
    */
   createDraft(id: string, options?: RequestOptions): APIPromise<Plan> {
     return this._client.post(path`/api/v1/plans/${id}/draft`, options);
@@ -108,16 +71,6 @@ export class Plans extends APIResource {
 
   /**
    * Retrieves the list of charges configured on a plan.
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const planListChargesResponse of client.v1.plans.listCharges(
-   *   'x',
-   * )) {
-   *   // ...
-   * }
-   * ```
    */
   listCharges(
     id: string,
@@ -133,16 +86,6 @@ export class Plans extends APIResource {
 
   /**
    * Retrieves the list of overage charges configured on a plan.
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const planListOverageChargesResponse of client.v1.plans.listOverageCharges(
-   *   'x',
-   * )) {
-   *   // ...
-   * }
-   * ```
    */
   listOverageCharges(
     id: string,
@@ -158,13 +101,6 @@ export class Plans extends APIResource {
 
   /**
    * Publishes a draft plan, making it available for use in subscriptions.
-   *
-   * @example
-   * ```ts
-   * const response = await client.v1.plans.publish('x', {
-   *   migrationType: 'NEW_CUSTOMERS',
-   * });
-   * ```
    */
   publish(id: string, body: PlanPublishParams, options?: RequestOptions): APIPromise<PlanPublishResponse> {
     return this._client.post(path`/api/v1/plans/${id}/publish`, { body, ...options });
@@ -172,11 +108,6 @@ export class Plans extends APIResource {
 
   /**
    * Removes a draft version of a plan.
-   *
-   * @example
-   * ```ts
-   * const response = await client.v1.plans.removeDraft('x');
-   * ```
    */
   removeDraft(id: string, options?: RequestOptions): APIPromise<PlanRemoveDraftResponse> {
     return this._client.delete(path`/api/v1/plans/${id}/draft`, options);