@schematichq/schematic-typescript-node 1.2.3 → 1.2.5

package/dist/api/resources/webhooks/types/UpdateWebhookRequestBodyRequestTypesItem.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export type UpdateWebhookRequestBodyRequestTypesItem = "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" | "credit.limit.warning" | "credit.limit.reached";
+export type UpdateWebhookRequestBodyRequestTypesItem = "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 UpdateWebhookRequestBodyRequestTypesItem: {
     readonly CompanyUpdated: "company.updated";
     readonly UserUpdated: "user.updated";
@@ -31,6 +31,9 @@ export declare const UpdateWebhookRequestBodyRequestTypesItem: {
     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";
 };

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

@@ -1,7 +1,9 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Schematic from "../index";
 export interface ApiKeyRequestResponseData {
+    apiKey?: Schematic.ApiKeyResponseData;
     apiKeyId: string;
     endedAt?: Date;
     environmentId?: string;

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

@@ -7,6 +7,7 @@ export interface BillingCreditGrantResponseData {
     companyName: string;
     createdAt: Date;
     creditIcon?: string;
+    creditId: string;
     creditName: string;
     expiresAt?: Date;
     grantReason: string;

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

@@ -6,5 +6,4 @@ export interface CreateOrUpdateConditionGroupRequestBody {
     conditions: Schematic.CreateOrUpdateConditionRequestBody[];
     flagId?: string;
     id?: string;
-    planId?: string;
 }

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

@@ -1,12 +1,11 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export type CreateOrUpdateRuleRequestBodyRuleType = "global_override" | "company_override" | "plan_entitlement" | "standard" | "default" | "plan_audience";
+export type CreateOrUpdateRuleRequestBodyRuleType = "global_override" | "company_override" | "plan_entitlement" | "standard" | "default";
 export declare const CreateOrUpdateRuleRequestBodyRuleType: {
     readonly GlobalOverride: "global_override";
     readonly CompanyOverride: "company_override";
     readonly PlanEntitlement: "plan_entitlement";
     readonly Standard: "standard";
     readonly Default: "default";
-    readonly PlanAudience: "plan_audience";
 };

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

@@ -0,0 +1,29 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Schematic from "../index";
+export interface PlanChangeResponseData {
+    action: Schematic.PlanChangeResponseDataAction;
+    actorType: Schematic.PlanChangeResponseDataActorType;
+    addOnsAdded: Schematic.PlanSnapshotView[];
+    addOnsRemoved: Schematic.PlanSnapshotView[];
+    apiKey?: Schematic.ApiKeyResponseData;
+    apiKeyRequest?: Schematic.ApiKeyRequestListResponseData;
+    basePlan?: Schematic.PlanSnapshotView;
+    /** Any special behavior that affected the assignment of the base plan during this change. */
+    basePlanAction?: Schematic.PlanChangeResponseDataBasePlanAction;
+    company?: Schematic.CompanyResponseData;
+    companyId: string;
+    createdAt: Date;
+    environmentId: string;
+    id: string;
+    previousBasePlan?: Schematic.PlanSnapshotView;
+    requestId?: string;
+    /** If a subscription was changed as a part of this plan change, indicates the type of change that was made. */
+    subscriptionChangeAction?: Schematic.PlanChangeResponseDataSubscriptionChangeAction;
+    /** Any traits were updated as part of this plan change (via pay-in-advance entitlements). */
+    traitsUpdated: Schematic.SubscriptionTraitUpdate[];
+    updatedAt: Date;
+    userId?: string;
+    userName?: string;
+}

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

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type PlanChangeResponseDataAction = "checkout" | "company_upsert" | "fallback_plan" | "manage_plan" | "plan_billing_product_changed" | "plan_deleted" | "quickstart" | "subscription_change";
+export declare const PlanChangeResponseDataAction: {
+    readonly Checkout: "checkout";
+    readonly CompanyUpsert: "company_upsert";
+    readonly FallbackPlan: "fallback_plan";
+    readonly ManagePlan: "manage_plan";
+    readonly PlanBillingProductChanged: "plan_billing_product_changed";
+    readonly PlanDeleted: "plan_deleted";
+    readonly Quickstart: "quickstart";
+    readonly SubscriptionChange: "subscription_change";
+};

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type PlanChangeResponseDataActorType = "app_user" | "api_key" | "system" | "temporary_access_token";
+export declare const PlanChangeResponseDataActorType: {
+    readonly AppUser: "app_user";
+    readonly ApiKey: "api_key";
+    readonly System: "system";
+    readonly TemporaryAccessToken: "temporary_access_token";
+};

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

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Any special behavior that affected the assignment of the base plan during this change.
+ */
+export type PlanChangeResponseDataBasePlanAction = "fallback" | "initial" | "trait" | "trial_expiry";
+export declare const PlanChangeResponseDataBasePlanAction: {
+    readonly Fallback: "fallback";
+    readonly Initial: "initial";
+    readonly Trait: "trait";
+    readonly TrialExpiry: "trial_expiry";
+};

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

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * If a subscription was changed as a part of this plan change, indicates the type of change that was made.
+ */
+export type PlanChangeResponseDataSubscriptionChangeAction = "downgrade" | "invalid" | "subscribe" | "unsubscribe" | "upgrade" | "upgrade_trial";
+export declare const PlanChangeResponseDataSubscriptionChangeAction: {
+    readonly Downgrade: "downgrade";
+    readonly Invalid: "invalid";
+    readonly Subscribe: "subscribe";
+    readonly Unsubscribe: "unsubscribe";
+    readonly Upgrade: "upgrade";
+    readonly UpgradeTrial: "upgrade_trial";
+};

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface PlanSnapshotView {
+    deleted: boolean;
+    description: string;
+    icon: string;
+    id: string;
+    name: string;
+}

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

@@ -16,7 +16,6 @@ export interface RuleConditionDetailResponseData {
     metricPeriodMonthReset?: string;
     metricValue?: number;
     operator: string;
-    planId?: string;
     resourceIds: string[];
     resources: Schematic.PreviewObjectResponseData[];
     ruleId: string;

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

@@ -8,7 +8,6 @@ export interface RuleConditionGroupDetailResponseData {
     environmentId: string;
     flagId?: string;
     id: string;
-    planId?: string;
     ruleId: string;
     updatedAt: Date;
 }

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

@@ -6,7 +6,6 @@ export interface RuleConditionGroupResponseData {
     environmentId: string;
     flagId?: string;
     id: string;
-    planId?: string;
     ruleId: string;
     updatedAt: Date;
 }

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

@@ -14,7 +14,6 @@ export interface RuleConditionResponseData {
     metricPeriodMonthReset?: string;
     metricValue?: number;
     operator: string;
-    planId?: string;
     resourceIds: string[];
     ruleId: string;
     traitEntityType?: string;

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

@@ -10,7 +10,6 @@ export interface RuleDetailResponseData {
     flagId?: string;
     id: string;
     name: string;
-    planId?: string;
     priority: number;
     ruleType: string;
     updatedAt: Date;

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

@@ -7,7 +7,6 @@ export interface RuleResponseData {
     flagId?: string;
     id: string;
     name: string;
-    planId?: string;
     priority: number;
     ruleType: string;
     updatedAt: Date;

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

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

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

@@ -3,7 +3,6 @@ export * from "./ApiKeyCreateResponseData";
 export * from "./ApiKeyRequestListResponseData";
 export * from "./ApiKeyRequestResponseData";
 export * from "./ApiKeyResponseData";
-export * from "./AudienceRequestBody";
 export * from "./BillingCouponResponseData";
 export * from "./BillingCreditBundleResponseData";
 export * from "./BillingCreditBundleView";
@@ -140,11 +139,13 @@ export * from "./ManagePlanRequest";
 export * from "./ManagePlanResponseResponseData";
 export * from "./MeterRequestBody";
 export * from "./OrderedPlansInGroup";
-export * from "./PaginationFilter";
 export * from "./PaymentMethodRequestBody";
 export * from "./PaymentMethodResponseData";
-export * from "./PlanAudienceDetailResponseData";
-export * from "./PlanAudienceResponseData";
+export * from "./PlanChangeResponseDataAction";
+export * from "./PlanChangeResponseDataActorType";
+export * from "./PlanChangeResponseDataBasePlanAction";
+export * from "./PlanChangeResponseDataSubscriptionChangeAction";
+export * from "./PlanChangeResponseData";
 export * from "./PlanCreditGrantView";
 export * from "./PlanDetailResponseData";
 export * from "./PlanEntitlementResponseData";
@@ -157,6 +158,7 @@ export * from "./PlanGroupResponseData";
 export * from "./PlanIssueResponseData";
 export * from "./PlanResponseData";
 export * from "./PlanSelection";
+export * from "./PlanSnapshotView";
 export * from "./PlanTraitResponseData";
 export * from "./PreviewObject";
 export * from "./PreviewObjectResponseData";
@@ -176,6 +178,7 @@ export * from "./RuleResponseData";
 export * from "./RulesDetailResponseData";
 export * from "./SegmentStatusResp";
 export * from "./StripeEmbedInfo";
+export * from "./SubscriptionTraitUpdate";
 export * from "./TemporaryAccessTokenResponseData";
 export * from "./TraitDefinition";
 export * from "./UpdateAddOnRequestBody";

package/dist/events.d.ts

@@ -21,6 +21,7 @@ declare class EventBuffer {
     private initialRetryDelay;
     private shutdown;
     private stopped;
+    private flushing;
     constructor(eventsApi: Events, opts?: EventBufferOptions);
     flush(): Promise<void>;
     push(event: CreateEventRequestBody): Promise<void>;