@stigg/typescript 0.1.0-alpha.3 → 0.1.0-alpha.7

package/src/resources/v1/products.ts

@@ -0,0 +1,162 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+
+export class Products extends APIResource {
+  /**
+   * 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,
+    });
+  }
+}
+
+export type ProductListProductsResponsesMyCursorIDPage = MyCursorIDPage<ProductListProductsResponse>;
+
+/**
+ * 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 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 declare namespace Products {
+  export {
+    type ProductListProductsResponse as ProductListProductsResponse,
+    type ProductListProductsResponsesMyCursorIDPage as ProductListProductsResponsesMyCursorIDPage,
+    type ProductListProductsParams as ProductListProductsParams,
+  };
+}

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

@@ -7,19 +7,17 @@ import { path } from '../../../internal/utils/path';
 
 export class FutureUpdate extends APIResource {
   /**
-   * Cancel pending payment update
+   * 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);
   }
 
   /**
-   * Cancel scheduled update
+   * 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);
   }
 }
@@ -27,27 +25,11 @@ export class FutureUpdate extends APIResource {
 /**
  * Response object
  */
-export interface FutureUpdateCancelPendingPaymentResponse {
-  data: FutureUpdateCancelPendingPaymentResponse.Data;
+export interface CancelSubscription {
+  data: CancelSubscription.Data;
 }
 
-export namespace FutureUpdateCancelPendingPaymentResponse {
-  export interface Data {
-    /**
-     * Subscription ID
-     */
-    id: string;
-  }
-}
-
-/**
- * Response object
- */
-export interface FutureUpdateCancelScheduleResponse {
-  data: FutureUpdateCancelScheduleResponse.Data;
-}
-
-export namespace FutureUpdateCancelScheduleResponse {
+export namespace CancelSubscription {
   export interface Data {
     /**
      * Subscription ID
@@ -57,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,24 +1,21 @@
 // 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 {
   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';