@schematichq/schematic-typescript-node 1.4.5 → 1.4.6

package/dist/api/resources/entitlements/client/requests/UpdatePlanEntitlementRequestBody.d.ts

@@ -10,6 +10,7 @@ export interface UpdatePlanEntitlementRequestBody {
     billingThreshold?: number;
     creditConsumptionRate?: number;
     currency?: string;
+    currencyPrices?: Schematic.CurrencyPriceRequestBody[];
     metricPeriod?: Schematic.UpdatePlanEntitlementRequestBodyMetricPeriod;
     metricPeriodMonthReset?: Schematic.UpdatePlanEntitlementRequestBodyMetricPeriodMonthReset;
     monthlyMeteredPriceId?: string;

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

@@ -3,6 +3,7 @@ export type { CountFeatureCompaniesRequest } from "./CountFeatureCompaniesReques
 export type { CountFeatureUsageRequest } from "./CountFeatureUsageRequest";
 export type { CountFeatureUsersRequest } from "./CountFeatureUsersRequest";
 export type { CountPlanEntitlementsRequest } from "./CountPlanEntitlementsRequest";
+export type { CreateBillingLinkedPlanEntitlementRequestBody } from "./CreateBillingLinkedPlanEntitlementRequestBody";
 export type { CreateCompanyOverrideRequestBody } from "./CreateCompanyOverrideRequestBody";
 export type { CreatePlanEntitlementRequestBody } from "./CreatePlanEntitlementRequestBody";
 export type { DuplicatePlanEntitlementsRequestBody } from "./DuplicatePlanEntitlementsRequestBody";

package/dist/api/resources/entitlements/types/CreateBillingLinkedPlanEntitlementRequestBodyMetricPeriod.d.ts

@@ -0,0 +1,7 @@
+export declare const CreateBillingLinkedPlanEntitlementRequestBodyMetricPeriod: {
+    readonly AllTime: "all_time";
+    readonly CurrentMonth: "current_month";
+    readonly CurrentWeek: "current_week";
+    readonly CurrentDay: "current_day";
+};
+export type CreateBillingLinkedPlanEntitlementRequestBodyMetricPeriod = (typeof CreateBillingLinkedPlanEntitlementRequestBodyMetricPeriod)[keyof typeof CreateBillingLinkedPlanEntitlementRequestBodyMetricPeriod];

package/dist/api/resources/entitlements/types/CreateBillingLinkedPlanEntitlementRequestBodyMetricPeriodMonthReset.d.ts

@@ -0,0 +1,5 @@
+export declare const CreateBillingLinkedPlanEntitlementRequestBodyMetricPeriodMonthReset: {
+    readonly FirstOfMonth: "first_of_month";
+    readonly BillingCycle: "billing_cycle";
+};
+export type CreateBillingLinkedPlanEntitlementRequestBodyMetricPeriodMonthReset = (typeof CreateBillingLinkedPlanEntitlementRequestBodyMetricPeriodMonthReset)[keyof typeof CreateBillingLinkedPlanEntitlementRequestBodyMetricPeriodMonthReset];

package/dist/api/resources/entitlements/types/UpsertPlanEntitlementForBillingProductResponse.d.ts

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

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

@@ -8,6 +8,8 @@ export * from "./CountFeatureUsersParams";
 export * from "./CountFeatureUsersResponse";
 export * from "./CountPlanEntitlementsParams";
 export * from "./CountPlanEntitlementsResponse";
+export * from "./CreateBillingLinkedPlanEntitlementRequestBodyMetricPeriod";
+export * from "./CreateBillingLinkedPlanEntitlementRequestBodyMetricPeriodMonthReset";
 export * from "./CreateCompanyOverrideRequestBodyMetricPeriod";
 export * from "./CreateCompanyOverrideRequestBodyMetricPeriodMonthReset";
 export * from "./CreateCompanyOverrideResponse";
@@ -39,3 +41,4 @@ export * from "./UpdateCompanyOverrideResponse";
 export * from "./UpdatePlanEntitlementRequestBodyMetricPeriod";
 export * from "./UpdatePlanEntitlementRequestBodyMetricPeriodMonthReset";
 export * from "./UpdatePlanEntitlementResponse";
+export * from "./UpsertPlanEntitlementForBillingProductResponse";

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

@@ -22,11 +22,11 @@ export declare class FeaturesClient {
      *
      * @example
      *     await client.features.listFeatures({
+     *         booleanRequireEvent: true,
+     *         planVersionId: "plan_version_id",
      *         q: "q",
      *         withoutCompanyOverrideFor: "without_company_override_for",
-     *         planVersionId: "plan_version_id",
      *         withoutPlanEntitlementFor: "without_plan_entitlement_for",
-     *         booleanRequireEvent: true,
      *         limit: 1000000,
      *         offset: 1000000
      *     })
@@ -97,6 +97,27 @@ export declare class FeaturesClient {
      */
     deleteFeature(feature_id: string, requestOptions?: FeaturesClient.RequestOptions): core.HttpResponsePromise<Schematic.DeleteFeatureResponse>;
     private __deleteFeature;
+    /**
+     * @param {Schematic.CreateBillingLinkedFeatureRequestBody} request
+     * @param {FeaturesClient.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.features.upsertFeatureForBillingProduct({
+     *         billingProvider: "orb",
+     *         description: "description",
+     *         externalResourceId: "external_resource_id",
+     *         featureType: "boolean",
+     *         name: "name"
+     *     })
+     */
+    upsertFeatureForBillingProduct(request: Schematic.CreateBillingLinkedFeatureRequestBody, requestOptions?: FeaturesClient.RequestOptions): core.HttpResponsePromise<Schematic.UpsertFeatureForBillingProductResponse>;
+    private __upsertFeatureForBillingProduct;
     /**
      * @param {Schematic.CountFeaturesRequest} request
      * @param {FeaturesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -109,11 +130,11 @@ export declare class FeaturesClient {
      *
      * @example
      *     await client.features.countFeatures({
+     *         booleanRequireEvent: true,
+     *         planVersionId: "plan_version_id",
      *         q: "q",
      *         withoutCompanyOverrideFor: "without_company_override_for",
-     *         planVersionId: "plan_version_id",
      *         withoutPlanEntitlementFor: "without_plan_entitlement_for",
-     *         booleanRequireEvent: true,
      *         limit: 1000000,
      *         offset: 1000000
      *     })

package/dist/api/resources/features/client/requests/CountFeaturesRequest.d.ts

@@ -2,29 +2,29 @@ import type * as Schematic from "../../../../index";
 /**
  * @example
  *     {
+ *         booleanRequireEvent: true,
+ *         planVersionId: "plan_version_id",
  *         q: "q",
  *         withoutCompanyOverrideFor: "without_company_override_for",
- *         planVersionId: "plan_version_id",
  *         withoutPlanEntitlementFor: "without_plan_entitlement_for",
- *         booleanRequireEvent: true,
  *         limit: 1000000,
  *         offset: 1000000
  *     }
  */
 export interface CountFeaturesRequest {
+    /** Only return boolean features if there is an associated event. Automatically includes boolean in the feature types filter. */
+    booleanRequireEvent?: boolean;
+    /** Filter by one or more feature types (boolean, event, trait) */
+    featureType?: Schematic.FeatureType | Schematic.FeatureType[];
     ids?: string | string[];
+    /** Filter by plan version ID when used with without_plan_entitlement_for; if not provided, the latest published version is used */
+    planVersionId?: string;
     /** Search by feature name or ID */
     q?: string;
     /** Filter out features that already have a company override for the specified company ID */
     withoutCompanyOverrideFor?: string;
-    /** Filter by plan version ID when used with without_plan_entitlement_for; if not provided, the latest published version is used */
-    planVersionId?: string;
     /** Filter out features that already have a plan entitlement for the specified plan ID */
     withoutPlanEntitlementFor?: string;
-    /** Filter by one or more feature types (boolean, event, trait) */
-    featureType?: Schematic.FeatureType | Schematic.FeatureType[];
-    /** Only return boolean features if there is an associated event. Automatically includes boolean in the feature types filter. */
-    booleanRequireEvent?: boolean;
     /** Page limit (default 100) */
     limit?: number;
     /** Page offset (default 0) */

package/dist/api/resources/features/client/requests/CreateBillingLinkedFeatureRequestBody.d.ts

@@ -0,0 +1,26 @@
+import type * as Schematic from "../../../../index";
+/**
+ * @example
+ *     {
+ *         billingProvider: "orb",
+ *         description: "description",
+ *         externalResourceId: "external_resource_id",
+ *         featureType: "boolean",
+ *         name: "name"
+ *     }
+ */
+export interface CreateBillingLinkedFeatureRequestBody {
+    billingProvider: Schematic.BillingProviderType;
+    description: string;
+    eventSubtype?: string;
+    externalResourceId: string;
+    featureType: Schematic.FeatureType;
+    flag?: Schematic.CreateOrUpdateFlagRequestBody;
+    icon?: string;
+    lifecyclePhase?: Schematic.FeatureLifecyclePhase;
+    maintainerId?: string;
+    name: string;
+    pluralName?: string;
+    singularName?: string;
+    traitId?: string;
+}

package/dist/api/resources/features/client/requests/ListFeaturesRequest.d.ts

@@ -2,29 +2,29 @@ import type * as Schematic from "../../../../index";
 /**
  * @example
  *     {
+ *         booleanRequireEvent: true,
+ *         planVersionId: "plan_version_id",
  *         q: "q",
  *         withoutCompanyOverrideFor: "without_company_override_for",
- *         planVersionId: "plan_version_id",
  *         withoutPlanEntitlementFor: "without_plan_entitlement_for",
- *         booleanRequireEvent: true,
  *         limit: 1000000,
  *         offset: 1000000
  *     }
  */
 export interface ListFeaturesRequest {
+    /** Only return boolean features if there is an associated event. Automatically includes boolean in the feature types filter. */
+    booleanRequireEvent?: boolean;
+    /** Filter by one or more feature types (boolean, event, trait) */
+    featureType?: Schematic.FeatureType | Schematic.FeatureType[];
     ids?: string | string[];
+    /** Filter by plan version ID when used with without_plan_entitlement_for; if not provided, the latest published version is used */
+    planVersionId?: string;
     /** Search by feature name or ID */
     q?: string;
     /** Filter out features that already have a company override for the specified company ID */
     withoutCompanyOverrideFor?: string;
-    /** Filter by plan version ID when used with without_plan_entitlement_for; if not provided, the latest published version is used */
-    planVersionId?: string;
     /** Filter out features that already have a plan entitlement for the specified plan ID */
     withoutPlanEntitlementFor?: string;
-    /** Filter by one or more feature types (boolean, event, trait) */
-    featureType?: Schematic.FeatureType | Schematic.FeatureType[];
-    /** Only return boolean features if there is an associated event. Automatically includes boolean in the feature types filter. */
-    booleanRequireEvent?: boolean;
     /** Page limit (default 100) */
     limit?: number;
     /** Page offset (default 0) */

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

@@ -1,6 +1,7 @@
 export type { CheckFlagsBulkRequestBody } from "./CheckFlagsBulkRequestBody";
 export type { CountFeaturesRequest } from "./CountFeaturesRequest";
 export type { CountFlagsRequest } from "./CountFlagsRequest";
+export type { CreateBillingLinkedFeatureRequestBody } from "./CreateBillingLinkedFeatureRequestBody";
 export type { CreateFeatureRequestBody } from "./CreateFeatureRequestBody";
 export type { ListFeaturesRequest } from "./ListFeaturesRequest";
 export type { ListFlagsRequest } from "./ListFlagsRequest";

package/dist/api/resources/features/types/UpsertFeatureForBillingProductResponse.d.ts

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

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

@@ -18,3 +18,4 @@ export * from "./ListFlagsResponse";
 export * from "./UpdateFeatureResponse";
 export * from "./UpdateFlagResponse";
 export * from "./UpdateFlagRulesResponse";
+export * from "./UpsertFeatureForBillingProductResponse";

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

@@ -33,6 +33,8 @@ export * from "./events/types";
 export * as features from "./features";
 export * from "./features/client/requests";
 export * from "./features/types";
+export * as integrationsapi from "./integrationsapi";
+export * from "./integrationsapi/types";
 export * as planbundle from "./planbundle";
 export * from "./planbundle/client/requests";
 export * from "./planbundle/types";

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

@@ -0,0 +1,27 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient";
+import * as core from "../../../../core";
+import * as Schematic from "../../../index";
+export declare namespace IntegrationsapiClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class IntegrationsapiClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<IntegrationsapiClient.Options>;
+    constructor(options: IntegrationsapiClient.Options);
+    /**
+     * @param {string} type - type
+     * @param {IntegrationsapiClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schematic.UnauthorizedError}
+     * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
+     * @throws {@link Schematic.InternalServerError}
+     *
+     * @example
+     *     await client.integrationsapi.getIntegrationWebhookUrl("type")
+     */
+    getIntegrationWebhookUrl(type: string, requestOptions?: IntegrationsapiClient.RequestOptions): core.HttpResponsePromise<Schematic.GetIntegrationWebhookUrlResponse>;
+    private __getIntegrationWebhookUrl;
+}

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

@@ -0,0 +1 @@
+export {};

package/dist/api/resources/integrationsapi/exports.d.ts

@@ -0,0 +1,2 @@
+export { IntegrationsapiClient } from "./client/Client";
+export * from "./client/index";

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

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

package/dist/api/resources/integrationsapi/types/GetIntegrationWebhookUrlResponse.d.ts

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

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

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

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

@@ -28,6 +28,25 @@ export declare class PlansClient {
      */
     updateCompanyPlans(company_plan_id: string, request: Schematic.UpdateCompanyPlansRequestBody, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.UpdateCompanyPlansResponse>;
     private __updateCompanyPlans;
+    /**
+     * @param {Schematic.CreateCustomPlanRequestBody} 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.createCustomPlan({
+     *         companyId: "company_id",
+     *         description: "description",
+     *         name: "name"
+     *     })
+     */
+    createCustomPlan(request: Schematic.CreateCustomPlanRequestBody, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.CreateCustomPlanResponse>;
+    private __createCustomPlan;
     /**
      * @param {Schematic.ListPlansRequest} request
      * @param {PlansClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -48,6 +67,7 @@ export declare class PlansClient {
      *         includeDraftVersions: true,
      *         planType: "plan",
      *         q: "q",
+     *         scopedToCompanyId: "scoped_to_company_id",
      *         withoutEntitlementFor: "without_entitlement_for",
      *         withoutPaidProductId: true,
      *         limit: 1000000,
@@ -144,6 +164,67 @@ export declare class PlansClient {
      */
     upsertBillingProductPlan(plan_id: string, request: Schematic.UpsertBillingProductRequestBody, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.UpsertBillingProductPlanResponse>;
     private __upsertBillingProductPlan;
+    /**
+     * @param {Schematic.CreateBillingLinkedPlanRequestBody} 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.upsertPlanForBillingProduct({
+     *         billingProvider: "orb",
+     *         description: "description",
+     *         externalResourceId: "external_resource_id",
+     *         name: "name",
+     *         planType: "plan"
+     *     })
+     */
+    upsertPlanForBillingProduct(request: Schematic.CreateBillingLinkedPlanRequestBody, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.UpsertPlanForBillingProductResponse>;
+    private __upsertPlanForBillingProduct;
+    /**
+     * @param {Schematic.ListBillingProductMatchCompaniesRequest} 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.listBillingProductMatchCompanies({
+     *         planId: "plan_id",
+     *         q: "q",
+     *         limit: 1000000,
+     *         offset: 1000000
+     *     })
+     */
+    listBillingProductMatchCompanies(request: Schematic.ListBillingProductMatchCompaniesRequest, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.ListBillingProductMatchCompaniesResponse>;
+    private __listBillingProductMatchCompanies;
+    /**
+     * @param {Schematic.CountBillingProductMatchCompaniesRequest} 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.countBillingProductMatchCompanies({
+     *         planId: "plan_id",
+     *         q: "q",
+     *         limit: 1000000,
+     *         offset: 1000000
+     *     })
+     */
+    countBillingProductMatchCompanies(request: Schematic.CountBillingProductMatchCompaniesRequest, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.CountBillingProductMatchCompaniesResponse>;
+    private __countBillingProductMatchCompanies;
     /**
      * @param {Schematic.CountPlansRequest} request
      * @param {PlansClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -164,6 +245,7 @@ export declare class PlansClient {
      *         includeDraftVersions: true,
      *         planType: "plan",
      *         q: "q",
+     *         scopedToCompanyId: "scoped_to_company_id",
      *         withoutEntitlementFor: "without_entitlement_for",
      *         withoutPaidProductId: true,
      *         limit: 1000000,
@@ -192,6 +274,7 @@ export declare class PlansClient {
     private __listPlanIssues;
     /**
      * @param {string} plan_id - plan_id
+     * @param {Schematic.DeletePlanVersionRequest} request
      * @param {PlansClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Schematic.BadRequestError}
@@ -201,9 +284,11 @@ export declare class PlansClient {
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
-     *     await client.plans.deletePlanVersion("plan_id")
+     *     await client.plans.deletePlanVersion("plan_id", {
+     *         promoteArchivedVersion: true
+     *     })
      */
-    deletePlanVersion(plan_id: string, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.DeletePlanVersionResponse>;
+    deletePlanVersion(plan_id: string, request?: Schematic.DeletePlanVersionRequest, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.DeletePlanVersionResponse>;
     private __deletePlanVersion;
     /**
      * @param {string} plan_id - plan_id
@@ -219,7 +304,11 @@ export declare class PlansClient {
      * @example
      *     await client.plans.publishPlanVersion("plan_id", {
      *         excludedCompanyIds: ["excluded_company_ids"],
-     *         migrationStrategy: "immediate"
+     *         migrationStrategy: "immediate",
+     *         payInAdvance: [{
+     *                 priceId: "price_id",
+     *                 quantity: 1000000
+     *             }]
      *     })
      */
     publishPlanVersion(plan_id: string, request: Schematic.PublishPlanVersionRequestBody, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.PublishPlanVersionResponse>;

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

@@ -0,0 +1,19 @@
+/**
+ * @example
+ *     {
+ *         planId: "plan_id",
+ *         q: "q",
+ *         limit: 1000000,
+ *         offset: 1000000
+ *     }
+ */
+export interface CountBillingProductMatchCompaniesRequest {
+    /** The plan ID to find billing product match companies for */
+    planId: string;
+    /** Search for companies by name, keys or string traits */
+    q?: string;
+    /** Page limit (default 100) */
+    limit?: number;
+    /** Page offset (default 0) */
+    offset?: number;
+}

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

@@ -10,6 +10,7 @@ import type * as Schematic from "../../../../index";
  *         includeDraftVersions: true,
  *         planType: "plan",
  *         q: "q",
+ *         scopedToCompanyId: "scoped_to_company_id",
  *         withoutEntitlementFor: "without_entitlement_for",
  *         withoutPaidProductId: true,
  *         limit: 1000000,
@@ -32,6 +33,8 @@ export interface CountPlansRequest {
     /** Filter by plan type */
     planType?: Schematic.PlanType;
     q?: string;
+    /** Filter plans scoped to a specific company (custom plans) */
+    scopedToCompanyId?: string;
     /** Filter out plans that already have a plan entitlement for the specified feature ID */
     withoutEntitlementFor?: string;
     /** Filter out plans that have a paid billing product ID */

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

@@ -0,0 +1,19 @@
+import type * as Schematic from "../../../../index";
+/**
+ * @example
+ *     {
+ *         billingProvider: "orb",
+ *         description: "description",
+ *         externalResourceId: "external_resource_id",
+ *         name: "name",
+ *         planType: "plan"
+ *     }
+ */
+export interface CreateBillingLinkedPlanRequestBody {
+    billingProvider: Schematic.BillingProviderType;
+    description: string;
+    externalResourceId: string;
+    icon?: Schematic.PlanIcon;
+    name: string;
+    planType: Schematic.PlanType;
+}

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

@@ -0,0 +1,16 @@
+import type * as Schematic from "../../../../index";
+/**
+ * @example
+ *     {
+ *         companyId: "company_id",
+ *         description: "description",
+ *         name: "name"
+ *     }
+ */
+export interface CreateCustomPlanRequestBody {
+    companyId: string;
+    copiedFromPlanId?: string;
+    description: string;
+    icon?: Schematic.PlanIcon;
+    name: string;
+}

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

@@ -0,0 +1,9 @@
+/**
+ * @example
+ *     {
+ *         promoteArchivedVersion: true
+ *     }
+ */
+export interface DeletePlanVersionRequest {
+    promoteArchivedVersion?: boolean;
+}

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

@@ -0,0 +1,19 @@
+/**
+ * @example
+ *     {
+ *         planId: "plan_id",
+ *         q: "q",
+ *         limit: 1000000,
+ *         offset: 1000000
+ *     }
+ */
+export interface ListBillingProductMatchCompaniesRequest {
+    /** The plan ID to find billing product match companies for */
+    planId: string;
+    /** Search for companies by name, keys or string traits */
+    q?: string;
+    /** Page limit (default 100) */
+    limit?: number;
+    /** Page offset (default 0) */
+    offset?: number;
+}

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

@@ -10,6 +10,7 @@ import type * as Schematic from "../../../../index";
  *         includeDraftVersions: true,
  *         planType: "plan",
  *         q: "q",
+ *         scopedToCompanyId: "scoped_to_company_id",
  *         withoutEntitlementFor: "without_entitlement_for",
  *         withoutPaidProductId: true,
  *         limit: 1000000,
@@ -32,6 +33,8 @@ export interface ListPlansRequest {
     /** Filter by plan type */
     planType?: Schematic.PlanType;
     q?: string;
+    /** Filter plans scoped to a specific company (custom plans) */
+    scopedToCompanyId?: string;
     /** Filter out plans that already have a plan entitlement for the specified feature ID */
     withoutEntitlementFor?: string;
     /** Filter out plans that have a paid billing product ID */

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

@@ -3,10 +3,18 @@ import type * as Schematic from "../../../../index";
  * @example
  *     {
  *         excludedCompanyIds: ["excluded_company_ids"],
- *         migrationStrategy: "immediate"
+ *         migrationStrategy: "immediate",
+ *         payInAdvance: [{
+ *                 priceId: "price_id",
+ *                 quantity: 1000000
+ *             }]
  *     }
  */
 export interface PublishPlanVersionRequestBody {
+    activationStrategy?: Schematic.CustomPlanActivationStrategy;
+    customerEmail?: string;
+    daysUntilDue?: number;
     excludedCompanyIds: string[];
     migrationStrategy: Schematic.PlanVersionMigrationStrategy;
+    payInAdvance: Schematic.UpdatePayInAdvanceRequestBody[];
 }

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

@@ -1,5 +1,10 @@
+export type { CountBillingProductMatchCompaniesRequest } from "./CountBillingProductMatchCompaniesRequest";
 export type { CountPlansRequest } from "./CountPlansRequest";
+export type { CreateBillingLinkedPlanRequestBody } from "./CreateBillingLinkedPlanRequestBody";
+export type { CreateCustomPlanRequestBody } from "./CreateCustomPlanRequestBody";
+export type { DeletePlanVersionRequest } from "./DeletePlanVersionRequest";
 export type { GetPlanRequest } from "./GetPlanRequest";
+export type { ListBillingProductMatchCompaniesRequest } from "./ListBillingProductMatchCompaniesRequest";
 export type { ListPlanIssuesRequest } from "./ListPlanIssuesRequest";
 export type { ListPlansRequest } from "./ListPlansRequest";
 export type { PublishPlanVersionRequestBody } from "./PublishPlanVersionRequestBody";

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

@@ -0,0 +1,13 @@
+/**
+ * Input parameters
+ */
+export interface CountBillingProductMatchCompaniesParams {
+    /** Page limit (default 100) */
+    limit?: number;
+    /** Page offset (default 0) */
+    offset?: number;
+    /** The plan ID to find billing product match companies for */
+    planId?: string;
+    /** Search for companies by name, keys or string traits */
+    q?: string;
+}

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

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

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

@@ -22,6 +22,8 @@ export interface CountPlansParams {
     /** Filter by plan type */
     planType?: Schematic.PlanType;
     q?: string;
+    /** Filter plans scoped to a specific company (custom plans) */
+    scopedToCompanyId?: string;
     /** Filter out plans that already have a plan entitlement for the specified feature ID */
     withoutEntitlementFor?: string;
     /** Filter out plans that have a paid billing product ID */

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

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