orb-billing 5.38.0 → 5.40.0

package/src/resources/plans/migrations.ts

@@ -0,0 +1,105 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import { isRequestOptions } from '../../core';
+import * as Core from '../../core';
+import { Page, type PageParams } from '../../pagination';
+
+export class Migrations extends APIResource {
+  /**
+   * Fetch migration
+   */
+  retrieve(
+    planId: string,
+    migrationId: string,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<MigrationRetrieveResponse> {
+    return this._client.get(`/plans/${planId}/migrations/${migrationId}`, options);
+  }
+
+  /**
+   * This endpoint returns a list of all migrations for a plan. The list of
+   * migrations is ordered starting from the most recently created migration. The
+   * response also includes pagination_metadata, which lets the caller retrieve the
+   * next page of results if they exist.
+   */
+  list(
+    planId: string,
+    query?: MigrationListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<MigrationListResponsesPage, MigrationListResponse>;
+  list(
+    planId: string,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<MigrationListResponsesPage, MigrationListResponse>;
+  list(
+    planId: string,
+    query: MigrationListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<MigrationListResponsesPage, MigrationListResponse> {
+    if (isRequestOptions(query)) {
+      return this.list(planId, {}, query);
+    }
+    return this._client.getAPIList(`/plans/${planId}/migrations`, MigrationListResponsesPage, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * This endpoint cancels a migration.
+   */
+  cancel(
+    planId: string,
+    migrationId: string,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<MigrationCancelResponse> {
+    return this._client.post(`/plans/${planId}/migrations/${migrationId}/cancel`, options);
+  }
+}
+
+export class MigrationListResponsesPage extends Page<MigrationListResponse> {}
+
+export interface MigrationRetrieveResponse {
+  id: string;
+
+  effective_time: (string & {}) | (string & {}) | 'end_of_term' | null;
+
+  plan_id: string;
+
+  status: 'not_started' | 'in_progress' | 'completed' | 'action_needed' | 'canceled';
+}
+
+export interface MigrationListResponse {
+  id: string;
+
+  effective_time: (string & {}) | (string & {}) | 'end_of_term' | null;
+
+  plan_id: string;
+
+  status: 'not_started' | 'in_progress' | 'completed' | 'action_needed' | 'canceled';
+}
+
+export interface MigrationCancelResponse {
+  id: string;
+
+  effective_time: (string & {}) | (string & {}) | 'end_of_term' | null;
+
+  plan_id: string;
+
+  status: 'not_started' | 'in_progress' | 'completed' | 'action_needed' | 'canceled';
+}
+
+export interface MigrationListParams extends PageParams {}
+
+Migrations.MigrationListResponsesPage = MigrationListResponsesPage;
+
+export declare namespace Migrations {
+  export {
+    type MigrationRetrieveResponse as MigrationRetrieveResponse,
+    type MigrationListResponse as MigrationListResponse,
+    type MigrationCancelResponse as MigrationCancelResponse,
+    MigrationListResponsesPage as MigrationListResponsesPage,
+    type MigrationListParams as MigrationListParams,
+  };
+}

package/src/resources/plans/plans.ts

@@ -6,10 +6,20 @@ import * as Core from '../../core';
 import * as Shared from '../shared';
 import * as ExternalPlanIDAPI from './external-plan-id';
 import { ExternalPlanID, ExternalPlanIDUpdateParams } from './external-plan-id';
+import * as MigrationsAPI from './migrations';
+import {
+  MigrationCancelResponse,
+  MigrationListParams,
+  MigrationListResponse,
+  MigrationListResponsesPage,
+  MigrationRetrieveResponse,
+  Migrations,
+} from './migrations';
 import { Page, type PageParams } from '../../pagination';
 
 export class Plans extends APIResource {
   externalPlanId: ExternalPlanIDAPI.ExternalPlanID = new ExternalPlanIDAPI.ExternalPlanID(this._client);
+  migrations: MigrationsAPI.Migrations = new MigrationsAPI.Migrations(this._client);
 
   /**
    * This endpoint allows creation of plans including their prices.
@@ -1214,6 +1224,8 @@ export interface PlanListParams extends PageParams {
 
 Plans.PlansPage = PlansPage;
 Plans.ExternalPlanID = ExternalPlanID;
+Plans.Migrations = Migrations;
+Plans.MigrationListResponsesPage = MigrationListResponsesPage;
 
 export declare namespace Plans {
   export {
@@ -1225,4 +1237,13 @@ export declare namespace Plans {
   };
 
   export { ExternalPlanID as ExternalPlanID, type ExternalPlanIDUpdateParams as ExternalPlanIDUpdateParams };
+
+  export {
+    Migrations as Migrations,
+    type MigrationRetrieveResponse as MigrationRetrieveResponse,
+    type MigrationListResponse as MigrationListResponse,
+    type MigrationCancelResponse as MigrationCancelResponse,
+    MigrationListResponsesPage as MigrationListResponsesPage,
+    type MigrationListParams as MigrationListParams,
+  };
 }

package/src/resources/prices/prices.ts

@@ -1016,9 +1016,6 @@ export declare namespace PriceCreateParams {
        * Configuration for a single threshold
        */
       export interface ConsumptionTable {
-        /**
-         * Quantity threshold
-         */
         threshold: string;
 
         /**
@@ -1128,9 +1125,6 @@ export declare namespace PriceCreateParams {
      * Configuration for tiered_package pricing
      */
     export interface TieredPackageConfig {
-      /**
-       * Package size
-       */
       package_size: string;
 
       /**
@@ -1152,9 +1146,6 @@ export declare namespace PriceCreateParams {
          */
         per_unit: string;
 
-        /**
-         * Tier lower bound
-         */
         tier_lower_bound: string;
       }
     }
@@ -1281,14 +1272,8 @@ export declare namespace PriceCreateParams {
        * Configuration for a single tier
        */
       export interface Tier {
-        /**
-         * Minimum amount
-         */
         minimum_amount: string;
 
-        /**
-         * Tier lower bound
-         */
         tier_lower_bound: string;
 
         /**
@@ -1415,9 +1400,6 @@ export declare namespace PriceCreateParams {
        * Configuration for a single tier
        */
       export interface Tier {
-        /**
-         * Tier lower bound
-         */
         tier_lower_bound: string;
 
         /**
@@ -1527,9 +1509,6 @@ export declare namespace PriceCreateParams {
      * Configuration for tiered_package_with_minimum pricing
      */
     export interface TieredPackageWithMinimumConfig {
-      /**
-       * Package size
-       */
       package_size: number;
 
       /**
@@ -1544,19 +1523,10 @@ export declare namespace PriceCreateParams {
        * Configuration for a single tier
        */
       export interface Tier {
-        /**
-         * Minimum amount
-         */
         minimum_amount: string;
 
-        /**
-         * Price per package
-         */
         per_unit: string;
 
-        /**
-         * Tier lower bound
-         */
         tier_lower_bound: string;
       }
     }
@@ -1661,19 +1631,10 @@ export declare namespace PriceCreateParams {
      * Configuration for package_with_allocation pricing
      */
     export interface PackageWithAllocationConfig {
-      /**
-       * Usage allocation
-       */
       allocation: string;
 
-      /**
-       * Price per package
-       */
       package_amount: string;
 
-      /**
-       * Package size
-       */
       package_size: string;
     }
   }
@@ -2605,14 +2566,8 @@ export declare namespace PriceCreateParams {
        * Configuration for a scaling factor
        */
       export interface ScalingFactor {
-        /**
-         * Scaling factor
-         */
         scaling_factor: string;
 
-        /**
-         * Scaling value
-         */
         scaling_value: string;
       }
 
@@ -2620,9 +2575,6 @@ export declare namespace PriceCreateParams {
        * Configuration for a unit amount
        */
       export interface UnitAmount {
-        /**
-         * Pricing value
-         */
         pricing_value: string;
 
         /**
@@ -2991,9 +2943,6 @@ export declare namespace PriceCreateParams {
        */
       grouping_key: string;
 
-      /**
-       * Package size
-       */
       package_size: string;
 
       /**
@@ -3009,13 +2958,10 @@ export declare namespace PriceCreateParams {
        */
       export interface Tier {
         /**
-         * Price per package
+         * Per package
          */
         per_unit: string;
 
-        /**
-         * Tier lower bound
-         */
         tier_lower_bound: string;
       }
     }
@@ -3125,9 +3071,6 @@ export declare namespace PriceCreateParams {
        */
       grouping_key: string;
 
-      /**
-       * Package size
-       */
       package_size: string;
 
       /**
@@ -3141,9 +3084,6 @@ export declare namespace PriceCreateParams {
        * Configuration for a single tier
        */
       export interface Tier {
-        /**
-         * Tier lower bound
-         */
         tier_lower_bound: string;
 
         /**
@@ -3284,19 +3224,10 @@ export declare namespace PriceCreateParams {
        * Configuration for a single matrix scaling factor
        */
       export interface MatrixScalingFactor {
-        /**
-         * First dimension value
-         */
         first_dimension_value: string;
 
-        /**
-         * Scaling factor
-         */
         scaling_factor: string;
 
-        /**
-         * Second dimension value (optional)
-         */
         second_dimension_value?: string | null;
       }
     }
@@ -3411,9 +3342,6 @@ export declare namespace PriceCreateParams {
        */
       matrix_scaling_factors: Array<ScalableMatrixWithTieredPricingConfig.MatrixScalingFactor>;
 
-      /**
-       * Tier pricing structure
-       */
       tiers: Array<ScalableMatrixWithTieredPricingConfig.Tier>;
 
       /**
@@ -3427,19 +3355,10 @@ export declare namespace PriceCreateParams {
        * Configuration for a single matrix scaling factor
        */
       export interface MatrixScalingFactor {
-        /**
-         * First dimension value
-         */
         first_dimension_value: string;
 
-        /**
-         * Scaling factor
-         */
         scaling_factor: string;
 
-        /**
-         * Second dimension value (optional)
-         */
         second_dimension_value?: string | null;
       }
 
@@ -3447,14 +3366,8 @@ export declare namespace PriceCreateParams {
        * Configuration for a single tier entry with business logic
        */
       export interface Tier {
-        /**
-         * Tier lower bound
-         */
         tier_lower_bound: string;
 
-        /**
-         * Per unit amount
-         */
         unit_amount: string;
       }
     }
@@ -3564,9 +3477,6 @@ export declare namespace PriceCreateParams {
        */
       dimension_values: Array<CumulativeGroupedBulkConfig.DimensionValue>;
 
-      /**
-       * Grouping key name
-       */
       group: string;
     }