@schematichq/schematic-typescript-node 1.1.5 → 1.1.6

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

@@ -4,11 +4,15 @@
 /**
  * @example
  *     {
- *         billingProductId: "billing_product_id"
+ *         isFreePlan: true,
+ *         isTrialable: true
  *     }
  */
 export interface UpsertBillingProductRequestBody {
-    billingProductId: string;
+    billingProductId?: string;
+    isFreePlan: boolean;
+    isTrialable: boolean;
     monthlyPriceId?: string;
+    trialDays?: number;
     yearlyPriceId?: string;
 }

package/dist/api/resources/webhooks/client/Client.js

@@ -89,7 +89,7 @@ class Webhooks {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.SchematicEnvironment.Default, "webhook-events"),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@schematichq/schematic-typescript-node", "X-Fern-SDK-Version": "1.1.5", "User-Agent": "@schematichq/schematic-typescript-node/1.1.5", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@schematichq/schematic-typescript-node", "X-Fern-SDK-Version": "1.1.6", "User-Agent": "@schematichq/schematic-typescript-node/1.1.6", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 requestType: "json",
@@ -180,7 +180,7 @@ class Webhooks {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.SchematicEnvironment.Default, `webhook-events/${encodeURIComponent(webhookEventId)}`),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@schematichq/schematic-typescript-node", "X-Fern-SDK-Version": "1.1.5", "User-Agent": "@schematichq/schematic-typescript-node/1.1.5", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@schematichq/schematic-typescript-node", "X-Fern-SDK-Version": "1.1.6", "User-Agent": "@schematichq/schematic-typescript-node/1.1.6", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -292,7 +292,7 @@ class Webhooks {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.SchematicEnvironment.Default, "webhook-events/count"),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@schematichq/schematic-typescript-node", "X-Fern-SDK-Version": "1.1.5", "User-Agent": "@schematichq/schematic-typescript-node/1.1.5", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@schematichq/schematic-typescript-node", "X-Fern-SDK-Version": "1.1.6", "User-Agent": "@schematichq/schematic-typescript-node/1.1.6", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 requestType: "json",
@@ -394,7 +394,7 @@ class Webhooks {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.SchematicEnvironment.Default, "webhooks"),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@schematichq/schematic-typescript-node", "X-Fern-SDK-Version": "1.1.5", "User-Agent": "@schematichq/schematic-typescript-node/1.1.5", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@schematichq/schematic-typescript-node", "X-Fern-SDK-Version": "1.1.6", "User-Agent": "@schematichq/schematic-typescript-node/1.1.6", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 requestType: "json",
@@ -489,7 +489,7 @@ class Webhooks {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.SchematicEnvironment.Default, "webhooks"),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@schematichq/schematic-typescript-node", "X-Fern-SDK-Version": "1.1.5", "User-Agent": "@schematichq/schematic-typescript-node/1.1.5", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@schematichq/schematic-typescript-node", "X-Fern-SDK-Version": "1.1.6", "User-Agent": "@schematichq/schematic-typescript-node/1.1.6", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.CreateWebhookRequestBody.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -580,7 +580,7 @@ class Webhooks {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.SchematicEnvironment.Default, `webhooks/${encodeURIComponent(webhookId)}`),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@schematichq/schematic-typescript-node", "X-Fern-SDK-Version": "1.1.5", "User-Agent": "@schematichq/schematic-typescript-node/1.1.5", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@schematichq/schematic-typescript-node", "X-Fern-SDK-Version": "1.1.6", "User-Agent": "@schematichq/schematic-typescript-node/1.1.6", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -672,7 +672,7 @@ class Webhooks {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.SchematicEnvironment.Default, `webhooks/${encodeURIComponent(webhookId)}`),
                 method: "PUT",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@schematichq/schematic-typescript-node", "X-Fern-SDK-Version": "1.1.5", "User-Agent": "@schematichq/schematic-typescript-node/1.1.5", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@schematichq/schematic-typescript-node", "X-Fern-SDK-Version": "1.1.6", "User-Agent": "@schematichq/schematic-typescript-node/1.1.6", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.UpdateWebhookRequestBody.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -771,7 +771,7 @@ class Webhooks {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.SchematicEnvironment.Default, `webhooks/${encodeURIComponent(webhookId)}`),
                 method: "DELETE",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@schematichq/schematic-typescript-node", "X-Fern-SDK-Version": "1.1.5", "User-Agent": "@schematichq/schematic-typescript-node/1.1.5", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@schematichq/schematic-typescript-node", "X-Fern-SDK-Version": "1.1.6", "User-Agent": "@schematichq/schematic-typescript-node/1.1.6", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -872,7 +872,7 @@ class Webhooks {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.SchematicEnvironment.Default, "webhooks/count"),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@schematichq/schematic-typescript-node", "X-Fern-SDK-Version": "1.1.5", "User-Agent": "@schematichq/schematic-typescript-node/1.1.5", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@schematichq/schematic-typescript-node", "X-Fern-SDK-Version": "1.1.6", "User-Agent": "@schematichq/schematic-typescript-node/1.1.6", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 requestType: "json",

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

