@schematichq/schematic-typescript-node 1.5.6 → 1.5.8

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

@@ -1,5 +1,5 @@
 import type * as Schematic from "../index";
-export type DataExportMetadata = Schematic.DataExportMetadata.AuditLog | Schematic.DataExportMetadata.CompanyFeatureUsage;
+export type DataExportMetadata = Schematic.DataExportMetadata.AuditLog | Schematic.DataExportMetadata.CompanyFeatureUsage | Schematic.DataExportMetadata.Event;
 export declare namespace DataExportMetadata {
     interface AuditLog extends Schematic.AuditLogExportMetadata {
         exportType: "audit-log";
@@ -7,4 +7,7 @@ export declare namespace DataExportMetadata {
     interface CompanyFeatureUsage extends Schematic.CompanyFeatureUsageExportMetadata {
         exportType: "company-feature-usage";
     }
+    interface Event extends Schematic.EventExportMetadata {
+        exportType: "event";
+    }
 }

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

@@ -1,5 +1,6 @@
 export declare const DataExportType: {
     readonly AuditLog: "audit-log";
     readonly CompanyFeatureUsage: "company-feature-usage";
+    readonly Event: "event";
 };
 export type DataExportType = (typeof DataExportType)[keyof typeof DataExportType];

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

@@ -0,0 +1,19 @@
+import type * as Schematic from "../index";
+export interface EventExportMetadata {
+    /** Restrict the export to events for this company ID (starting with 'comp_') */
+    companyId?: string;
+    /** Restrict the export to events captured at or before this time */
+    endTime?: Date;
+    /** Restrict the export to track events with this subtype */
+    eventSubtype?: string;
+    /** Restrict the export to these event types (e.g. "track", "identify"); defaults to track, identify and inference events. Flag check events are only exported when requested here explicitly, and require a flag_id. */
+    eventTypes?: Schematic.EventExportMetadataEventTypesItem[];
+    /** Restrict the export to flag-check events for this flag ID (starting with 'flag_') */
+    flagId?: string;
+    /** Account member emails to notify when the export completes; empty means the artifact is only retrievable via the API */
+    notificationEmailRecipientEmailAddresses?: string[];
+    /** Restrict the export to events captured at or after this time */
+    startTime?: Date;
+    /** Restrict the export to events for this user ID (starting with 'user_') */
+    userId?: string;
+}

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

@@ -0,0 +1,7 @@
+export declare const EventExportMetadataEventTypesItem: {
+    readonly FlagCheck: "flag_check";
+    readonly Identify: "identify";
+    readonly Inference: "inference";
+    readonly Track: "track";
+};
+export type EventExportMetadataEventTypesItem = (typeof EventExportMetadataEventTypesItem)[keyof typeof EventExportMetadataEventTypesItem];

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

@@ -2,7 +2,7 @@ import type * as Schematic from "../index";
 export interface FeatureView {
     accountId: string;
     billingLinkedResource?: Schematic.BillingLinkedResourceResponseData;
-    billingProduct?: Schematic.BillingProductResponseData;
+    billingProduct?: Schematic.BillingProductRecordResponseData;
     createdAt: Date;
     description: string;
     eventSubtype?: string;

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

@@ -1,4 +1,5 @@
 export interface TestWebhookResponseData {
+    failureReason?: string;
     responseCode: number;
     success: boolean;
 }

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

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

@@ -0,0 +1,16 @@
+import type * as Schematic from "../index";
+export interface UserUsageDetailResponseData {
+    /** The user's net credit consumption within the window */
+    credits: Schematic.UserCreditUsageResponseData[];
+    /** The user's net credit consumption by UTC day */
+    dailyCreditPoints: Schematic.UserDailyCreditPointResponseData[];
+    /** The user's per-feature usage by UTC day */
+    dailyPoints: Schematic.UserDailyUsagePointResponseData[];
+    /** End of the usage window (exclusive) */
+    endTime: Date;
+    /** The user's per-feature usage totals within the window */
+    featureTotals: Schematic.UserFeatureUsageResponseData[];
+    /** Start of the usage window */
+    startTime: Date;
+    user?: Schematic.UserResponseData;
+}

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

@@ -49,6 +49,7 @@ export * from "./BillingProductPriceInterval";
 export * from "./BillingProductPriceResponseData";
 export * from "./BillingProductPriceTierResponseData";
 export * from "./BillingProductPricing";
+export * from "./BillingProductRecordResponseData";
 export * from "./BillingProductResponseData";
 export * from "./BillingProviderType";
 export * from "./BillingStrategy";
@@ -98,6 +99,8 @@ export * from "./CompanyCreditBalanceResponseData";
 export * from "./CompanyDetailResponseData";
 export * from "./CompanyEventPeriodMetricsResponseData";
 export * from "./CompanyFeatureUsageExportMetadata";
+export * from "./CompanyFeatureUsageExportMetadataSortOrderDirection";
+export * from "./CompanyFeatureUsageExportMetadataVisibleColumnsItem";
 export * from "./CompanyLedgerResponseData";
 export * from "./CompanyMatchingCriteria";
 export * from "./CompanyMembershipDetailResponseData";
@@ -110,6 +113,7 @@ export * from "./CompanyPlanInvalidReason";
 export * from "./CompanyPlanWithBillingSubView";
 export * from "./CompanyResponseData";
 export * from "./CompanySubscriptionResponseData";
+export * from "./CompanyTaxIdView";
 export * from "./ComparableOperator";
 export * from "./CompatiblePlans";
 export * from "./CompatiblePlansResponseData";
@@ -217,6 +221,8 @@ export * from "./EventBodyIdentifyCompany";
 export * from "./EventBodyInference";
 export * from "./EventBodyTrack";
 export * from "./EventDetailResponseData";
+export * from "./EventExportMetadata";
+export * from "./EventExportMetadataEventTypesItem";
 export * from "./EventResponseData";
 export * from "./EventStatus";
 export * from "./EventSummaryResponseData";
@@ -284,6 +290,7 @@ export * from "./PlanChangeAction";
 export * from "./PlanChangeBasePlanAction";
 export * from "./PlanChangeResponseData";
 export * from "./PlanChangeSubscriptionAction";
+export * from "./PlanCreditGrantScaling";
 export * from "./PlanCreditGrantView";
 export * from "./PlanCurrencyPriceRequestBody";
 export * from "./PlanCurrencyPricesResponseData";
@@ -372,6 +379,8 @@ export * from "./StripeIntegrationConfig";
 export * from "./SubscriptionStatus";
 export * from "./SubscriptionTraitUpdate";
 export * from "./SubscriptionType";
+export * from "./TaxIdInput";
+export * from "./TaxIdType";
 export * from "./TemporaryAccessTokenResourceType";
 export * from "./TemporaryAccessTokenResponseData";
 export * from "./TestWebhookResponseData";
@@ -399,8 +408,14 @@ export * from "./UpsertUserSubRequestBody";
 export * from "./UsageBasedEntitlementRequestBody";
 export * from "./UsageBasedEntitlementResponseData";
 export * from "./UsageTimeSeriesPointResponseData";
+export * from "./UserCreditUsageResponseData";
+export * from "./UserDailyCreditPointResponseData";
+export * from "./UserDailyUsagePointResponseData";
 export * from "./UserDetailResponseData";
+export * from "./UserFeatureUsageResponseData";
 export * from "./UserResponseData";
+export * from "./UserUsageByCompanyResponseData";
+export * from "./UserUsageDetailResponseData";
 export * from "./WarningTier";
 export * from "./WarningTierRequestBody";
 export * from "./WarningTierResponseData";