@schematichq/schematic-typescript-node 1.5.8 → 1.5.10

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

@@ -19,6 +19,8 @@ export declare class CatalogsClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.catalogs.listCatalogs({
@@ -39,6 +41,8 @@ export declare class CatalogsClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.catalogs.createCatalog({
@@ -55,6 +59,8 @@ export declare class CatalogsClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.catalogs.getCatalog("catalog_id")
@@ -71,6 +77,8 @@ export declare class CatalogsClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.catalogs.updateCatalog("catalog_id")
@@ -86,6 +94,8 @@ export declare class CatalogsClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.catalogs.deleteCatalog("catalog_id")
@@ -100,6 +110,8 @@ export declare class CatalogsClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.catalogs.getConfiguration("catalog_id")
@@ -116,6 +128,8 @@ export declare class CatalogsClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.catalogs.updateConfiguration("catalog_id")
@@ -130,6 +144,8 @@ export declare class CatalogsClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.catalogs.getCreditBundlesInCatalog("catalog_id")
@@ -146,6 +162,8 @@ export declare class CatalogsClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.catalogs.addCreditBundle("catalog_id", "credit_bundle_id")
@@ -162,6 +180,8 @@ export declare class CatalogsClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.catalogs.removeCreditBundle("catalog_id", "credit_bundle_id")
@@ -176,6 +196,8 @@ export declare class CatalogsClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.catalogs.getDerivedFeatures("catalog_id")
@@ -190,6 +212,8 @@ export declare class CatalogsClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.catalogs.getPlansInCatalog("catalog_id")
@@ -206,6 +230,8 @@ export declare class CatalogsClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.catalogs.addPlan("catalog_id", "plan_id")
@@ -222,6 +248,8 @@ export declare class CatalogsClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.catalogs.removePlan("catalog_id", "plan_id")

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

@@ -19,6 +19,8 @@ export declare class CheckoutClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.checkout.internal({
@@ -58,6 +60,8 @@ export declare class CheckoutClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.checkout.getCheckoutData({
@@ -75,6 +79,8 @@ export declare class CheckoutClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.checkout.previewCheckoutInternal({
@@ -113,6 +119,8 @@ export declare class CheckoutClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.checkout.getCompanyBillingDetails("company_id")
@@ -129,6 +137,8 @@ export declare class CheckoutClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.checkout.updateCompanyBillingDetails("company_id", {
@@ -149,6 +159,8 @@ export declare class CheckoutClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.checkout.managePlan({
@@ -181,6 +193,8 @@ export declare class CheckoutClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.checkout.previewManagePlan({
@@ -213,6 +227,8 @@ export declare class CheckoutClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.checkout.cancelSubscription({
@@ -231,6 +247,8 @@ export declare class CheckoutClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.checkout.updateCustomerSubscriptionTrialEnd("subscription_id")

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

@@ -19,6 +19,8 @@ export declare class CompaniesClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.companies.listCompanies({
@@ -30,6 +32,7 @@ export declare class CompaniesClient {
      *         planIds: ["plan_ids"],
      *         planVersionId: "plan_version_id",
      *         planVersionIds: ["plan_version_ids"],
+     *         planVersionUnpublished: true,
      *         q: "q",
      *         sortOrderColumn: "sort_order_column",
      *         sortOrderDirection: "asc",
@@ -55,6 +58,8 @@ export declare class CompaniesClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.companies.upsertCompany({
@@ -73,6 +78,8 @@ export declare class CompaniesClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.companies.getCompany("company_id")
@@ -89,6 +96,8 @@ export declare class CompaniesClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.companies.deleteCompany("company_id", {
@@ -107,6 +116,8 @@ export declare class CompaniesClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.companies.countCompanies({
@@ -118,6 +129,7 @@ export declare class CompaniesClient {
      *         planIds: ["plan_ids"],
      *         planVersionId: "plan_version_id",
      *         planVersionIds: ["plan_version_ids"],
+     *         planVersionUnpublished: true,
      *         q: "q",
      *         sortOrderColumn: "sort_order_column",
      *         sortOrderDirection: "asc",
@@ -143,6 +155,8 @@ export declare class CompaniesClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.companies.createCompany({
@@ -162,6 +176,8 @@ export declare class CompaniesClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.companies.deleteCompanyByKeys({
@@ -186,6 +202,8 @@ export declare class CompaniesClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.companies.lookupCompany({
@@ -205,13 +223,15 @@ export declare class CompaniesClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.companies.getCompanyBillingEntity({
      *         companyId: "company_id"
      *     })
      */
-    getCompanyBillingEntity(request?: Schematic.GetCompanyBillingEntityRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.GetCompanyBillingEntityResponse>;
+    getCompanyBillingEntity(request: Schematic.GetCompanyBillingEntityRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.GetCompanyBillingEntityResponse>;
     private __getCompanyBillingEntity;
     /**
      * @param {Schematic.GetBillingEntityChildSubscriptionsRequest} request
@@ -222,13 +242,15 @@ export declare class CompaniesClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.companies.getBillingEntityChildSubscriptions({
      *         companyId: "company_id"
      *     })
      */
-    getBillingEntityChildSubscriptions(request?: Schematic.GetBillingEntityChildSubscriptionsRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.GetBillingEntityChildSubscriptionsResponse>;
+    getBillingEntityChildSubscriptions(request: Schematic.GetBillingEntityChildSubscriptionsRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.GetBillingEntityChildSubscriptionsResponse>;
     private __getBillingEntityChildSubscriptions;
     /**
      * @param {Schematic.ListCompanyMembershipsRequest} request
@@ -239,6 +261,8 @@ export declare class CompaniesClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.companies.listCompanyMemberships({
@@ -259,6 +283,8 @@ export declare class CompaniesClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.companies.getOrCreateCompanyMembership({
@@ -277,6 +303,8 @@ export declare class CompaniesClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.companies.deleteCompanyMembership("company_membership_id")
@@ -292,6 +320,8 @@ export declare class CompaniesClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.companies.getActiveCompanySubscription({
@@ -312,6 +342,8 @@ export declare class CompaniesClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.companies.upsertCompanyTrait({
@@ -332,6 +364,8 @@ export declare class CompaniesClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.companies.listEntityKeyDefinitions({
@@ -353,6 +387,8 @@ export declare class CompaniesClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.companies.deleteEntityKeyDefinition("entity_key_definition_id")
@@ -368,6 +404,8 @@ export declare class CompaniesClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.companies.countEntityKeyDefinitions({
@@ -389,6 +427,8 @@ export declare class CompaniesClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.companies.countEntityKeys({
@@ -409,6 +449,8 @@ export declare class CompaniesClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.companies.listEntityTraitDefinitions({
@@ -432,6 +474,8 @@ export declare class CompaniesClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.companies.getOrCreateEntityTraitDefinition({
@@ -450,6 +494,8 @@ export declare class CompaniesClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.companies.getEntityTraitDefinition("entity_trait_definition_id")
@@ -466,6 +512,8 @@ export declare class CompaniesClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.companies.updateEntityTraitDefinition("entity_trait_definition_id", {
@@ -474,6 +522,39 @@ export declare class CompaniesClient {
      */
     updateEntityTraitDefinition(entity_trait_definition_id: string, request: Schematic.UpdateEntityTraitDefinitionRequestBody, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.UpdateEntityTraitDefinitionResponse>;
     private __updateEntityTraitDefinition;
+    /**
+     * @param {string} entity_trait_definition_id - entity_trait_definition_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}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
+     *
+     * @example
+     *     await client.companies.deleteEntityTraitDefinition("entity_trait_definition_id")
+     */
+    deleteEntityTraitDefinition(entity_trait_definition_id: string, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.DeleteEntityTraitDefinitionResponse>;
+    private __deleteEntityTraitDefinition;
+    /**
+     * @param {string} entity_trait_definition_id - entity_trait_definition_id
+     * @param {CompaniesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schematic.UnauthorizedError}
+     * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
+     * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
+     *
+     * @example
+     *     await client.companies.getEntityTraitDefinitionUsage("entity_trait_definition_id")
+     */
+    getEntityTraitDefinitionUsage(entity_trait_definition_id: string, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.GetEntityTraitDefinitionUsageResponse>;
+    private __getEntityTraitDefinitionUsage;
     /**
      * @param {Schematic.CountEntityTraitDefinitionsRequest} request
      * @param {CompaniesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -483,6 +564,8 @@ export declare class CompaniesClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.companies.countEntityTraitDefinitions({
@@ -506,6 +589,8 @@ export declare class CompaniesClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.companies.getEntityTraitValues({
@@ -517,6 +602,28 @@ export declare class CompaniesClient {
      */
     getEntityTraitValues(request: Schematic.GetEntityTraitValuesRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.GetEntityTraitValuesResponse>;
     private __getEntityTraitValues;
+    /**
+     * @param {Schematic.CountEntityTraitsRequest} 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}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
+     *
+     * @example
+     *     await client.companies.countEntityTraits({
+     *         definitionId: "definition_id",
+     *         entityType: "company",
+     *         limit: 1000000,
+     *         offset: 1000000
+     *     })
+     */
+    countEntityTraits(request?: Schematic.CountEntityTraitsRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.CountEntityTraitsResponse>;
+    private __countEntityTraits;
     /**
      * @param {Schematic.ListPlanChangesRequest} request
      * @param {CompaniesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -526,6 +633,8 @@ export declare class CompaniesClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.companies.listPlanChanges({
@@ -533,7 +642,6 @@ export declare class CompaniesClient {
      *         basePlanAction: "fallback",
      *         companyId: "company_id",
      *         companyIds: ["company_ids"],
-     *         planIds: ["plan_ids"],
      *         limit: 1000000,
      *         offset: 1000000
      *     })
@@ -548,6 +656,8 @@ export declare class CompaniesClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.companies.getPlanChange("plan_change_id")
@@ -563,6 +673,8 @@ export declare class CompaniesClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.companies.listPlanTraits({
@@ -584,6 +696,8 @@ export declare class CompaniesClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.companies.getPlanTrait("plan_trait_id")
@@ -599,6 +713,8 @@ export declare class CompaniesClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.companies.updatePlanTraitsBulk({
@@ -621,6 +737,8 @@ export declare class CompaniesClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.companies.countPlanTraits({
@@ -643,6 +761,8 @@ export declare class CompaniesClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.companies.upsertUserTrait({
@@ -663,6 +783,8 @@ export declare class CompaniesClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.companies.listUsers({
@@ -685,6 +807,8 @@ export declare class CompaniesClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.companies.upsertUser({
@@ -703,6 +827,8 @@ export declare class CompaniesClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.companies.getUser("user_id")
@@ -718,6 +844,8 @@ export declare class CompaniesClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.companies.deleteUser("user_id")
@@ -733,6 +861,8 @@ export declare class CompaniesClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.companies.countUsers({
@@ -755,6 +885,8 @@ export declare class CompaniesClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.companies.createUser({
@@ -774,6 +906,8 @@ export declare class CompaniesClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.companies.deleteUserByKeys({
@@ -792,6 +926,8 @@ export declare class CompaniesClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.companies.lookupUser({

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

@@ -10,6 +10,7 @@ import type * as Schematic from "../../../../index";
  *         planIds: ["plan_ids"],
  *         planVersionId: "plan_version_id",
  *         planVersionIds: ["plan_version_ids"],
+ *         planVersionUnpublished: true,
  *         q: "q",
  *         sortOrderColumn: "sort_order_column",
  *         sortOrderDirection: "asc",
@@ -41,6 +42,8 @@ export interface CountCompaniesRequest {
     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[];
+    /** Filter companies assigned to a plan version that is no longer published, meaning the plan has since moved on to a newer version */
+    planVersionUnpublished?: boolean;
     /** 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/CountEntityTraitsRequest.d.ts

@@ -0,0 +1,18 @@
+import type * as Schematic from "../../../../index";
+/**
+ * @example
+ *     {
+ *         definitionId: "definition_id",
+ *         entityType: "company",
+ *         limit: 1000000,
+ *         offset: 1000000
+ *     }
+ */
+export interface CountEntityTraitsRequest {
+    definitionId?: string;
+    entityType?: Schematic.EntityType;
+    /** Page limit (default 100) */
+    limit?: number;
+    /** Page offset (default 0) */
+    offset?: number;
+}