@stigg/typescript 0.1.0-alpha.1 → 0.1.0-alpha.11

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

@@ -0,0 +1,423 @@
+// 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';
+
+export class Products extends APIResource {
+  /**
+   * Archives a product, preventing new subscriptions. All plans and addons are
+   * archived.
+   */
+  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<Product> {
+    return this._client.post('/api/v1/products', { body, ...options });
+  }
+
+  /**
+   * Duplicates an existing product, including its plans, addons, and configuration.
+   */
+  duplicateProduct(
+    pathID: string,
+    body: ProductDuplicateProductParams,
+    options?: RequestOptions,
+  ): APIPromise<Product> {
+    return this._client.post(path`/api/v1/products/${pathID}/duplicate`, { body, ...options });
+  }
+
+  /**
+   * Retrieves a paginated list of products in the environment.
+   */
+  listProducts(
+    query: ProductListProductsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ProductListProductsResponsesMyCursorIDPage, ProductListProductsResponse> {
+    return this._client.getAPIList('/api/v1/products', MyCursorIDPage<ProductListProductsResponse>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Restores an archived product, allowing new subscriptions to be created.
+   */
+  unarchiveProduct(id: string, options?: RequestOptions): APIPromise<Product> {
+    return this._client.post(path`/api/v1/products/${id}/unarchive`, options);
+  }
+
+  /**
+   * Updates an existing product's properties such as display name, description, and
+   * metadata.
+   */
+  updateProduct(id: string, body: ProductUpdateProductParams, options?: RequestOptions): APIPromise<Product> {
+    return this._client.patch(path`/api/v1/products/${id}`, { body, ...options });
+  }
+}
+
+export type ProductListProductsResponsesMyCursorIDPage = MyCursorIDPage<ProductListProductsResponse>;
+
+/**
+ * Response object
+ */
+export interface Product {
+  /**
+   * Product configuration object
+   */
+  data: Product.Data;
+}
+
+export namespace Product {
+  /**
+   * 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;
+    }
+  }
+}
+
+/**
+ * Product configuration object
+ */
+export interface ProductListProductsResponse {
+  /**
+   * 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?: ProductListProductsResponse.ProductSettings;
+}
+
+export namespace ProductListProductsResponse {
+  /**
+   * 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
+   */
+  id: string;
+
+  /**
+   * Description of the product
+   */
+  description?: string | null;
+
+  /**
+   * Display name of the product
+   */
+  displayName?: string;
+
+  /**
+   * Additional metadata for the product
+   */
+  metadata?: { [key: string]: string } | null;
+
+  /**
+   * Indicates if multiple subscriptions to this product are allowed
+   */
+  multipleSubscriptions?: boolean;
+}
+
+export interface ProductDuplicateProductParams {
+  /**
+   * The unique identifier for the entity
+   */
+  body_id: string;
+
+  /**
+   * Description of the product
+   */
+  description?: string | null;
+
+  /**
+   * Display name of the product
+   */
+  displayName?: string;
+}
+
+export interface ProductListProductsParams extends MyCursorIDPageParams {
+  /**
+   * Filter by entity ID
+   */
+  id?: string;
+
+  /**
+   * Filter by creation date using range operators: gt, gte, lt, lte
+   */
+  createdAt?: ProductListProductsParams.CreatedAt;
+
+  /**
+   * Filter by product status. Supports comma-separated values for multiple statuses
+   */
+  status?: string;
+}
+
+export namespace ProductListProductsParams {
+  /**
+   * Filter by creation date using range operators: gt, gte, lt, lte
+   */
+  export interface CreatedAt {
+    /**
+     * Greater than the specified createdAt value
+     */
+    gt?: string;
+
+    /**
+     * Greater than or equal to the specified createdAt value
+     */
+    gte?: string;
+
+    /**
+     * Less than the specified createdAt value
+     */
+    lt?: string;
+
+    /**
+     * Less than or equal to the specified createdAt value
+     */
+    lte?: string;
+  }
+}
+
+export interface ProductUpdateProductParams {
+  /**
+   * Description of the product
+   */
+  description?: string | null;
+
+  /**
+   * Display name of the product
+   */
+  displayName?: string;
+
+  /**
+   * Additional metadata for the product
+   */
+  metadata?: { [key: string]: string } | null;
+
+  /**
+   * Indicates if multiple subscriptions to this product are allowed
+   */
+  multipleSubscriptions?: boolean;
+
+  productSettings?: ProductUpdateProductParams.ProductSettings;
+
+  /**
+   * Rule defining when usage resets upon subscription update.
+   */
+  usageResetCutoffRule?: ProductUpdateProductParams.UsageResetCutoffRule;
+}
+
+export namespace ProductUpdateProductParams {
+  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;
+
+    prorateAtEndOfBillingPeriod?: boolean | null;
+
+    /**
+     * ID of the plan to start the subscription with
+     */
+    subscriptionStartPlanId?: string | null;
+  }
+
+  /**
+   * Rule defining when usage resets upon subscription update.
+   */
+  export interface UsageResetCutoffRule {
+    /**
+     * Behavior of the usage reset cutoff rule
+     */
+    behavior: 'NEVER_RESET' | 'ALWAYS_RESET' | 'BILLING_PERIOD_CHANGE';
+  }
+}
+
+export declare namespace Products {
+  export {
+    type Product as Product,
+    type ProductListProductsResponse as ProductListProductsResponse,
+    type ProductListProductsResponsesMyCursorIDPage as ProductListProductsResponsesMyCursorIDPage,
+    type ProductCreateProductParams as ProductCreateProductParams,
+    type ProductDuplicateProductParams as ProductDuplicateProductParams,
+    type ProductListProductsParams as ProductListProductsParams,
+    type ProductUpdateProductParams as ProductUpdateProductParams,
+  };
+}

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

@@ -7,41 +7,29 @@ import { path } from '../../../internal/utils/path';
 
 export class FutureUpdate extends APIResource {
   /**
-   * Perform cancel future update on a Subscription
+   * Cancels a subscription update that is pending payment completion.
    */
-  cancelPendingPayment(
-    id: string,
-    options?: RequestOptions,
-  ): APIPromise<FutureUpdateCancelPendingPaymentResponse> {
+  cancelPendingPayment(id: string, options?: RequestOptions): APIPromise<CancelSubscription> {
     return this._client.delete(path`/api/v1/subscriptions/${id}/future-update/pending-payment`, options);
   }
 
   /**
-   * Perform cancel future update on a Subscription
+   * Cancels a scheduled subscription update, such as a future downgrade or plan
+   * change.
    */
-  cancelSchedule(id: string, options?: RequestOptions): APIPromise<FutureUpdateCancelScheduleResponse> {
+  cancelSchedule(id: string, options?: RequestOptions): APIPromise<CancelSubscription> {
     return this._client.delete(path`/api/v1/subscriptions/${id}/future-update/schedule`, options);
   }
 }
 
-export interface FutureUpdateCancelPendingPaymentResponse {
-  data: FutureUpdateCancelPendingPaymentResponse.Data;
+/**
+ * Response object
+ */
+export interface CancelSubscription {
+  data: CancelSubscription.Data;
 }
 
-export namespace FutureUpdateCancelPendingPaymentResponse {
-  export interface Data {
-    /**
-     * Subscription ID
-     */
-    id: string;
-  }
-}
-
-export interface FutureUpdateCancelScheduleResponse {
-  data: FutureUpdateCancelScheduleResponse.Data;
-}
-
-export namespace FutureUpdateCancelScheduleResponse {
+export namespace CancelSubscription {
   export interface Data {
     /**
      * Subscription ID
@@ -51,8 +39,5 @@ export namespace FutureUpdateCancelScheduleResponse {
 }
 
 export declare namespace FutureUpdate {
-  export {
-    type FutureUpdateCancelPendingPaymentResponse as FutureUpdateCancelPendingPaymentResponse,
-    type FutureUpdateCancelScheduleResponse as FutureUpdateCancelScheduleResponse,
-  };
+  export { type CancelSubscription as CancelSubscription };
 }

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

@@ -1,23 +1,28 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export {
-  FutureUpdate,
-  type FutureUpdateCancelPendingPaymentResponse,
-  type FutureUpdateCancelScheduleResponse,
-} from './future-update';
+export { FutureUpdate, type CancelSubscription } from './future-update';
+export { Invoice, type InvoiceMarkAsPaidResponse } from './invoice';
 export {
   Subscriptions,
-  type SubscriptionCreateResponse,
-  type SubscriptionRetrieveResponse,
+  type Subscription,
   type SubscriptionListResponse,
-  type SubscriptionDelegateResponse,
-  type SubscriptionMigrateResponse,
+  type SubscriptionImportResponse,
   type SubscriptionPreviewResponse,
-  type SubscriptionTransferResponse,
-  type SubscriptionCreateParams,
+  type SubscriptionProvisionResponse,
+  type SubscriptionUpdateParams,
   type SubscriptionListParams,
+  type SubscriptionCancelParams,
   type SubscriptionDelegateParams,
+  type SubscriptionImportParams,
   type SubscriptionMigrateParams,
   type SubscriptionPreviewParams,
+  type SubscriptionProvisionParams,
   type SubscriptionTransferParams,
+  type SubscriptionListResponsesMyCursorIDPage,
 } from './subscriptions';
+export {
+  Usage,
+  type UsageChargeUsageResponse,
+  type UsageSyncResponse,
+  type UsageChargeUsageParams,
+} from './usage';

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

@@ -0,0 +1,42 @@
+// 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 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.
+   */
+  markAsPaid(id: string, options?: RequestOptions): APIPromise<InvoiceMarkAsPaidResponse> {
+    return this._client.post(path`/api/v1/subscriptions/${id}/invoice/paid`, options);
+  }
+}
+
+/**
+ * Response object
+ */
+export interface InvoiceMarkAsPaidResponse {
+  /**
+   * Result of marking a subscription invoice as paid.
+   */
+  data: InvoiceMarkAsPaidResponse.Data;
+}
+
+export namespace InvoiceMarkAsPaidResponse {
+  /**
+   * Result of marking a subscription invoice as paid.
+   */
+  export interface Data {
+    /**
+     * The subscription ID whose invoice was marked as paid
+     */
+    id: string;
+  }
+}
+
+export declare namespace Invoice {
+  export { type InvoiceMarkAsPaidResponse as InvoiceMarkAsPaidResponse };
+}