@stigg/typescript 0.1.0-beta.15 → 0.1.0-beta.16

package/src/resources/v1/products.ts

@@ -13,13 +13,6 @@ export class Products extends APIResource {
   /**
    * Archives a product, preventing new subscriptions. All plans and addons are
    * archived.
-   *
-   * @example
-   * ```ts
-   * const product = await client.v1.products.archiveProduct(
-   *   'x',
-   * );
-   * ```
    */
   archiveProduct(id: string, options?: RequestOptions): APIPromise<Product> {
     return this._client.post(path`/api/v1/products/${id}/archive`, options);
@@ -27,14 +20,6 @@ export class Products extends APIResource {
 
   /**
    * Creates a new product.
-   *
-   * @example
-   * ```ts
-   * const product = await client.v1.products.createProduct({
-   *   id: 'id',
-   *   displayName: 'displayName',
-   * });
-   * ```
    */
   createProduct(body: ProductCreateProductParams, options?: RequestOptions): APIPromise<Product> {
     return this._client.post('/api/v1/products', { body, ...options });
@@ -42,14 +27,6 @@ export class Products extends APIResource {
 
   /**
    * Duplicates an existing product, including its plans, addons, and configuration.
-   *
-   * @example
-   * ```ts
-   * const product = await client.v1.products.duplicateProduct(
-   *   'x',
-   *   { targetId: 'targetId' },
-   * );
-   * ```
    */
   duplicateProduct(
     id: string,
@@ -61,14 +38,6 @@ export class Products extends APIResource {
 
   /**
    * Retrieves a paginated list of products in the environment.
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const productListProductsResponse of client.v1.products.listProducts()) {
-   *   // ...
-   * }
-   * ```
    */
   listProducts(
     query: ProductListProductsParams | null | undefined = {},
@@ -82,13 +51,6 @@ export class Products extends APIResource {
 
   /**
    * Restores an archived product, allowing new subscriptions to be created.
-   *
-   * @example
-   * ```ts
-   * const product = await client.v1.products.unarchiveProduct(
-   *   'x',
-   * );
-   * ```
    */
   unarchiveProduct(id: string, options?: RequestOptions): APIPromise<Product> {
     return this._client.post(path`/api/v1/products/${id}/unarchive`, options);
@@ -97,11 +59,6 @@ export class Products extends APIResource {
   /**
    * Updates an existing product's properties such as display name, description, and
    * metadata.
-   *
-   * @example
-   * ```ts
-   * const product = await client.v1.products.updateProduct('x');
-   * ```
    */
   updateProduct(id: string, body: ProductUpdateProductParams, options?: RequestOptions): APIPromise<Product> {
     return this._client.patch(path`/api/v1/products/${id}`, { body, ...options });

package/src/resources/v1/subscriptions/future-update.ts

@@ -11,14 +11,6 @@ import { path } from '../../../internal/utils/path';
 export class FutureUpdate extends APIResource {
   /**
    * Cancels a subscription update that is pending payment completion.
-   *
-   * @example
-   * ```ts
-   * const cancelSubscription =
-   *   await client.v1.subscriptions.futureUpdate.cancelPendingPayment(
-   *     'x',
-   *   );
-   * ```
    */
   cancelPendingPayment(id: string, options?: RequestOptions): APIPromise<CancelSubscription> {
     return this._client.delete(path`/api/v1/subscriptions/${id}/future-update/pending-payment`, options);
@@ -27,14 +19,6 @@ export class FutureUpdate extends APIResource {
   /**
    * Cancels a scheduled subscription update, such as a future downgrade or plan
    * change.
-   *
-   * @example
-   * ```ts
-   * const cancelSubscription =
-   *   await client.v1.subscriptions.futureUpdate.cancelSchedule(
-   *     'x',
-   *   );
-   * ```
    */
   cancelSchedule(id: string, options?: RequestOptions): APIPromise<CancelSubscription> {
     return this._client.delete(path`/api/v1/subscriptions/${id}/future-update/schedule`, options);

package/src/resources/v1/subscriptions/invoice.ts

@@ -12,12 +12,6 @@ export class Invoice extends APIResource {
   /**
    * Marks the latest invoice of a subscription as paid in the billing provider. The
    * invoice must exist and have an OPEN status.
-   *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.v1.subscriptions.invoice.markAsPaid('x');
-   * ```
    */
   markAsPaid(id: string, options?: RequestOptions): APIPromise<InvoiceMarkAsPaidResponse> {
     return this._client.post(path`/api/v1/subscriptions/${id}/invoice/paid`, options);

package/src/resources/v1/subscriptions/subscriptions.ts

@@ -20,13 +20,6 @@ export class Subscriptions extends APIResource {
   /**
    * Retrieves a subscription by its unique identifier, including plan details,
    * billing period, status, and add-ons.
-   *
-   * @example
-   * ```ts
-   * const subscription = await client.v1.subscriptions.retrieve(
-   *   'x',
-   * );
-   * ```
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<Subscription> {
     return this._client.get(path`/api/v1/subscriptions/${id}`, options);
@@ -35,13 +28,6 @@ export class Subscriptions extends APIResource {
   /**
    * Updates an active subscription's properties including billing period, add-ons,
    * unit quantities, and discounts.
-   *
-   * @example
-   * ```ts
-   * const subscription = await client.v1.subscriptions.update(
-   *   'x',
-   * );
-   * ```
    */
   update(id: string, body: SubscriptionUpdateParams, options?: RequestOptions): APIPromise<Subscription> {
     return this._client.patch(path`/api/v1/subscriptions/${id}`, { body, ...options });
@@ -50,14 +36,6 @@ export class Subscriptions extends APIResource {
   /**
    * Retrieves a paginated list of subscriptions, with optional filters for customer,
    * status, and plan.
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const subscriptionListResponse of client.v1.subscriptions.list()) {
-   *   // ...
-   * }
-   * ```
    */
   list(
     query: SubscriptionListParams | null | undefined = {},
@@ -72,13 +50,6 @@ export class Subscriptions extends APIResource {
   /**
    * Cancels an active subscription, either immediately or at a specified time such
    * as end of billing period.
-   *
-   * @example
-   * ```ts
-   * const subscription = await client.v1.subscriptions.cancel(
-   *   'x',
-   * );
-   * ```
    */
   cancel(id: string, body: SubscriptionCancelParams, options?: RequestOptions): APIPromise<Subscription> {
     return this._client.post(path`/api/v1/subscriptions/${id}/cancel`, { body, ...options });
@@ -87,14 +58,6 @@ export class Subscriptions extends APIResource {
   /**
    * Delegates the payment responsibility of a subscription to a different customer.
    * The delegated customer will be billed for this subscription.
-   *
-   * @example
-   * ```ts
-   * const subscription = await client.v1.subscriptions.delegate(
-   *   'x',
-   *   { targetCustomerId: 'targetCustomerId' },
-   * );
-   * ```
    */
   delegate(id: string, body: SubscriptionDelegateParams, options?: RequestOptions): APIPromise<Subscription> {
     return this._client.post(path`/api/v1/subscriptions/${id}/delegate`, { body, ...options });
@@ -103,19 +66,6 @@ export class Subscriptions extends APIResource {
   /**
    * Imports multiple subscriptions in bulk. Used for migrating subscription data
    * from external systems.
-   *
-   * @example
-   * ```ts
-   * const response = await client.v1.subscriptions.import({
-   *   subscriptions: [
-   *     {
-   *       id: 'id',
-   *       customerId: 'customerId',
-   *       planId: 'planId',
-   *     },
-   *   ],
-   * });
-   * ```
    */
   import(body: SubscriptionImportParams, options?: RequestOptions): APIPromise<SubscriptionImportResponse> {
     return this._client.post('/api/v1/subscriptions/import', { body, ...options });
@@ -124,13 +74,6 @@ export class Subscriptions extends APIResource {
   /**
    * Migrates a subscription to the latest published version of its plan or add-ons.
    * Handles prorated charges or credits automatically.
-   *
-   * @example
-   * ```ts
-   * const subscription = await client.v1.subscriptions.migrate(
-   *   'x',
-   * );
-   * ```
    */
   migrate(id: string, body: SubscriptionMigrateParams, options?: RequestOptions): APIPromise<Subscription> {
     return this._client.post(path`/api/v1/subscriptions/${id}/migrate`, { body, ...options });
@@ -139,14 +82,6 @@ export class Subscriptions extends APIResource {
   /**
    * Previews the pricing impact of creating or updating a subscription without
    * making changes. Returns estimated costs, taxes, and proration details.
-   *
-   * @example
-   * ```ts
-   * const response = await client.v1.subscriptions.preview({
-   *   customerId: 'customerId',
-   *   planId: 'planId',
-   * });
-   * ```
    */
   preview(
     body: SubscriptionPreviewParams,
@@ -158,14 +93,6 @@ export class Subscriptions extends APIResource {
   /**
    * Creates a new subscription for an existing customer. When payment is required
    * and no payment method exists, returns a checkout URL.
-   *
-   * @example
-   * ```ts
-   * const response = await client.v1.subscriptions.provision({
-   *   customerId: 'customerId',
-   *   planId: 'planId',
-   * });
-   * ```
    */
   provision(
     body: SubscriptionProvisionParams,
@@ -177,14 +104,6 @@ export class Subscriptions extends APIResource {
   /**
    * Transfers a subscription to a different resource ID. Used for multi-resource
    * products where subscriptions apply to specific entities like websites or apps.
-   *
-   * @example
-   * ```ts
-   * const subscription = await client.v1.subscriptions.transfer(
-   *   'x',
-   *   { destinationResourceId: 'destinationResourceId' },
-   * );
-   * ```
    */
   transfer(id: string, body: SubscriptionTransferParams, options?: RequestOptions): APIPromise<Subscription> {
     return this._client.post(path`/api/v1/subscriptions/${id}/transfer`, { body, ...options });

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

@@ -12,12 +12,6 @@ export class Usage extends APIResource {
   /**
    * Immediately charges usage for a subscription via the billing integration.
    * Calculates usage since the last charge and creates an invoice.
-   *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.v1.subscriptions.usage.chargeUsage('x');
-   * ```
    */
   chargeUsage(
     id: string,
@@ -30,13 +24,6 @@ export class Usage extends APIResource {
   /**
    * Triggers a usage sync for a subscription, reporting current usage to the billing
    * provider.
-   *
-   * @example
-   * ```ts
-   * const response = await client.v1.subscriptions.usage.sync(
-   *   'x',
-   * );
-   * ```
    */
   sync(id: string, options?: RequestOptions): APIPromise<UsageSyncResponse> {
     return this._client.post(path`/api/v1/subscriptions/${id}/usage/sync`, options);

package/src/resources/v1/usage.ts

@@ -11,17 +11,6 @@ import { path } from '../../internal/utils/path';
 export class Usage extends APIResource {
   /**
    * Retrieves historical usage data for a customer's metered feature over time.
-   *
-   * @example
-   * ```ts
-   * const response = await client.v1.usage.history(
-   *   'featureId',
-   *   {
-   *     customerId: 'customerId',
-   *     startDate: '2019-12-27T18:11:19.117Z',
-   *   },
-   * );
-   * ```
    */
   history(
     featureID: string,
@@ -35,19 +24,6 @@ export class Usage extends APIResource {
   /**
    * Reports usage measurements for metered features. The reported usage is used to
    * track, limit, and bill customer consumption.
-   *
-   * @example
-   * ```ts
-   * const response = await client.v1.usage.report({
-   *   usages: [
-   *     {
-   *       customerId: 'customerId',
-   *       featureId: 'featureId',
-   *       value: -9007199254740991,
-   *     },
-   *   ],
-   * });
-   * ```
    */
   report(body: UsageReportParams, options?: RequestOptions): APIPromise<UsageReportResponse> {
     return this._client.post('/api/v1/usage', { body, ...options });

package/src/resources/v1/v1.ts

@@ -11,6 +11,8 @@ import {
   CouponUpdateCouponParams,
   Coupons,
 } from './coupons';
+import * as EventsAPI from './events';
+import { EventReportParams, EventReportResponse, Events } from './events';
 import * as FeaturesAPI from './features';
 import {
   Feature,
@@ -87,8 +89,6 @@ import {
   CustomerUpdateParams,
   Customers,
 } from './customers/customers';
-import * as EventsAPI from './events/events';
-import { EventReportParams, EventReportResponse, Events } from './events/events';
 import * as PlansAPI from './plans/plans';
 import {
   Plan,

package/src/resources/{v1/events/beta → v1-beta}/customers/assignments.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';
 
 export class Assignments extends APIResource {
   /**
@@ -15,7 +15,7 @@ export class Assignments extends APIResource {
    * @example
    * ```ts
    * // Automatically fetches more pages as needed.
-   * for await (const assignmentListResponse of client.v1.events.beta.customers.assignments.list(
+   * for await (const assignmentListResponse of client.v1Beta.customers.assignments.list(
    *   'id',
    * )) {
    *   // ...
@@ -43,25 +43,22 @@ export class Assignments extends APIResource {
    * @example
    * ```ts
    * const response =
-   *   await client.v1.events.beta.customers.assignments.upsert(
-   *     'id',
-   *     {
-   *       assignments: [
-   *         {
-   *           entityId: 'workspace-001',
-   *           capabilityId: 'compute-minutes',
-   *           usageLimit: 1000,
-   *           cadence: 'MONTH',
-   *         },
-   *         {
-   *           entityId: 'workspace-002',
-   *           capabilityId: 'compute-minutes',
-   *           usageLimit: 2000,
-   *           cadence: 'MONTH',
-   *         },
-   *       ],
-   *     },
-   *   );
+   *   await client.v1Beta.customers.assignments.upsert('id', {
+   *     assignments: [
+   *       {
+   *         entityId: 'workspace-001',
+   *         capabilityId: 'compute-minutes',
+   *         usageLimit: 1000,
+   *         cadence: 'MONTH',
+   *       },
+   *       {
+   *         entityId: 'workspace-002',
+   *         capabilityId: 'compute-minutes',
+   *         usageLimit: 2000,
+   *         cadence: 'MONTH',
+   *       },
+   *     ],
+   *   });
    * ```
    */
   upsert(

package/src/resources/{v1/events/beta → v1-beta}/customers/customers.ts

@@ -1,6 +1,6 @@
 // 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 AssignmentsAPI from './assignments';
 import {
   AssignmentListParams,

package/src/resources/{v1/events/beta → v1-beta}/customers/entities.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';
 
 export class Entities extends APIResource {
   /**
@@ -13,10 +13,9 @@ export class Entities extends APIResource {
    * @example
    * ```ts
    * const entity =
-   *   await client.v1.events.beta.customers.entities.retrieve(
-   *     'x',
-   *     { id: 'id' },
-   *   );
+   *   await client.v1Beta.customers.entities.retrieve('x', {
+   *     id: 'id',
+   *   });
    * ```
    */
   retrieve(
@@ -34,7 +33,7 @@ export class Entities extends APIResource {
    * @example
    * ```ts
    * // Automatically fetches more pages as needed.
-   * for await (const entityListResponse of client.v1.events.beta.customers.entities.list(
+   * for await (const entityListResponse of client.v1Beta.customers.entities.list(
    *   'id',
    * )) {
    *   // ...
@@ -59,10 +58,9 @@ export class Entities extends APIResource {
    * @example
    * ```ts
    * const response =
-   *   await client.v1.events.beta.customers.entities.archive(
-   *     'id',
-   *     { ids: ['user-7f3a0c1d', 'user-c4d1b2e9'] },
-   *   );
+   *   await client.v1Beta.customers.entities.archive('id', {
+   *     ids: ['user-7f3a0c1d', 'user-c4d1b2e9'],
+   *   });
    * ```
    */
   archive(
@@ -79,10 +77,9 @@ export class Entities extends APIResource {
    * @example
    * ```ts
    * const response =
-   *   await client.v1.events.beta.customers.entities.unarchive(
-   *     'id',
-   *     { ids: ['user-7f3a0c1d', 'user-c4d1b2e9'] },
-   *   );
+   *   await client.v1Beta.customers.entities.unarchive('id', {
+   *     ids: ['user-7f3a0c1d', 'user-c4d1b2e9'],
+   *   });
    * ```
    */
   unarchive(
@@ -100,26 +97,20 @@ export class Entities extends APIResource {
    * @example
    * ```ts
    * const response =
-   *   await client.v1.events.beta.customers.entities.upsert(
-   *     'id',
-   *     {
-   *       entities: [
-   *         {
-   *           id: 'user-7f3a0c1d',
-   *           typeRefId: 'user',
-   *           metadata: {
-   *             email: 'jane@acme.com',
-   *             role: 'admin',
-   *           },
-   *         },
-   *         {
-   *           id: 'user-c4d1b2e9',
-   *           typeRefId: 'user',
-   *           metadata: { email: 'john@acme.com' },
-   *         },
-   *       ],
-   *     },
-   *   );
+   *   await client.v1Beta.customers.entities.upsert('id', {
+   *     entities: [
+   *       {
+   *         id: 'user-7f3a0c1d',
+   *         typeRefId: 'user',
+   *         metadata: { email: 'jane@acme.com', role: 'admin' },
+   *       },
+   *       {
+   *         id: 'user-c4d1b2e9',
+   *         typeRefId: 'user',
+   *         metadata: { email: 'john@acme.com' },
+   *       },
+   *     ],
+   *   });
    * ```
    */
   upsert(id: string, body: EntityUpsertParams, options?: RequestOptions): APIPromise<EntityUpsertResponse> {

package/src/resources/{v1/events/beta → v1-beta}/customers/entitlements.ts

@@ -1,9 +1,9 @@
 // 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';
+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 Entitlements extends APIResource {
   /**
@@ -14,9 +14,7 @@ export class Entitlements extends APIResource {
    * @example
    * ```ts
    * const response =
-   *   await client.v1.events.beta.customers.entitlements.check(
-   *     'x',
-   *   );
+   *   await client.v1Beta.customers.entitlements.check('x');
    * ```
    */
   check(

package/src/resources/{v1/events/beta → v1-beta}/entity-types.ts

@@ -1,9 +1,9 @@
 // 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 { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
 
 export class EntityTypes extends APIResource {
   /**
@@ -14,7 +14,7 @@ export class EntityTypes extends APIResource {
    * @example
    * ```ts
    * // Automatically fetches more pages as needed.
-   * for await (const entityTypeListResponse of client.v1.events.beta.entityTypes.list()) {
+   * for await (const entityTypeListResponse of client.v1Beta.entityTypes.list()) {
    *   // ...
    * }
    * ```
@@ -36,21 +36,20 @@ export class EntityTypes extends APIResource {
    *
    * @example
    * ```ts
-   * const response =
-   *   await client.v1.events.beta.entityTypes.upsert({
-   *     types: [
-   *       {
-   *         id: 'org',
-   *         displayName: 'Organization',
-   *         attributionKeys: ['organizationId'],
-   *       },
-   *       {
-   *         id: 'team',
-   *         displayName: 'Team',
-   *         attributionKeys: ['teamId'],
-   *       },
-   *     ],
-   *   });
+   * const response = await client.v1Beta.entityTypes.upsert({
+   *   types: [
+   *     {
+   *       id: 'org',
+   *       displayName: 'Organization',
+   *       attributionKeys: ['organizationId'],
+   *     },
+   *     {
+   *       id: 'team',
+   *       displayName: 'Team',
+   *       attributionKeys: ['teamId'],
+   *     },
+   *   ],
+   * });
    * ```
    */
   upsert(body: EntityTypeUpsertParams, options?: RequestOptions): APIPromise<EntityTypeUpsertResponse> {

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

@@ -1,6 +1,5 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { Beta } from './beta';
 export { Customers } from './customers/index';
 export {
   EntityTypes,
@@ -10,3 +9,4 @@ export {
   type EntityTypeUpsertParams,
   type EntityTypeListResponsesMyCursorIDPage,
 } from './entity-types';
+export { V1Beta } from './v1-beta';

package/src/resources/{v1/events/beta/beta.ts → v1-beta/v1-beta.ts}

@@ -1,6 +1,6 @@
 // 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 EntityTypesAPI from './entity-types';
 import {
   EntityTypeListParams,
@@ -13,15 +13,15 @@ import {
 import * as CustomersAPI from './customers/customers';
 import { Customers } from './customers/customers';
 
-export class Beta extends APIResource {
+export class V1Beta extends APIResource {
   customers: CustomersAPI.Customers = new CustomersAPI.Customers(this._client);
   entityTypes: EntityTypesAPI.EntityTypes = new EntityTypesAPI.EntityTypes(this._client);
 }
 
-Beta.Customers = Customers;
-Beta.EntityTypes = EntityTypes;
+V1Beta.Customers = Customers;
+V1Beta.EntityTypes = EntityTypes;
 
-export declare namespace Beta {
+export declare namespace V1Beta {
   export { Customers as Customers };
 
   export {

package/src/resources/{v1/events/beta.ts → v1-beta.ts}

@@ -1,3 +1,3 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export * from './beta/index';
+export * from './v1-beta/index';