@schematichq/schematic-typescript-node 1.1.6 → 1.1.8

package/serialization/types/index.d.ts

@@ -4,6 +4,7 @@ export * from "./ApiKeyRequestListResponseData";
 export * from "./ApiKeyRequestResponseData";
 export * from "./ApiKeyResponseData";
 export * from "./AudienceRequestBody";
+export * from "./BillingCouponResponseData";
 export * from "./BillingCustomerResponseData";
 export * from "./BillingCustomerSubscription";
 export * from "./BillingCustomerWithSubscriptionsResponseData";
@@ -16,14 +17,19 @@ export * from "./BillingProductPlanResponseData";
 export * from "./BillingProductPriceResponseData";
 export * from "./BillingProductPricing";
 export * from "./BillingProductResponseData";
+export * from "./BillingSubscriptionDiscount";
+export * from "./BillingSubscriptionDiscountView";
 export * from "./BillingSubscriptionResponseData";
 export * from "./BillingSubscriptionView";
-export * from "./CheckFlagOutputWithFlagKey";
+export * from "./ChangeSubscriptionInternalRequestBody";
+export * from "./ChangeSubscriptionRequestBody";
 export * from "./CheckFlagRequestBody";
 export * from "./CheckFlagResponseData";
 export * from "./CheckFlagsResponseData";
+export * from "./CheckoutDataResponseData";
 export * from "./CompanyCrmDealsResponseData";
 export * from "./CompanyDetailResponseData";
+export * from "./CompanyEventPeriodMetricsResponseData";
 export * from "./CompanyMembershipDetailResponseData";
 export * from "./CompanyMembershipResponseData";
 export * from "./CompanyOverrideResponseData";
@@ -36,6 +42,7 @@ export * from "./ComponentHydrateResponseData";
 export * from "./ComponentPreviewResponseData";
 export * from "./ComponentResponseData";
 export * from "./CountResponse";
+export * from "./CouponRequestBody";
 export * from "./CreateEntitlementReqCommonMetricPeriod";
 export * from "./CreateEntitlementReqCommonMetricPeriodMonthReset";
 export * from "./CreateEntitlementReqCommonValueType";
@@ -105,6 +112,7 @@ export * from "./PlanGroupResponseData";
 export * from "./PlanResponseData";
 export * from "./PreviewObject";
 export * from "./PreviewObjectResponseData";
+export * from "./PreviewSubscriptionChangeResponseData";
 export * from "./RawEventBatchResponseData";
 export * from "./RawEventResponseData";
 export * from "./RuleConditionDetailResponseData";
@@ -117,15 +125,19 @@ export * from "./RulesDetailResponseData";
 export * from "./SegmentStatusResp";
 export * from "./StripeEmbedInfo";
 export * from "./TemporaryAccessTokenResponseData";
+export * from "./UpdateAddOnRequestBody";
 export * from "./UpdateEntitlementReqCommonMetricPeriod";
 export * from "./UpdateEntitlementReqCommonMetricPeriodMonthReset";
 export * from "./UpdateEntitlementReqCommonValueType";
 export * from "./UpdateEntitlementReqCommon";
+export * from "./UpdatePayInAdvanceRequestBody";
 export * from "./UpdateRuleRequestBody";
 export * from "./UpsertCompanyRequestBody";
 export * from "./UpsertTraitRequestBody";
 export * from "./UpsertUserRequestBody";
 export * from "./UpsertUserSubRequestBody";
+export * from "./UsageBasedEntitlementRequestBody";
+export * from "./UsageBasedEntitlementResponseData";
 export * from "./UserDetailResponseData";
 export * from "./UserResponseData";
 export * from "./WebhookEventDetailResponseData";

package/serialization/types/index.js

@@ -20,6 +20,7 @@ __exportStar(require("./ApiKeyRequestListResponseData"), exports);
 __exportStar(require("./ApiKeyRequestResponseData"), exports);
 __exportStar(require("./ApiKeyResponseData"), exports);
 __exportStar(require("./AudienceRequestBody"), exports);
+__exportStar(require("./BillingCouponResponseData"), exports);
 __exportStar(require("./BillingCustomerResponseData"), exports);
 __exportStar(require("./BillingCustomerSubscription"), exports);
 __exportStar(require("./BillingCustomerWithSubscriptionsResponseData"), exports);
@@ -32,14 +33,19 @@ __exportStar(require("./BillingProductPlanResponseData"), exports);
 __exportStar(require("./BillingProductPriceResponseData"), exports);
 __exportStar(require("./BillingProductPricing"), exports);
 __exportStar(require("./BillingProductResponseData"), exports);
