@stigg/typescript 0.1.0-alpha.8 → 0.1.0-beta.1

package/src/resources/v1/plans.ts

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

package/src/resources/v1/products.ts

@@ -6,22 +6,22 @@ import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from '../../co
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Operations related to products
+ */
 export class Products extends APIResource {
   /**
    * Archives a product, preventing new subscriptions. All plans and addons are
    * archived.
    */
-  archiveProduct(id: string, options?: RequestOptions): APIPromise<ProductArchiveProductResponse> {
+  archiveProduct(id: string, options?: RequestOptions): APIPromise<Product> {
     return this._client.post(path`/api/v1/products/${id}/archive`, options);
   }
 
   /**
    * Creates a new product.
    */
-  createProduct(
-    body: ProductCreateProductParams,
-    options?: RequestOptions,
-  ): APIPromise<ProductCreateProductResponse> {
+  createProduct(body: ProductCreateProductParams, options?: RequestOptions): APIPromise<Product> {
     return this._client.post('/api/v1/products', { body, ...options });
   }
 
@@ -32,7 +32,7 @@ export class Products extends APIResource {
     id: string,
     body: ProductDuplicateProductParams,
     options?: RequestOptions,
-  ): APIPromise<ProductDuplicateProductResponse> {
+  ): APIPromise<Product> {
     return this._client.post(path`/api/v1/products/${id}/duplicate`, { body, ...options });
   }
 
@@ -52,7 +52,7 @@ export class Products extends APIResource {
   /**
    * Restores an archived product, allowing new subscriptions to be created.
    */
-  unarchiveProduct(id: string, options?: RequestOptions): APIPromise<ProductUnarchiveProductResponse> {
+  unarchiveProduct(id: string, options?: RequestOptions): APIPromise<Product> {
     return this._client.post(path`/api/v1/products/${id}/unarchive`, options);
   }
 
@@ -60,11 +60,7 @@ export class Products extends APIResource {
    * Updates an existing product's properties such as display name, description, and
    * metadata.
    */
-  updateProduct(
-    id: string,
-    body: ProductUpdateProductParams,
-    options?: RequestOptions,
-  ): APIPromise<ProductUpdateProductResponse> {
+  updateProduct(id: string, body: ProductUpdateProductParams, options?: RequestOptions): APIPromise<Product> {
     return this._client.patch(path`/api/v1/products/${id}`, { body, ...options });
   }
 }
@@ -74,214 +70,14 @@ export type ProductListProductsResponsesMyCursorIDPage = MyCursorIDPage<ProductL
 /**
  * Response object
  */
-export interface ProductArchiveProductResponse {
+export interface Product {
   /**
    * Product configuration object
    */
-  data: ProductArchiveProductResponse.Data;
+  data: Product.Data;
 }
 
-export namespace ProductArchiveProductResponse {
-  /**
-   * Product configuration object
-   */
-  export interface Data {
-    /**
-     * The unique identifier for the entity
-     */
-    id: string;
-
-    /**
-     * Timestamp of when the record was created
-     */
-    createdAt: string;
-
-    /**
-     * Description of the product
-     */
-    description: string | null;
-
-    /**
-     * Display name of the product
-     */
-    displayName: string;
-
-    /**
-     * Metadata associated with the entity
-     */
-    metadata: { [key: string]: string };
-
-    /**
-     * Indicates if multiple subscriptions to this product are allowed
-     */
-    multipleSubscriptions: boolean;
-
-    /**
-     * The status of the product
-     */
-    status: 'PUBLISHED' | 'ARCHIVED';
-
-    /**
-     * Timestamp of when the record was last updated
-     */
-    updatedAt: string;
-
-    /**
-     * Product behavior settings for subscription lifecycle management.
-     */
-    productSettings?: Data.ProductSettings;
-  }
-
-  export namespace Data {
-    /**
-     * Product behavior settings for subscription lifecycle management.
-     */
-    export interface ProductSettings {
-      /**
-       * Time when the subscription will be cancelled
-       */
-      subscriptionCancellationTime: 'END_OF_BILLING_PERIOD' | 'IMMEDIATE' | 'SPECIFIC_DATE';
-
-      /**
-       * Setup for the end of the subscription
-       */
-      subscriptionEndSetup: 'DOWNGRADE_TO_FREE' | 'CANCEL_SUBSCRIPTION';
-
-      /**
-       * Setup for the start of the subscription
-       */
-      subscriptionStartSetup: 'PLAN_SELECTION' | 'TRIAL_PERIOD' | 'FREE_PLAN';
-
-      /**
-       * ID of the plan to downgrade to at the end of the billing period
-       */
-      downgradePlanId?: string | null;
-
-      /**
-       * Indicates if the subscription should be prorated at the end of the billing
-       * period
-       */
-      prorateAtEndOfBillingPeriod?: boolean | null;
-
-      /**
-       * ID of the plan to start the subscription with
-       */
-      subscriptionStartPlanId?: string | null;
-    }
-  }
-}
-
-/**
- * Response object
- */
-export interface ProductCreateProductResponse {
-  /**
-   * Product configuration object
-   */
-  data: ProductCreateProductResponse.Data;
-}
-
-export namespace ProductCreateProductResponse {
-  /**
-   * Product configuration object
-   */
-  export interface Data {
-    /**
-     * The unique identifier for the entity
-     */
-    id: string;
-
-    /**
-     * Timestamp of when the record was created
-     */
-    createdAt: string;
-
-    /**
-     * Description of the product
-     */
-    description: string | null;
-
-    /**
-     * Display name of the product
-     */
-    displayName: string;
-
-    /**
-     * Metadata associated with the entity
-     */
-    metadata: { [key: string]: string };
-
-    /**
-     * Indicates if multiple subscriptions to this product are allowed
-     */
-    multipleSubscriptions: boolean;
-
-    /**
-     * The status of the product
-     */
-    status: 'PUBLISHED' | 'ARCHIVED';
-
-    /**
-     * Timestamp of when the record was last updated
-     */
-    updatedAt: string;
-
-    /**
-     * Product behavior settings for subscription lifecycle management.
-     */
-    productSettings?: Data.ProductSettings;
-  }
-
-  export namespace Data {
-    /**
-     * Product behavior settings for subscription lifecycle management.
-     */
-    export interface ProductSettings {
-      /**
-       * Time when the subscription will be cancelled
-       */
-      subscriptionCancellationTime: 'END_OF_BILLING_PERIOD' | 'IMMEDIATE' | 'SPECIFIC_DATE';
-
-      /**
-       * Setup for the end of the subscription
-       */
-      subscriptionEndSetup: 'DOWNGRADE_TO_FREE' | 'CANCEL_SUBSCRIPTION';
-
-      /**
-       * Setup for the start of the subscription
-       */
-      subscriptionStartSetup: 'PLAN_SELECTION' | 'TRIAL_PERIOD' | 'FREE_PLAN';
-
-      /**
-       * ID of the plan to downgrade to at the end of the billing period
-       */
-      downgradePlanId?: string | null;
-
-      /**
-       * Indicates if the subscription should be prorated at the end of the billing
-       * period
-       */
-      prorateAtEndOfBillingPeriod?: boolean | null;
-
-      /**
-       * ID of the plan to start the subscription with
-       */
-      subscriptionStartPlanId?: string | null;
-    }
-  }
-}
-
-/**
- * Response object
- */
-export interface ProductDuplicateProductResponse {
-  /**
-   * Product configuration object
-   */
-  data: ProductDuplicateProductResponse.Data;
-}
-
-export namespace ProductDuplicateProductResponse {
+export namespace Product {
   /**
    * Product configuration object
    */
@@ -459,206 +255,6 @@ export namespace ProductListProductsResponse {
   }
 }
 
-/**
- * Response object
- */
-export interface ProductUnarchiveProductResponse {
-  /**
-   * Product configuration object
-   */
-  data: ProductUnarchiveProductResponse.Data;
-}
-
-export namespace ProductUnarchiveProductResponse {
-  /**
-   * Product configuration object
-   */
-  export interface Data {
-    /**
-     * The unique identifier for the entity
-     */
-    id: string;
-
-    /**
-     * Timestamp of when the record was created
-     */
-    createdAt: string;
-
-    /**
-     * Description of the product
-     */
-    description: string | null;
-
-    /**
-     * Display name of the product
-     */
-    displayName: string;
-
-    /**
-     * Metadata associated with the entity
-     */
-    metadata: { [key: string]: string };
-
-    /**
-     * Indicates if multiple subscriptions to this product are allowed
-     */
-    multipleSubscriptions: boolean;
-
-    /**
-     * The status of the product
-     */
-    status: 'PUBLISHED' | 'ARCHIVED';
-
-    /**
-     * Timestamp of when the record was last updated
-     */
-    updatedAt: string;
-
-    /**
-     * Product behavior settings for subscription lifecycle management.
-     */
-    productSettings?: Data.ProductSettings;
-  }
-
-  export namespace Data {
-    /**
-     * Product behavior settings for subscription lifecycle management.
-     */
-    export interface ProductSettings {
-      /**
-       * Time when the subscription will be cancelled
-       */
-      subscriptionCancellationTime: 'END_OF_BILLING_PERIOD' | 'IMMEDIATE' | 'SPECIFIC_DATE';
-
-      /**
-       * Setup for the end of the subscription
-       */
-      subscriptionEndSetup: 'DOWNGRADE_TO_FREE' | 'CANCEL_SUBSCRIPTION';
-
-      /**
-       * Setup for the start of the subscription
-       */
-      subscriptionStartSetup: 'PLAN_SELECTION' | 'TRIAL_PERIOD' | 'FREE_PLAN';
-
-      /**
-       * ID of the plan to downgrade to at the end of the billing period
-       */
-      downgradePlanId?: string | null;
-
-      /**
-       * Indicates if the subscription should be prorated at the end of the billing
-       * period
-       */
-      prorateAtEndOfBillingPeriod?: boolean | null;
-
-      /**
-       * ID of the plan to start the subscription with
-       */
-      subscriptionStartPlanId?: string | null;
-    }
-  }
-}
-
-/**
- * Response object
- */
-export interface ProductUpdateProductResponse {
-  /**
-   * Product configuration object
-   */
-  data: ProductUpdateProductResponse.Data;
-}
-
-export namespace ProductUpdateProductResponse {
-  /**
-   * Product configuration object
-   */
-  export interface Data {
-    /**
-     * The unique identifier for the entity
-     */
-    id: string;
-
-    /**
-     * Timestamp of when the record was created
-     */
-    createdAt: string;
-
-    /**
-     * Description of the product
-     */
-    description: string | null;
-
-    /**
-     * Display name of the product
-     */
-    displayName: string;
-
-    /**
-     * Metadata associated with the entity
-     */
-    metadata: { [key: string]: string };
-
-    /**
-     * Indicates if multiple subscriptions to this product are allowed
-     */
-    multipleSubscriptions: boolean;
-
-    /**
-     * The status of the product
-     */
-    status: 'PUBLISHED' | 'ARCHIVED';
-
-    /**
-     * Timestamp of when the record was last updated
-     */
-    updatedAt: string;
-
-    /**
-     * Product behavior settings for subscription lifecycle management.
-     */
-    productSettings?: Data.ProductSettings;
-  }
-
-  export namespace Data {
-    /**
-     * Product behavior settings for subscription lifecycle management.
-     */
-    export interface ProductSettings {
-      /**
-       * Time when the subscription will be cancelled
-       */
-      subscriptionCancellationTime: 'END_OF_BILLING_PERIOD' | 'IMMEDIATE' | 'SPECIFIC_DATE';
-
-      /**
-       * Setup for the end of the subscription
-       */
-      subscriptionEndSetup: 'DOWNGRADE_TO_FREE' | 'CANCEL_SUBSCRIPTION';
-
-      /**
-       * Setup for the start of the subscription
-       */
-      subscriptionStartSetup: 'PLAN_SELECTION' | 'TRIAL_PERIOD' | 'FREE_PLAN';
-
-      /**
-       * ID of the plan to downgrade to at the end of the billing period
-       */
-      downgradePlanId?: string | null;
-
-      /**
-       * Indicates if the subscription should be prorated at the end of the billing
-       * period
-       */
-      prorateAtEndOfBillingPeriod?: boolean | null;
-
-      /**
-       * ID of the plan to start the subscription with
-       */
-      subscriptionStartPlanId?: string | null;
-    }
-  }
-}
-
 export interface ProductCreateProductParams {
   /**
    * The unique identifier for the entity
@@ -666,14 +262,14 @@ export interface ProductCreateProductParams {
   id: string;
 
   /**
-   * Description of the product
+   * Display name of the product
    */
-  description?: string | null;
+  displayName: string;
 
   /**
-   * Display name of the product
+   * Description of the product
    */
-  displayName?: string;
+  description?: string | null;
 
   /**
    * Additional metadata for the product
@@ -687,6 +283,11 @@ export interface ProductCreateProductParams {
 }
 
 export interface ProductDuplicateProductParams {
+  /**
+   * The unique identifier for the entity
+   */
+  targetId: string;
+
   /**
    * Description of the product
    */
@@ -712,7 +313,7 @@ export interface ProductListProductsParams extends MyCursorIDPageParams {
   /**
    * Filter by product status. Supports comma-separated values for multiple statuses
    */
-  status?: string;
+  status?: Array<'PUBLISHED' | 'ARCHIVED'>;
 }
 
 export namespace ProductListProductsParams {
@@ -793,6 +394,10 @@ export namespace ProductUpdateProductParams {
      */
     downgradePlanId?: string | null;
 
+    /**
+     * Indicates if the subscription should be prorated at the end of the billing
+     * period
+     */
     prorateAtEndOfBillingPeriod?: boolean | null;
 
     /**
@@ -814,12 +419,8 @@ export namespace ProductUpdateProductParams {
 
 export declare namespace Products {
   export {
-    type ProductArchiveProductResponse as ProductArchiveProductResponse,
-    type ProductCreateProductResponse as ProductCreateProductResponse,
-    type ProductDuplicateProductResponse as ProductDuplicateProductResponse,
+    type Product as Product,
     type ProductListProductsResponse as ProductListProductsResponse,
-    type ProductUnarchiveProductResponse as ProductUnarchiveProductResponse,
-    type ProductUpdateProductResponse as ProductUpdateProductResponse,
     type ProductListProductsResponsesMyCursorIDPage as ProductListProductsResponsesMyCursorIDPage,
     type ProductCreateProductParams as ProductCreateProductParams,
     type ProductDuplicateProductParams as ProductDuplicateProductParams,

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

@@ -5,6 +5,9 @@ import { APIPromise } from '../../../core/api-promise';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
+/**
+ * Operations related to subscriptions
+ */
 export class FutureUpdate extends APIResource {
   /**
    * Cancels a subscription update that is pending payment completion.

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

@@ -5,6 +5,9 @@ import { APIPromise } from '../../../core/api-promise';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
+/**
+ * Operations related to subscriptions
+ */
 export class Invoice extends APIResource {
   /**
    * Marks the latest invoice of a subscription as paid in the billing provider. The