@schematichq/schematic-typescript-node 1.4.4 → 1.4.6

package/dist/api/resources/billing/client/requests/ListBillingPricesRequest.d.ts

@@ -2,22 +2,25 @@ import type * as Schematic from "../../../../index";
 /**
  * @example
  *     {
+ *         currency: "currency",
  *         forInitialPlan: true,
  *         forTrialExpiryPlan: true,
  *         interval: "interval",
  *         isActive: true,
- *         price: 1,
+ *         price: 1000000,
  *         productId: "product_id",
- *         providerType: "schematic",
+ *         providerType: "orb",
  *         q: "q",
  *         tiersMode: "graduated",
  *         usageType: "licensed",
  *         withMeter: true,
- *         limit: 1,
- *         offset: 1
+ *         limit: 1000000,
+ *         offset: 1000000
  *     }
  */
 export interface ListBillingPricesRequest {
+    /** Filter for prices in a specific currency (e.g. usd, eur) */
+    currency?: string;
     /** Filter for prices valid for initial plans (free prices only) */
     forInitialPlan?: boolean;
     /** Filter for prices valid for trial expiry plans (free prices only) */

package/dist/api/resources/billing/client/requests/ListBillingProductPricesRequest.d.ts

@@ -2,22 +2,25 @@ import type * as Schematic from "../../../../index";
 /**
  * @example
  *     {
+ *         currency: "currency",
  *         forInitialPlan: true,
  *         forTrialExpiryPlan: true,
  *         interval: "interval",
  *         isActive: true,
- *         price: 1,
+ *         price: 1000000,
  *         productId: "product_id",
- *         providerType: "schematic",
+ *         providerType: "orb",
  *         q: "q",
  *         tiersMode: "graduated",
  *         usageType: "licensed",
  *         withMeter: true,
- *         limit: 1,
- *         offset: 1
+ *         limit: 1000000,
+ *         offset: 1000000
  *     }
  */
 export interface ListBillingProductPricesRequest {
+    /** Filter for prices in a specific currency (e.g. usd, eur) */
+    currency?: string;
     /** Filter for prices valid for initial plans (free prices only) */
     forInitialPlan?: boolean;
     /** Filter for prices valid for trial expiry plans (free prices only) */

package/dist/api/resources/billing/client/requests/ListBillingProductsRequest.d.ts

@@ -5,14 +5,14 @@ import type * as Schematic from "../../../../index";
  *         isActive: true,
  *         name: "name",
  *         priceUsageType: "licensed",
- *         providerType: "schematic",
+ *         providerType: "orb",
  *         q: "q",
  *         withOneTimeCharges: true,
  *         withPricesOnly: true,
  *         withZeroPrice: true,
  *         withoutLinkedToPlan: true,
- *         limit: 1,
- *         offset: 1
+ *         limit: 1000000,
+ *         offset: 1000000
  *     }
  */
 export interface ListBillingProductsRequest {

package/dist/api/resources/billing/client/requests/ListCouponsRequest.d.ts

@@ -3,8 +3,8 @@
  *     {
  *         isActive: true,
  *         q: "q",
- *         limit: 1,
- *         offset: 1
+ *         limit: 1000000,
+ *         offset: 1000000
  *     }
  */
 export interface ListCouponsRequest {

package/dist/api/resources/billing/client/requests/ListCustomersWithSubscriptionsRequest.d.ts

@@ -3,10 +3,10 @@ import type * as Schematic from "../../../../index";
  * @example
  *     {
  *         name: "name",
- *         providerType: "schematic",
+ *         providerType: "orb",
  *         q: "q",
- *         limit: 1,
- *         offset: 1
+ *         limit: 1000000,
+ *         offset: 1000000
  *     }
  */
 export interface ListCustomersWithSubscriptionsRequest {

package/dist/api/resources/billing/client/requests/ListInvoicesRequest.d.ts

@@ -4,8 +4,8 @@
  *         companyId: "company_id",
  *         customerExternalId: "customer_external_id",
  *         subscriptionExternalId: "subscription_external_id",
- *         limit: 1,
- *         offset: 1
+ *         limit: 1000000,
+ *         offset: 1000000
  *     }
  */
 export interface ListInvoicesRequest {

package/dist/api/resources/billing/client/requests/ListMetersRequest.d.ts

@@ -2,8 +2,8 @@
  * @example
  *     {
  *         displayName: "display_name",
- *         limit: 1,
- *         offset: 1
+ *         limit: 1000000,
+ *         offset: 1000000
  *     }
  */
 export interface ListMetersRequest {

package/dist/api/resources/billing/client/requests/ListPaymentMethodsRequest.d.ts

@@ -3,8 +3,8 @@
  *     {
  *         companyId: "company_id",
  *         customerExternalId: "customer_external_id",
- *         limit: 1,
- *         offset: 1
+ *         limit: 1000000,
+ *         offset: 1000000
  *     }
  */
 export interface ListPaymentMethodsRequest {

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

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

package/dist/api/resources/billing/types/ListBillingPricesParams.d.ts

@@ -3,6 +3,8 @@ import type * as Schematic from "../../../index";
  * Input parameters
  */
 export interface ListBillingPricesParams {
+    /** Filter for prices in a specific currency (e.g. usd, eur) */
+    currency?: string;
     /** Filter for prices valid for initial plans (free prices only) */
     forInitialPlan?: boolean;
     /** Filter for prices valid for trial expiry plans (free prices only) */

package/dist/api/resources/billing/types/ListBillingProductPricesParams.d.ts

@@ -3,6 +3,8 @@ import type * as Schematic from "../../../index";
  * Input parameters
  */
 export interface ListBillingProductPricesParams {
+    /** Filter for prices in a specific currency (e.g. usd, eur) */
+    currency?: string;
     /** Filter for prices valid for initial plans (free prices only) */
     forInitialPlan?: boolean;
     /** Filter for prices valid for trial expiry plans (free prices only) */

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

@@ -29,13 +29,13 @@ export declare class CheckoutClient {
      *         companyId: "company_id",
      *         creditBundles: [{
      *                 bundleId: "bundle_id",
-     *                 quantity: 1
+     *                 quantity: 1000000
      *             }],
      *         newPlanId: "new_plan_id",
      *         newPriceId: "new_price_id",
      *         payInAdvance: [{
      *                 priceId: "price_id",
-     *                 quantity: 1
+     *                 quantity: 1000000
      *             }],
      *         skipTrial: true
      *     })
@@ -78,13 +78,13 @@ export declare class CheckoutClient {
      *         companyId: "company_id",
      *         creditBundles: [{
      *                 bundleId: "bundle_id",
-     *                 quantity: 1
+     *                 quantity: 1000000
      *             }],
      *         newPlanId: "new_plan_id",
      *         newPriceId: "new_price_id",
      *         payInAdvance: [{
      *                 priceId: "price_id",
-     *                 quantity: 1
+     *                 quantity: 1000000
      *             }],
      *         skipTrial: true
      *     })
@@ -109,11 +109,11 @@ export declare class CheckoutClient {
      *         companyId: "company_id",
      *         creditBundles: [{
      *                 bundleId: "bundle_id",
-     *                 quantity: 1
+     *                 quantity: 1000000
      *             }],
      *         payInAdvanceEntitlements: [{
      *                 priceId: "price_id",
-     *                 quantity: 1
+     *                 quantity: 1000000
      *             }]
      *     })
      */
@@ -137,11 +137,11 @@ export declare class CheckoutClient {
      *         companyId: "company_id",
      *         creditBundles: [{
      *                 bundleId: "bundle_id",
-     *                 quantity: 1
+     *                 quantity: 1000000
      *             }],
      *         payInAdvanceEntitlements: [{
      *                 priceId: "price_id",
-     *                 quantity: 1
+     *                 quantity: 1000000
      *             }]
      *     })
      */

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

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

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

@@ -22,6 +22,7 @@ export declare class CompaniesClient {
      *
      * @example
      *     await client.companies.listCompanies({
+     *         hasScheduledDowngrade: true,
      *         monetizedSubscriptions: true,
      *         planId: "plan_id",
      *         planVersionId: "plan_version_id",
@@ -33,8 +34,8 @@ export declare class CompaniesClient {
      *         withoutPlan: true,
      *         withoutSubscription: true,
      *         withSubscription: true,
-     *         limit: 1,
-     *         offset: 1
+     *         limit: 1000000,
+     *         offset: 1000000
      *     })
      */
     listCompanies(request?: Schematic.ListCompaniesRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.ListCompaniesResponse>;
@@ -103,6 +104,7 @@ export declare class CompaniesClient {
      *
      * @example
      *     await client.companies.countCompanies({
+     *         hasScheduledDowngrade: true,
      *         monetizedSubscriptions: true,
      *         planId: "plan_id",
      *         planVersionId: "plan_version_id",
@@ -114,8 +116,8 @@ export declare class CompaniesClient {
      *         withoutPlan: true,
      *         withoutSubscription: true,
      *         withSubscription: true,
-     *         limit: 1,
-     *         offset: 1
+     *         limit: 1000000,
+     *         offset: 1000000
      *     })
      */
     countCompanies(request?: Schematic.CountCompaniesRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.CountCompaniesResponse>;
@@ -159,6 +161,12 @@ export declare class CompaniesClient {
     deleteCompanyByKeys(request: Schematic.KeysRequestBody, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.DeleteCompanyByKeysResponse>;
     private __deleteCompanyByKeys;
     /**
+     * Company lookup is determined to resolve a company from its keys, similar to how many of our other apis work.
+     * The following approaches will all work to resolve a company and any of them are appropriate:
+     * 1. `/companies/lookup?keys={"foo": "bar", "fizz": "buzz"}`
+     * 2. `/companies/lookup?keys[foo]=bar&keys[fizz]=buzz`
+     * 2. `/companies/lookup?foo=bar&fizz=buzz`
+     *
      * @param {Schematic.LookupCompanyRequest} request
      * @param {CompaniesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -190,8 +198,8 @@ export declare class CompaniesClient {
      *     await client.companies.listCompanyMemberships({
      *         companyId: "company_id",
      *         userId: "user_id",
-     *         limit: 1,
-     *         offset: 1
+     *         limit: 1000000,
+     *         offset: 1000000
      *     })
      */
     listCompanyMemberships(request?: Schematic.ListCompanyMembershipsRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.ListCompanyMembershipsResponse>;
@@ -242,8 +250,8 @@ export declare class CompaniesClient {
      * @example
      *     await client.companies.getActiveCompanySubscription({
      *         companyId: "company_id",
-     *         limit: 1,
-     *         offset: 1
+     *         limit: 1000000,
+     *         offset: 1000000
      *     })
      */
     getActiveCompanySubscription(request?: Schematic.GetActiveCompanySubscriptionRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.GetActiveCompanySubscriptionResponse>;
@@ -282,8 +290,8 @@ export declare class CompaniesClient {
      *     await client.companies.listEntityKeyDefinitions({
      *         entityType: "company",
      *         q: "q",
-     *         limit: 1,
-     *         offset: 1
+     *         limit: 1000000,
+     *         offset: 1000000
      *     })
      */
     listEntityKeyDefinitions(request?: Schematic.ListEntityKeyDefinitionsRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.ListEntityKeyDefinitionsResponse>;
@@ -302,8 +310,8 @@ export declare class CompaniesClient {
      *     await client.companies.countEntityKeyDefinitions({
      *         entityType: "company",
      *         q: "q",
-     *         limit: 1,
-     *         offset: 1
+     *         limit: 1000000,
+     *         offset: 1000000
      *     })
      */
     countEntityKeyDefinitions(request?: Schematic.CountEntityKeyDefinitionsRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.CountEntityKeyDefinitionsResponse>;
@@ -323,8 +331,8 @@ export declare class CompaniesClient {
      *         entityType: "company",
      *         q: "q",
      *         traitType: "boolean",
-     *         limit: 1,
-     *         offset: 1
+     *         limit: 1000000,
+     *         offset: 1000000
      *     })
      */
     listEntityTraitDefinitions(request?: Schematic.ListEntityTraitDefinitionsRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.ListEntityTraitDefinitionsResponse>;
@@ -395,8 +403,8 @@ export declare class CompaniesClient {
      *         entityType: "company",
      *         q: "q",
      *         traitType: "boolean",
-     *         limit: 1,
-     *         offset: 1
+     *         limit: 1000000,
+     *         offset: 1000000
      *     })
      */
     countEntityTraitDefinitions(request?: Schematic.CountEntityTraitDefinitionsRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.CountEntityTraitDefinitionsResponse>;
@@ -415,8 +423,8 @@ export declare class CompaniesClient {
      *     await client.companies.getEntityTraitValues({
      *         definitionId: "definition_id",
      *         q: "q",
-     *         limit: 1,
-     *         offset: 1
+     *         limit: 1000000,
+     *         offset: 1000000
      *     })
      */
     getEntityTraitValues(request: Schematic.GetEntityTraitValuesRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.GetEntityTraitValuesResponse>;
@@ -433,11 +441,11 @@ export declare class CompaniesClient {
      *
      * @example
      *     await client.companies.listPlanChanges({
-     *         action: "action",
-     *         basePlanAction: "base_plan_action",
+     *         action: "checkout",
+     *         basePlanAction: "fallback",
      *         companyId: "company_id",
-     *         limit: 1,
-     *         offset: 1
+     *         limit: 1000000,
+     *         offset: 1000000
      *     })
      */
     listPlanChanges(request?: Schematic.ListPlanChangesRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.ListPlanChangesResponse>;
@@ -470,8 +478,8 @@ export declare class CompaniesClient {
      *     await client.companies.listPlanTraits({
      *         planId: "plan_id",
      *         traitId: "trait_id",
-     *         limit: 1,
-     *         offset: 1
+     *         limit: 1000000,
+     *         offset: 1000000
      *     })
      */
     listPlanTraits(request?: Schematic.ListPlanTraitsRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.ListPlanTraitsResponse>;
@@ -579,8 +587,8 @@ export declare class CompaniesClient {
      *     await client.companies.countPlanTraits({
      *         planId: "plan_id",
      *         traitId: "trait_id",
-     *         limit: 1,
-     *         offset: 1
+     *         limit: 1000000,
+     *         offset: 1000000
      *     })
      */
     countPlanTraits(request?: Schematic.CountPlanTraitsRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.CountPlanTraitsResponse>;
@@ -620,8 +628,8 @@ export declare class CompaniesClient {
      *         companyId: "company_id",
      *         planId: "plan_id",
      *         q: "q",
-     *         limit: 1,
-     *         offset: 1
+     *         limit: 1000000,
+     *         offset: 1000000
      *     })
      */
     listUsers(request?: Schematic.ListUsersRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.ListUsersResponse>;
@@ -689,8 +697,8 @@ export declare class CompaniesClient {
      *         companyId: "company_id",
      *         planId: "plan_id",
      *         q: "q",
-     *         limit: 1,
-     *         offset: 1
+     *         limit: 1000000,
+     *         offset: 1000000
      *     })
      */
     countUsers(request?: Schematic.CountUsersRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.CountUsersResponse>;

package/dist/api/resources/companies/client/requests/CountCompaniesRequest.d.ts

@@ -2,6 +2,7 @@ import type * as Schematic from "../../../../index";
 /**
  * @example
  *     {
+ *         hasScheduledDowngrade: true,
  *         monetizedSubscriptions: true,
  *         planId: "plan_id",
  *         planVersionId: "plan_version_id",
@@ -13,13 +14,15 @@ import type * as Schematic from "../../../../index";
  *         withoutPlan: true,
  *         withoutSubscription: true,
  *         withSubscription: true,
- *         limit: 1,
- *         offset: 1
+ *         limit: 1000000,
+ *         offset: 1000000
  *     }
  */
 export interface CountCompaniesRequest {
     /** Filter companies by one or more credit type IDs (each ID starts with bcrd_) */
     creditTypeIds?: string | string[];
+    /** Filter companies that have a pending scheduled downgrade */
+    hasScheduledDowngrade?: boolean;
     /** Filter companies by multiple company IDs (starts with comp_) */
     ids?: string | string[];
     /** Filter companies that have monetized subscriptions */

package/dist/api/resources/companies/client/requests/CountEntityKeyDefinitionsRequest.d.ts

@@ -4,8 +4,8 @@ import type * as Schematic from "../../../../index";
  *     {
  *         entityType: "company",
  *         q: "q",
- *         limit: 1,
- *         offset: 1
+ *         limit: 1000000,
+ *         offset: 1000000
  *     }
  */
 export interface CountEntityKeyDefinitionsRequest {

package/dist/api/resources/companies/client/requests/CountEntityTraitDefinitionsRequest.d.ts

@@ -5,8 +5,8 @@ import type * as Schematic from "../../../../index";
  *         entityType: "company",
  *         q: "q",
  *         traitType: "boolean",
- *         limit: 1,
- *         offset: 1
+ *         limit: 1000000,
+ *         offset: 1000000
  *     }
  */
 export interface CountEntityTraitDefinitionsRequest {

package/dist/api/resources/companies/client/requests/CountPlanTraitsRequest.d.ts

@@ -3,8 +3,8 @@
  *     {
  *         planId: "plan_id",
  *         traitId: "trait_id",
- *         limit: 1,
- *         offset: 1
+ *         limit: 1000000,
+ *         offset: 1000000
  *     }
  */
 export interface CountPlanTraitsRequest {

package/dist/api/resources/companies/client/requests/CountUsersRequest.d.ts

@@ -4,8 +4,8 @@
  *         companyId: "company_id",
  *         planId: "plan_id",
  *         q: "q",
- *         limit: 1,
- *         offset: 1
+ *         limit: 1000000,
+ *         offset: 1000000
  *     }
  */
 export interface CountUsersRequest {

package/dist/api/resources/companies/client/requests/GetActiveCompanySubscriptionRequest.d.ts

@@ -2,8 +2,8 @@
  * @example
  *     {
  *         companyId: "company_id",
- *         limit: 1,
- *         offset: 1
+ *         limit: 1000000,
+ *         offset: 1000000
  *     }
  */
 export interface GetActiveCompanySubscriptionRequest {

package/dist/api/resources/companies/client/requests/GetEntityTraitValuesRequest.d.ts

@@ -3,8 +3,8 @@
  *     {
  *         definitionId: "definition_id",
  *         q: "q",
- *         limit: 1,
- *         offset: 1
+ *         limit: 1000000,
+ *         offset: 1000000
  *     }
  */
 export interface GetEntityTraitValuesRequest {

package/dist/api/resources/companies/client/requests/ListCompaniesRequest.d.ts

@@ -2,6 +2,7 @@ import type * as Schematic from "../../../../index";
 /**
  * @example
  *     {
+ *         hasScheduledDowngrade: true,
  *         monetizedSubscriptions: true,
  *         planId: "plan_id",
  *         planVersionId: "plan_version_id",
@@ -13,13 +14,15 @@ import type * as Schematic from "../../../../index";
  *         withoutPlan: true,
  *         withoutSubscription: true,
  *         withSubscription: true,
- *         limit: 1,
- *         offset: 1
+ *         limit: 1000000,
+ *         offset: 1000000
  *     }
  */
 export interface ListCompaniesRequest {
     /** Filter companies by one or more credit type IDs (each ID starts with bcrd_) */
     creditTypeIds?: string | string[];
+    /** Filter companies that have a pending scheduled downgrade */
+    hasScheduledDowngrade?: boolean;
     /** Filter companies by multiple company IDs (starts with comp_) */
     ids?: string | string[];
     /** Filter companies that have monetized subscriptions */

package/dist/api/resources/companies/client/requests/ListCompanyMembershipsRequest.d.ts

@@ -3,8 +3,8 @@
  *     {
  *         companyId: "company_id",
  *         userId: "user_id",
- *         limit: 1,
- *         offset: 1
+ *         limit: 1000000,
+ *         offset: 1000000
  *     }
  */
 export interface ListCompanyMembershipsRequest {

package/dist/api/resources/companies/client/requests/ListEntityKeyDefinitionsRequest.d.ts

@@ -4,8 +4,8 @@ import type * as Schematic from "../../../../index";
  *     {
  *         entityType: "company",
  *         q: "q",
- *         limit: 1,
- *         offset: 1
+ *         limit: 1000000,
+ *         offset: 1000000
  *     }
  */
 export interface ListEntityKeyDefinitionsRequest {

package/dist/api/resources/companies/client/requests/ListEntityTraitDefinitionsRequest.d.ts

@@ -5,8 +5,8 @@ import type * as Schematic from "../../../../index";
  *         entityType: "company",
  *         q: "q",
  *         traitType: "boolean",
- *         limit: 1,
- *         offset: 1
+ *         limit: 1000000,
+ *         offset: 1000000
  *     }
  */
 export interface ListEntityTraitDefinitionsRequest {

package/dist/api/resources/companies/client/requests/ListPlanChangesRequest.d.ts

@@ -1,16 +1,17 @@
+import type * as Schematic from "../../../../index";
 /**
  * @example
  *     {
- *         action: "action",
- *         basePlanAction: "base_plan_action",
+ *         action: "checkout",
+ *         basePlanAction: "fallback",
  *         companyId: "company_id",
- *         limit: 1,
- *         offset: 1
+ *         limit: 1000000,
+ *         offset: 1000000
  *     }
  */
 export interface ListPlanChangesRequest {
-    action?: string;
-    basePlanAction?: string;
+    action?: Schematic.PlanChangeAction;
+    basePlanAction?: Schematic.PlanChangeBasePlanAction;
     companyId?: string;
     companyIds?: string | string[];
     planIds?: string | string[];

package/dist/api/resources/companies/client/requests/ListPlanTraitsRequest.d.ts

@@ -3,8 +3,8 @@
  *     {
  *         planId: "plan_id",
  *         traitId: "trait_id",
- *         limit: 1,
- *         offset: 1
+ *         limit: 1000000,
+ *         offset: 1000000
  *     }
  */
 export interface ListPlanTraitsRequest {

package/dist/api/resources/companies/client/requests/ListUsersRequest.d.ts

@@ -4,8 +4,8 @@
  *         companyId: "company_id",
  *         planId: "plan_id",
  *         q: "q",
- *         limit: 1,
- *         offset: 1
+ *         limit: 1000000,
+ *         offset: 1000000
  *     }
  */
 export interface ListUsersRequest {

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

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

package/dist/api/resources/companies/types/CountCompaniesParams.d.ts

@@ -5,6 +5,8 @@ import type * as Schematic from "../../../index";
 export interface CountCompaniesParams {
     /** Filter companies by one or more credit type IDs (each ID starts with bcrd_) */
     creditTypeIds?: string[];
+    /** Filter companies that have a pending scheduled downgrade */
+    hasScheduledDowngrade?: boolean;
     /** Filter companies by multiple company IDs (starts with comp_) */
     ids?: string[];
     /** Page limit (default 100) */

package/dist/api/resources/companies/types/ListCompaniesParams.d.ts

@@ -5,6 +5,8 @@ import type * as Schematic from "../../../index";
 export interface ListCompaniesParams {
     /** Filter companies by one or more credit type IDs (each ID starts with bcrd_) */
     creditTypeIds?: string[];
+    /** Filter companies that have a pending scheduled downgrade */
+    hasScheduledDowngrade?: boolean;
     /** Filter companies by multiple company IDs (starts with comp_) */
     ids?: string[];
     /** Page limit (default 100) */