@schematichq/schematic-typescript-node 1.5.7 → 1.5.9

package/README.md

@@ -12,7 +12,7 @@ yarn add @schematichq/schematic-typescript-node
 pnpm add @schematichq/schematic-typescript-node
 ```
 
-2. [Issue an API key](https://docs.schematichq.com/quickstart#create-an-api-key) for the appropriate environment using the [Schematic app](https://app.schematichq.com/settings/api-keys). Be sure to capture the secret key when you issue the API key; you'll only see this key once, and this is what you'll use with schematic-typescript-node.
+2. [Issue an API key](https://docs.schematichq.com/quickstart/account-setup#2-create-your-api-keys) for the appropriate environment using the [Schematic app](https://app.schematichq.com/settings/api-keys). Be sure to capture the secret key when you issue the API key; you'll only see this key once, and this is what you'll use with schematic-typescript-node.
 
 3. Using this secret key, initialize a client in your application:
 

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

@@ -310,6 +310,34 @@ export declare class AccountsClient {
      */
     deleteEnvironment(environment_id: string, requestOptions?: AccountsClient.RequestOptions): core.HttpResponsePromise<Schematic.DeleteEnvironmentResponse>;
     private __deleteEnvironment;
+    /**
+     * @param {AccountsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schematic.UnauthorizedError}
+     * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
+     * @throws {@link Schematic.InternalServerError}
+     *
+     * @example
+     *     await client.accounts.getOnboardingState()
+     */
+    getOnboardingState(requestOptions?: AccountsClient.RequestOptions): core.HttpResponsePromise<Schematic.GetOnboardingStateResponse>;
+    private __getOnboardingState;
+    /**
+     * @param {Schematic.UpdateOnboardingStateRequestBody} request
+     * @param {AccountsClient.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.accounts.updateOnboardingState()
+     */
+    updateOnboardingState(request?: Schematic.UpdateOnboardingStateRequestBody, requestOptions?: AccountsClient.RequestOptions): core.HttpResponsePromise<Schematic.UpdateOnboardingStateResponse>;
+    private __updateOnboardingState;
     /**
      * @param {AccountsClient.RequestOptions} requestOptions - Request-specific configuration.
      *

package/dist/api/resources/accounts/client/requests/UpdateOnboardingStateRequestBody.d.ts

@@ -0,0 +1,11 @@
+import type * as Schematic from "../../../../index";
+/**
+ * @example
+ *     {}
+ */
+export interface UpdateOnboardingStateRequestBody {
+    path?: Schematic.OnboardingPath;
+    pricingPageUrl?: string;
+    track?: Schematic.OnboardingTrack;
+    websiteUrl?: string;
+}

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

@@ -9,3 +9,4 @@ export type { ListAuditLogsRequest } from "./ListAuditLogsRequest";
 export type { ListEnvironmentsRequest } from "./ListEnvironmentsRequest";
 export type { UpdateApiKeyRequestBody } from "./UpdateApiKeyRequestBody";
 export type { UpdateEnvironmentRequestBody } from "./UpdateEnvironmentRequestBody";
+export type { UpdateOnboardingStateRequestBody } from "./UpdateOnboardingStateRequestBody";

package/dist/api/resources/accounts/types/GetOnboardingStateResponse.d.ts

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

package/dist/api/resources/accounts/types/UpdateOnboardingStateResponse.d.ts

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

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

@@ -12,6 +12,7 @@ export * from "./GetAccountMemberResponse";
 export * from "./GetApiKeyResponse";
 export * from "./GetAuditLogResponse";
 export * from "./GetEnvironmentResponse";
+export * from "./GetOnboardingStateResponse";
 export * from "./GetWhoAmIResponse";
 export * from "./ListAccountMembersParams";
 export * from "./ListAccountMembersResponse";
@@ -24,3 +25,4 @@ export * from "./ListEnvironmentsResponse";
 export * from "./QuickstartResponse";
 export * from "./UpdateApiKeyResponse";
 export * from "./UpdateEnvironmentResponse";
+export * from "./UpdateOnboardingStateResponse";

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

@@ -30,6 +30,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",
@@ -118,6 +119,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",
@@ -211,7 +213,7 @@ export declare class CompaniesClient {
      *         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
@@ -228,7 +230,7 @@ export declare class CompaniesClient {
      *         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
@@ -344,6 +346,21 @@ export declare class CompaniesClient {
      */
     listEntityKeyDefinitions(request?: Schematic.ListEntityKeyDefinitionsRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.ListEntityKeyDefinitionsResponse>;
     private __listEntityKeyDefinitions;
+    /**
+     * @param {string} entity_key_definition_id - entity_key_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}
+     *
+     * @example
+     *     await client.companies.deleteEntityKeyDefinition("entity_key_definition_id")
+     */
+    deleteEntityKeyDefinition(entity_key_definition_id: string, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.DeleteEntityKeyDefinitionResponse>;
+    private __deleteEntityKeyDefinition;
     /**
      * @param {Schematic.CountEntityKeyDefinitionsRequest} request
      * @param {CompaniesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -365,6 +382,26 @@ export declare class CompaniesClient {
      */
     countEntityKeyDefinitions(request?: Schematic.CountEntityKeyDefinitionsRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.CountEntityKeyDefinitionsResponse>;
     private __countEntityKeyDefinitions;
+    /**
+     * @param {Schematic.CountEntityKeysRequest} 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.countEntityKeys({
+     *         definitionId: "definition_id",
+     *         entityType: "company",
+     *         limit: 1000000,
+     *         offset: 1000000
+     *     })
+     */
+    countEntityKeys(request?: Schematic.CountEntityKeysRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.CountEntityKeysResponse>;
+    private __countEntityKeys;
     /**
      * @param {Schematic.ListEntityTraitDefinitionsRequest} request
      * @param {CompaniesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -439,6 +476,35 @@ 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}
+     *
+     * @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}
+     *
+     * @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.
@@ -482,6 +548,26 @@ 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}
+     *
+     * @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.
@@ -498,7 +584,6 @@ export declare class CompaniesClient {
      *         basePlanAction: "fallback",
      *         companyId: "company_id",
      *         companyIds: ["company_ids"],
-     *         planIds: ["plan_ids"],
      *         limit: 1000000,
      *         offset: 1000000
      *     })

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/CountEntityKeysRequest.d.ts

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

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;
+}

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

@@ -5,5 +5,5 @@
  *     }
  */
 export interface GetBillingEntityChildSubscriptionsRequest {
-    companyId?: string;
+    companyId: string;
 }

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

@@ -5,5 +5,5 @@
  *     }
  */
 export interface GetCompanyBillingEntityRequest {
-    companyId?: string;
+    companyId: string;
 }

package/dist/api/resources/companies/client/requests/ListCompaniesRequest.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 ListCompaniesRequest {
     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/ListPlanChangesRequest.d.ts

@@ -6,7 +6,6 @@ import type * as Schematic from "../../../../index";
  *         basePlanAction: "fallback",
  *         companyId: "company_id",
  *         companyIds: ["company_ids"],
- *         planIds: ["plan_ids"],
  *         limit: 1000000,
  *         offset: 1000000
  *     }
@@ -16,7 +15,6 @@ export interface ListPlanChangesRequest {
     basePlanAction?: Schematic.PlanChangeBasePlanAction;
     companyId?: string;
     companyIds?: string | string[];
-    planIds?: string | string[];
     /** Page limit (default 100) */
     limit?: number;
     /** Page offset (default 0) */

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

@@ -1,6 +1,8 @@
 export type { CountCompaniesRequest } from "./CountCompaniesRequest";
 export type { CountEntityKeyDefinitionsRequest } from "./CountEntityKeyDefinitionsRequest";
+export type { CountEntityKeysRequest } from "./CountEntityKeysRequest";
 export type { CountEntityTraitDefinitionsRequest } from "./CountEntityTraitDefinitionsRequest";
+export type { CountEntityTraitsRequest } from "./CountEntityTraitsRequest";
 export type { CountPlanTraitsRequest } from "./CountPlanTraitsRequest";
 export type { CountUsersRequest } from "./CountUsersRequest";
 export type { CreateEntityTraitDefinitionRequestBody } from "./CreateEntityTraitDefinitionRequestBody";

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

@@ -23,6 +23,8 @@ export interface CountCompaniesParams {
     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[];
+    /** 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/types/CountEntityKeysParams.d.ts

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -23,6 +23,8 @@ export interface ListCompaniesParams {
     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[];
+    /** 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/types/ListPlanChangesParams.d.ts

@@ -11,5 +11,4 @@ export interface ListPlanChangesParams {
     limit?: number;
     /** Page offset (default 0) */
     offset?: number;
-    planIds?: string[];
 }

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

@@ -2,8 +2,12 @@ export * from "./CountCompaniesParams";
 export * from "./CountCompaniesResponse";
 export * from "./CountEntityKeyDefinitionsParams";
 export * from "./CountEntityKeyDefinitionsResponse";
+export * from "./CountEntityKeysParams";
+export * from "./CountEntityKeysResponse";
 export * from "./CountEntityTraitDefinitionsParams";
 export * from "./CountEntityTraitDefinitionsResponse";
+export * from "./CountEntityTraitsParams";
+export * from "./CountEntityTraitsResponse";
 export * from "./CountPlanTraitsParams";
 export * from "./CountPlanTraitsResponse";
 export * from "./CountUsersParams";
@@ -14,6 +18,8 @@ export * from "./DeleteCompanyByKeysResponse";
 export * from "./DeleteCompanyMembershipResponse";
 export * from "./DeleteCompanyParams";
 export * from "./DeleteCompanyResponse";
+export * from "./DeleteEntityKeyDefinitionResponse";
+export * from "./DeleteEntityTraitDefinitionResponse";
 export * from "./DeleteUserByKeysResponse";
 export * from "./DeleteUserResponse";
 export * from "./GetActiveCompanySubscriptionParams";
@@ -24,6 +30,7 @@ export * from "./GetCompanyBillingEntityParams";
 export * from "./GetCompanyBillingEntityResponse";
 export * from "./GetCompanyResponse";
 export * from "./GetEntityTraitDefinitionResponse";
+export * from "./GetEntityTraitDefinitionUsageResponse";
 export * from "./GetEntityTraitValuesParams";
 export * from "./GetEntityTraitValuesResponse";
 export * from "./GetOrCreateCompanyMembershipResponse";

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

@@ -301,7 +301,7 @@ export declare class CreditsClient {
      *         offset: 1000000
      *     })
      */
-    countCompanyGrants(request?: Schematic.CountCompanyGrantsRequest, requestOptions?: CreditsClient.RequestOptions): core.HttpResponsePromise<Schematic.CountCompanyGrantsResponse>;
+    countCompanyGrants(request: Schematic.CountCompanyGrantsRequest, requestOptions?: CreditsClient.RequestOptions): core.HttpResponsePromise<Schematic.CountCompanyGrantsResponse>;
     private __countCompanyGrants;
     /**
      * @param {Schematic.ListCompanyGrantsRequest} request
@@ -322,7 +322,7 @@ export declare class CreditsClient {
      *         offset: 1000000
      *     })
      */
-    listCompanyGrants(request?: Schematic.ListCompanyGrantsRequest, requestOptions?: CreditsClient.RequestOptions): core.HttpResponsePromise<Schematic.ListCompanyGrantsResponse>;
+    listCompanyGrants(request: Schematic.ListCompanyGrantsRequest, requestOptions?: CreditsClient.RequestOptions): core.HttpResponsePromise<Schematic.ListCompanyGrantsResponse>;
     private __listCompanyGrants;
     /**
      * @param {Schematic.CountBillingCreditsGrantsRequest} request

package/dist/api/resources/credits/client/requests/CountCompanyGrantsRequest.d.ts

@@ -10,7 +10,7 @@ import type * as Schematic from "../../../../index";
  *     }
  */
 export interface CountCompanyGrantsRequest {
-    companyId?: string;
+    companyId: string;
     order?: Schematic.CreditGrantSortOrder;
     dir?: Schematic.SortDirection;
     /** Page limit (default 100) */

package/dist/api/resources/credits/client/requests/CreateCreditBundleRequestBody.d.ts

@@ -11,6 +11,8 @@ import type * as Schematic from "../../../../index";
 export interface CreateCreditBundleRequestBody {
     bundleName: string;
     bundleType?: Schematic.BillingCreditBundleType;
+    /** Plans whose companies may purchase this bundle. Omitted or empty means the bundle is purchasable on every plan. */
+    compatiblePlanIds?: string[];
     creditId: string;
     currency: string;
     currencyPrices?: Schematic.CreditBundleCurrencyPriceRequestBody[];

package/dist/api/resources/credits/client/requests/ListCompanyGrantsRequest.d.ts

@@ -10,7 +10,7 @@ import type * as Schematic from "../../../../index";
  *     }
  */
 export interface ListCompanyGrantsRequest {
-    companyId?: string;
+    companyId: string;
     order?: Schematic.CreditGrantSortOrder;
     dir?: Schematic.SortDirection;
     /** Page limit (default 100) */

package/dist/api/resources/credits/client/requests/UpdateCreditBundleDetailsRequestBody.d.ts

@@ -8,6 +8,8 @@ import type * as Schematic from "../../../../index";
  */
 export interface UpdateCreditBundleDetailsRequestBody {
     bundleName: string;
+    /** Plans whose companies may purchase this bundle. Omitted leaves compatibility unchanged; empty resets the bundle to purchasable on every plan. */
+    compatiblePlanIds?: string[];
     currencyPrices?: Schematic.CreditBundleCurrencyPriceRequestBody[];
     expiryType?: Schematic.BillingCreditExpiryType;
     expiryUnit?: Schematic.BillingCreditExpiryUnit;

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

@@ -190,6 +190,29 @@ export declare class EntitlementsClient {
      */
     listFeatureUsage(request?: Schematic.ListFeatureUsageRequest, requestOptions?: EntitlementsClient.RequestOptions): core.HttpResponsePromise<Schematic.ListFeatureUsageResponse>;
     private __listFeatureUsage;
+    /**
+     * @param {Schematic.ListFeatureUsageHistoryRequest} request
+     * @param {EntitlementsClient.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.entitlements.listFeatureUsageHistory({
+     *         companyIds: ["company_ids"],
+     *         endTime: new Date("2024-01-15T09:30:00.000Z"),
+     *         featureIds: ["feature_ids"],
+     *         granularity: "daily",
+     *         startTime: new Date("2024-01-15T09:30:00.000Z"),
+     *         limit: 1000000,
+     *         offset: 1000000
+     *     })
+     */
+    listFeatureUsageHistory(request: Schematic.ListFeatureUsageHistoryRequest, requestOptions?: EntitlementsClient.RequestOptions): core.HttpResponsePromise<Schematic.ListFeatureUsageHistoryResponse>;
+    private __listFeatureUsageHistory;
     /**
      * @param {Schematic.GetFeatureUsageTimeSeriesRequest} request
      * @param {EntitlementsClient.RequestOptions} requestOptions - Request-specific configuration.

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

@@ -0,0 +1,29 @@
+import type * as Schematic from "../../../../index";
+/**
+ * @example
+ *     {
+ *         companyIds: ["company_ids"],
+ *         endTime: new Date("2024-01-15T09:30:00.000Z"),
+ *         featureIds: ["feature_ids"],
+ *         granularity: "daily",
+ *         startTime: new Date("2024-01-15T09:30:00.000Z"),
+ *         limit: 1000000,
+ *         offset: 1000000
+ *     }
+ */
+export interface ListFeatureUsageHistoryRequest {
+    /** Restrict to these company IDs; omit for every company in the environment */
+    companyIds?: string | string[];
+    /** Exclusive end of the window; must fall on an hour boundary */
+    endTime: Date;
+    /** Restrict to these event features; omit for every event feature in the environment. Where several features measure the same event, each is reported separately and a page may carry more rows than the requested limit */
+    featureIds?: string | string[];
+    /** Bucket the window; omit for a single total per company and feature */
+    granularity?: Schematic.TimeSeriesGranularity;
+    /** Inclusive start of the window; must fall on an hour boundary */
+    startTime: Date;
+    /** Page limit (default 100) */
+    limit?: number;
+    /** Page offset (default 0) */
+    offset?: number;
+}

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

@@ -13,6 +13,7 @@ export type { GetUserUsageByCompanyRequest } from "./GetUserUsageByCompanyReques
 export type { GetUserUsageDetailRequest } from "./GetUserUsageDetailRequest";
 export type { ListCompanyOverridesRequest } from "./ListCompanyOverridesRequest";
 export type { ListFeatureCompaniesRequest } from "./ListFeatureCompaniesRequest";
+export type { ListFeatureUsageHistoryRequest } from "./ListFeatureUsageHistoryRequest";
 export type { ListFeatureUsageRequest } from "./ListFeatureUsageRequest";
 export type { ListFeatureUsersRequest } from "./ListFeatureUsersRequest";
 export type { ListPlanEntitlementsRequest } from "./ListPlanEntitlementsRequest";

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

@@ -0,0 +1,20 @@
+import type * as Schematic from "../../../index";
+/**
+ * Input parameters
+ */
+export interface ListFeatureUsageHistoryParams {
+    /** Restrict to these company IDs; omit for every company in the environment */
+    companyIds?: string[];
+    /** Exclusive end of the window; must fall on an hour boundary */
+    endTime?: Date;
+    /** Restrict to these event features; omit for every event feature in the environment. Where several features measure the same event, each is reported separately and a page may carry more rows than the requested limit */
+    featureIds?: string[];
+    /** Bucket the window; omit for a single total per company and feature */
+    granularity?: Schematic.TimeSeriesGranularity;
+    /** Page limit (default 100) */
+    limit?: number;
+    /** Page offset (default 0) */
+    offset?: number;
+    /** Inclusive start of the window; must fall on an hour boundary */
+    startTime?: Date;
+}