@schematichq/schematic-typescript-node 1.5.6 → 1.5.7

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

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

@@ -9,6 +9,7 @@ export interface CustomPlanBillingResponseData {
     paidAt?: Date;
     planId: string;
     publishedAt?: Date;
+    sendInvoice: boolean;
     status: Schematic.CustomPlanBillingStatus;
     stripeInvoiceUrl?: string;
     updatedAt: Date;

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

@@ -0,0 +1,5 @@
+export declare const PlanCreditGrantScaling: {
+    readonly Fixed: "fixed";
+    readonly PerLicense: "per_license";
+};
+export type PlanCreditGrantScaling = (typeof PlanCreditGrantScaling)[keyof typeof PlanCreditGrantScaling];

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

@@ -25,6 +25,7 @@ export interface PlanCreditGrantView {
     expiryUnit?: Schematic.BillingCreditExpiryUnit;
     expiryUnitCount?: number;
     id: string;
+    licenseId?: string;
     plan?: Schematic.GenericPreviewObject;
     planId: string;
     planVersionId?: string;
@@ -34,6 +35,7 @@ export interface PlanCreditGrantView {
     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/PlanDetailResponseData.d.ts

@@ -24,8 +24,8 @@ export interface PlanDetailResponseData {
     id: string;
     includedCreditGrants?: Schematic.BillingPlanCreditGrantResponseData[];
     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/PlanGroupPlanDetailResponseData.d.ts

@@ -28,8 +28,8 @@ export interface PlanGroupPlanDetailResponseData {
     includedCreditGrants?: Schematic.BillingPlanCreditGrantResponseData[];
     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/PlanViewPublicResponseData.d.ts

@@ -29,8 +29,8 @@ export interface PlanViewPublicResponseData {
     includedCreditGrants: Schematic.PlanCreditGrantView[];
     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/TaxIdInput.d.ts

@@ -0,0 +1,5 @@
+import type * as Schematic from "../index";
+export interface TaxIdInput {
+    type: Schematic.TaxIdType;
+    value: string;
+}

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

@@ -0,0 +1,41 @@
+export declare const TaxIdType: {
+    readonly AeTrn: "ae_trn";
+    readonly AuAbn: "au_abn";
+    readonly AuArn: "au_arn";
+    readonly BrCnpj: "br_cnpj";
+    readonly BrCpf: "br_cpf";
+    readonly CaBn: "ca_bn";
+    readonly CaGstHst: "ca_gst_hst";
+    readonly CaPstBc: "ca_pst_bc";
+    readonly CaPstMb: "ca_pst_mb";
+    readonly CaPstSk: "ca_pst_sk";
+    readonly CaQst: "ca_qst";
+    readonly ChUid: "ch_uid";
+    readonly ChVat: "ch_vat";
+    readonly EuVat: "eu_vat";
+    readonly GbVat: "gb_vat";
+    readonly HkBr: "hk_br";
+    readonly IdNpwp: "id_npwp";
+    readonly IlVat: "il_vat";
+    readonly InGst: "in_gst";
+    readonly JpCn: "jp_cn";
+    readonly JpRn: "jp_rn";
+    readonly JpTrn: "jp_trn";
+    readonly KrBrn: "kr_brn";
+    readonly MxRfc: "mx_rfc";
+    readonly MyFrp: "my_frp";
+    readonly MyItn: "my_itn";
+    readonly MySst: "my_sst";
+    readonly NoVat: "no_vat";
+    readonly NzGst: "nz_gst";
+    readonly PhTin: "ph_tin";
+    readonly SaVat: "sa_vat";
+    readonly SgGst: "sg_gst";
+    readonly SgUen: "sg_uen";
+    readonly ThVat: "th_vat";
+    readonly TrTin: "tr_tin";
+    readonly TwVat: "tw_vat";
+    readonly UsEin: "us_ein";
+    readonly ZaVat: "za_vat";
+};
+export type TaxIdType = (typeof TaxIdType)[keyof typeof TaxIdType];

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

@@ -16,9 +16,13 @@ export interface UpdateBillingPlanCreditGrantRequestBody {
     expiryType?: Schematic.BillingCreditExpiryType;
     expiryUnit?: Schematic.BillingCreditExpiryUnit;
     expiryUnitCount?: number;
+    /** The license whose quantity scales this grant. Cannot be changed after creation. */
+    licenseId?: string;
     resetCadence: Schematic.BillingPlanCreditGrantResetCadence;
     resetStart: Schematic.BillingPlanCreditGrantResetStart;
     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. */
     rolloverPercentage?: number;
+    /** Whether the grant is a fixed amount per company, or issued once per license the company holds. Cannot be changed after creation. */
+    scaling?: Schematic.PlanCreditGrantScaling;
 }

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

@@ -0,0 +1,14 @@
+import type * as Schematic from "../index";
+export interface UserCreditUsageResponseData {
+    billingCreditId: string;
+    /** The display name of the credit type */
+    creditName: string;
+    /** The user's net track-driven consumption of the credit within the window (draws minus refunds) */
+    creditsUsed: number;
+    /** This row's fraction (0-1) of the company's total track-driven consumption of the credit within the window, including unattributed consumption */
+    share: number;
+    /** The user the consumption is attributed to; null for consumption from events sent without a user */
+    user?: Schematic.UserResponseData;
+    /** The user the consumption is attributed to; null for unattributed consumption */
+    userId?: string;
+}

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

@@ -0,0 +1,6 @@
+export interface UserDailyCreditPointResponseData {
+    /** The user's net credit consumption on the day */
+    creditsUsed: number;
+    /** The UTC day */
+    date: Date;
+}

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

@@ -0,0 +1,8 @@
+import type * as Schematic from "../index";
+export interface UserDailyUsagePointResponseData {
+    /** The UTC day */
+    date: Date;
+    feature?: Schematic.FeatureResponseData;
+    /** The user's usage of the feature on the day */
+    value: number;
+}

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

@@ -0,0 +1,14 @@
+import type * as Schematic from "../index";
+export interface UserFeatureUsageResponseData {
+    feature?: Schematic.FeatureResponseData;
+    /** When the user last used the feature within the window */
+    lastSeen: Date;
+    /** This row's fraction (0-1) of the company's total usage of the feature within the window, including unattributed usage */
+    share: number;
+    /** The user the usage is attributed to; null for usage from events sent without a user */
+    user?: Schematic.UserResponseData;
+    /** The user the usage is attributed to; null for unattributed usage */
+    userId?: string;
+    /** The user's usage of the feature within the window */
+    value: number;
+}

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

@@ -0,0 +1,11 @@
+import type * as Schematic from "../index";
+export interface UserUsageByCompanyResponseData {
+    /** Per-user net credit consumption within the window */
+    credits: Schematic.UserCreditUsageResponseData[];
+    /** End of the usage window (exclusive) */
+    endTime: Date;
+    /** Per-user, per-feature usage within the window; rows for a feature sum to the company total */
+    rows: Schematic.UserFeatureUsageResponseData[];
+    /** Start of the usage window */
+    startTime: Date;
+}