@@ -4,5 +4,8 @@
 export interface BillingCustomerSubscription {
     currency: string;
     expiredAt?: Date;
+    interval: string;
+    meteredUsage: boolean;
+    perUnitPrice: number;
     totalPrice: number;
 }

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

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface BillingPriceView {
+    createdAt: Date;
+    currency: string;
+    id: string;
+    interval: string;
+    meterId?: string;
+    price: number;
+    priceExternalId: string;
+    priceId: string;
+    productExternalId: string;
+    productId: string;
+    productName: string;
+    updatedAt: Date;
+    usageType: string;
+}

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

@@ -3,7 +3,6 @@
  */
 import * as Schematic from "../index";
 export interface BillingProductDetailResponseData {
-    prices: Schematic.BillingPriceResponseData[];
     accountId: string;
     createdAt: Date;
     currency: string;
@@ -11,6 +10,7 @@ export interface BillingProductDetailResponseData {
     externalId: string;
     name: string;
     price: number;
+    prices: Schematic.BillingPriceResponseData[];
     productId: string;
     quantity: number;
     updatedAt: Date;

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

@@ -2,17 +2,18 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface BillingProductForSubscriptionResponseData {
-    accountId: string;
     createdAt: Date;
     currency: string;
     environmentId: string;
     externalId: string;
     id: string;
     interval: string;
+    meterId?: string;
     name: string;
     price: number;
     priceExternalId: string;
     quantity: number;
     subscriptionId: string;
     updatedAt: Date;
+    usageType: string;
 }

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

@@ -8,7 +8,9 @@ export interface BillingProductPlanResponseData {
     accountId: string;
     billingProductId: string;
     environmentId: string;
+    isTrialable: boolean;
     monthlyPriceId?: string;
     planId: string;
+    trialDays?: number;
     yearlyPriceId?: string;
 }

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

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface BillingProductPriceResponseData {
+    createdAt: Date;
+    currency: string;
+    id: string;
+    interval: string;
+    meterId?: string;
+    price: number;
+    priceExternalId: string;
+    productExternalId: string;
+    updatedAt: Date;
+    usageType: string;
+}

package/dist/api/types/BillingProductPriceResponseData.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/dist/api/types/BillingProductPricing.d.ts

@@ -4,7 +4,10 @@
 export interface BillingProductPricing {
     currency: string;
     interval: string;
+    meterId?: string;
     price: number;
     priceExternalId: string;
     productExternalId: string;
+    quantity: number;
+    usageType: string;
 }

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

@@ -2,11 +2,18 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface BillingSubscriptionResponseData {
+    companyId?: string;
+    createdAt: Date;
     currency: string;
+    customerExternalId: string;
     expiredAt?: Date;
-    externalId: string;
     id: string;
     interval: string;
+    metadata?: Record<string, unknown>;
+    periodEnd: number;
+    periodStart: number;
+    status: string;
+    subscriptionExternalId: string;
     totalPrice: number;
-    updatedAt: Date;
+    trialEnd?: number;
 }

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

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Schematic from "../index";
+export interface BillingSubscriptionView {
+    companyId?: string;
+    createdAt: Date;
+    currency: string;
+    customerExternalId: string;
+    expiredAt?: Date;
+    id: string;
+    interval: string;
+    latestInvoice?: Schematic.InvoiceResponseData;
+    metadata?: Record<string, unknown>;
+    paymentMethod?: Schematic.PaymentMethodResponseData;
+    periodEnd: number;
+    periodStart: number;
+    products: Schematic.BillingProductForSubscriptionResponseData[];
+    status: string;
+    subscriptionExternalId: string;
+    totalPrice: number;
+    trialEnd?: number;
+}

package/dist/api/types/BillingSubscriptionView.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/dist/api/types/CompanyDetailResponseData.d.ts

@@ -4,7 +4,8 @@
 import * as Schematic from "../index";
 export interface CompanyDetailResponseData {
     addOns: Schematic.CompanyPlanWithBillingSubView[];
-    billingSubscriptions: Schematic.BillingSubscriptionResponseData[];
+    billingSubscription?: Schematic.BillingSubscriptionView;
+    billingSubscriptions: Schematic.BillingSubscriptionView[];
     createdAt: Date;
     entityTraits: Schematic.EntityTraitDetailResponseData[];
     environmentId: string;

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

@@ -10,11 +10,13 @@ export interface CompanyOverrideResponseData {
     companyId: string;
     createdAt: Date;
     environmentId: string;
+    expirationDate?: Date;
     feature?: Schematic.FeatureResponseData;
     featureId: string;
     id: string;
     metricPeriod?: string;
-    ruleId: string;
+    metricPeriodMonthReset?: string;
+    ruleId?: string;
     updatedAt: Date;
     valueBool?: boolean;
     valueNumeric?: number;

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

@@ -14,9 +14,12 @@ export interface CompanyPlanDetailResponseData {
     icon: string;
     id: string;
     isDefault: boolean;
+    isFree: boolean;
+    isTrialable: boolean;
     monthlyPrice?: Schematic.BillingPriceResponseData;
     name: string;
     planType: string;
+    trialDays?: number;
     updatedAt: Date;
     valid: boolean;
     yearlyPrice?: Schematic.BillingPriceResponseData;

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

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ComponentCapabilities {
+    checkout: boolean;
+}

package/dist/api/types/ComponentCapabilities.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/dist/api/types/ComponentHydrateResponseData.d.ts

@@ -5,6 +5,7 @@ import * as Schematic from "../index";
 export interface ComponentHydrateResponseData {
     activeAddOns: Schematic.CompanyPlanDetailResponseData[];
     activePlans: Schematic.CompanyPlanDetailResponseData[];
+    capabilities?: Schematic.ComponentCapabilities;
     company?: Schematic.CompanyDetailResponseData;
     component?: Schematic.ComponentResponseData;
     featureUsage?: Schematic.FeatureUsageDetailResponseData;

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

@@ -8,6 +8,7 @@ import * as Schematic from "../index";
 export interface ComponentPreviewResponseData {
     activeAddOns: Schematic.CompanyPlanDetailResponseData[];
     activePlans: Schematic.CompanyPlanDetailResponseData[];
+    capabilities?: Schematic.ComponentCapabilities;
     company?: Schematic.CompanyDetailResponseData;
     component?: Schematic.ComponentResponseData;
     featureUsage?: Schematic.FeatureUsageDetailResponseData;

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

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Schematic from "../index";
+export interface CreateEntitlementReqCommon {
+    featureId: string;
+    meteredPriceId?: string;
+    metricPeriod?: Schematic.CreateEntitlementReqCommonMetricPeriod;
+    metricPeriodMonthReset?: Schematic.CreateEntitlementReqCommonMetricPeriodMonthReset;
+    valueBool?: boolean;
+    valueNumeric?: number;
+    valueTraitId?: string;
+    valueType: Schematic.CreateEntitlementReqCommonValueType;
+}

package/dist/api/types/CreateEntitlementReqCommon.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/dist/api/types/{CreateReqCommonMetricPeriod.d.ts → CreateEntitlementReqCommonMetricPeriod.d.ts}

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

package/{api/types/CreateReqCommonMetricPeriod.js → dist/api/types/CreateEntitlementReqCommonMetricPeriod.js}

@@ -3,8 +3,9 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CreateReqCommonMetricPeriod = void 0;
-exports.CreateReqCommonMetricPeriod = {
+exports.CreateEntitlementReqCommonMetricPeriod = void 0;
+exports.CreateEntitlementReqCommonMetricPeriod = {
+    AllTime: "all_time",
     Billing: "billing",
     CurrentMonth: "current_month",
     CurrentWeek: "current_week",

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type CreateEntitlementReqCommonMetricPeriodMonthReset = "first_of_month" | "billing_cycle";
+export declare const CreateEntitlementReqCommonMetricPeriodMonthReset: {
+    readonly FirstOfMonth: "first_of_month";
+    readonly BillingCycle: "billing_cycle";
+};

package/dist/api/types/CreateEntitlementReqCommonMetricPeriodMonthReset.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateEntitlementReqCommonMetricPeriodMonthReset = void 0;
+exports.CreateEntitlementReqCommonMetricPeriodMonthReset = {
+    FirstOfMonth: "first_of_month",
+    BillingCycle: "billing_cycle",
+};

package/dist/api/types/{CreateReqCommonValueType.d.ts → CreateEntitlementReqCommonValueType.d.ts}

@@ -1,8 +1,8 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type CreateReqCommonValueType = "boolean" | "numeric" | "trait" | "unlimited";
-export declare const CreateReqCommonValueType: {
+export declare type CreateEntitlementReqCommonValueType = "boolean" | "numeric" | "trait" | "unlimited";
+export declare const CreateEntitlementReqCommonValueType: {
     readonly Boolean: "boolean";
     readonly Numeric: "numeric";
     readonly Trait: "trait";

package/dist/api/types/{UpdateReqCommonValueType.js → CreateEntitlementReqCommonValueType.js}

@@ -3,8 +3,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UpdateReqCommonValueType = void 0;
-exports.UpdateReqCommonValueType = {
+exports.CreateEntitlementReqCommonValueType = void 0;
+exports.CreateEntitlementReqCommonValueType = {
     Boolean: "boolean",
     Numeric: "numeric",
     Trait: "trait",

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

@@ -11,6 +11,8 @@ export interface CreateOrUpdateConditionRequestBody {
     id?: string;
     /** Period of time over which to measure the track event metric */
     metricPeriod?: Schematic.CreateOrUpdateConditionRequestBodyMetricPeriod;
+    /** When metric_period=current_month, specify whether the month restarts based on the calendar month or the billing period */
+    metricPeriodMonthReset?: Schematic.CreateOrUpdateConditionRequestBodyMetricPeriodMonthReset;
     /** Value to compare the track event metric against */
     metricValue?: number;
     operator: Schematic.CreateOrUpdateConditionRequestBodyOperator;

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

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

package/dist/api/types/CreateOrUpdateConditionRequestBodyMetricPeriod.js

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

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * When metric_period=current_month, specify whether the month restarts based on the calendar month or the billing period
+ */
+export declare type CreateOrUpdateConditionRequestBodyMetricPeriodMonthReset = "first_of_month" | "billing_cycle";
+export declare const CreateOrUpdateConditionRequestBodyMetricPeriodMonthReset: {
+    readonly FirstOfMonth: "first_of_month";
+    readonly BillingCycle: "billing_cycle";
+};

package/dist/api/types/CreateOrUpdateConditionRequestBodyMetricPeriodMonthReset.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateOrUpdateConditionRequestBodyMetricPeriodMonthReset = void 0;
+exports.CreateOrUpdateConditionRequestBodyMetricPeriodMonthReset = {
+    FirstOfMonth: "first_of_month",
+    BillingCycle: "billing_cycle",
+};

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

@@ -13,6 +13,8 @@ export interface FeatureCompanyResponseData {
     entitlementId: string;
     entitlementType: string;
     feature?: Schematic.FeatureDetailResponseData;
+    /** If the period is current_month, when the month resets. */
+    monthReset?: string;
     /** The period over which usage is measured. */
     period?: string;
     plan?: Schematic.PlanResponseData;

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

@@ -13,6 +13,8 @@ export interface FeatureCompanyUserResponseData {
     entitlementId: string;
     entitlementType: string;
     feature?: Schematic.FeatureDetailResponseData;
+    /** If the period is current_month, when the month resets. */
+    monthReset?: string;
     /** The period over which usage is measured. */
     period?: string;
     plan?: Schematic.PlanResponseData;

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

@@ -12,6 +12,8 @@ export interface FeatureUsageResponseData {
     entitlementId: string;
     entitlementType: string;
     feature?: Schematic.FeatureDetailResponseData;
+    /** If the period is current_month, when the month resets. */
+    monthReset?: string;
     /** The period over which usage is measured. */
     period?: string;
     plan?: Schematic.PlanResponseData;

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

@@ -12,9 +12,12 @@ export interface PlanDetailResponseData {
     icon: string;
     id: string;
     isDefault: boolean;
+    isFree: boolean;
+    isTrialable: boolean;
     monthlyPrice?: Schematic.BillingPriceResponseData;
     name: string;
     planType: string;
+    trialDays?: number;
     updatedAt: Date;
     yearlyPrice?: Schematic.BillingPriceResponseData;
 }

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

@@ -8,9 +8,12 @@ export interface PlanEntitlementResponseData {
     feature?: Schematic.FeatureResponseData;
     featureId: string;
     id: string;
+    meteredPrice?: Schematic.BillingPriceView;
     metricPeriod?: string;
+    metricPeriodMonthReset?: string;
     plan?: Schematic.PlanResponseData;
     planId: string;
+    priceBehavior?: string;
     ruleId: string;
     updatedAt: Date;
     valueBool?: boolean;

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

@@ -6,8 +6,11 @@ import * as Schematic from "../index";
  * The returned resource
  */
 export interface PlanGroupDetailResponseData {
+    addOns: Schematic.PlanGroupPlanDetailResponseData[];
     defaultPlan?: Schematic.PlanGroupPlanDetailResponseData;
     defaultPlanId?: string;
     id: string;
     plans: Schematic.PlanGroupPlanDetailResponseData[];
+    trialDays?: number;
+    trialPaymentMethodRequired?: boolean;
 }

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

@@ -13,9 +13,12 @@ export interface PlanGroupPlanDetailResponseData {
     icon: string;
     id: string;
     isDefault: boolean;
+    isFree: boolean;
+    isTrialable: boolean;
     monthlyPrice?: Schematic.BillingPriceResponseData;
     name: string;
     planType: string;
+    trialDays?: number;
     updatedAt: Date;
     yearlyPrice?: Schematic.BillingPriceResponseData;
 }

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

@@ -9,4 +9,6 @@ export interface PlanGroupResponseData {
     defaultPlanId?: string;
     id: string;
     planIds: string[];
+    trialDays?: number;
+    trialPaymentMethodRequired?: boolean;
 }

package/dist/api/types/{RuleConditionResourceResponseData.d.ts → PreviewObjectResponseData.d.ts}

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

package/dist/api/types/PreviewObjectResponseData.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/dist/api/types/RuleConditionDetailResponseData.d.ts

@@ -13,11 +13,12 @@ export interface RuleConditionDetailResponseData {
     flagId?: string;
     id: string;
     metricPeriod?: string;
+    metricPeriodMonthReset?: string;
     metricValue?: number;
     operator: string;
     planId?: string;
     resourceIds: string[];
-    resources: Schematic.RuleConditionResourceResponseData[];
+    resources: Schematic.PreviewObjectResponseData[];
     ruleId: string;
     trait?: Schematic.EntityTraitDefinitionResponseData;
     traitEntityType?: string;