+__exportStar(require("./BillingSubscriptionDiscount"), exports);
+__exportStar(require("./BillingSubscriptionDiscountView"), exports);
 __exportStar(require("./BillingSubscriptionResponseData"), exports);
 __exportStar(require("./BillingSubscriptionView"), exports);
-__exportStar(require("./CheckFlagOutputWithFlagKey"), exports);
+__exportStar(require("./ChangeSubscriptionInternalRequestBody"), exports);
+__exportStar(require("./ChangeSubscriptionRequestBody"), exports);
 __exportStar(require("./CheckFlagRequestBody"), exports);
 __exportStar(require("./CheckFlagResponseData"), exports);
 __exportStar(require("./CheckFlagsResponseData"), exports);
+__exportStar(require("./CheckoutDataResponseData"), exports);
 __exportStar(require("./CompanyCrmDealsResponseData"), exports);
 __exportStar(require("./CompanyDetailResponseData"), exports);
+__exportStar(require("./CompanyEventPeriodMetricsResponseData"), exports);
 __exportStar(require("./CompanyMembershipDetailResponseData"), exports);
 __exportStar(require("./CompanyMembershipResponseData"), exports);
 __exportStar(require("./CompanyOverrideResponseData"), exports);
@@ -52,6 +58,7 @@ __exportStar(require("./ComponentHydrateResponseData"), exports);
 __exportStar(require("./ComponentPreviewResponseData"), exports);
 __exportStar(require("./ComponentResponseData"), exports);
 __exportStar(require("./CountResponse"), exports);
+__exportStar(require("./CouponRequestBody"), exports);
 __exportStar(require("./CreateEntitlementReqCommonMetricPeriod"), exports);
 __exportStar(require("./CreateEntitlementReqCommonMetricPeriodMonthReset"), exports);
 __exportStar(require("./CreateEntitlementReqCommonValueType"), exports);
@@ -121,6 +128,7 @@ __exportStar(require("./PlanGroupResponseData"), exports);
 __exportStar(require("./PlanResponseData"), exports);
 __exportStar(require("./PreviewObject"), exports);
 __exportStar(require("./PreviewObjectResponseData"), exports);
+__exportStar(require("./PreviewSubscriptionChangeResponseData"), exports);
 __exportStar(require("./RawEventBatchResponseData"), exports);
 __exportStar(require("./RawEventResponseData"), exports);
 __exportStar(require("./RuleConditionDetailResponseData"), exports);
@@ -133,15 +141,19 @@ __exportStar(require("./RulesDetailResponseData"), exports);
 __exportStar(require("./SegmentStatusResp"), exports);
 __exportStar(require("./StripeEmbedInfo"), exports);
 __exportStar(require("./TemporaryAccessTokenResponseData"), exports);
+__exportStar(require("./UpdateAddOnRequestBody"), exports);
 __exportStar(require("./UpdateEntitlementReqCommonMetricPeriod"), exports);
 __exportStar(require("./UpdateEntitlementReqCommonMetricPeriodMonthReset"), exports);
 __exportStar(require("./UpdateEntitlementReqCommonValueType"), exports);
 __exportStar(require("./UpdateEntitlementReqCommon"), exports);
+__exportStar(require("./UpdatePayInAdvanceRequestBody"), exports);
 __exportStar(require("./UpdateRuleRequestBody"), exports);
 __exportStar(require("./UpsertCompanyRequestBody"), exports);
 __exportStar(require("./UpsertTraitRequestBody"), exports);
 __exportStar(require("./UpsertUserRequestBody"), exports);
 __exportStar(require("./UpsertUserSubRequestBody"), exports);
+__exportStar(require("./UsageBasedEntitlementRequestBody"), exports);
+__exportStar(require("./UsageBasedEntitlementResponseData"), exports);
 __exportStar(require("./UserDetailResponseData"), exports);
 __exportStar(require("./UserResponseData"), exports);
 __exportStar(require("./WebhookEventDetailResponseData"), exports);

package/wrapper.d.ts

@@ -2,19 +2,32 @@ import * as api from "./api";
 import { SchematicClient as BaseClient } from "./Client";
 import { CacheProvider } from "./cache";
 import { Logger } from "./logger";
