@schematichq/schematic-typescript-node 1.5.6 → 1.5.8

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

@@ -8,5 +8,6 @@ export interface CreateApiKeyRequestBody {
     description?: string;
     environmentId?: string;
     name: string;
+    rateLimitPercent?: number;
     readonly?: boolean;
 }

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

@@ -5,4 +5,5 @@
 export interface UpdateApiKeyRequestBody {
     description?: string;
     name?: string;
+    rateLimitPercent?: number;
 }

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

@@ -319,6 +319,7 @@ export declare class BillingClient {
      *         forTrialExpiryPlan: true,
      *         ids: ["ids"],
      *         interval: "interval",
+     *         intervalCount: 1000000,
      *         isActive: true,
      *         planVersionId: "plan_version_id",
      *         price: 1000000,
@@ -395,6 +396,7 @@ export declare class BillingClient {
      *         forTrialExpiryPlan: true,
      *         ids: ["ids"],
      *         interval: "interval",
+     *         intervalCount: 1000000,
      *         isActive: true,
      *         planVersionId: "plan_version_id",
      *         price: 1000000,

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

@@ -7,6 +7,7 @@ import type * as Schematic from "../../../../index";
  *         forTrialExpiryPlan: true,
  *         ids: ["ids"],
  *         interval: "interval",
+ *         intervalCount: 1000000,
  *         isActive: true,
  *         planVersionId: "plan_version_id",
  *         price: 1000000,
@@ -30,6 +31,8 @@ export interface ListBillingPricesRequest {
     forTrialExpiryPlan?: boolean;
     ids?: string | string[];
     interval?: string;
+    /** Filter for prices billed every N intervals; combine with interval (e.g. interval=month, interval_count=3 for quarterly) */
+    intervalCount?: number;
     /** Filter for active prices on active products (defaults to true if not specified) */
     isActive?: boolean;
     /** Filter for prices belonging to a specific plan version (e.g. the latest published version) */

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

@@ -7,6 +7,7 @@ import type * as Schematic from "../../../../index";
  *         forTrialExpiryPlan: true,
  *         ids: ["ids"],
  *         interval: "interval",
+ *         intervalCount: 1000000,
  *         isActive: true,
  *         planVersionId: "plan_version_id",
  *         price: 1000000,
@@ -30,6 +31,8 @@ export interface ListBillingProductPricesRequest {
     forTrialExpiryPlan?: boolean;
     ids?: string | string[];
     interval?: string;
+    /** Filter for prices billed every N intervals; combine with interval (e.g. interval=month, interval_count=3 for quarterly) */
+    intervalCount?: number;
     /** Filter for active prices on active products (defaults to true if not specified) */
     isActive?: boolean;
     /** Filter for prices belonging to a specific plan version (e.g. the latest published version) */

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

@@ -11,6 +11,8 @@ export interface ListBillingPricesParams {
     forTrialExpiryPlan?: boolean;
     ids?: string[];
     interval?: string;
+    /** Filter for prices billed every N intervals; combine with interval (e.g. interval=month, interval_count=3 for quarterly) */
+    intervalCount?: number;
     /** Filter for active prices on active products (defaults to true if not specified) */
     isActive?: boolean;
     /** Page limit (default 100) */

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

@@ -11,6 +11,8 @@ export interface ListBillingProductPricesParams {
     forTrialExpiryPlan?: boolean;
     ids?: string[];
     interval?: string;
+    /** Filter for prices billed every N intervals; combine with interval (e.g. interval=month, interval_count=3 for quarterly) */
+    intervalCount?: number;
     /** Filter for active prices on active products (defaults to true if not specified) */
     isActive?: boolean;
     /** Page limit (default 100) */

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

@@ -42,7 +42,6 @@ export declare class CatalogsClient {
      *
      * @example
      *     await client.catalogs.createCatalog({
-     *         isDefault: true,
      *         name: "name"
      *     })
      */

package/dist/api/resources/catalogs/client/requests/CreateCatalogRequestBody.d.ts

@@ -1,12 +1,10 @@
 /**
  * @example
  *     {
- *         isDefault: true,
  *         name: "name"
  *     }
  */
 export interface CreateCatalogRequestBody {
     description?: string;
-    isDefault: boolean;
     name: string;
 }

package/dist/api/resources/checkout/client/requests/UpdateCompanyBillingDetailsRequestBody.d.ts

@@ -12,5 +12,6 @@ export interface UpdateCompanyBillingDetailsRequestBody {
     address?: Schematic.CustomerBillingAddress;
     email?: string;
     phone?: string;
+    taxId?: Schematic.TaxIdInput;
     values: Schematic.CheckoutFieldValue[];
 }

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

@@ -344,6 +344,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 +380,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.

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

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

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

@@ -2,6 +2,8 @@ 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 "./CountPlanTraitsParams";
@@ -14,6 +16,7 @@ export * from "./DeleteCompanyByKeysResponse";
 export * from "./DeleteCompanyMembershipResponse";
 export * from "./DeleteCompanyParams";
 export * from "./DeleteCompanyResponse";
+export * from "./DeleteEntityKeyDefinitionResponse";
 export * from "./DeleteUserByKeysResponse";
 export * from "./DeleteUserResponse";
 export * from "./GetActiveCompanySubscriptionParams";

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

@@ -451,4 +451,42 @@ export declare class EntitlementsClient {
      */
     getFeatureUsageByCompany(request: Schematic.GetFeatureUsageByCompanyRequest, requestOptions?: EntitlementsClient.RequestOptions): core.HttpResponsePromise<Schematic.GetFeatureUsageByCompanyResponse>;
     private __getFeatureUsageByCompany;
+    /**
+     * @param {Schematic.GetUserUsageByCompanyRequest} request
+     * @param {EntitlementsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schematic.UnauthorizedError}
+     * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
+     * @throws {@link Schematic.InternalServerError}
+     *
+     * @example
+     *     await client.entitlements.getUserUsageByCompany({
+     *         companyId: "company_id",
+     *         endTime: new Date("2024-01-15T09:30:00.000Z"),
+     *         featureId: "feature_id",
+     *         startTime: new Date("2024-01-15T09:30:00.000Z")
+     *     })
+     */
+    getUserUsageByCompany(request: Schematic.GetUserUsageByCompanyRequest, requestOptions?: EntitlementsClient.RequestOptions): core.HttpResponsePromise<Schematic.GetUserUsageByCompanyResponse>;
+    private __getUserUsageByCompany;
+    /**
+     * @param {Schematic.GetUserUsageDetailRequest} request
+     * @param {EntitlementsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schematic.UnauthorizedError}
+     * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
+     * @throws {@link Schematic.InternalServerError}
+     *
+     * @example
+     *     await client.entitlements.getUserUsageDetail({
+     *         companyId: "company_id",
+     *         endTime: new Date("2024-01-15T09:30:00.000Z"),
+     *         startTime: new Date("2024-01-15T09:30:00.000Z"),
+     *         userId: "user_id"
+     *     })
+     */
+    getUserUsageDetail(request: Schematic.GetUserUsageDetailRequest, requestOptions?: EntitlementsClient.RequestOptions): core.HttpResponsePromise<Schematic.GetUserUsageDetailResponse>;
+    private __getUserUsageDetail;
 }

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

@@ -0,0 +1,19 @@
+/**
+ * @example
+ *     {
+ *         companyId: "company_id",
+ *         endTime: new Date("2024-01-15T09:30:00.000Z"),
+ *         featureId: "feature_id",
+ *         startTime: new Date("2024-01-15T09:30:00.000Z")
+ *     }
+ */
+export interface GetUserUsageByCompanyRequest {
+    /** Company to break usage down for */
+    companyId: string;
+    /** End of the usage window (exclusive); defaults to now */
+    endTime?: Date;
+    /** Restrict to a single event-based feature */
+    featureId?: string;
+    /** Start of the usage window; defaults to 30 days before the end */
+    startTime?: Date;
+}

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

@@ -0,0 +1,19 @@
+/**
+ * @example
+ *     {
+ *         companyId: "company_id",
+ *         endTime: new Date("2024-01-15T09:30:00.000Z"),
+ *         startTime: new Date("2024-01-15T09:30:00.000Z"),
+ *         userId: "user_id"
+ *     }
+ */
+export interface GetUserUsageDetailRequest {
+    /** Company the user belongs to */
+    companyId: string;
+    /** End of the usage window (exclusive); defaults to now */
+    endTime?: Date;
+    /** Start of the usage window; defaults to 30 days before the end */
+    startTime?: Date;
+    /** User to break usage down for */
+    userId: string;
+}

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

@@ -9,6 +9,8 @@ export type { CreatePlanEntitlementRequestBody } from "./CreatePlanEntitlementRe
 export type { DuplicatePlanEntitlementsRequestBody } from "./DuplicatePlanEntitlementsRequestBody";
 export type { GetFeatureUsageByCompanyRequest } from "./GetFeatureUsageByCompanyRequest";
 export type { GetFeatureUsageTimeSeriesRequest } from "./GetFeatureUsageTimeSeriesRequest";
+export type { GetUserUsageByCompanyRequest } from "./GetUserUsageByCompanyRequest";
+export type { GetUserUsageDetailRequest } from "./GetUserUsageDetailRequest";
 export type { ListCompanyOverridesRequest } from "./ListCompanyOverridesRequest";
 export type { ListFeatureCompaniesRequest } from "./ListFeatureCompaniesRequest";
 export type { ListFeatureUsageRequest } from "./ListFeatureUsageRequest";

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

@@ -0,0 +1,13 @@
+/**
+ * Input parameters
+ */
+export interface GetUserUsageByCompanyParams {
+    /** Company to break usage down for */
+    companyId?: string;
+    /** End of the usage window (exclusive); defaults to now */
+    endTime?: Date;
+    /** Restrict to a single event-based feature */
+    featureId?: string;
+    /** Start of the usage window; defaults to 30 days before the end */
+    startTime?: Date;
+}

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

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

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

@@ -0,0 +1,13 @@
+/**
+ * Input parameters
+ */
+export interface GetUserUsageDetailParams {
+    /** Company the user belongs to */
+    companyId?: string;
+    /** End of the usage window (exclusive); defaults to now */
+    endTime?: Date;
+    /** Start of the usage window; defaults to 30 days before the end */
+    startTime?: Date;
+    /** User to break usage down for */
+    userId?: string;
+}

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

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

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

@@ -19,6 +19,10 @@ export * from "./GetFeatureUsageByCompanyResponse";
 export * from "./GetFeatureUsageTimeSeriesParams";
 export * from "./GetFeatureUsageTimeSeriesResponse";
 export * from "./GetPlanEntitlementResponse";
+export * from "./GetUserUsageByCompanyParams";
+export * from "./GetUserUsageByCompanyResponse";
+export * from "./GetUserUsageDetailParams";
+export * from "./GetUserUsageDetailResponse";
 export * from "./ListCompanyOverridesParams";
 export * from "./ListCompanyOverridesResponse";
 export * from "./ListFeatureCompaniesParams";

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

@@ -8,9 +8,15 @@ import type * as Schematic from "../../../../index";
  */
 export interface PublishPlanVersionRequestBody {
     activationStrategy?: Schematic.CustomPlanActivationStrategy;
+    address?: Schematic.CustomerBillingAddress;
     couponExternalId?: string;
+    customFieldValues?: Schematic.CheckoutFieldValue[];
     customerEmail?: string;
     daysUntilDue?: number;
     excludedCompanyIds: string[];
     migrationStrategy: Schematic.PlanVersionMigrationStrategy;
+    phone?: string;
+    /** Whether Stripe emails the invoice when it is finalized. Defaults to true. */
+    sendInvoice?: boolean;
+    taxId?: Schematic.TaxIdInput;
 }

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

@@ -9,4 +9,6 @@ export interface RetryCustomPlanBillingRequestBody {
     activationStrategy?: Schematic.CustomPlanActivationStrategy;
     customerEmail: string;
     daysUntilDue?: number;
+    /** Whether Stripe emails the invoice when it is finalized. Defaults to true. */
+    sendInvoice?: boolean;
 }

package/dist/api/types/ApiKeyCreateResponseData.d.ts

@@ -8,6 +8,7 @@ export interface ApiKeyCreateResponseData {
     integration?: Schematic.ApiKeyIntegrationResponseData;
     lastUsedAt?: Date;
     name: string;
+    rateLimitPercent?: number;
     readonly: boolean;
     scopes: Schematic.ApiKeyScope[];
     secret: string;

package/dist/api/types/ApiKeyResponseData.d.ts

@@ -8,6 +8,7 @@ export interface ApiKeyResponseData {
     integration?: Schematic.ApiKeyIntegrationResponseData;
     lastUsedAt?: Date;
     name: string;
+    rateLimitPercent?: number;
     readonly: boolean;
     scopes: Schematic.ApiKeyScope[];
     updatedAt: Date;

package/dist/api/types/BillingCreditView.d.ts

@@ -18,7 +18,7 @@ export interface BillingCreditView {
     price?: Schematic.BillingPriceView;
     pricePerUnit?: number;
     pricePerUnitDecimal?: string;
-    product?: Schematic.BillingProductResponseData;
+    product?: Schematic.BillingProductRecordResponseData;
     singularName?: string;
     updatedAt: Date;
 }

package/dist/api/types/BillingPlanCreditGrantResponseData.d.ts

@@ -28,6 +28,8 @@ export interface BillingPlanCreditGrantResponseData {
     expiryUnit?: Schematic.BillingCreditExpiryUnit;
     expiryUnitCount?: number;
     id: string;
+    /** The license whose quantity scales this grant. Set only when scaling is per_license. */
+    licenseId?: string;
     plan?: Schematic.PreviewObjectResponseData;
     planId: string;
     /** Use plan.name from the nested plan object instead */
@@ -38,5 +40,7 @@ export interface BillingPlanCreditGrantResponseData {
     resetType?: Schematic.BillingPlanCreditGrantResetType;
     /** Percentage of unused credits that carry over when this grant resets. Only meaningful when reset_type is plan_period. */
     rolloverPercentage: number;
+    /** Whether the grant is a fixed amount per company, or issued once per license the company holds. */
+    scaling: Schematic.PlanCreditGrantScaling;
     updatedAt: Date;
 }

package/dist/api/types/BillingProductRecordResponseData.d.ts

@@ -0,0 +1,12 @@
+import type * as Schematic from "../index";
+export interface BillingProductRecordResponseData {
+    accountId: string;
+    createdAt: Date;
+    environmentId: string;
+    externalId: string;
+    id: string;
+    isActive: boolean;
+    name: string;
+    providerType: Schematic.BillingProviderType;
+    updatedAt: Date;
+}

package/dist/api/types/CatalogConfigOrderedEntitlement.d.ts

@@ -1,4 +1,4 @@
 export interface CatalogConfigOrderedEntitlement {
-    planEntitlementId: string;
+    featureId: string;
     visible?: boolean;
 }

package/dist/api/types/CatalogConfigOrderedEntitlementResponseData.d.ts

@@ -1,4 +1,4 @@
 export interface CatalogConfigOrderedEntitlementResponseData {
-    planEntitlementId: string;
+    featureId: string;
     visible: boolean;
 }

package/dist/api/types/CatalogResponseData.d.ts

@@ -6,7 +6,6 @@ export interface CatalogResponseData {
     customPlanPriceText?: string;
     customPlansVisible: boolean;
     description?: string;
-    environmentId: string;
     id: string;
     isDefault: boolean;
     name: string;

package/dist/api/types/CompanyBillingDetailsResponseData.d.ts

@@ -5,4 +5,5 @@ export interface CompanyBillingDetailsResponseData {
     customFields: Schematic.CheckoutFieldWithValue[];
     email?: string;
     phone?: string;
+    taxIds: Schematic.CompanyTaxIdView[];
 }

package/dist/api/types/CompanyBillingDetailsView.d.ts

@@ -5,4 +5,5 @@ export interface CompanyBillingDetailsView {
     customFields: Schematic.CheckoutFieldWithValue[];
     email?: string;
     phone?: string;
+    taxIds: Schematic.CompanyTaxIdView[];
 }

package/dist/api/types/CompanyFeatureUsageExportMetadata.d.ts

@@ -1,10 +1,11 @@
+import type * as Schematic from "../index";
 export interface CompanyFeatureUsageExportMetadata {
     /** Restrict the export to these Schematic company IDs (starting with 'comp_') */
     companyIds?: string[];
     /** Restrict the export to companies with these billing credit type IDs */
     creditTypeIds?: string[];
-    /** Schematic feature IDs (starting with 'feat_') to include as usage columns; at least one is required */
-    featureIds: string[];
+    /** Schematic feature IDs (starting with 'feat_') to include as usage columns; empty means no usage columns */
+    featureIds?: string[];
     /** Restrict the export to companies that do (or do not) have a scheduled downgrade */
     hasScheduledDowngrade?: boolean;
     /** Restrict the export to companies with (or without) a monetized subscription */
@@ -19,10 +20,16 @@ export interface CompanyFeatureUsageExportMetadata {
     planVersionId?: string;
     /** Free-text search over company name and keys */
     q?: string;
+    /** Column to sort the exported rows by (e.g. name, created_at, plan); defaults to name */
+    sortOrderColumn?: string;
+    /** Direction to sort the exported rows by; defaults to asc */
+    sortOrderDirection?: Schematic.CompanyFeatureUsageExportMetadataSortOrderDirection;
     /** Restrict the export to companies whose subscription has one of these statuses */
     subscriptionStatuses?: string[];
     /** Restrict the export to companies whose subscription has one of these types */
     subscriptionTypes?: string[];
+    /** Company columns to include, mirroring the companies list; omit to include the plan column only */
+    visibleColumns?: Schematic.CompanyFeatureUsageExportMetadataVisibleColumnsItem[];
     /** Restrict the export to companies that have an entitlement for this feature ID */
     withEntitlementFor?: string;
     /** Restrict the export to companies with a subscription */

package/dist/api/types/CompanyFeatureUsageExportMetadataSortOrderDirection.d.ts

@@ -0,0 +1,6 @@
+/** Direction to sort the exported rows by; defaults to asc */
+export declare const CompanyFeatureUsageExportMetadataSortOrderDirection: {
+    readonly Asc: "asc";
+    readonly Desc: "desc";
+};
+export type CompanyFeatureUsageExportMetadataSortOrderDirection = (typeof CompanyFeatureUsageExportMetadataSortOrderDirection)[keyof typeof CompanyFeatureUsageExportMetadataSortOrderDirection];

package/dist/api/types/CompanyFeatureUsageExportMetadataVisibleColumnsItem.d.ts

@@ -0,0 +1,7 @@
+export declare const CompanyFeatureUsageExportMetadataVisibleColumnsItem: {
+    readonly Plan: "plan";
+    readonly Subscription: "subscription";
+    readonly Users: "users";
+    readonly LastSeenAt: "last_seen_at";
+};
+export type CompanyFeatureUsageExportMetadataVisibleColumnsItem = (typeof CompanyFeatureUsageExportMetadataVisibleColumnsItem)[keyof typeof CompanyFeatureUsageExportMetadataVisibleColumnsItem];

package/dist/api/types/CompanyPlanCreditGrantView.d.ts

@@ -28,6 +28,7 @@ export interface CompanyPlanCreditGrantView {
     expiryUnit?: Schematic.BillingCreditExpiryUnit;
     expiryUnitCount?: number;
     id: string;
+    licenseId?: string;
     plan?: Schematic.GenericPreviewObject;
     planId: string;
     planVersionId?: string;
@@ -37,6 +38,7 @@ export interface CompanyPlanCreditGrantView {
     resetStart?: Schematic.BillingPlanCreditGrantResetStart;
     resetType: Schematic.BillingPlanCreditGrantResetType;
     rolloverPercentage: number;
+    scaling: Schematic.PlanCreditGrantScaling;
     /** Deprecated field, will be removed in the future. Use Credit.SingularName instead. */
     singularName?: string;
     updatedAt: Date;

package/dist/api/types/CompanyPlanDetailResponseData.d.ts

@@ -32,8 +32,8 @@ export interface CompanyPlanDetailResponseData {
     invalidReason?: Schematic.CompanyPlanInvalidReason;
     isCustom: boolean;
     isDefault: boolean;
-    /** Deprecated: Use BillingStrategy instead */
-    isFree: boolean;
+    /** Deprecated: reports the plan's charge type, not its price. Read the plan's prices to tell whether it costs anything, or billing_strategy to tell how it is billed. */
+    isFree?: boolean;
     isTrialable: boolean;
     monthlyPrice?: Schematic.BillingPriceResponseData;
     name: string;

package/dist/api/types/CompanyTaxIdView.d.ts

@@ -0,0 +1,7 @@
+export interface CompanyTaxIdView {
+    country: string;
+    id: string;
+    type: string;
+    value: string;
+    verificationStatus?: string;
+}

package/dist/api/types/ComponentCheckoutSettings.d.ts

@@ -1,6 +1,8 @@
+import type * as Schematic from "../index";
 export interface ComponentCheckoutSettings {
     collectAddress: boolean;
     collectEmail: boolean;
     collectPhone: boolean;
+    prorationBehavior: Schematic.ProrationBehavior;
     taxCollectionEnabled: boolean;
 }

package/dist/api/types/CreateBillingPlanCreditGrantRequestBody.d.ts

@@ -17,6 +17,8 @@ export interface CreateBillingPlanCreditGrantRequestBody {
     expiryType?: Schematic.BillingCreditExpiryType;
     expiryUnit?: Schematic.BillingCreditExpiryUnit;
     expiryUnitCount?: number;
+    /** The license whose quantity scales this grant. Required when scaling is per_license. */
+    licenseId?: string;
     planId: string;
     planVersionId?: string;
     resetCadence: Schematic.BillingPlanCreditGrantResetCadence;
@@ -24,4 +26,6 @@ export interface CreateBillingPlanCreditGrantRequestBody {
     resetType?: Schematic.BillingPlanCreditGrantResetType;
     /** Percentage of unused credits that carry over when this grant resets. Only applies when reset_type is plan_period. Rolled-over credits expire at the next reset and are not rolled again. Defaults to 0. */
     rolloverPercentage?: number;
+    /** Whether the grant is a fixed amount per company, or issued once per license the company holds. Defaults to fixed. */
+    scaling?: Schematic.PlanCreditGrantScaling;
 }