@schematichq/schematic-typescript-node 1.4.5 → 1.4.7

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

@@ -14,6 +14,8 @@ export interface ListBillingProductsParams {
     priceUsageType?: Schematic.BillingPriceUsageType;
     providerType?: Schematic.BillingProviderType;
     q?: string;
+    /** Filter to products that have at least one recurring price */
+    recurringChargesOnly?: boolean;
     /** Filter products that are one time charges */
     withOneTimeCharges?: boolean;
     /** Filter products that have prices */

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

@@ -3,6 +3,7 @@ export * from "./CountBillingProductsResponse";
 export * from "./CountCustomersParams";
 export * from "./CountCustomersResponse";
 export * from "./DeleteBillingProductResponse";
+export * from "./DeletePaymentMethodByExternalIdResponse";
 export * from "./DeleteProductPriceResponse";
 export * from "./ListBillingPricesParams";
 export * from "./ListBillingPricesResponse";

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

@@ -26,6 +26,9 @@ export declare class CheckoutClient {
      *                 addOnId: "add_on_id",
      *                 priceId: "price_id"
      *             }],
+     *         autoTopupOverrides: [{
+     *                 planCreditGrantId: "plan_credit_grant_id"
+     *             }],
      *         companyId: "company_id",
      *         creditBundles: [{
      *                 bundleId: "bundle_id",
@@ -75,6 +78,9 @@ export declare class CheckoutClient {
      *                 addOnId: "add_on_id",
      *                 priceId: "price_id"
      *             }],
+     *         autoTopupOverrides: [{
+     *                 planCreditGrantId: "plan_credit_grant_id"
+     *             }],
      *         companyId: "company_id",
      *         creditBundles: [{
      *                 bundleId: "bundle_id",

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

@@ -22,12 +22,19 @@ export declare class CompaniesClient {
      *
      * @example
      *     await client.companies.listCompanies({
+     *         creditTypeIds: ["credit_type_ids"],
+     *         hasScheduledDowngrade: true,
+     *         ids: ["ids"],
      *         monetizedSubscriptions: true,
      *         planId: "plan_id",
+     *         planIds: ["plan_ids"],
      *         planVersionId: "plan_version_id",
+     *         planVersionIds: ["plan_version_ids"],
      *         q: "q",
      *         sortOrderColumn: "sort_order_column",
      *         sortOrderDirection: "asc",
+     *         subscriptionStatuses: ["active"],
+     *         subscriptionTypes: ["free"],
      *         withEntitlementFor: "with_entitlement_for",
      *         withoutFeatureOverrideFor: "without_feature_override_for",
      *         withoutPlan: true,
@@ -103,12 +110,19 @@ export declare class CompaniesClient {
      *
      * @example
      *     await client.companies.countCompanies({
+     *         creditTypeIds: ["credit_type_ids"],
+     *         hasScheduledDowngrade: true,
+     *         ids: ["ids"],
      *         monetizedSubscriptions: true,
      *         planId: "plan_id",
+     *         planIds: ["plan_ids"],
      *         planVersionId: "plan_version_id",
+     *         planVersionIds: ["plan_version_ids"],
      *         q: "q",
      *         sortOrderColumn: "sort_order_column",
      *         sortOrderDirection: "asc",
+     *         subscriptionStatuses: ["active"],
+     *         subscriptionTypes: ["free"],
      *         withEntitlementFor: "with_entitlement_for",
      *         withoutFeatureOverrideFor: "without_feature_override_for",
      *         withoutPlan: true,
@@ -248,6 +262,7 @@ export declare class CompaniesClient {
      * @example
      *     await client.companies.getActiveCompanySubscription({
      *         companyId: "company_id",
+     *         companyIds: ["company_ids"],
      *         limit: 1000000,
      *         offset: 1000000
      *     })
@@ -287,6 +302,7 @@ export declare class CompaniesClient {
      * @example
      *     await client.companies.listEntityKeyDefinitions({
      *         entityType: "company",
+     *         ids: ["ids"],
      *         q: "q",
      *         limit: 1000000,
      *         offset: 1000000
@@ -307,6 +323,7 @@ export declare class CompaniesClient {
      * @example
      *     await client.companies.countEntityKeyDefinitions({
      *         entityType: "company",
+     *         ids: ["ids"],
      *         q: "q",
      *         limit: 1000000,
      *         offset: 1000000
@@ -327,8 +344,10 @@ export declare class CompaniesClient {
      * @example
      *     await client.companies.listEntityTraitDefinitions({
      *         entityType: "company",
+     *         ids: ["ids"],
      *         q: "q",
      *         traitType: "boolean",
+     *         traitTypes: ["boolean"],
      *         limit: 1000000,
      *         offset: 1000000
      *     })
@@ -399,8 +418,10 @@ export declare class CompaniesClient {
      * @example
      *     await client.companies.countEntityTraitDefinitions({
      *         entityType: "company",
+     *         ids: ["ids"],
      *         q: "q",
      *         traitType: "boolean",
+     *         traitTypes: ["boolean"],
      *         limit: 1000000,
      *         offset: 1000000
      *     })
@@ -439,9 +460,11 @@ export declare class CompaniesClient {
      *
      * @example
      *     await client.companies.listPlanChanges({
-     *         action: "action",
-     *         basePlanAction: "base_plan_action",
+     *         action: "checkout",
+     *         basePlanAction: "fallback",
      *         companyId: "company_id",
+     *         companyIds: ["company_ids"],
+     *         planIds: ["plan_ids"],
      *         limit: 1000000,
      *         offset: 1000000
      *     })
@@ -474,33 +497,16 @@ export declare class CompaniesClient {
      *
      * @example
      *     await client.companies.listPlanTraits({
+     *         ids: ["ids"],
      *         planId: "plan_id",
      *         traitId: "trait_id",
+     *         traitIds: ["trait_ids"],
      *         limit: 1000000,
      *         offset: 1000000
      *     })
      */
     listPlanTraits(request?: Schematic.ListPlanTraitsRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.ListPlanTraitsResponse>;
     private __listPlanTraits;
-    /**
-     * @param {Schematic.CreatePlanTraitRequestBody} request
-     * @param {CompaniesClient.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.companies.createPlanTrait({
-     *         planId: "plan_id",
-     *         traitId: "trait_id",
-     *         traitValue: "trait_value"
-     *     })
-     */
-    createPlanTrait(request: Schematic.CreatePlanTraitRequestBody, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.CreatePlanTraitResponse>;
-    private __createPlanTrait;
     /**
      * @param {string} plan_trait_id - plan_trait_id
      * @param {CompaniesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -515,40 +521,6 @@ export declare class CompaniesClient {
      */
     getPlanTrait(plan_trait_id: string, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.GetPlanTraitResponse>;
     private __getPlanTrait;
-    /**
-     * @param {string} plan_trait_id - plan_trait_id
-     * @param {Schematic.UpdatePlanTraitRequestBody} request
-     * @param {CompaniesClient.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.companies.updatePlanTrait("plan_trait_id", {
-     *         planId: "plan_id",
-     *         traitValue: "trait_value"
-     *     })
-     */
-    updatePlanTrait(plan_trait_id: string, request: Schematic.UpdatePlanTraitRequestBody, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.UpdatePlanTraitResponse>;
-    private __updatePlanTrait;
-    /**
-     * @param {string} plan_trait_id - plan_trait_id
-     * @param {CompaniesClient.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.companies.deletePlanTrait("plan_trait_id")
-     */
-    deletePlanTrait(plan_trait_id: string, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.DeletePlanTraitResponse>;
-    private __deletePlanTrait;
     /**
      * @param {Schematic.UpdatePlanTraitBulkRequestBody} request
      * @param {CompaniesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -583,8 +555,10 @@ export declare class CompaniesClient {
      *
      * @example
      *     await client.companies.countPlanTraits({
+     *         ids: ["ids"],
      *         planId: "plan_id",
      *         traitId: "trait_id",
+     *         traitIds: ["trait_ids"],
      *         limit: 1000000,
      *         offset: 1000000
      *     })
@@ -624,6 +598,7 @@ export declare class CompaniesClient {
      * @example
      *     await client.companies.listUsers({
      *         companyId: "company_id",
+     *         ids: ["ids"],
      *         planId: "plan_id",
      *         q: "q",
      *         limit: 1000000,
@@ -693,6 +668,7 @@ export declare class CompaniesClient {
      * @example
      *     await client.companies.countUsers({
      *         companyId: "company_id",
+     *         ids: ["ids"],
      *         planId: "plan_id",
      *         q: "q",
      *         limit: 1000000,

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

@@ -2,12 +2,19 @@ import type * as Schematic from "../../../../index";
 /**
  * @example
  *     {
+ *         creditTypeIds: ["credit_type_ids"],
+ *         hasScheduledDowngrade: true,
+ *         ids: ["ids"],
  *         monetizedSubscriptions: true,
  *         planId: "plan_id",
+ *         planIds: ["plan_ids"],
  *         planVersionId: "plan_version_id",
+ *         planVersionIds: ["plan_version_ids"],
  *         q: "q",
  *         sortOrderColumn: "sort_order_column",
  *         sortOrderDirection: "asc",
+ *         subscriptionStatuses: ["active"],
+ *         subscriptionTypes: ["free"],
  *         withEntitlementFor: "with_entitlement_for",
  *         withoutFeatureOverrideFor: "without_feature_override_for",
  *         withoutPlan: true,
@@ -20,6 +27,8 @@ import type * as Schematic from "../../../../index";
 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 */
@@ -30,6 +39,8 @@ export interface CountCompaniesRequest {
     planIds?: string | string[];
     /** Filter companies by plan version ID (starts with plvr_) */
     planVersionId?: string;
+    /** Filter companies by one or more plan version IDs (each ID starts with plvr_). Takes precedence over plan_version_id when set. */
+    planVersionIds?: string | string[];
     /** Search for companies by name, keys or string traits */
     q?: string;
     /** Column to sort by (e.g. name, created_at, last_seen_at) */

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

@@ -3,6 +3,7 @@ import type * as Schematic from "../../../../index";
  * @example
  *     {
  *         entityType: "company",
+ *         ids: ["ids"],
  *         q: "q",
  *         limit: 1000000,
  *         offset: 1000000

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

@@ -3,8 +3,10 @@ import type * as Schematic from "../../../../index";
  * @example
  *     {
  *         entityType: "company",
+ *         ids: ["ids"],
  *         q: "q",
  *         traitType: "boolean",
+ *         traitTypes: ["boolean"],
  *         limit: 1000000,
  *         offset: 1000000
  *     }

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

@@ -1,8 +1,10 @@
 /**
  * @example
  *     {
+ *         ids: ["ids"],
  *         planId: "plan_id",
  *         traitId: "trait_id",
+ *         traitIds: ["trait_ids"],
  *         limit: 1000000,
  *         offset: 1000000
  *     }

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

@@ -2,6 +2,7 @@
  * @example
  *     {
  *         companyId: "company_id",
+ *         ids: ["ids"],
  *         planId: "plan_id",
  *         q: "q",
  *         limit: 1000000,

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

@@ -2,6 +2,7 @@
  * @example
  *     {
  *         companyId: "company_id",
+ *         companyIds: ["company_ids"],
  *         limit: 1000000,
  *         offset: 1000000
  *     }

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

@@ -2,12 +2,19 @@ import type * as Schematic from "../../../../index";
 /**
  * @example
  *     {
+ *         creditTypeIds: ["credit_type_ids"],
+ *         hasScheduledDowngrade: true,
+ *         ids: ["ids"],
  *         monetizedSubscriptions: true,
  *         planId: "plan_id",
+ *         planIds: ["plan_ids"],
  *         planVersionId: "plan_version_id",
+ *         planVersionIds: ["plan_version_ids"],
  *         q: "q",
  *         sortOrderColumn: "sort_order_column",
  *         sortOrderDirection: "asc",
+ *         subscriptionStatuses: ["active"],
+ *         subscriptionTypes: ["free"],
  *         withEntitlementFor: "with_entitlement_for",
  *         withoutFeatureOverrideFor: "without_feature_override_for",
  *         withoutPlan: true,
@@ -20,6 +27,8 @@ import type * as Schematic from "../../../../index";
 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 */
@@ -30,6 +39,8 @@ export interface ListCompaniesRequest {
     planIds?: string | string[];
     /** Filter companies by plan version ID (starts with plvr_) */
     planVersionId?: string;
+    /** Filter companies by one or more plan version IDs (each ID starts with plvr_). Takes precedence over plan_version_id when set. */
+    planVersionIds?: string | string[];
     /** Search for companies by name, keys or string traits */
     q?: string;
     /** Column to sort by (e.g. name, created_at, last_seen_at) */

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

@@ -3,6 +3,7 @@ import type * as Schematic from "../../../../index";
  * @example
  *     {
  *         entityType: "company",
+ *         ids: ["ids"],
  *         q: "q",
  *         limit: 1000000,
  *         offset: 1000000

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

@@ -3,8 +3,10 @@ import type * as Schematic from "../../../../index";
  * @example
  *     {
  *         entityType: "company",
+ *         ids: ["ids"],
  *         q: "q",
  *         traitType: "boolean",
+ *         traitTypes: ["boolean"],
  *         limit: 1000000,
  *         offset: 1000000
  *     }

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

@@ -1,16 +1,19 @@
+import type * as Schematic from "../../../../index";
 /**
  * @example
  *     {
- *         action: "action",
- *         basePlanAction: "base_plan_action",
+ *         action: "checkout",
+ *         basePlanAction: "fallback",
  *         companyId: "company_id",
+ *         companyIds: ["company_ids"],
+ *         planIds: ["plan_ids"],
  *         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

@@ -1,8 +1,10 @@
 /**
  * @example
  *     {
+ *         ids: ["ids"],
  *         planId: "plan_id",
  *         traitId: "trait_id",
+ *         traitIds: ["trait_ids"],
  *         limit: 1000000,
  *         offset: 1000000
  *     }

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

@@ -2,6 +2,7 @@
  * @example
  *     {
  *         companyId: "company_id",
+ *         ids: ["ids"],
  *         planId: "plan_id",
  *         q: "q",
  *         limit: 1000000,

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

@@ -4,7 +4,6 @@ export type { CountEntityTraitDefinitionsRequest } from "./CountEntityTraitDefin
 export type { CountPlanTraitsRequest } from "./CountPlanTraitsRequest";
 export type { CountUsersRequest } from "./CountUsersRequest";
 export type { CreateEntityTraitDefinitionRequestBody } from "./CreateEntityTraitDefinitionRequestBody";
-export type { CreatePlanTraitRequestBody } from "./CreatePlanTraitRequestBody";
 export type { DeleteCompanyRequest } from "./DeleteCompanyRequest";
 export type { GetActiveCompanySubscriptionRequest } from "./GetActiveCompanySubscriptionRequest";
 export type { GetEntityTraitValuesRequest } from "./GetEntityTraitValuesRequest";
@@ -20,4 +19,3 @@ export type { LookupCompanyRequest } from "./LookupCompanyRequest";
 export type { LookupUserRequest } from "./LookupUserRequest";
 export type { UpdateEntityTraitDefinitionRequestBody } from "./UpdateEntityTraitDefinitionRequestBody";
 export type { UpdatePlanTraitBulkRequestBody } from "./UpdatePlanTraitBulkRequestBody";
-export type { UpdatePlanTraitRequestBody } from "./UpdatePlanTraitRequestBody";

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) */
@@ -19,6 +21,8 @@ export interface CountCompaniesParams {
     planIds?: string[];
     /** Filter companies by plan version ID (starts with plvr_) */
     planVersionId?: string;
+    /** Filter companies by one or more plan version IDs (each ID starts with plvr_). Takes precedence over plan_version_id when set. */
+    planVersionIds?: string[];
     /** Search for companies by name, keys or string traits */
     q?: string;
     /** Column to sort by (e.g. name, created_at, last_seen_at) */

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) */
@@ -19,6 +21,8 @@ export interface ListCompaniesParams {
     planIds?: string[];
     /** Filter companies by plan version ID (starts with plvr_) */
     planVersionId?: string;
+    /** Filter companies by one or more plan version IDs (each ID starts with plvr_). Takes precedence over plan_version_id when set. */
+    planVersionIds?: string[];
     /** Search for companies by name, keys or string traits */
     q?: string;
     /** Column to sort by (e.g. name, created_at, last_seen_at) */

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

@@ -1,9 +1,10 @@
+import type * as Schematic from "../../../index";
 /**
  * Input parameters
  */
 export interface ListPlanChangesParams {
-    action?: string;
-    basePlanAction?: string;
+    action?: Schematic.PlanChangeAction;
+    basePlanAction?: Schematic.PlanChangeBasePlanAction;
     companyId?: string;
     companyIds?: string[];
     /** Page limit (default 100) */

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

@@ -9,13 +9,11 @@ export * from "./CountPlanTraitsResponse";
 export * from "./CountUsersParams";
 export * from "./CountUsersResponse";
 export * from "./CreateCompanyResponse";
-export * from "./CreatePlanTraitResponse";
 export * from "./CreateUserResponse";
 export * from "./DeleteCompanyByKeysResponse";
 export * from "./DeleteCompanyMembershipResponse";
 export * from "./DeleteCompanyParams";
 export * from "./DeleteCompanyResponse";
-export * from "./DeletePlanTraitResponse";
 export * from "./DeleteUserByKeysResponse";
 export * from "./DeleteUserResponse";
 export * from "./GetActiveCompanySubscriptionParams";
@@ -48,7 +46,6 @@ export * from "./LookupCompanyResponse";
 export * from "./LookupUserParams";
 export * from "./LookupUserResponse";
 export * from "./UpdateEntityTraitDefinitionResponse";
-export * from "./UpdatePlanTraitResponse";
 export * from "./UpdatePlanTraitsBulkResponse";
 export * from "./UpsertCompanyResponse";
 export * from "./UpsertCompanyTraitResponse";