@schematichq/schematic-typescript-node 1.1.10 → 1.1.11

package/events.test.js

@@ -11,17 +11,27 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const events_1 = require("./events");
+process.env.NODE_ENV = "test";
 jest.useFakeTimers();
 describe("EventBuffer", () => {
     let mockEventsApi;
     let mockLogger;
     beforeEach(() => {
+        const mockResponse = {
+            data: {
+                events: [],
+            },
+            params: {},
+        };
         mockEventsApi = {
-            createEventBatch: jest.fn().mockResolvedValue(undefined),
+            createEventBatch: jest.fn().mockResolvedValue(mockResponse),
         };
         mockLogger = {
             error: jest.fn(),
             log: jest.fn(),
+            warn: jest.fn(),
+            info: jest.fn(),
+            debug: jest.fn(),
         };
     });
     it("should push and flush events correctly", () => __awaiter(void 0, void 0, void 0, function* () {
@@ -69,6 +79,8 @@ describe("EventBuffer", () => {
         const buffer = new events_1.EventBuffer(mockEventsApi, {
             logger: mockLogger,
             interval: 1000,
+            maxRetries: 1,
+            initialRetryDelay: 1,
         });
         const event = {
             body: {
@@ -81,9 +93,10 @@ describe("EventBuffer", () => {
         };
         yield buffer.push(event);
         yield buffer.push(event);
-        // Manually trigger flush
+        // Since we're skipping delays in test environment,
+        // we can just call flush directly
         yield buffer.flush();
-        expect(mockLogger.error).toHaveBeenCalledWith("Failed to flush events", expect.any(Error));
+        expect(mockLogger.error).toHaveBeenCalledWith("Event batch submission failed after 1 retries:", expect.any(Error));
     }));
     it("should stop accepting events after stop is called", () => __awaiter(void 0, void 0, void 0, function* () {
         const buffer = new events_1.EventBuffer(mockEventsApi, {
@@ -145,4 +158,38 @@ describe("EventBuffer", () => {
         jest.advanceTimersByTime(1000);
         expect(mockEventsApi.createEventBatch).not.toHaveBeenCalled();
     }));
+    it("should retry and succeed after a failure", () => __awaiter(void 0, void 0, void 0, function* () {
+        const mockResponse = {
+            data: {
+                events: [],
+            },
+            params: {},
+        };
+        // First call fails, second succeeds
+        mockEventsApi.createEventBatch
+            .mockRejectedValueOnce(new Error("Temporary failure"))
+            .mockResolvedValueOnce(mockResponse);
+        const buffer = new events_1.EventBuffer(mockEventsApi, {
+            logger: mockLogger,
+            interval: 1000,
+            maxRetries: 3,
+            initialRetryDelay: 1,
+        });
+        const event = {
+            body: {
+                company: { id: "test-company" },
+                event: "test-event",
+                user: { id: "test-user" },
+            },
+            eventType: "track",
+            sentAt: new Date(),
+        };
+        yield buffer.push(event);
+        // Since we're skipping delays in test environment,
+        // we can just call flush directly
+        yield buffer.flush();
+        // Verify that the createEventBatch was called twice (once failed, once succeeded)
+        expect(mockEventsApi.createEventBatch).toHaveBeenCalledTimes(2);
+        expect(mockLogger.info).toHaveBeenCalledWith("Event batch submission succeeded after 1 retries");
+    }));
 });

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@schematichq/schematic-typescript-node",
-    "version": "1.1.10",
+    "version": "1.1.11",
     "private": false,
     "repository": "https://github.com/schematichq/schematic-node",
     "main": "./index.js",
@@ -40,5 +40,6 @@
         "path": false,
         "crypto": false,
         "timers": false
-    }
+    },
+    "packageManager": "yarn@1.22.22"
 }

package/reference.md

@@ -699,6 +699,46 @@ await client.accounts.deleteEnvironment("environment_id");
 </dl>
 </details>
 
+<details><summary><code>client.accounts.<a href="/src/api/resources/accounts/client/Client.ts">quickstart</a>() -> Schematic.QuickstartResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.accounts.quickstart();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `Accounts.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## features
 
 <details><summary><code>client.features.<a href="/src/api/resources/features/client/Client.ts">countAudienceCompanies</a>({ ...params }) -> Schematic.CountAudienceCompaniesResponse</code></summary>
@@ -1926,7 +1966,7 @@ await client.billing.upsertBillingCustomer({
 </dl>
 </details>
 
-<details><summary><code>client.billing.<a href="/src/api/resources/billing/client/Client.ts">listCustomers</a>({ ...params }) -> Schematic.ListCustomersResponse</code></summary>
+<details><summary><code>client.billing.<a href="/src/api/resources/billing/client/Client.ts">listCustomersWithSubscriptions</a>({ ...params }) -> Schematic.ListCustomersWithSubscriptionsResponse</code></summary>
 <dl>
 <dd>
 
@@ -1939,7 +1979,7 @@ await client.billing.upsertBillingCustomer({
 <dd>
 
 ```typescript
-await client.billing.listCustomers();
+await client.billing.listCustomersWithSubscriptions();
 ```
 
 </dd>
@@ -1955,7 +1995,7 @@ await client.billing.listCustomers();
 <dl>
 <dd>
 
-**request:** `Schematic.ListCustomersRequest`
+**request:** `Schematic.ListCustomersWithSubscriptionsRequest`
 
 </dd>
 </dl>
@@ -2393,6 +2433,7 @@ await client.billing.searchBillingPrices();
 
 ```typescript
 await client.billing.upsertBillingPrice({
+    billingScheme: "per_unit",
     currency: "currency",
     externalAccountId: "external_account_id",
     interval: "interval",
@@ -2599,12 +2640,9 @@ await client.billing.deleteProductPrice("billing_id");
 
 ```typescript
 await client.billing.upsertBillingProduct({
-    active: true,
-    currency: "currency",
     externalId: "external_id",
     name: "name",
     price: 1.1,
-    quantity: 1,
 });
 ```
 
@@ -3411,9 +3449,7 @@ await client.companies.deleteCompanyByKeys({
 ```typescript
 await client.companies.lookupCompany({
     keys: {
-        keys: {
-            key: "value",
-        },
+        keys: "keys",
     },
 });
 ```
@@ -4264,6 +4300,11 @@ await client.companies.listUsers();
 
 ```typescript
 await client.companies.upsertUser({
+    companies: [
+        {
+            key: "value",
+        },
+    ],
     company: {
         key: "value",
     },
@@ -4463,6 +4504,11 @@ await client.companies.countUsers();
 
 ```typescript
 await client.companies.createUser({
+    companies: [
+        {
+            key: "value",
+        },
+    ],
     company: {
         key: "value",
     },
@@ -4571,9 +4617,7 @@ await client.companies.deleteUserByKeys({
 ```typescript
 await client.companies.lookupUser({
     keys: {
-        keys: {
-            key: "value",
-        },
+        keys: "keys",
     },
 });
 ```
@@ -5527,9 +5571,7 @@ await client.entitlements.countPlanEntitlements();
 ```typescript
 await client.entitlements.getFeatureUsageByCompany({
     keys: {
-        keys: {
-            key: "value",
-        },
+        keys: "keys",
     },
 });
 ```
@@ -5797,6 +5839,309 @@ await client.plans.deleteAudience("plan_audience_id");
 </dl>
 </details>
 
+<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">listPlanTraits</a>({ ...params }) -> Schematic.ListPlanTraitsResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.plans.listPlanTraits();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Schematic.ListPlanTraitsRequest`
+
+</dd>
+</dl>
+
+<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">createPlanTrait</a>({ ...params }) -> Schematic.CreatePlanTraitResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.plans.createPlanTrait({
+    planId: "plan_id",
+    traitId: "trait_id",
+    traitValue: "trait_value",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Schematic.CreatePlanTraitRequestBody`
+
+</dd>
+</dl>
+
+<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">getPlanTrait</a>(planTraitId) -> Schematic.GetPlanTraitResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.plans.getPlanTrait("plan_trait_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**planTraitId:** `string` — plan_trait_id
+
+</dd>
+</dl>
+
+<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">updatePlanTrait</a>(planTraitId, { ...params }) -> Schematic.UpdatePlanTraitResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.plans.updatePlanTrait("plan_trait_id", {
+    planId: "plan_id",
+    traitValue: "trait_value",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**planTraitId:** `string` — plan_trait_id
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Schematic.UpdatePlanTraitRequestBody`
+
+</dd>
+</dl>
+
+<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">deletePlanTrait</a>(planTraitId) -> Schematic.DeletePlanTraitResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.plans.deletePlanTrait("plan_trait_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**planTraitId:** `string` — plan_trait_id
+
+</dd>
+</dl>
+
+<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">countPlanTraits</a>({ ...params }) -> Schematic.CountPlanTraitsResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.plans.countPlanTraits();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Schematic.CountPlanTraitsRequest`
+
+</dd>
+</dl>
+
+<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">listPlans</a>({ ...params }) -> Schematic.ListPlansResponse</code></summary>
 <dl>
 <dd>
@@ -6771,6 +7116,58 @@ await client.crm.upsertCrmProduct({
 </dl>
 </details>
 
+## dataexports
+
+<details><summary><code>client.dataexports.<a href="/src/api/resources/dataexports/client/Client.ts">createDataExport</a>({ ...params }) -> Schematic.CreateDataExportResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.dataexports.createDataExport({
+    metadata: "metadata",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Schematic.CreateDataExportRequestBody`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Dataexports.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## events
 
 <details><summary><code>client.events.<a href="/src/api/resources/events/client/Client.ts">createEventBatch</a>({ ...params }) -> Schematic.CreateEventBatchResponse</code></summary>

package/serialization/resources/accounts/types/QuickstartResponse.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";
+import { QuickstartResp } from "../../../types/QuickstartResp";
+export declare const QuickstartResponse: core.serialization.ObjectSchema<serializers.QuickstartResponse.Raw, Schematic.QuickstartResponse>;
+export declare namespace QuickstartResponse {
+    interface Raw {
+        data: QuickstartResp.Raw;
+        params: Record<string, unknown>;
+    }
+}

package/serialization/resources/accounts/types/QuickstartResponse.js

@@ -0,0 +1,45 @@
+"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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QuickstartResponse = void 0;
+const core = __importStar(require("../../../../core"));
+const QuickstartResp_1 = require("../../../types/QuickstartResp");
+exports.QuickstartResponse = core.serialization.object({
+    data: QuickstartResp_1.QuickstartResp,
+    params: core.serialization.record(core.serialization.string(), core.serialization.unknown()),
+});

package/serialization/resources/accounts/types/index.d.ts

@@ -19,3 +19,4 @@ export * from "./GetEnvironmentResponse";
 export * from "./UpdateEnvironmentRequestBodyEnvironmentType";
 export * from "./UpdateEnvironmentResponse";
 export * from "./DeleteEnvironmentResponse";
+export * from "./QuickstartResponse";

package/serialization/resources/accounts/types/index.js

@@ -35,3 +35,4 @@ __exportStar(require("./GetEnvironmentResponse"), exports);
 __exportStar(require("./UpdateEnvironmentRequestBodyEnvironmentType"), exports);
 __exportStar(require("./UpdateEnvironmentResponse"), exports);
 __exportStar(require("./DeleteEnvironmentResponse"), exports);
+__exportStar(require("./QuickstartResponse"), exports);