@schematichq/schematic-typescript-node 1.1.2 → 1.1.4

package/dist/serialization/types/CompanyDetailResponseData.js

@@ -31,6 +31,7 @@ const core = __importStar(require("../../core"));
 const PreviewObject_1 = require("./PreviewObject");
 const EntityTraitDetailResponseData_1 = require("./EntityTraitDetailResponseData");
 const EntityKeyDetailResponseData_1 = require("./EntityKeyDetailResponseData");
+const BillingPlan_1 = require("./BillingPlan");
 exports.CompanyDetailResponseData = core.serialization.object({
     addOns: core.serialization.property("add_ons", core.serialization.list(PreviewObject_1.PreviewObject)),
     createdAt: core.serialization.property("created_at", core.serialization.date()),
@@ -41,7 +42,7 @@ exports.CompanyDetailResponseData = core.serialization.object({
     lastSeenAt: core.serialization.property("last_seen_at", core.serialization.date().optional()),
     logoUrl: core.serialization.property("logo_url", core.serialization.string().optional()),
     name: core.serialization.string(),
-    plan: PreviewObject_1.PreviewObject.optional(),
+    plan: BillingPlan_1.BillingPlan.optional(),
     plans: core.serialization.list(PreviewObject_1.PreviewObject),
     traits: core.serialization.record(core.serialization.string(), core.serialization.unknown()).optional(),
     updatedAt: core.serialization.property("updated_at", core.serialization.date()),

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

@@ -4,14 +4,14 @@
 import * as serializers from "../index";
 import * as Schematic from "../../api/index";
 import * as core from "../../core";
-import { BillingProductResponseData } from "./BillingProductResponseData";
+import { BillingProductForSubscriptionResponseData } from "./BillingProductForSubscriptionResponseData";
 export declare const CompanySubscriptionResponseData: core.serialization.ObjectSchema<serializers.CompanySubscriptionResponseData.Raw, Schematic.CompanySubscriptionResponseData>;
 export declare namespace CompanySubscriptionResponseData {
     interface Raw {
         customer_external_id: string;
         expired_at?: string | null;
         interval: string;
-        products: BillingProductResponseData.Raw[];
+        products: BillingProductForSubscriptionResponseData.Raw[];
         subscription_external_id: string;
     }
 }

package/dist/serialization/types/CompanySubscriptionResponseData.js

@@ -28,11 +28,11 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CompanySubscriptionResponseData = void 0;
 const core = __importStar(require("../../core"));
-const BillingProductResponseData_1 = require("./BillingProductResponseData");
+const BillingProductForSubscriptionResponseData_1 = require("./BillingProductForSubscriptionResponseData");
 exports.CompanySubscriptionResponseData = core.serialization.object({
     customerExternalId: core.serialization.property("customer_external_id", core.serialization.string()),
     expiredAt: core.serialization.property("expired_at", core.serialization.date().optional()),
     interval: core.serialization.string(),
-    products: core.serialization.list(BillingProductResponseData_1.BillingProductResponseData),
+    products: core.serialization.list(BillingProductForSubscriptionResponseData_1.BillingProductForSubscriptionResponseData),
     subscriptionExternalId: core.serialization.property("subscription_external_id", core.serialization.string()),
 });

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

@@ -9,7 +9,6 @@ import { FeatureDetailResponseData } from "./FeatureDetailResponseData";
 export declare const PlanDetailResponseData: core.serialization.ObjectSchema<serializers.PlanDetailResponseData.Raw, Schematic.PlanDetailResponseData>;
 export declare namespace PlanDetailResponseData {
     interface Raw {
-        audience_type: string;
         billing_product?: BillingProductDetailResponseData.Raw | null;
         company_count: number;
         created_at: string;

package/dist/serialization/types/PlanDetailResponseData.js

@@ -31,7 +31,6 @@ const core = __importStar(require("../../core"));
 const BillingProductDetailResponseData_1 = require("./BillingProductDetailResponseData");
 const FeatureDetailResponseData_1 = require("./FeatureDetailResponseData");
 exports.PlanDetailResponseData = core.serialization.object({
-    audienceType: core.serialization.property("audience_type", core.serialization.string()),
     billingProduct: core.serialization.property("billing_product", BillingProductDetailResponseData_1.BillingProductDetailResponseData.optional()),
     companyCount: core.serialization.property("company_count", core.serialization.number()),
     createdAt: core.serialization.property("created_at", core.serialization.date()),

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

@@ -7,7 +7,6 @@ import * as core from "../../core";
 export declare const PlanResponseData: core.serialization.ObjectSchema<serializers.PlanResponseData.Raw, Schematic.PlanResponseData>;
 export declare namespace PlanResponseData {
     interface Raw {
-        audience_type: string;
         created_at: string;
         description: string;
         icon: string;

package/dist/serialization/types/PlanResponseData.js

@@ -29,7 +29,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PlanResponseData = void 0;
 const core = __importStar(require("../../core"));
 exports.PlanResponseData = core.serialization.object({
-    audienceType: core.serialization.property("audience_type", core.serialization.string()),
     createdAt: core.serialization.property("created_at", core.serialization.date()),
     description: core.serialization.string(),
     icon: core.serialization.string(),

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

@@ -7,8 +7,11 @@ export * from "./AudienceRequestBody";
 export * from "./BillingCustomerResponseData";
 export * from "./BillingCustomerSubscription";
 export * from "./BillingCustomerWithSubscriptionsResponseData";
+export * from "./BillingPlan";
+export * from "./BillingPlanGroupResponseData";
 export * from "./BillingPriceResponseData";
 export * from "./BillingProductDetailResponseData";
+export * from "./BillingProductForSubscriptionResponseData";
 export * from "./BillingProductPlanResponseData";
 export * from "./BillingProductPricing";
 export * from "./BillingProductResponseData";
@@ -22,7 +25,6 @@ export * from "./CompanyDetailResponseData";
 export * from "./CompanyMembershipDetailResponseData";
 export * from "./CompanyMembershipResponseData";
 export * from "./CompanyOverrideResponseData";
-export * from "./CompanyPlanResponseData";
 export * from "./CompanyResponseData";
 export * from "./CompanySubscriptionResponseData";
 export * from "./ComponentHydrateResponseData";

package/dist/serialization/types/index.js

@@ -23,8 +23,11 @@ __exportStar(require("./AudienceRequestBody"), exports);
 __exportStar(require("./BillingCustomerResponseData"), exports);
 __exportStar(require("./BillingCustomerSubscription"), exports);
 __exportStar(require("./BillingCustomerWithSubscriptionsResponseData"), exports);
+__exportStar(require("./BillingPlan"), exports);
+__exportStar(require("./BillingPlanGroupResponseData"), exports);
 __exportStar(require("./BillingPriceResponseData"), exports);
 __exportStar(require("./BillingProductDetailResponseData"), exports);
+__exportStar(require("./BillingProductForSubscriptionResponseData"), exports);
 __exportStar(require("./BillingProductPlanResponseData"), exports);
 __exportStar(require("./BillingProductPricing"), exports);
 __exportStar(require("./BillingProductResponseData"), exports);
@@ -38,7 +41,6 @@ __exportStar(require("./CompanyDetailResponseData"), exports);
 __exportStar(require("./CompanyMembershipDetailResponseData"), exports);
 __exportStar(require("./CompanyMembershipResponseData"), exports);
 __exportStar(require("./CompanyOverrideResponseData"), exports);
-__exportStar(require("./CompanyPlanResponseData"), exports);
 __exportStar(require("./CompanyResponseData"), exports);
 __exportStar(require("./CompanySubscriptionResponseData"), exports);
 __exportStar(require("./ComponentHydrateResponseData"), exports);

package/dist/wrapper.js

@@ -18,7 +18,9 @@ const custom_1 = require("./core/fetcher/custom");
 class SchematicClient extends Client_1.SchematicClient {
     constructor(opts) {
         var _a, _b;
-        const { apiKey = "", offline = false } = opts !== null && opts !== void 0 ? opts : {};
+        const { apiKey = "", basePath, eventBufferInterval, flagDefaults = {}, logger = new logger_1.ConsoleLogger(), } = opts !== null && opts !== void 0 ? opts : {};
+        let { offline = false } = opts !== null && opts !== void 0 ? opts : {};
+        // Set headers
         const headers = {};
         if (opts === null || opts === void 0 ? void 0 : opts.environmentId) {
             headers["X-Schematic-Environment-Id"] = opts.environmentId;
@@ -26,28 +28,31 @@ class SchematicClient extends Client_1.SchematicClient {
         if (opts === null || opts === void 0 ? void 0 : opts.headers) {
             Object.assign(headers, opts.headers);
         }
+        // Handle implied offline mode
+        if (offline) {
+            if (apiKey !== "") {
+                logger.debug("Offline mode enabled, ignoring API key");
+            }
+        }
+        else if (apiKey === "" && !offline) {
+            logger.warn("No API key was provided, running in offline mode");
+            offline = true;
+        }
+        // Initialize wrapped client
         super({
             apiKey,
-            environment: (opts === null || opts === void 0 ? void 0 : opts.basePath) ? opts.basePath : undefined,
+            environment: basePath,
             fetcher: offline ? custom_1.offlineFetcher : (0, custom_1.provideFetcher)(headers),
         });
-        const { flagDefaults = {} } = opts !== null && opts !== void 0 ? opts : {};
+        this.logger = logger;
         this.eventBuffer = new events_1.EventBuffer(this.events, {
-            interval: opts === null || opts === void 0 ? void 0 : opts.eventBufferInterval,
+            interval: eventBufferInterval,
+            logger,
+            offline,
         });
         this.flagCheckCacheProviders = (_b = (_a = opts === null || opts === void 0 ? void 0 : opts.cacheProviders) === null || _a === void 0 ? void 0 : _a.flagChecks) !== null && _b !== void 0 ? _b : [new cache_1.LocalCache()];
-        this.logger = (opts === null || opts === void 0 ? void 0 : opts.logger) || new logger_1.ConsoleLogger();
-        if (offline) {
-            if (apiKey !== "") {
-                this.logger.debug("Offline mode enabled, ignoring API key");
-            }
-        }
-        else if (apiKey === "") {
-            this.logger.warn("No API key was provided, running in offline mode");
-            this.offline = true;
-        }
-        this.offline = offline;
         this.flagDefaults = flagDefaults;
+        this.offline = offline;
     }
     checkFlag(evalCtx, key) {
         return __awaiter(this, void 0, void 0, function* () {

package/events.d.ts

@@ -5,13 +5,16 @@ interface EventBufferOptions {
     interval?: number;
     logger?: Logger;
     maxSize?: number;
+    offline?: boolean;
 }
 declare class EventBuffer {
     private events;
     private eventsApi;
     private interval;
+    private intervalId;
     private logger;
     private maxSize;
+    private offline;
     private shutdown;
     private stopped;
     constructor(eventsApi: Events, opts?: EventBufferOptions);

package/events.js

@@ -16,13 +16,15 @@ const DEFAULT_MAX_SIZE = 1000; // 1000 items
 class EventBuffer {
     constructor(eventsApi, opts) {
         this.events = [];
+        this.intervalId = null;
         this.shutdown = false;
         this.stopped = false;
-        const { logger, maxSize, interval } = opts || {};
+        const { logger = new logger_1.ConsoleLogger(), maxSize = DEFAULT_MAX_SIZE, interval = DEFAULT_FLUSH_INTERVAL, offline = false, } = opts || {};
         this.eventsApi = eventsApi;
-        this.interval = interval || DEFAULT_FLUSH_INTERVAL;
-        this.logger = logger || new logger_1.ConsoleLogger();
-        this.maxSize = maxSize || DEFAULT_MAX_SIZE;
+        this.interval = interval;
+        this.logger = logger;
+        this.maxSize = maxSize;
+        this.offline = offline;
         this.startPeriodicFlush();
     }
     flush() {
@@ -42,6 +44,9 @@ class EventBuffer {
     }
     push(event) {
         return __awaiter(this, void 0, void 0, function* () {
+            if (this.offline) {
+                return;
+            }
             if (this.stopped) {
                 this.logger.error("Event buffer is stopped, not accepting new events");
                 return;
@@ -56,11 +61,18 @@ class EventBuffer {
         return __awaiter(this, void 0, void 0, function* () {
             this.shutdown = true;
             this.stopped = true;
+            if (this.intervalId) {
+                clearInterval(this.intervalId);
+                this.intervalId = null;
+            }
             yield this.flush();
         });
     }
     startPeriodicFlush() {
-        setInterval(() => __awaiter(this, void 0, void 0, function* () {
+        if (this.offline || this.intervalId) {
+            return;
+        }
+        this.intervalId = setInterval(() => __awaiter(this, void 0, void 0, function* () {
             if (this.shutdown)
                 return;
             yield this.flush();

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@schematichq/schematic-typescript-node",
-    "version": "1.1.2",
+    "version": "1.1.4",
     "private": false,
     "repository": "https://github.com/schematichq/schematic-node",
     "main": "./index.js",

package/reference.md

@@ -1,5 +1,47 @@
 # Reference
 
+<details><summary><code>client.<a href="/src/Client.ts">getCompanyPlans</a>() -> void</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.getCompanyPlans();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `SchematicClient.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+##
+
 ## accounts
 
 <details><summary><code>client.accounts.<a href="/src/api/resources/accounts/client/Client.ts">listApiKeys</a>({ ...params }) -> Schematic.ListApiKeysResponse</code></summary>
@@ -1917,6 +1959,154 @@ await client.billing.countCustomers();
 </dl>
 </details>
 
+<details><summary><code>client.billing.<a href="/src/api/resources/billing/client/Client.ts">getBillingPlanGroupByAccountId</a>() -> Schematic.GetBillingPlanGroupByAccountIdResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.billing.getBillingPlanGroupByAccountId();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `Billing.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.billing.<a href="/src/api/resources/billing/client/Client.ts">createBillingPlanGroup</a>({ ...params }) -> Schematic.CreateBillingPlanGroupResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.billing.createBillingPlanGroup({
+    planIds: ["plan_ids"],
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Schematic.CreateBillingPlanGroupRequestBody`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Billing.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.billing.<a href="/src/api/resources/billing/client/Client.ts">updateBillingPlanGroup</a>(billingId, { ...params }) -> Schematic.UpdateBillingPlanGroupResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.billing.updateBillingPlanGroup("billing_id", {
+    planIds: ["plan_ids"],
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**billingId:** `string` — billing_id
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Schematic.UpdateBillingPlanGroupRequestBody`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Billing.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.billing.<a href="/src/api/resources/billing/client/Client.ts">upsertBillingPrice</a>({ ...params }) -> Schematic.UpsertBillingPriceResponse</code></summary>
 <dl>
 <dd>
@@ -2179,6 +2369,58 @@ await client.billing.upsertBillingSubscription({
 </dl>
 </details>
 
+<details><summary><code>client.billing.<a href="/src/api/resources/billing/client/Client.ts">changeSubscriptionWeb</a>({ ...params }) -> Schematic.ChangeSubscriptionWebResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.billing.changeSubscriptionWeb({
+    action: "action",
+    newPlanId: "new_plan_id",
+    newPriceId: "new_price_id",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Schematic.ChangeSubscriptionRequestBody`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Billing.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## companies
 
 <details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">listCompanies</a>({ ...params }) -> Schematic.ListCompaniesResponse</code></summary>
@@ -2781,54 +3023,6 @@ await client.companies.deleteCompanyMembership("company_membership_id");
 </dl>
 </details>
 
-<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">listCompanyPlans</a>({ ...params }) -> Schematic.ListCompanyPlansResponse</code></summary>
-<dl>
-<dd>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.companies.listCompanyPlans();
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `Schematic.ListCompanyPlansRequest`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `Companies.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
 <details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">getActiveCompanySubscription</a>({ ...params }) -> Schematic.GetActiveCompanySubscriptionResponse</code></summary>
 <dl>
 <dd>
@@ -6083,7 +6277,6 @@ await client.plans.getPlan("plan_id");
 
 ```typescript
 await client.plans.updatePlan("plan_id", {
-    audienceType: "audience_type",
     name: "name",
 });
 ```
@@ -6234,6 +6427,46 @@ await client.plans.upsertBillingProductPlan("plan_id", {
 </dl>
 </details>
 
+<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">listActivePlans</a>() -> Schematic.ListActivePlansResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.plans.listActivePlans();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `Plans.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">countPlans</a>({ ...params }) -> Schematic.CountPlansResponse</code></summary>
 <dl>
 <dd>

package/serialization/resources/billing/client/requests/ChangeSubscriptionRequestBody.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 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 ChangeSubscriptionRequestBody: core.serialization.Schema<serializers.ChangeSubscriptionRequestBody.Raw, Schematic.ChangeSubscriptionRequestBody>;
+export declare namespace ChangeSubscriptionRequestBody {
+    interface Raw {
+        action: string;
+        new_plan_id: string;
+        new_price_id: string;
+    }
+}

package/serialization/resources/billing/client/requests/ChangeSubscriptionRequestBody.js

@@ -0,0 +1,35 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChangeSubscriptionRequestBody = void 0;
+const core = __importStar(require("../../../../../core"));
+exports.ChangeSubscriptionRequestBody = core.serialization.object({
+    action: core.serialization.string(),
+    newPlanId: core.serialization.property("new_plan_id", core.serialization.string()),
+    newPriceId: core.serialization.property("new_price_id", core.serialization.string()),
+});