@schematichq/schematic-typescript-node 1.2.5 → 1.2.7

package/dist/api/{resources/plans/types/CreatePlanRequestBodyPlanType.d.ts → types/PlanType.d.ts}

@@ -1,8 +1,8 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export type CreatePlanRequestBodyPlanType = "plan" | "add_on";
-export declare const CreatePlanRequestBodyPlanType: {
+export type PlanType = "plan" | "add_on";
+export declare const PlanType: {
     readonly Plan: "plan";
     readonly AddOn: "add_on";
 };

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

@@ -13,6 +13,7 @@ export interface PreviewSubscriptionFinanceResponseData {
     taxAmount?: number;
     taxDisplayName?: string;
     taxRequireBillingDetails: boolean;
+    totalPerBillingPeriod: number;
     trialEnd?: Date;
     upcomingInvoiceLineItems: Schematic.PreviewSubscriptionUpcomingInvoiceLineItems[];
 }

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type ProrationBehavior = "create_prorations" | "invoice_immediately";
+export declare const ProrationBehavior: {
+    readonly CreateProrations: "create_prorations";
+    readonly InvoiceImmediately: "invoice_immediately";
+};

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

@@ -11,6 +11,6 @@ export interface Rule {
     id: string;
     name: string;
     priority: number;
-    ruleType: string;
+    ruleType: Schematic.RuleRuleType;
     value: boolean;
 }

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

@@ -20,7 +20,7 @@ export interface RuleConditionDetailResponseData {
     resources: Schematic.PreviewObjectResponseData[];
     ruleId: string;
     trait?: Schematic.EntityTraitDefinitionResponseData;
-    traitEntityType?: string;
+    traitEntityType?: Schematic.EntityType;
     traitId?: string;
     traitValue: string;
     updatedAt: Date;

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

@@ -1,6 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Schematic from "../index";
 export interface RuleConditionResponseData {
     comparisonTraitId?: string;
     conditionGroupId?: string;
@@ -16,7 +17,7 @@ export interface RuleConditionResponseData {
     operator: string;
     resourceIds: string[];
     ruleId: string;
-    traitEntityType?: string;
+    traitEntityType?: Schematic.EntityType;
     traitId?: string;
     traitValue: string;
     updatedAt: Date;

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

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type RuleRuleType = "default" | "global_override" | "company_override" | "company_override_usage_exceeded" | "plan_entitlement" | "plan_entitlement_usage_exceeded" | "standard";
+export declare const RuleRuleType: {
+    readonly Default: "default";
+    readonly GlobalOverride: "global_override";
+    readonly CompanyOverride: "company_override";
+    readonly CompanyOverrideUsageExceeded: "company_override_usage_exceeded";
+    readonly PlanEntitlement: "plan_entitlement";
+    readonly PlanEntitlementUsageExceeded: "plan_entitlement_usage_exceeded";
+    readonly Standard: "standard";
+};

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The current schema version hash for rules engine types. The first enum value is always the current version.
+ */
+export type RulesEngineSchemaVersion = "549e6fea" | "placeholder-for-fern-compatibility";
+export declare const RulesEngineSchemaVersion: {
+    readonly FiveHundredFortyNineE6Fea: "549e6fea";
+    readonly PlaceholderForFernCompatibility: "placeholder-for-fern-compatibility";
+};

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

@@ -0,0 +1,20 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Schematic from "../index";
+export interface RulesengineCheckFlagResult {
+    companyId?: string;
+    err?: string;
+    featureAllocation?: number;
+    featureUsage?: number;
+    featureUsageEvent?: string;
+    featureUsagePeriod?: Schematic.RulesengineCheckFlagResultFeatureUsagePeriod;
+    featureUsageResetAt?: Date;
+    flagId?: string;
+    flagKey: string;
+    reason: string;
+    ruleId?: string;
+    ruleType?: Schematic.RulesengineCheckFlagResultRuleType;
+    userId?: string;
+    value: boolean;
+}

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type RulesengineCheckFlagResultFeatureUsagePeriod = "all_time" | "current_day" | "current_month" | "current_week";
+export declare const RulesengineCheckFlagResultFeatureUsagePeriod: {
+    readonly AllTime: "all_time";
+    readonly CurrentDay: "current_day";
+    readonly CurrentMonth: "current_month";
+    readonly CurrentWeek: "current_week";
+};

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

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type RulesengineCheckFlagResultRuleType = "default" | "global_override" | "company_override" | "company_override_usage_exceeded" | "plan_entitlement" | "plan_entitlement_usage_exceeded" | "standard";
+export declare const RulesengineCheckFlagResultRuleType: {
+    readonly Default: "default";
+    readonly GlobalOverride: "global_override";
+    readonly CompanyOverride: "company_override";
+    readonly CompanyOverrideUsageExceeded: "company_override_usage_exceeded";
+    readonly PlanEntitlement: "plan_entitlement";
+    readonly PlanEntitlementUsageExceeded: "plan_entitlement_usage_exceeded";
+    readonly Standard: "standard";
+};

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

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Schematic from "../index";
+export interface RulesengineCompany {
+    accountId: string;
+    basePlanId?: string;
+    billingProductIds: string[];
+    creditBalances: Record<string, number>;
+    crmProductIds: string[];
+    environmentId: string;
+    id: string;
+    keys: Record<string, string>;
+    metrics: Schematic.RulesengineCompanyMetric[];
+    planIds: string[];
+    rules: Schematic.RulesengineRule[];
+    subscription?: Schematic.RulesengineSubscription;
+    traits: Schematic.RulesengineTrait[];
+}

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

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Schematic from "../index";
+export interface RulesengineCompanyMetric {
+    accountId: string;
+    companyId: string;
+    createdAt: Date;
+    environmentId: string;
+    eventSubtype: string;
+    monthReset: Schematic.RulesengineCompanyMetricMonthReset;
+    period: Schematic.RulesengineCompanyMetricPeriod;
+    validUntil?: Date;
+    value: number;
+}

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

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

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type RulesengineCompanyMetricPeriod = "all_time" | "current_day" | "current_month" | "current_week";
+export declare const RulesengineCompanyMetricPeriod: {
+    readonly AllTime: "all_time";
+    readonly CurrentDay: "current_day";
+    readonly CurrentMonth: "current_month";
+    readonly CurrentWeek: "current_week";
+};

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

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Schematic from "../index";
+export interface RulesengineCondition {
+    accountId: string;
+    comparisonTraitDefinition?: Schematic.RulesengineTraitDefinition;
+    conditionType: Schematic.RulesengineConditionConditionType;
+    consumptionRate?: number;
+    creditId?: string;
+    environmentId: string;
+    eventSubtype?: string;
+    id: string;
+    metricPeriod?: Schematic.RulesengineConditionMetricPeriod;
+    metricPeriodMonthReset?: Schematic.RulesengineConditionMetricPeriodMonthReset;
+    metricValue?: number;
+    operator: Schematic.RulesengineConditionOperator;
+    resourceIds: string[];
+    traitDefinition?: Schematic.RulesengineTraitDefinition;
+    traitValue: string;
+}

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

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type RulesengineConditionConditionType = "base_plan" | "billing_product" | "company" | "credit" | "crm_product" | "metric" | "plan" | "trait" | "user";
+export declare const RulesengineConditionConditionType: {
+    readonly BasePlan: "base_plan";
+    readonly BillingProduct: "billing_product";
+    readonly Company: "company";
+    readonly Credit: "credit";
+    readonly CrmProduct: "crm_product";
+    readonly Metric: "metric";
+    readonly Plan: "plan";
+    readonly Trait: "trait";
+    readonly User: "user";
+};

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

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Schematic from "../index";
+export interface RulesengineConditionGroup {
+    conditions: Schematic.RulesengineCondition[];
+}

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type RulesengineConditionMetricPeriod = "all_time" | "current_day" | "current_month" | "current_week";
+export declare const RulesengineConditionMetricPeriod: {
+    readonly AllTime: "all_time";
+    readonly CurrentDay: "current_day";
+    readonly CurrentMonth: "current_month";
+    readonly CurrentWeek: "current_week";
+};

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

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

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

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

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type RulesengineEntityType = "company" | "user";
+export declare const RulesengineEntityType: {
+    readonly Company: "company";
+    readonly User: "user";
+};

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Schematic from "../index";
+export interface RulesengineFlag {
+    accountId: string;
+    defaultValue: boolean;
+    environmentId: string;
+    id: string;
+    key: string;
+    rules: Schematic.RulesengineRule[];
+}

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

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Schematic from "../index";
+export interface RulesengineRule {
+    accountId: string;
+    conditionGroups: Schematic.RulesengineConditionGroup[];
+    conditions: Schematic.RulesengineCondition[];
+    environmentId: string;
+    flagId?: string;
+    id: string;
+    name: string;
+    priority: number;
+    ruleType: Schematic.RulesengineRuleRuleType;
+    value: boolean;
+}

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

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type RulesengineRuleRuleType = "default" | "global_override" | "company_override" | "company_override_usage_exceeded" | "plan_entitlement" | "plan_entitlement_usage_exceeded" | "standard";
+export declare const RulesengineRuleRuleType: {
+    readonly Default: "default";
+    readonly GlobalOverride: "global_override";
+    readonly CompanyOverride: "company_override";
+    readonly CompanyOverrideUsageExceeded: "company_override_usage_exceeded";
+    readonly PlanEntitlement: "plan_entitlement";
+    readonly PlanEntitlementUsageExceeded: "plan_entitlement_usage_exceeded";
+    readonly Standard: "standard";
+};

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface RulesengineSubscription {
+    id: string;
+    periodEnd: Date;
+    periodStart: Date;
+}

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Schematic from "../index";
+export interface RulesengineTrait {
+    traitDefinition?: Schematic.RulesengineTraitDefinition;
+    value: string;
+}

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Schematic from "../index";
+export interface RulesengineTraitDefinition {
+    comparableType: Schematic.RulesengineTraitDefinitionComparableType;
+    entityType: Schematic.RulesengineEntityType;
+    id: string;
+}

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type RulesengineTraitDefinitionComparableType = "bool" | "date" | "int" | "string";
+export declare const RulesengineTraitDefinitionComparableType: {
+    readonly Bool: "bool";
+    readonly Date: "date";
+    readonly Int: "int";
+    readonly String: "string";
+};

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Schematic from "../index";
+export interface RulesengineUser {
+    accountId: string;
+    environmentId: string;
+    id: string;
+    keys: Record<string, string>;
+    rules: Schematic.RulesengineRule[];
+    traits: Schematic.RulesengineTrait[];
+}

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

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

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Schematic from "../index";
+export interface SkippedEntitlementResponseData {
+    entitlementId: string;
+    errors: Schematic.SkippedEntitlementErrorResponseData[];
+    featureId: string;
+    featureName: string;
+}

package/dist/api/{resources/credits/types/ListCompanyGrantsRequestDir.d.ts → types/SortDirection.d.ts}

@@ -1,8 +1,8 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export type ListCompanyGrantsRequestDir = "asc" | "desc";
-export declare const ListCompanyGrantsRequestDir: {
+export type SortDirection = "asc" | "desc";
+export declare const SortDirection: {
     readonly Asc: "asc";
     readonly Desc: "desc";
 };

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

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type SubscriptionStatus = "active" | "canceled" | "expired" | "incomplete" | "incomplete_expired" | "past_due" | "paused" | "trialing" | "unpaid";
+export declare const SubscriptionStatus: {
+    readonly Active: "active";
+    readonly Canceled: "canceled";
+    readonly Expired: "expired";
+    readonly Incomplete: "incomplete";
+    readonly IncompleteExpired: "incomplete_expired";
+    readonly PastDue: "past_due";
+    readonly Paused: "paused";
+    readonly Trialing: "trialing";
+    readonly Unpaid: "unpaid";
+};

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

@@ -1,12 +1,13 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Schematic from "../index";
 export interface SubscriptionTraitUpdate {
     featureId: string;
     hierarchy: string[];
     reason: string;
     traitId: string;
     traitName: string;
-    traitType: string;
+    traitType: Schematic.TraitType;
     value: string;
 }

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type SubscriptionType = "free" | "one_time" | "paid" | "trial";
+export declare const SubscriptionType: {
+    readonly Free: "free";
+    readonly OneTime: "one_time";
+    readonly Paid: "paid";
+    readonly Trial: "trial";
+};

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

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type TemporaryAccessTokenResourceType = "company";

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

@@ -1,12 +1,13 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Schematic from "../index";
 export interface TemporaryAccessTokenResponseData {
     apiKeyId: string;
     createdAt: Date;
     environmentId: string;
     expiredAt: Date;
     id: string;
-    resourceType: string;
+    resourceType: Schematic.TemporaryAccessTokenResourceType;
     updatedAt: Date;
 }

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

@@ -1,8 +1,9 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Schematic from "../index";
 export interface TraitDefinition {
-    comparableType: string;
-    entityType: string;
+    comparableType: Schematic.TraitDefinitionComparableType;
+    entityType: Schematic.EntityType;
     id: string;
 }

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type TraitDefinitionComparableType = "bool" | "date" | "int" | "string";
+export declare const TraitDefinitionComparableType: {
+    readonly Bool: "bool";
+    readonly Date: "date";
+    readonly Int: "int";
+    readonly String: "string";
+};

package/dist/api/{resources/companies/types/ListEntityTraitDefinitionsRequestTraitType.d.ts → types/TraitType.d.ts}

@@ -1,8 +1,8 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export type ListEntityTraitDefinitionsRequestTraitType = "boolean" | "currency" | "date" | "number" | "string" | "url";
-export declare const ListEntityTraitDefinitionsRequestTraitType: {
+export type TraitType = "boolean" | "currency" | "date" | "number" | "string" | "url";
+export declare const TraitType: {
     readonly Boolean: "boolean";
     readonly Currency: "currency";
     readonly Date: "date";

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

@@ -10,5 +10,5 @@ export interface UpdateEntitlementReqCommon {
     valueCreditId?: string;
     valueNumeric?: number;
     valueTraitId?: string;
-    valueType: Schematic.UpdateEntitlementReqCommonValueType;
+    valueType: Schematic.EntitlementValueType;
 }

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

@@ -11,11 +11,11 @@ export interface UsageBasedEntitlementRequestBody {
     monthlyUnitPrice?: number;
     monthlyUnitPriceDecimal?: string;
     overageBillingProductId?: string;
-    priceBehavior?: Schematic.UsageBasedEntitlementRequestBodyPriceBehavior;
+    priceBehavior?: Schematic.EntitlementPriceBehavior;
     /** Use MonthlyPriceTiers or YearlyPriceTiers instead */
     priceTiers?: Schematic.CreatePriceTierRequestBody[];
     softLimit?: number;
-    tierMode?: string;
+    tierMode?: Schematic.BillingTiersMode;
     yearlyMeteredPriceId?: string;
     yearlyPriceTiers?: Schematic.CreatePriceTierRequestBody[];
     yearlyUnitPrice?: number;

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

@@ -10,9 +10,9 @@ export interface UsageBasedEntitlementResponseData {
     metricPeriod?: string;
     metricPeriodMonthReset?: string;
     monthlyUsageBasedPrice?: Schematic.BillingPriceView;
-    priceBehavior?: string;
+    priceBehavior?: Schematic.EntitlementPriceBehavior;
     valueBool?: boolean;
     valueNumeric?: number;
-    valueType: string;
+    valueType: Schematic.EntitlementValueType;
     yearlyUsageBasedPrice?: Schematic.BillingPriceView;
 }

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

@@ -6,10 +6,10 @@ export interface WebhookEventDetailResponseData {
     createdAt: Date;
     id: string;
     payload?: string;
-    requestType: string;
+    requestType: Schematic.WebhookRequestType;
     responseCode?: number;
     sentAt?: Date;
-    status: string;
+    status: Schematic.WebhookEventStatus;
     updatedAt: Date;
     webhook?: Schematic.WebhookResponseData;
     webhookId: string;

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

@@ -1,14 +1,15 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Schematic from "../index";
 export interface WebhookEventResponseData {
     createdAt: Date;
     id: string;
     payload?: string;
-    requestType: string;
+    requestType: Schematic.WebhookRequestType;
     responseCode?: number;
     sentAt?: Date;
-    status: string;
+    status: Schematic.WebhookEventStatus;
     updatedAt: Date;
     webhookId: string;
 }

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type WebhookEventStatus = "failure" | "pending" | "success";
+export declare const WebhookEventStatus: {
+    readonly Failure: "failure";
+    readonly Pending: "pending";
+    readonly Success: "success";
+};