@schematichq/schematic-typescript-node 1.2.6 → 1.2.7

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

@@ -4,6 +4,6 @@
 import * as Schematic from "../index";
 export interface TraitDefinition {
     comparableType: Schematic.TraitDefinitionComparableType;
-    entityType: Schematic.TraitDefinitionEntityType;
+    entityType: Schematic.EntityType;
     id: 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";
+};

package/dist/api/{resources/webhooks/types/CreateWebhookRequestBodyRequestTypesItem.d.ts → types/WebhookRequestType.d.ts}

@@ -1,39 +1,41 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export type CreateWebhookRequestBodyRequestTypesItem = "company.updated" | "user.updated" | "plan.updated" | "plan.entitlement.updated" | "company.override.updated" | "feature.updated" | "flag.updated" | "flag_rules.updated" | "company.created" | "user.created" | "plan.created" | "plan.entitlement.created" | "company.override.created" | "feature.created" | "flag.created" | "company.deleted" | "user.deleted" | "plan.deleted" | "plan.entitlement.deleted" | "company.override.deleted" | "feature.deleted" | "flag.deleted" | "test.send" | "subscription.trial.ended" | "entitlement.limit.warning" | "entitlement.limit.reached" | "entitlement.soft_limit.warning" | "entitlement.soft_limit.reached" | "entitlement.tier_limit.warning" | "entitlement.tier_limit.reached" | "credit.limit.warning" | "credit.limit.reached" | "company.plan_change";
-export declare const CreateWebhookRequestBodyRequestTypesItem: {
-    readonly CompanyUpdated: "company.updated";
-    readonly UserUpdated: "user.updated";
-    readonly PlanUpdated: "plan.updated";
-    readonly PlanEntitlementUpdated: "plan.entitlement.updated";
-    readonly CompanyOverrideUpdated: "company.override.updated";
-    readonly FeatureUpdated: "feature.updated";
-    readonly FlagUpdated: "flag.updated";
-    readonly FlagRulesUpdated: "flag_rules.updated";
+export type WebhookRequestType = "subscription.trial.ended" | "company.created" | "company.deleted" | "company.override.created" | "company.override.deleted" | "company.override.expired" | "company.override.updated" | "company.plan_changed" | "company.updated" | "credit.limit.reached" | "credit.limit.warning" | "entitlement.limit.reached" | "entitlement.limit.warning" | "entitlement.soft_limit.reached" | "entitlement.soft_limit.warning" | "entitlement.tier_limit.reached" | "entitlement.tier_limit.warning" | "feature.created" | "feature.deleted" | "feature.updated" | "flag.created" | "flag.deleted" | "flag_rules.updated" | "flag.updated" | "plan.created" | "plan.deleted" | "plan.entitlement.created" | "plan.entitlement.deleted" | "plan.entitlement.updated" | "plan.updated" | "rule.deleted" | "test.send" | "user.created" | "user.deleted" | "user.updated";
+export declare const WebhookRequestType: {
+    readonly SubscriptionTrialEnded: "subscription.trial.ended";
     readonly CompanyCreated: "company.created";
-    readonly UserCreated: "user.created";
-    readonly PlanCreated: "plan.created";
-    readonly PlanEntitlementCreated: "plan.entitlement.created";
+    readonly CompanyDeleted: "company.deleted";
     readonly CompanyOverrideCreated: "company.override.created";
+    readonly CompanyOverrideDeleted: "company.override.deleted";
+    readonly CompanyOverrideExpired: "company.override.expired";
+    readonly CompanyOverrideUpdated: "company.override.updated";
+    readonly CompanyPlanChanged: "company.plan_changed";
+    readonly CompanyUpdated: "company.updated";
+    readonly CreditLimitReached: "credit.limit.reached";
+    readonly CreditLimitWarning: "credit.limit.warning";
+    readonly EntitlementLimitReached: "entitlement.limit.reached";
+    readonly EntitlementLimitWarning: "entitlement.limit.warning";
+    readonly EntitlementSoftLimitReached: "entitlement.soft_limit.reached";
+    readonly EntitlementSoftLimitWarning: "entitlement.soft_limit.warning";
+    readonly EntitlementTierLimitReached: "entitlement.tier_limit.reached";
+    readonly EntitlementTierLimitWarning: "entitlement.tier_limit.warning";
     readonly FeatureCreated: "feature.created";
+    readonly FeatureDeleted: "feature.deleted";
+    readonly FeatureUpdated: "feature.updated";
     readonly FlagCreated: "flag.created";
-    readonly CompanyDeleted: "company.deleted";
-    readonly UserDeleted: "user.deleted";
+    readonly FlagDeleted: "flag.deleted";
+    readonly FlagRulesUpdated: "flag_rules.updated";
+    readonly FlagUpdated: "flag.updated";
+    readonly PlanCreated: "plan.created";
     readonly PlanDeleted: "plan.deleted";
+    readonly PlanEntitlementCreated: "plan.entitlement.created";
     readonly PlanEntitlementDeleted: "plan.entitlement.deleted";
-    readonly CompanyOverrideDeleted: "company.override.deleted";
-    readonly FeatureDeleted: "feature.deleted";
-    readonly FlagDeleted: "flag.deleted";
+    readonly PlanEntitlementUpdated: "plan.entitlement.updated";
+    readonly PlanUpdated: "plan.updated";
+    readonly RuleDeleted: "rule.deleted";
     readonly TestSend: "test.send";
-    readonly SubscriptionTrialEnded: "subscription.trial.ended";
-    readonly EntitlementLimitWarning: "entitlement.limit.warning";
-    readonly EntitlementLimitReached: "entitlement.limit.reached";
-    readonly EntitlementSoftLimitWarning: "entitlement.soft_limit.warning";
-    readonly EntitlementSoftLimitReached: "entitlement.soft_limit.reached";
-    readonly EntitlementTierLimitWarning: "entitlement.tier_limit.warning";
-    readonly EntitlementTierLimitReached: "entitlement.tier_limit.reached";
-    readonly CreditLimitWarning: "credit.limit.warning";
-    readonly CreditLimitReached: "credit.limit.reached";
-    readonly CompanyPlanChange: "company.plan_change";
+    readonly UserCreated: "user.created";
+    readonly UserDeleted: "user.deleted";
+    readonly UserUpdated: "user.updated";
 };

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

@@ -8,9 +8,9 @@ export interface WebhookResponseData {
     entitlementTriggerConfigs?: Schematic.EntitlementTriggerConfig[];
     id: string;
     name: string;
-    requestTypes: string[];
+    requestTypes: Schematic.WebhookRequestType[];
     secret: string;
-    status: string;
+    status: Schematic.WebhookStatus;
     updatedAt: Date;
     url: string;
 }

package/dist/api/{resources/webhooks/types/UpdateWebhookRequestBodyStatus.d.ts → types/WebhookStatus.d.ts}

@@ -1,8 +1,8 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export type UpdateWebhookRequestBodyStatus = "active" | "inactive";
-export declare const UpdateWebhookRequestBodyStatus: {
+export type WebhookStatus = "active" | "inactive";
+export declare const WebhookStatus: {
     readonly Active: "active";
     readonly Inactive: "inactive";
 };