@schematichq/schematic-typescript-node 1.5.5 → 1.5.7

package/dist/api/resources/licenses/types/ListLicensesResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Schematic from "../../../index";
+export interface ListLicensesResponse {
+    data: Schematic.LicenseResponseData[];
+    /** Input parameters */
+    params: Schematic.ListLicensesParams;
+}

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

@@ -0,0 +1,5 @@
+export * from "./CountLicensesParams";
+export * from "./CountLicensesResponse";
+export * from "./GetSingleLicenseResponse";
+export * from "./ListLicensesParams";
+export * from "./ListLicensesResponse";

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

@@ -162,4 +162,24 @@ export declare class PlanmigrationsClient {
      */
     countMigrations(request?: Schematic.CountMigrationsRequest, requestOptions?: PlanmigrationsClient.RequestOptions): core.HttpResponsePromise<Schematic.CountMigrationsResponse>;
     private __countMigrations;
+    /**
+     * @param {Schematic.PreviewMigrationRequestBody} request
+     * @param {PlanmigrationsClient.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.planmigrations.previewMigration({
+     *         companyIds: ["company_ids"],
+     *         planId: "plan_id",
+     *         planVersionIdTo: "plan_version_id_to",
+     *         targetPlanType: "plan"
+     *     })
+     */
+    previewMigration(request: Schematic.PreviewMigrationRequestBody, requestOptions?: PlanmigrationsClient.RequestOptions): core.HttpResponsePromise<Schematic.PreviewMigrationResponse>;
+    private __previewMigration;
 }

package/dist/api/resources/planmigrations/client/requests/PreviewMigrationRequestBody.d.ts

@@ -0,0 +1,16 @@
+import type * as Schematic from "../../../../index";
+/**
+ * @example
+ *     {
+ *         companyIds: ["company_ids"],
+ *         planId: "plan_id",
+ *         planVersionIdTo: "plan_version_id_to",
+ *         targetPlanType: "plan"
+ *     }
+ */
+export interface PreviewMigrationRequestBody {
+    companyIds: string[];
+    planId: string;
+    planVersionIdTo: string;
+    targetPlanType: Schematic.PlanType;
+}

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

@@ -3,4 +3,5 @@ export type { CountMigrationsRequest } from "./CountMigrationsRequest";
 export type { CreateMigrationInput } from "./CreateMigrationInput";
 export type { ListCompanyMigrationsRequest } from "./ListCompanyMigrationsRequest";
 export type { ListMigrationsRequest } from "./ListMigrationsRequest";
+export type { PreviewMigrationRequestBody } from "./PreviewMigrationRequestBody";
 export type { RetryMigrationRequestBody } from "./RetryMigrationRequestBody";

package/dist/api/resources/planmigrations/types/PreviewMigrationResponse.d.ts

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

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

@@ -8,5 +8,6 @@ export * from "./ListCompanyMigrationsParams";
 export * from "./ListCompanyMigrationsResponse";
 export * from "./ListMigrationsParams";
 export * from "./ListMigrationsResponse";
+export * from "./PreviewMigrationResponse";
 export * from "./RetryCompanyMigrationResponse";
 export * from "./RetryMigrationResponse";

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