+/**
+ * Configuration options for the SchematicClient
+ */
 export interface SchematicOptions {
+    /** API key for authentication */
     apiKey?: string;
+    /** Custom base URL for API endpoints */
     basePath?: string;
+    /** Cache provider configuration */
     cacheProviders?: {
+        /** Providers for caching flag check results */
         flagChecks?: CacheProvider<boolean>[];
     };
+    /** If using an API key that is not environment-specific, use this option to specify the environment */
     environmentId?: string;
+    /** Interval in milliseconds for flushing event buffer */
     eventBufferInterval?: number;
+    /** Default values for feature flags */
     flagDefaults?: {
         [key: string]: boolean;
     };
+    /** Additional HTTP headers for API requests */
     headers?: Record<string, string>;
+    /** Custom logger implementation */
     logger?: Logger;
+    /** Enable offline mode to prevent network activity */
     offline?: boolean;
 }
 export declare class SchematicClient extends BaseClient {
@@ -23,12 +36,48 @@ export declare class SchematicClient extends BaseClient {
     private flagDefaults;
     private logger;
     private offline;
+    /**
+     * Creates a new instance of the SchematicClient
+     * @param opts - Configuration options for the client
+     */
     constructor(opts?: SchematicOptions);
+    /**
+     * Checks the value of a feature flag for the given evaluation context
+     * @param evalCtx - The context (company and/or user) for evaluating the feature flag
+     * @param key - The unique identifier of the feature flag
+     * @returns Promise resolving to the flag's boolean value, falling back to default if unavailable
+     * @throws Will log error and return flag default if check fails
+     */
     checkFlag(evalCtx: api.CheckFlagRequestBody, key: string): Promise<boolean>;
+    /**
+     * Gracefully shuts down the client by stopping the event buffer
+     * @returns Promise that resolves when the event buffer has been stopped
+     */
     close(): Promise<void>;
+    /**
+     * Send a non-blocking event to create or update companies and users
+     * @param body - The identify event payload containing user properties
+     * @returns Promise that resolves when the event has been enqueued
+     * @throws Will log error if event enqueueing fails
+     */
     identify(body: api.EventBodyIdentify): Promise<void>;
+    /**
+     * Send a non-blocking event to track usage
+     * @param body - The track event payload containing event details
+     * @returns Promise that resolves when the event has been enqueued
+     * @throws Will log error if event enqueueing fails
+     */
     track(body: api.EventBodyTrack): Promise<void>;
+    /**
+     * Sets the default value for a specific feature flag
+     * @param flag - The feature flag identifier
+     * @param value - The default boolean value to set
+     */
     setFlagDefault(flag: string, value: boolean): void;
+    /**
+     * Sets default values for multiple feature flags at once
+     * @param values - Object mapping flag identifiers to their default boolean values
+     */
     setFlagDefaults(values: {
         [key: string]: boolean;
     }): void;

package/wrapper.js

@@ -16,6 +16,10 @@ const logger_1 = require("./logger");
 const events_1 = require("./events");
 const custom_1 = require("./core/fetcher/custom");
 class SchematicClient extends Client_1.SchematicClient {
+    /**
+     * Creates a new instance of the SchematicClient
+     * @param opts - Configuration options for the client
+     */
     constructor(opts) {
         var _a, _b;
         const { apiKey = "", basePath, eventBufferInterval, flagDefaults = {}, logger = new logger_1.ConsoleLogger(), } = opts !== null && opts !== void 0 ? opts : {};
@@ -54,6 +58,13 @@ class SchematicClient extends Client_1.SchematicClient {
         this.flagDefaults = flagDefaults;
         this.offline = offline;
     }
+    /**
+     * Checks the value of a feature flag for the given evaluation context
+     * @param evalCtx - The context (company and/or user) for evaluating the feature flag
+     * @param key - The unique identifier of the feature flag
+     * @returns Promise resolving to the flag's boolean value, falling back to default if unavailable
+     * @throws Will log error and return flag default if check fails
+     */
     checkFlag(evalCtx, key) {
         return __awaiter(this, void 0, void 0, function* () {
             if (this.offline) {
@@ -82,11 +93,21 @@ class SchematicClient extends Client_1.SchematicClient {
             }
         });
     }
+    /**
+     * Gracefully shuts down the client by stopping the event buffer
+     * @returns Promise that resolves when the event buffer has been stopped
+     */
     close() {
         return __awaiter(this, void 0, void 0, function* () {
             return this.eventBuffer.stop();
         });
     }
+    /**
+     * Send a non-blocking event to create or update companies and users
+     * @param body - The identify event payload containing user properties
+     * @returns Promise that resolves when the event has been enqueued
+     * @throws Will log error if event enqueueing fails
+     */
     identify(body) {
         return __awaiter(this, void 0, void 0, function* () {
             if (this.offline)
@@ -99,6 +120,12 @@ class SchematicClient extends Client_1.SchematicClient {
             }
         });
     }
+    /**
+     * Send a non-blocking event to track usage
+     * @param body - The track event payload containing event details
+     * @returns Promise that resolves when the event has been enqueued
+     * @throws Will log error if event enqueueing fails
+     */
     track(body) {
         return __awaiter(this, void 0, void 0, function* () {
             if (this.offline)
@@ -111,9 +138,18 @@ class SchematicClient extends Client_1.SchematicClient {
             }
         });
     }
+    /**
+     * Sets the default value for a specific feature flag
+     * @param flag - The feature flag identifier
+     * @param value - The default boolean value to set
+     */
     setFlagDefault(flag, value) {
         this.flagDefaults[flag] = value;
     }
+    /**
+     * Sets default values for multiple feature flags at once
+     * @param values - Object mapping flag identifiers to their default boolean values
+     */
     setFlagDefaults(values) {
         Object.assign(this.flagDefaults, values);
     }

package/api/types/CheckFlagOutputWithFlagKey.d.ts

@@ -1,12 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface CheckFlagOutputWithFlagKey {
-    companyId?: string;
-    error?: string;
-    flag: string;
-    reason: string;
-    ruleId?: string;
-    userId?: string;
-    value: boolean;
-}

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

@@ -1,12 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface CheckFlagOutputWithFlagKey {
-    companyId?: string;
-    error?: string;
-    flag: string;
-    reason: string;
-    ruleId?: string;
-    userId?: string;
-    value: boolean;
-}

package/dist/serialization/resources/events/types/GetEventSummaryBySubtypeResponse.d.ts

@@ -1,14 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as serializers from "../../../index";
-import * as Schematic from "../../../../api/index";
-import * as core from "../../../../core";
-import { EventSummaryResponseData } from "../../../types/EventSummaryResponseData";
-export declare const GetEventSummaryBySubtypeResponse: core.serialization.ObjectSchema<serializers.GetEventSummaryBySubtypeResponse.Raw, Schematic.GetEventSummaryBySubtypeResponse>;
-export declare namespace GetEventSummaryBySubtypeResponse {
-    interface Raw {
-        data: EventSummaryResponseData.Raw;
-        params: Record<string, unknown>;
-    }
-}

package/dist/serialization/types/CheckFlagOutputWithFlagKey.d.ts

@@ -1,18 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as serializers from "../index";
-import * as Schematic from "../../api/index";
-import * as core from "../../core";
-export declare const CheckFlagOutputWithFlagKey: core.serialization.ObjectSchema<serializers.CheckFlagOutputWithFlagKey.Raw, Schematic.CheckFlagOutputWithFlagKey>;
-export declare namespace CheckFlagOutputWithFlagKey {
-    interface Raw {
-        company_id?: string | null;
-        error?: string | null;
-        flag: string;
-        reason: string;
-        rule_id?: string | null;
-        user_id?: string | null;
-        value: boolean;
-    }
-}

package/serialization/resources/events/types/GetEventSummaryBySubtypeResponse.d.ts

@@ -1,14 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as serializers from "../../../index";
-import * as Schematic from "../../../../api/index";
-import * as core from "../../../../core";
-import { EventSummaryResponseData } from "../../../types/EventSummaryResponseData";
-export declare const GetEventSummaryBySubtypeResponse: core.serialization.ObjectSchema<serializers.GetEventSummaryBySubtypeResponse.Raw, Schematic.GetEventSummaryBySubtypeResponse>;
-export declare namespace GetEventSummaryBySubtypeResponse {
-    interface Raw {
-        data: EventSummaryResponseData.Raw;
-        params: Record<string, unknown>;
-    }
-}

package/serialization/types/CheckFlagOutputWithFlagKey.d.ts

@@ -1,18 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as serializers from "../index";
-import * as Schematic from "../../api/index";
-import * as core from "../../core";
-export declare const CheckFlagOutputWithFlagKey: core.serialization.ObjectSchema<serializers.CheckFlagOutputWithFlagKey.Raw, Schematic.CheckFlagOutputWithFlagKey>;
-export declare namespace CheckFlagOutputWithFlagKey {
-    interface Raw {
-        company_id?: string | null;
-        error?: string | null;
-        flag: string;
-        reason: string;
-        rule_id?: string | null;
-        user_id?: string | null;
-        value: boolean;
-    }
-}