@schematichq/schematic-typescript-node 1.3.1 → 1.4.0

package/dist/api/resources/planbundle/client/requests/UpdatePlanBundleRequestBody.d.ts

@@ -12,5 +12,6 @@ export interface UpdatePlanBundleRequestBody {
     creditGrants?: Schematic.PlanBundleCreditGrantRequestBody[];
     entitlements: Schematic.PlanBundleEntitlementRequestBody[];
     plan?: Schematic.UpdatePlanRequestBody;
+    planVersionId?: string;
     traits?: Schematic.UpdatePlanTraitTraitRequestBody[];
 }

package/dist/api/resources/plangroups/client/Client.d.ts

@@ -54,6 +54,8 @@ export declare class PlangroupsClient {
      *         prorationBehavior: "create_prorations",
      *         showAsMonthlyPrices: true,
      *         showCredits: true,
+     *         showFeatureDescription: true,
+     *         showHardLimit: true,
      *         showPeriodToggle: true,
      *         showZeroPriceAsFree: true,
      *         syncCustomerBillingDetails: true
@@ -93,6 +95,8 @@ export declare class PlangroupsClient {
      *         prorationBehavior: "create_prorations",
      *         showAsMonthlyPrices: true,
      *         showCredits: true,
+     *         showFeatureDescription: true,
+     *         showHardLimit: true,
      *         showPeriodToggle: true,
      *         showZeroPriceAsFree: true,
      *         syncCustomerBillingDetails: true

package/dist/api/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts

@@ -21,6 +21,8 @@ import type * as Schematic from "../../../../index";
  *         prorationBehavior: "create_prorations",
  *         showAsMonthlyPrices: true,
  *         showCredits: true,
+ *         showFeatureDescription: true,
+ *         showHardLimit: true,
  *         showPeriodToggle: true,
  *         showZeroPriceAsFree: true,
  *         syncCustomerBillingDetails: true
@@ -47,8 +49,12 @@ export interface CreatePlanGroupRequestBody {
     preventSelfServiceDowngradeButtonText?: string;
     preventSelfServiceDowngradeUrl?: string;
     prorationBehavior: Schematic.ProrationBehavior;
+    scheduledDowngradeBehavior?: Schematic.ScheduledDowngradeConfigBehavior;
+    scheduledDowngradePreventWhenOverLimit?: boolean;
     showAsMonthlyPrices: boolean;
     showCredits: boolean;
+    showFeatureDescription: boolean;
+    showHardLimit: boolean;
     showPeriodToggle: boolean;
     showZeroPriceAsFree: boolean;
     syncCustomerBillingDetails: boolean;

package/dist/api/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts

@@ -21,6 +21,8 @@ import type * as Schematic from "../../../../index";
  *         prorationBehavior: "create_prorations",
  *         showAsMonthlyPrices: true,
  *         showCredits: true,
+ *         showFeatureDescription: true,
+ *         showHardLimit: true,
  *         showPeriodToggle: true,
  *         showZeroPriceAsFree: true,
  *         syncCustomerBillingDetails: true
@@ -47,8 +49,12 @@ export interface UpdatePlanGroupRequestBody {
     preventSelfServiceDowngradeButtonText?: string;
     preventSelfServiceDowngradeUrl?: string;
     prorationBehavior: Schematic.ProrationBehavior;
+    scheduledDowngradeBehavior?: Schematic.ScheduledDowngradeConfigBehavior;
+    scheduledDowngradePreventWhenOverLimit?: boolean;
     showAsMonthlyPrices: boolean;
     showCredits: boolean;
+    showFeatureDescription: boolean;
+    showHardLimit: boolean;
     showPeriodToggle: boolean;
     showZeroPriceAsFree: boolean;
     syncCustomerBillingDetails: boolean;

package/dist/api/resources/planmigrations/client/Client.d.ts

@@ -0,0 +1,109 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient";
+import * as core from "../../../../core";
+import * as Schematic from "../../../index";
+export declare namespace PlanmigrationsClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class PlanmigrationsClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<PlanmigrationsClient.Options>;
+    constructor(options: PlanmigrationsClient.Options);
+    /**
+     * @param {Schematic.ListCompanyMigrationsRequest} request
+     * @param {PlanmigrationsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schematic.BadRequestError}
+     * @throws {@link Schematic.UnauthorizedError}
+     * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
+     * @throws {@link Schematic.InternalServerError}
+     *
+     * @example
+     *     await client.planmigrations.listCompanyMigrations({
+     *         migrationId: "migration_id",
+     *         q: "q",
+     *         status: "completed",
+     *         limit: 1,
+     *         offset: 1
+     *     })
+     */
+    listCompanyMigrations(request?: Schematic.ListCompanyMigrationsRequest, requestOptions?: PlanmigrationsClient.RequestOptions): core.HttpResponsePromise<Schematic.ListCompanyMigrationsResponse>;
+    private __listCompanyMigrations;
+    /**
+     * @param {Schematic.CountCompanyMigrationsRequest} request
+     * @param {PlanmigrationsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schematic.BadRequestError}
+     * @throws {@link Schematic.UnauthorizedError}
+     * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
+     * @throws {@link Schematic.InternalServerError}
+     *
+     * @example
+     *     await client.planmigrations.countCompanyMigrations({
+     *         migrationId: "migration_id",
+     *         q: "q",
+     *         status: "completed",
+     *         limit: 1,
+     *         offset: 1
+     *     })
+     */
+    countCompanyMigrations(request?: Schematic.CountCompanyMigrationsRequest, requestOptions?: PlanmigrationsClient.RequestOptions): core.HttpResponsePromise<Schematic.CountCompanyMigrationsResponse>;
+    private __countCompanyMigrations;
+    /**
+     * @param {Schematic.ListMigrationsRequest} request
+     * @param {PlanmigrationsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schematic.BadRequestError}
+     * @throws {@link Schematic.UnauthorizedError}
+     * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
+     * @throws {@link Schematic.InternalServerError}
+     *
+     * @example
+     *     await client.planmigrations.listMigrations({
+     *         planVersionId: "plan_version_id",
+     *         status: "completed",
+     *         limit: 1,
+     *         offset: 1
+     *     })
+     */
+    listMigrations(request?: Schematic.ListMigrationsRequest, requestOptions?: PlanmigrationsClient.RequestOptions): core.HttpResponsePromise<Schematic.ListMigrationsResponse>;
+    private __listMigrations;
+    /**
+     * @param {string} plan_version_migration_id - plan_version_migration_id
+     * @param {PlanmigrationsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schematic.UnauthorizedError}
+     * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
+     * @throws {@link Schematic.InternalServerError}
+     *
+     * @example
+     *     await client.planmigrations.getMigration("plan_version_migration_id")
+     */
+    getMigration(plan_version_migration_id: string, requestOptions?: PlanmigrationsClient.RequestOptions): core.HttpResponsePromise<Schematic.GetMigrationResponse>;
+    private __getMigration;
+    /**
+     * @param {Schematic.CountMigrationsRequest} request
+     * @param {PlanmigrationsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schematic.BadRequestError}
+     * @throws {@link Schematic.UnauthorizedError}
+     * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
+     * @throws {@link Schematic.InternalServerError}
+     *
+     * @example
+     *     await client.planmigrations.countMigrations({
+     *         planVersionId: "plan_version_id",
+     *         status: "completed",
+     *         limit: 1,
+     *         offset: 1
+     *     })
+     */
+    countMigrations(request?: Schematic.CountMigrationsRequest, requestOptions?: PlanmigrationsClient.RequestOptions): core.HttpResponsePromise<Schematic.CountMigrationsResponse>;
+    private __countMigrations;
+}

package/dist/api/resources/planmigrations/client/index.d.ts

@@ -0,0 +1 @@
+export * from "./requests";

package/dist/api/resources/planmigrations/client/requests/CountCompanyMigrationsRequest.d.ts

@@ -0,0 +1,20 @@
+import type * as Schematic from "../../../../index";
+/**
+ * @example
+ *     {
+ *         migrationId: "migration_id",
+ *         q: "q",
+ *         status: "completed",
+ *         limit: 1,
+ *         offset: 1
+ *     }
+ */
+export interface CountCompanyMigrationsRequest {
+    migrationId?: string;
+    q?: string;
+    status?: Schematic.PlanVersionCompanyMigrationStatus;
+    /** Page limit (default 100) */
+    limit?: number;
+    /** Page offset (default 0) */
+    offset?: number;
+}

package/dist/api/resources/planmigrations/client/requests/CountMigrationsRequest.d.ts

@@ -0,0 +1,18 @@
+import type * as Schematic from "../../../../index";
+/**
+ * @example
+ *     {
+ *         planVersionId: "plan_version_id",
+ *         status: "completed",
+ *         limit: 1,
+ *         offset: 1
+ *     }
+ */
+export interface CountMigrationsRequest {
+    planVersionId?: string;
+    status?: Schematic.PlanVersionMigrationStatus;
+    /** Page limit (default 100) */
+    limit?: number;
+    /** Page offset (default 0) */
+    offset?: number;
+}

package/dist/api/resources/planmigrations/client/requests/ListCompanyMigrationsRequest.d.ts

@@ -0,0 +1,20 @@
+import type * as Schematic from "../../../../index";
+/**
+ * @example
+ *     {
+ *         migrationId: "migration_id",
+ *         q: "q",
+ *         status: "completed",
+ *         limit: 1,
+ *         offset: 1
+ *     }
+ */
+export interface ListCompanyMigrationsRequest {
+    migrationId?: string;
+    q?: string;
+    status?: Schematic.PlanVersionCompanyMigrationStatus;
+    /** Page limit (default 100) */
+    limit?: number;
+    /** Page offset (default 0) */
+    offset?: number;
+}

package/dist/api/resources/planmigrations/client/requests/ListMigrationsRequest.d.ts

@@ -0,0 +1,18 @@
+import type * as Schematic from "../../../../index";
+/**
+ * @example
+ *     {
+ *         planVersionId: "plan_version_id",
+ *         status: "completed",
+ *         limit: 1,
+ *         offset: 1
+ *     }
+ */
+export interface ListMigrationsRequest {
+    planVersionId?: string;
+    status?: Schematic.PlanVersionMigrationStatus;
+    /** Page limit (default 100) */
+    limit?: number;
+    /** Page offset (default 0) */
+    offset?: number;
+}

package/dist/api/resources/planmigrations/client/requests/index.d.ts

@@ -0,0 +1,4 @@
+export type { CountCompanyMigrationsRequest } from "./CountCompanyMigrationsRequest";
+export type { CountMigrationsRequest } from "./CountMigrationsRequest";
+export type { ListCompanyMigrationsRequest } from "./ListCompanyMigrationsRequest";
+export type { ListMigrationsRequest } from "./ListMigrationsRequest";

package/dist/api/resources/planmigrations/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./client";
+export * from "./types";

package/dist/api/resources/planmigrations/types/CountCompanyMigrationsParams.d.ts

@@ -0,0 +1,13 @@
+import type * as Schematic from "../../../index";
+/**
+ * Input parameters
+ */
+export interface CountCompanyMigrationsParams {
+    /** Page limit (default 100) */
+    limit?: number;
+    migrationId?: string;
+    /** Page offset (default 0) */
+    offset?: number;
+    q?: string;
+    status?: Schematic.PlanVersionCompanyMigrationStatus;
+}

package/dist/api/resources/planmigrations/types/CountCompanyMigrationsResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Schematic from "../../../index";
+export interface CountCompanyMigrationsResponse {
+    data: Schematic.CountResponse;
+    /** Input parameters */
+    params: Schematic.CountCompanyMigrationsParams;
+}

package/dist/api/resources/planmigrations/types/CountMigrationsParams.d.ts

@@ -0,0 +1,12 @@
+import type * as Schematic from "../../../index";
+/**
+ * Input parameters
+ */
+export interface CountMigrationsParams {
+    /** Page limit (default 100) */
+    limit?: number;
+    /** Page offset (default 0) */
+    offset?: number;
+    planVersionId?: string;
+    status?: Schematic.PlanVersionMigrationStatus;
+}

package/dist/api/resources/planmigrations/types/CountMigrationsResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Schematic from "../../../index";
+export interface CountMigrationsResponse {
+    data: Schematic.CountResponse;
+    /** Input parameters */
+    params: Schematic.CountMigrationsParams;
+}

package/dist/api/resources/planmigrations/types/GetMigrationResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Schematic from "../../../index";
+export interface GetMigrationResponse {
+    data: Schematic.PlanVersionMigrationResponseData;
+    /** Input parameters */
+    params: Record<string, unknown>;
+}

package/dist/api/resources/planmigrations/types/ListCompanyMigrationsParams.d.ts

@@ -0,0 +1,13 @@
+import type * as Schematic from "../../../index";
+/**
+ * Input parameters
+ */
+export interface ListCompanyMigrationsParams {
+    /** Page limit (default 100) */
+    limit?: number;
+    migrationId?: string;
+    /** Page offset (default 0) */
+    offset?: number;
+    q?: string;
+    status?: Schematic.PlanVersionCompanyMigrationStatus;
+}

package/dist/api/resources/planmigrations/types/ListCompanyMigrationsResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Schematic from "../../../index";
+export interface ListCompanyMigrationsResponse {
+    data: Schematic.PlanVersionCompanyMigrationResponseData[];
+    /** Input parameters */
+    params: Schematic.ListCompanyMigrationsParams;
+}

package/dist/api/resources/planmigrations/types/ListMigrationsParams.d.ts

@@ -0,0 +1,12 @@
+import type * as Schematic from "../../../index";
+/**
+ * Input parameters
+ */
+export interface ListMigrationsParams {
+    /** Page limit (default 100) */
+    limit?: number;
+    /** Page offset (default 0) */
+    offset?: number;
+    planVersionId?: string;
+    status?: Schematic.PlanVersionMigrationStatus;
+}

package/dist/api/resources/planmigrations/types/ListMigrationsResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Schematic from "../../../index";
+export interface ListMigrationsResponse {
+    data: Schematic.PlanVersionMigrationResponseData[];
+    /** Input parameters */
+    params: Schematic.ListMigrationsParams;
+}

package/dist/api/resources/planmigrations/types/index.d.ts

@@ -0,0 +1,9 @@
+export * from "./CountCompanyMigrationsParams";
+export * from "./CountCompanyMigrationsResponse";
+export * from "./CountMigrationsParams";
+export * from "./CountMigrationsResponse";
+export * from "./GetMigrationResponse";
+export * from "./ListCompanyMigrationsParams";
+export * from "./ListCompanyMigrationsResponse";
+export * from "./ListMigrationsParams";
+export * from "./ListMigrationsResponse";

package/dist/api/resources/plans/client/Client.d.ts

@@ -76,6 +76,7 @@ export declare class PlansClient {
     private __createPlan;
     /**
      * @param {string} plan_id - plan_id
+     * @param {Schematic.GetPlanRequest} request
      * @param {PlansClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Schematic.UnauthorizedError}
@@ -84,9 +85,11 @@ export declare class PlansClient {
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
-     *     await client.plans.getPlan("plan_id")
+     *     await client.plans.getPlan("plan_id", {
+     *         planVersionId: "plan_version_id"
+     *     })
      */
-    getPlan(plan_id: string, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.GetPlanResponse>;
+    getPlan(plan_id: string, request?: Schematic.GetPlanRequest, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.GetPlanResponse>;
     private __getPlan;
     /**
      * @param {string} plan_id - plan_id
@@ -179,9 +182,44 @@ export declare class PlansClient {
      *
      * @example
      *     await client.plans.listPlanIssues({
-     *         planId: "plan_id"
+     *         planId: "plan_id",
+     *         planVersionId: "plan_version_id"
      *     })
      */
     listPlanIssues(request: Schematic.ListPlanIssuesRequest, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.ListPlanIssuesResponse>;
     private __listPlanIssues;
+    /**
+     * @param {string} plan_id - plan_id
+     * @param {PlansClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schematic.BadRequestError}
+     * @throws {@link Schematic.UnauthorizedError}
+     * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
+     * @throws {@link Schematic.InternalServerError}
+     *
+     * @example
+     *     await client.plans.deletePlanVersion("plan_id")
+     */
+    deletePlanVersion(plan_id: string, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.DeletePlanVersionResponse>;
+    private __deletePlanVersion;
+    /**
+     * @param {string} plan_id - plan_id
+     * @param {Schematic.PublishPlanVersionRequestBody} request
+     * @param {PlansClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schematic.BadRequestError}
+     * @throws {@link Schematic.UnauthorizedError}
+     * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
+     * @throws {@link Schematic.InternalServerError}
+     *
+     * @example
+     *     await client.plans.publishPlanVersion("plan_id", {
+     *         excludedCompanyIds: ["excluded_company_ids"],
+     *         migrationStrategy: "immediate"
+     *     })
+     */
+    publishPlanVersion(plan_id: string, request: Schematic.PublishPlanVersionRequestBody, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.PublishPlanVersionResponse>;
+    private __publishPlanVersion;
 }

package/dist/api/resources/plans/client/requests/GetPlanRequest.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         planVersionId: "plan_version_id"
+ *     }
+ */
+export interface GetPlanRequest {
+    /** Fetch billing settings for a specific plan version */
+    planVersionId?: string;
+}

package/dist/api/resources/plans/client/requests/ListPlanIssuesRequest.d.ts

@@ -1,9 +1,11 @@
 /**
  * @example
  *     {
- *         planId: "plan_id"
+ *         planId: "plan_id",
+ *         planVersionId: "plan_version_id"
  *     }
  */
 export interface ListPlanIssuesRequest {
     planId: string;
+    planVersionId?: string;
 }

package/dist/api/resources/plans/client/requests/PublishPlanVersionRequestBody.d.ts

@@ -0,0 +1,12 @@
+import type * as Schematic from "../../../../index";
+/**
+ * @example
+ *     {
+ *         excludedCompanyIds: ["excluded_company_ids"],
+ *         migrationStrategy: "immediate"
+ *     }
+ */
+export interface PublishPlanVersionRequestBody {
+    excludedCompanyIds: string[];
+    migrationStrategy: Schematic.PlanVersionMigrationStrategy;
+}

package/dist/api/resources/plans/client/requests/index.d.ts

@@ -1,4 +1,6 @@
 export type { CountPlansRequest } from "./CountPlansRequest";
+export type { GetPlanRequest } from "./GetPlanRequest";
 export type { ListPlanIssuesRequest } from "./ListPlanIssuesRequest";
 export type { ListPlansRequest } from "./ListPlansRequest";
+export type { PublishPlanVersionRequestBody } from "./PublishPlanVersionRequestBody";
 export type { UpdateCompanyPlansRequestBody } from "./UpdateCompanyPlansRequestBody";

package/dist/api/resources/plans/types/CountPlansParams.d.ts

@@ -17,6 +17,7 @@ export interface CountPlansParams {
     limit?: number;
     /** Page offset (default 0) */
     offset?: number;
+    /** Filter by plan type */
     planType?: Schematic.PlanType;
     q?: string;
     /** Filter out plans that already have a plan entitlement for the specified feature ID */

package/dist/api/resources/plans/types/DeletePlanVersionResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Schematic from "../../../index";
+export interface DeletePlanVersionResponse {
+    data: Schematic.DeleteResponse;
+    /** Input parameters */
+    params: Record<string, unknown>;
+}

package/dist/api/resources/plans/types/GetPlanParams.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Input parameters
+ */
+export interface GetPlanParams {
+    /** Fetch billing settings for a specific plan version */
+    planVersionId?: string;
+}

package/dist/api/resources/plans/types/GetPlanResponse.d.ts

@@ -2,5 +2,5 @@ import type * as Schematic from "../../../index";
 export interface GetPlanResponse {
     data: Schematic.PlanDetailResponseData;
     /** Input parameters */
-    params: Record<string, unknown>;
+    params: Schematic.GetPlanParams;
 }

package/dist/api/resources/plans/types/ListPlanIssuesParams.d.ts

@@ -3,4 +3,5 @@
  */
 export interface ListPlanIssuesParams {
     planId?: string;
+    planVersionId?: string;
 }

package/dist/api/resources/plans/types/ListPlansParams.d.ts

@@ -17,6 +17,7 @@ export interface ListPlansParams {
     limit?: number;
     /** Page offset (default 0) */
     offset?: number;
+    /** Filter by plan type */
     planType?: Schematic.PlanType;
     q?: string;
     /** Filter out plans that already have a plan entitlement for the specified feature ID */

package/dist/api/resources/plans/types/PublishPlanVersionResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Schematic from "../../../index";
+export interface PublishPlanVersionResponse {
+    data: Schematic.PlanVersionResponseData;
+    /** Input parameters */
+    params: Record<string, unknown>;
+}

package/dist/api/resources/plans/types/index.d.ts

@@ -2,11 +2,14 @@ export * from "./CountPlansParams";
 export * from "./CountPlansResponse";
 export * from "./CreatePlanResponse";
 export * from "./DeletePlanResponse";
+export * from "./DeletePlanVersionResponse";
+export * from "./GetPlanParams";
 export * from "./GetPlanResponse";
 export * from "./ListPlanIssuesParams";
 export * from "./ListPlanIssuesResponse";
 export * from "./ListPlansParams";
 export * from "./ListPlansResponse";
+export * from "./PublishPlanVersionResponse";
 export * from "./UpdateCompanyPlansResponse";
 export * from "./UpdatePlanResponse";
 export * from "./UpsertBillingProductPlanResponse";