@@ -2,6 +2,7 @@ export declare const BillingCreditGrantZeroedOutReason: {
     readonly CustomerArchived: "customer_archived";
     readonly Expired: "expired";
     readonly IntegrationUninstalled: "integration_uninstalled";
+    readonly LicenseRetired: "license_retired";
     readonly Manual: "manual";
     readonly PlanChange: "plan_change";
     readonly PlanPeriodReset: "plan_period_reset";

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

@@ -0,0 +1,8 @@
+export interface CompanyBillingAddressView {
+    city: string;
+    country: string;
+    line1: string;
+    line2: string;
+    postalCode: string;
+    state: string;
+}

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

@@ -0,0 +1,5 @@
+export interface CompanyBillingCheckoutSettings {
+    collectAddress: boolean;
+    collectEmail: boolean;
+    collectPhone: boolean;
+}

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

@@ -0,0 +1,9 @@
+import type * as Schematic from "../index";
+export interface CompanyBillingDetailsResponseData {
+    address?: Schematic.CompanyBillingAddressView;
+    checkoutSettings: Schematic.CompanyBillingCheckoutSettings;
+    customFields: Schematic.CheckoutFieldWithValue[];
+    email?: string;
+    phone?: string;
+    taxIds: Schematic.CompanyTaxIdView[];
+}

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

@@ -0,0 +1,9 @@
+import type * as Schematic from "../index";
+export interface CompanyBillingDetailsView {
+    address?: Schematic.CompanyBillingAddressView;
+    checkoutSettings: Schematic.CompanyBillingCheckoutSettings;
+    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/CreateEntitlementInBundleRequestBody.d.ts

@@ -31,6 +31,7 @@ export interface CreateEntitlementInBundleRequestBody {
     valueNumeric?: number;
     valueTraitId?: string;
     valueType: Schematic.EntitlementValueType;
+    warningTiers?: Schematic.WarningTierRequestBody[];
     yearlyMeteredPriceId?: string;
     yearlyPriceTiers?: Schematic.CreatePriceTierRequestBody[];
     yearlyUnitPrice?: number;

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

@@ -0,0 +1,7 @@
+import type * as Schematic from "../index";
+export interface CreditsAutoTopupSuccess {
+    company?: Schematic.CreditsAutoTopupCompanySummary;
+    credit?: Schematic.CreditsAutoTopupCreditSummary;
+    grantId: string;
+    quantity: number;
+}

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

@@ -0,0 +1,9 @@
+import type * as Schematic from "../index";
+export interface CreditsCreditPurchaseSuccess {
+    bundleId: string;
+    bundleName: string;
+    company?: Schematic.CreditsWebhookCompanySummary;
+    credit?: Schematic.CreditsWebhookCreditSummary;
+    grantIds: string[];
+    quantity: number;
+}

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

@@ -0,0 +1,4 @@
+export interface CreditsWebhookCompanySummary {
+    id: string;
+    name: string;
+}

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

@@ -0,0 +1,4 @@
+export interface CreditsWebhookCreditSummary {
+    id: string;
+    name: string;
+}

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

@@ -0,0 +1,8 @@
+export interface CustomerBillingAddress {
+    city: string;
+    country: string;
+    line1: string;
+    line2: string;
+    postalCode: string;
+    state: string;
+}

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

@@ -1,6 +1,8 @@
 import type * as Schematic from "../index";
 export interface FeatureDetailResponseData {
     billingLinkedResource?: Schematic.BillingLinkedResourceResponseData;
+    /** The billing provider product that sells this feature in the current environment. Set for license features once they have been priced in a plan; a feature priced in several environments has a different product in each. */
+    billingProduct?: Schematic.BillingProductResponseData;
     createdAt: Date;
     description: string;
     eventSubtype?: string;
@@ -9,6 +11,8 @@ export interface FeatureDetailResponseData {
     flags: Schematic.FlagDetailResponseData[];
     icon: string;
     id: string;
+    /** The license sold through this feature. Set only on features of type license, and created automatically with them. */
+    licenseId?: string;
     lifecyclePhase?: Schematic.FeatureLifecyclePhase;
     maintainer?: Schematic.AccountMemberResponseData;
     maintainerAccountMemberId?: string;
@@ -19,4 +23,6 @@ export interface FeatureDetailResponseData {
     trait?: Schematic.EntityTraitDefinitionResponseData;
     traitId?: string;
     updatedAt: Date;
+    /** Set when the feature carries a pay-in-advance quantity. Provisioned lazily for other feature types, and at creation for license features. */
+    usageLimitTraitId?: string;
 }

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

@@ -9,6 +9,8 @@ export interface FeatureInPlanResponseData {
     flags: Schematic.FlagInPlanResponseData[];
     icon: string;
     id: string;
+    /** The license sold through this feature. Set only on features of type license, and created automatically with them. */
+    licenseId?: string;
     lifecyclePhase?: Schematic.FeatureLifecyclePhase;
     maintainerAccountMemberId?: string;
     name: string;
@@ -18,4 +20,6 @@ export interface FeatureInPlanResponseData {
     trait?: Schematic.EntityTraitDefinitionResponseData;
     traitId?: string;
     updatedAt: Date;
+    /** Set when the feature carries a pay-in-advance quantity. Provisioned lazily for other feature types, and at creation for license features. */
+    usageLimitTraitId?: string;
 }

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

@@ -6,6 +6,8 @@ export interface FeatureResponseData {
     featureType: Schematic.FeatureType;
     icon: string;
     id: string;
+    /** The license sold through this feature. Set only on features of type license, and created automatically with them. */
+    licenseId?: string;
     lifecyclePhase?: Schematic.FeatureLifecyclePhase;
     maintainerAccountMemberId?: string;
     name: string;
@@ -13,4 +15,6 @@ export interface FeatureResponseData {
     singularName?: string;
     traitId?: string;
     updatedAt: Date;
+    /** Set when the feature carries a pay-in-advance quantity. Provisioned lazily for other feature types, and at creation for license features. */
+    usageLimitTraitId?: string;
 }

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

@@ -1,6 +1,7 @@
 export declare const FeatureType: {
     readonly Boolean: "boolean";
     readonly Event: "event";
+    readonly License: "license";
     readonly Trait: "trait";
 };
 export type FeatureType = (typeof FeatureType)[keyof typeof FeatureType];

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

@@ -2,6 +2,7 @@ import type * as Schematic from "../index";
 export interface FeatureView {
     accountId: string;
     billingLinkedResource?: Schematic.BillingLinkedResourceResponseData;
+    billingProduct?: Schematic.BillingProductResponseData;
     createdAt: Date;
     description: string;
     eventSubtype?: string;
@@ -10,6 +11,7 @@ export interface FeatureView {
     flags: Schematic.FlagView[];
     icon: string;
     id: string;
+    licenseId?: string;
     lifecyclePhase?: Schematic.FeatureLifecyclePhase;
     name: string;
     plans: Schematic.PreviewObject[];

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

@@ -0,0 +1,6 @@
+export interface LicenseResponseData {
+    createdAt: Date;
+    id: string;
+    name: 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/PlanVersionMigrationPreviewCompanyResponseData.d.ts

@@ -0,0 +1,8 @@
+export interface PlanVersionMigrationPreviewCompanyResponseData {
+    companyId: string;
+    hasBillingChanges: boolean;
+    hasCustomPricing: boolean;
+    note?: string;
+    planVersionIdFrom?: string;
+    willUpdateSubscription: boolean;
+}

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

@@ -0,0 +1,4 @@
+import type * as Schematic from "../index";
+export interface PlanVersionMigrationPreviewResponseData {
+    companies: Schematic.PlanVersionMigrationPreviewCompanyResponseData[];
+}

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