@schematichq/schematic-typescript-node 1.1.2 → 1.1.5

package/api/types/CompanyDetailResponseData.d.ts

@@ -3,7 +3,8 @@
  */
 import * as Schematic from "../index";
 export interface CompanyDetailResponseData {
-    addOns: Schematic.PreviewObject[];
+    addOns: Schematic.CompanyPlanWithBillingSubView[];
+    billingSubscriptions: Schematic.BillingSubscriptionResponseData[];
     createdAt: Date;
     entityTraits: Schematic.EntityTraitDetailResponseData[];
     environmentId: string;
@@ -12,8 +13,8 @@ export interface CompanyDetailResponseData {
     lastSeenAt?: Date;
     logoUrl?: string;
     name: string;
-    plan?: Schematic.PreviewObject;
-    plans: Schematic.PreviewObject[];
+    plan?: Schematic.CompanyPlanWithBillingSubView;
+    plans: Schematic.GenericPreviewObject[];
     /** A map of trait names to trait values */
     traits?: Record<string, unknown>;
     updatedAt: Date;

package/api/types/CompanyPlanDetailResponseData.d.ts

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Schematic from "../index";
+export interface CompanyPlanDetailResponseData {
+    audienceType?: string;
+    billingProduct?: Schematic.BillingProductDetailResponseData;
+    companyCount: number;
+    createdAt: Date;
+    current: boolean;
+    description: string;
+    entitlements: Schematic.PlanEntitlementResponseData[];
+    features: Schematic.FeatureDetailResponseData[];
+    icon: string;
+    id: string;
+    isDefault: boolean;
+    monthlyPrice?: Schematic.BillingPriceResponseData;
+    name: string;
+    planType: string;
+    updatedAt: Date;
+    valid: boolean;
+    yearlyPrice?: Schematic.BillingPriceResponseData;
+}

package/api/types/CompanyPlanDetailResponseData.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/CompanyPlanWithBillingSubView.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CompanyPlanWithBillingSubView {
+    billingProductId?: string;
+    description?: string;
+    id: string;
+    imageUrl?: string;
+    name: string;
+    planPeriod?: string;
+    planPrice?: number;
+}

package/api/types/CompanyPlanWithBillingSubView.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/CompanySubscriptionResponseData.d.ts

@@ -3,9 +3,14 @@
  */
 import * as Schematic from "../index";
 export interface CompanySubscriptionResponseData {
+    currency: string;
     customerExternalId: string;
     expiredAt?: Date;
     interval: string;
-    products: Schematic.BillingProductResponseData[];
+    latestInvoice?: Schematic.InvoiceResponseData;
+    paymentMethod?: Schematic.PaymentMethodResponseData;
+    products: Schematic.BillingProductForSubscriptionResponseData[];
+    status: string;
     subscriptionExternalId: string;
+    totalPrice: number;
 }

package/api/types/ComponentHydrateResponseData.d.ts

@@ -2,11 +2,13 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Schematic from "../index";
-/**
- * The returned resource
- */
 export interface ComponentHydrateResponseData {
+    activeAddOns: Schematic.CompanyPlanDetailResponseData[];
+    activePlans: Schematic.CompanyPlanDetailResponseData[];
     company?: Schematic.CompanyDetailResponseData;
     component?: Schematic.ComponentResponseData;
     featureUsage?: Schematic.FeatureUsageDetailResponseData;
+    stripeEmbed?: Schematic.StripeEmbedInfo;
+    subscription?: Schematic.CompanySubscriptionResponseData;
+    upcomingInvoice?: Schematic.InvoiceResponseData;
 }

package/api/types/ComponentPreviewResponseData.d.ts

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Schematic from "../index";
+/**
+ * The returned resource
+ */
+export interface ComponentPreviewResponseData {
+    activeAddOns: Schematic.CompanyPlanDetailResponseData[];
+    activePlans: Schematic.CompanyPlanDetailResponseData[];
+    company?: Schematic.CompanyDetailResponseData;
+    component?: Schematic.ComponentResponseData;
+    featureUsage?: Schematic.FeatureUsageDetailResponseData;
+    invoices: Schematic.InvoiceResponseData[];
+    stripeEmbed?: Schematic.StripeEmbedInfo;
+    subscription?: Schematic.CompanySubscriptionResponseData;
+    upcomingInvoice?: Schematic.InvoiceResponseData;
+}

package/api/types/ComponentPreviewResponseData.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ComponentResponseData.d.ts

@@ -1,6 +1,9 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * The updated resource
+ */
 export interface ComponentResponseData {
     ast?: Record<string, number>;
     createdAt: Date;

package/api/types/CreateOrUpdateConditionRequestBodyConditionType.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type CreateOrUpdateConditionRequestBodyConditionType = "company" | "metric" | "trait" | "user" | "plan" | "billing_product" | "crm_product";
+export declare type CreateOrUpdateConditionRequestBodyConditionType = "company" | "metric" | "trait" | "user" | "plan" | "billing_product" | "crm_product" | "base_plan";
 export declare const CreateOrUpdateConditionRequestBodyConditionType: {
     readonly Company: "company";
     readonly Metric: "metric";
@@ -10,4 +10,5 @@ export declare const CreateOrUpdateConditionRequestBodyConditionType: {
     readonly Plan: "plan";
     readonly BillingProduct: "billing_product";
     readonly CrmProduct: "crm_product";
+    readonly BasePlan: "base_plan";
 };

package/api/types/CreateOrUpdateConditionRequestBodyConditionType.js

@@ -12,4 +12,5 @@ exports.CreateOrUpdateConditionRequestBodyConditionType = {
     Plan: "plan",
     BillingProduct: "billing_product",
     CrmProduct: "crm_product",
+    BasePlan: "base_plan",
 };

package/api/types/CreateOrUpdateConditionRequestBodyMetricPeriod.d.ts

@@ -4,8 +4,9 @@
 /**
  * Period of time over which to measure the track event metric
  */
-export declare type CreateOrUpdateConditionRequestBodyMetricPeriod = "current_month" | "current_week" | "current_day";
+export declare type CreateOrUpdateConditionRequestBodyMetricPeriod = "billing" | "current_month" | "current_week" | "current_day";
 export declare const CreateOrUpdateConditionRequestBodyMetricPeriod: {
+    readonly Billing: "billing";
     readonly CurrentMonth: "current_month";
     readonly CurrentWeek: "current_week";
     readonly CurrentDay: "current_day";

package/api/types/CreateOrUpdateConditionRequestBodyMetricPeriod.js

@@ -5,6 +5,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CreateOrUpdateConditionRequestBodyMetricPeriod = void 0;
 exports.CreateOrUpdateConditionRequestBodyMetricPeriod = {
+    Billing: "billing",
     CurrentMonth: "current_month",
     CurrentWeek: "current_week",
     CurrentDay: "current_day",

package/api/types/CreateOrUpdateConditionRequestBodyOperator.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type CreateOrUpdateConditionRequestBodyOperator = "eq" | "ne" | "gt" | "gte" | "lt" | "lte";
+export declare type CreateOrUpdateConditionRequestBodyOperator = "eq" | "ne" | "gt" | "gte" | "lt" | "lte" | "is_empty" | "not_empty";
 export declare const CreateOrUpdateConditionRequestBodyOperator: {
     readonly Eq: "eq";
     readonly Ne: "ne";
@@ -9,4 +9,6 @@ export declare const CreateOrUpdateConditionRequestBodyOperator: {
     readonly Gte: "gte";
     readonly Lt: "lt";
     readonly Lte: "lte";
+    readonly IsEmpty: "is_empty";
+    readonly NotEmpty: "not_empty";
 };

package/api/types/CreateOrUpdateConditionRequestBodyOperator.js

@@ -11,4 +11,6 @@ exports.CreateOrUpdateConditionRequestBodyOperator = {
     Gte: "gte",
     Lt: "lt",
     Lte: "lte",
+    IsEmpty: "is_empty",
+    NotEmpty: "not_empty",
 };

package/api/types/CreateReqCommonMetricPeriod.d.ts

@@ -1,8 +1,9 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type CreateReqCommonMetricPeriod = "current_month" | "current_week" | "current_day";
+export declare type CreateReqCommonMetricPeriod = "billing" | "current_month" | "current_week" | "current_day";
 export declare const CreateReqCommonMetricPeriod: {
+    readonly Billing: "billing";
     readonly CurrentMonth: "current_month";
     readonly CurrentWeek: "current_week";
     readonly CurrentDay: "current_day";

package/api/types/CreateReqCommonMetricPeriod.js

@@ -5,6 +5,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CreateReqCommonMetricPeriod = void 0;
 exports.CreateReqCommonMetricPeriod = {
+    Billing: "billing",
     CurrentMonth: "current_month",
     CurrentWeek: "current_week",
     CurrentDay: "current_day",

package/api/types/EventBodyFlagCheck.d.ts

@@ -13,9 +13,9 @@ export interface EventBodyFlagCheck {
     /** The reason why the value was returned */
     reason: string;
     /** Key-value pairs used to to identify company for which the flag was checked */
-    reqCompany?: Record<string, string | undefined>;
+    reqCompany?: Record<string, string>;
     /** Key-value pairs used to to identify user for which the flag was checked */
-    reqUser?: Record<string, string | undefined>;
+    reqUser?: Record<string, string>;
     /** Schematic rule ID (starting with 'rule\_') of the rule that matched for the flag, if any */
     ruleId?: string;
     /** Schematic user ID (starting with 'user\_') of the user evaluated, if any */

package/api/types/GenericPreviewObject.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface GenericPreviewObject {
+    description?: string;
+    id: string;
+    imageUrl?: string;
+    name: string;
+}

package/api/types/GenericPreviewObject.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/InvoiceRequestBody.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface InvoiceRequestBody {
+    amountDue: number;
+    amountPaid: number;
+    amountRemaining: number;
+    collectionMethod: string;
+    currency: string;
+    customerExternalId: string;
+    dueDate?: Date;
+    paymentMethodExternalId?: string;
+    subscriptionExternalId?: string;
+    subtotal: number;
+    url?: string;
+}

package/api/types/InvoiceRequestBody.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/InvoiceResponseData.d.ts

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface InvoiceResponseData {
+    amountDue: number;
+    amountPaid: number;
+    amountRemaining: number;
+    collectionMethod: string;
+    companyId?: string;
+    createdAt: Date;
+    currency: string;
+    customerExternalId: string;
+    dueDate?: Date;
+    environmentId: string;
+    externalId?: string;
+    id: string;
+    paymentMethodExternalId?: string;
+    subscriptionExternalId?: string;
+    subtotal: number;
+    updatedAt: Date;
+    url?: string;
+}

package/api/types/InvoiceResponseData.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/MeterRequestBody.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface MeterRequestBody {
+    displayName: string;
+    eventName: string;
+    eventPayloadKey: string;
+}

package/api/types/MeterRequestBody.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/PaymentMethodRequestBody.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface PaymentMethodRequestBody {
+    accountLast4?: string;
+    accountName?: string;
+    bankName?: string;
+    billingEmail?: string;
+    billingName?: string;
+    cardBrand?: string;
+    cardExpMonth?: number;
+    cardExpYear?: number;
+    cardLast4?: string;
+    customerExternalId: string;
+    paymentMethodType: string;
+    subscriptionExternalId?: string;
+}

package/api/types/PaymentMethodRequestBody.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/PaymentMethodResponseData.d.ts

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface PaymentMethodResponseData {
+    accountLast4?: string;
+    accountName?: string;
+    bankName?: string;
+    billingEmail?: string;
+    billingName?: string;
+    cardBrand?: string;
+    cardExpMonth?: number;
+    cardExpYear?: number;
+    cardLast4?: string;
+    companyId?: string;
+    createdAt: Date;
+    customerExternalId: string;
+    environmentId: string;
+    externalId: string;
+    id: string;
+    paymentMethodType: string;
+    subscriptionExternalId?: string;
+    updatedAt: Date;
+}

package/api/types/PaymentMethodResponseData.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/PlanDetailResponseData.d.ts

@@ -2,11 +2,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Schematic from "../index";
-/**
- * The updated resource
- */
 export interface PlanDetailResponseData {
-    audienceType: string;
+    audienceType?: string;
     billingProduct?: Schematic.BillingProductDetailResponseData;
     companyCount: number;
     createdAt: Date;
@@ -14,7 +11,10 @@ export interface PlanDetailResponseData {
     features: Schematic.FeatureDetailResponseData[];
     icon: string;
     id: string;
+    isDefault: boolean;
+    monthlyPrice?: Schematic.BillingPriceResponseData;
     name: string;
     planType: string;
     updatedAt: Date;
+    yearlyPrice?: Schematic.BillingPriceResponseData;
 }

package/api/types/PlanEntitlementResponseData.d.ts

@@ -2,9 +2,6 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Schematic from "../index";
-/**
- * The updated resource
- */
 export interface PlanEntitlementResponseData {
     createdAt: Date;
     environmentId: string;

package/api/types/PlanGroupDetailResponseData.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Schematic from "../index";
+/**
+ * The returned resource
+ */
+export interface PlanGroupDetailResponseData {
+    defaultPlan?: Schematic.PlanGroupPlanDetailResponseData;
+    defaultPlanId?: string;
+    id: string;
+    plans: Schematic.PlanGroupPlanDetailResponseData[];
+}

package/api/types/PlanGroupDetailResponseData.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/PlanGroupPlanDetailResponseData.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Schematic from "../index";
+export interface PlanGroupPlanDetailResponseData {
+    audienceType?: string;
+    billingProduct?: Schematic.BillingProductDetailResponseData;
+    companyCount: number;
+    createdAt: Date;
+    description: string;
+    entitlements: Schematic.PlanEntitlementResponseData[];
+    features: Schematic.FeatureDetailResponseData[];
+    icon: string;
+    id: string;
+    isDefault: boolean;
+    monthlyPrice?: Schematic.BillingPriceResponseData;
+    name: string;
+    planType: string;
+    updatedAt: Date;
+    yearlyPrice?: Schematic.BillingPriceResponseData;
+}

package/api/types/PlanGroupPlanDetailResponseData.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/PlanGroupResponseData.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The updated resource
+ */
+export interface PlanGroupResponseData {
+    addOnIds: string[];
+    defaultPlanId?: string;
+    id: string;
+    planIds: string[];
+}

package/api/types/PlanGroupResponseData.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/PlanResponseData.d.ts

@@ -2,7 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface PlanResponseData {
-    audienceType: string;
+    audienceType?: string;
     createdAt: Date;
     description: string;
     icon: string;

package/api/types/StripeEmbedInfo.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface StripeEmbedInfo {
+    publishableKey: string;
+    setupIntentClientSecret?: string;
+}

package/api/types/StripeEmbedInfo.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/UpdateReqCommonMetricPeriod.d.ts

@@ -1,8 +1,9 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type UpdateReqCommonMetricPeriod = "current_month" | "current_week" | "current_day";
+export declare type UpdateReqCommonMetricPeriod = "billing" | "current_month" | "current_week" | "current_day";
 export declare const UpdateReqCommonMetricPeriod: {
+    readonly Billing: "billing";
     readonly CurrentMonth: "current_month";
     readonly CurrentWeek: "current_week";
     readonly CurrentDay: "current_day";

package/api/types/UpdateReqCommonMetricPeriod.js

@@ -5,6 +5,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UpdateReqCommonMetricPeriod = void 0;
 exports.UpdateReqCommonMetricPeriod = {
+    Billing: "billing",
     CurrentMonth: "current_month",
     CurrentWeek: "current_week",
     CurrentDay: "current_day",

package/api/types/index.d.ts

@@ -7,8 +7,10 @@ export * from "./AudienceRequestBody";
 export * from "./BillingCustomerResponseData";
 export * from "./BillingCustomerSubscription";
 export * from "./BillingCustomerWithSubscriptionsResponseData";
+export * from "./BillingMeterResponseData";
 export * from "./BillingPriceResponseData";
 export * from "./BillingProductDetailResponseData";
+export * from "./BillingProductForSubscriptionResponseData";
 export * from "./BillingProductPlanResponseData";
 export * from "./BillingProductPricing";
 export * from "./BillingProductResponseData";
@@ -22,10 +24,12 @@ export * from "./CompanyDetailResponseData";
 export * from "./CompanyMembershipDetailResponseData";
 export * from "./CompanyMembershipResponseData";
 export * from "./CompanyOverrideResponseData";
-export * from "./CompanyPlanResponseData";
+export * from "./CompanyPlanDetailResponseData";
+export * from "./CompanyPlanWithBillingSubView";
 export * from "./CompanyResponseData";
 export * from "./CompanySubscriptionResponseData";
 export * from "./ComponentHydrateResponseData";
+export * from "./ComponentPreviewResponseData";
 export * from "./ComponentResponseData";
 export * from "./CountResponse";
 export * from "./EventBodyTrack";
@@ -76,14 +80,23 @@ export * from "./FeatureUsageResponseDataAllocationType";
 export * from "./FeatureUsageResponseData";
 export * from "./FlagDetailResponseData";
 export * from "./FlagResponseData";
+export * from "./GenericPreviewObject";
+export * from "./InvoiceRequestBody";
+export * from "./InvoiceResponseData";
 export * from "./IssueTemporaryAccessTokenResponseData";
 export * from "./KeysRequestBody";
+export * from "./MeterRequestBody";
 export * from "./MetricCountsHourlyResponseData";
 export * from "./PaginationFilter";
+export * from "./PaymentMethodRequestBody";
+export * from "./PaymentMethodResponseData";
 export * from "./PlanAudienceDetailResponseData";
 export * from "./PlanAudienceResponseData";
 export * from "./PlanDetailResponseData";
 export * from "./PlanEntitlementResponseData";
+export * from "./PlanGroupDetailResponseData";
+export * from "./PlanGroupPlanDetailResponseData";
+export * from "./PlanGroupResponseData";
 export * from "./PlanResponseData";
 export * from "./PreviewObject";
 export * from "./RawEventBatchResponseData";
@@ -97,6 +110,7 @@ export * from "./RuleDetailResponseData";
 export * from "./RuleResponseData";
 export * from "./RulesDetailResponseData";
 export * from "./SegmentStatusResp";
+export * from "./StripeEmbedInfo";
 export * from "./TemporaryAccessTokenResponseData";
 export * from "./UpdateReqCommonMetricPeriod";
 export * from "./UpdateReqCommonValueType";