@chrt-inc/typescript-sdk 1.359.1 → 1.363.0

package/reference.md

@@ -1371,9 +1371,9 @@ await client.flights.getFlightInfoForTaskV1("task_id");
 </dl>
 </details>
 
-## TaskArtifactNotifications
+## Notifications
 
-<details><summary><code>client.taskArtifactNotifications.<a href="/src/api/resources/taskArtifactNotifications/client/Client.ts">getPreferencesV1</a>() -> Chrt.TaskArtifactNotificationPreferences1</code></summary>
+<details><summary><code>client.notifications.<a href="/src/api/resources/notifications/client/Client.ts">getNotificationV1</a>() -> string</code></summary>
 <dl>
 <dd>
 
@@ -1385,7 +1385,7 @@ await client.flights.getFlightInfoForTaskV1("task_id");
 <dl>
 <dd>
 
-Retrieves task_artifact notification preferences for the caller's organization. | () -> (TaskArtifactNotificationPreferences1)
+Development notification endpoint that returns the caller's ID for testing. | () -> (str)
 
 </dd>
 </dl>
@@ -1401,7 +1401,7 @@ Retrieves task_artifact notification preferences for the caller's organization.
 <dd>
 
 ```typescript
-await client.taskArtifactNotifications.getPreferencesV1();
+await client.notifications.getNotificationV1();
 ```
 
 </dd>
@@ -1417,7 +1417,7 @@ await client.taskArtifactNotifications.getPreferencesV1();
 <dl>
 <dd>
 
-**requestOptions:** `TaskArtifactNotifications.RequestOptions`
+**requestOptions:** `Notifications.RequestOptions`
 
 </dd>
 </dl>
@@ -1428,7 +1428,7 @@ await client.taskArtifactNotifications.getPreferencesV1();
 </dl>
 </details>
 
-<details><summary><code>client.taskArtifactNotifications.<a href="/src/api/resources/taskArtifactNotifications/client/Client.ts">upsertPreferencesV1</a>({ ...params }) -> string</code></summary>
+<details><summary><code>client.notifications.<a href="/src/api/resources/notifications/client/Client.ts">createNotificationV1</a>({ ...params }) -> Chrt.NotificationRes</code></summary>
 <dl>
 <dd>
 
@@ -1440,7 +1440,7 @@ await client.taskArtifactNotifications.getPreferencesV1();
 <dl>
 <dd>
 
-Creates or updates task_artifact notification preferences for the caller's organization. | (TaskArtifactNotificationPreferencesClientCreate1) -> (PydanticObjectId)
+Send a notification email to a chrt.com recipient. | (NotificationReq) -> (NotificationRes)
 
 </dd>
 </dl>
@@ -1456,8 +1456,10 @@ Creates or updates task_artifact notification preferences for the caller's organ
 <dd>
 
 ```typescript
-await client.taskArtifactNotifications.upsertPreferencesV1({
-    schema_version: 1,
+await client.notifications.createNotificationV1({
+    recipient: "aaron",
+    name: "name",
+    message: "message",
 });
 ```
 
@@ -1474,7 +1476,7 @@ await client.taskArtifactNotifications.upsertPreferencesV1({
 <dl>
 <dd>
 
-**request:** `Chrt.TaskArtifactNotificationPreferencesClientCreate1`
+**request:** `Chrt.NotificationReq`
 
 </dd>
 </dl>
@@ -1482,7 +1484,7 @@ await client.taskArtifactNotifications.upsertPreferencesV1({
 <dl>
 <dd>
 
-**requestOptions:** `TaskArtifactNotifications.RequestOptions`
+**requestOptions:** `Notifications.RequestOptions`
 
 </dd>
 </dl>
@@ -8417,250 +8419,6 @@ await client.connections.connectionToForwarder.createV1({
 </dl>
 </details>
 
-## Notifications Shipper
-
-<details><summary><code>client.notifications.shipper.<a href="/src/api/resources/notifications/resources/shipper/client/Client.ts">getPreferencesV1</a>() -> Chrt.ShipperNotificationPreferences1</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Retrieves notification preferences for the caller's shipper organization. | () -> (ShipperNotificationPreferences1)
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.notifications.shipper.getPreferencesV1();
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**requestOptions:** `Shipper.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.notifications.shipper.<a href="/src/api/resources/notifications/resources/shipper/client/Client.ts">upsertPreferencesV1</a>({ ...params }) -> string</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Creates or updates notification preferences for the caller's shipper organization. | (ShipperNotificationPreferencesClientCreate1) -> (PydanticObjectId)
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.notifications.shipper.upsertPreferencesV1({
-    schema_version: 1,
-});
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `Chrt.notifications.ShipperNotificationPreferencesClientCreate1`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `Shipper.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-## Notifications Courier
-
-<details><summary><code>client.notifications.courier.<a href="/src/api/resources/notifications/resources/courier/client/Client.ts">getPreferencesV1</a>() -> Chrt.CourierNotificationPreferences1</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Retrieves notification preferences for the caller's courier organization. | () -> (CourierNotificationPreferences1)
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.notifications.courier.getPreferencesV1();
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**requestOptions:** `Courier.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.notifications.courier.<a href="/src/api/resources/notifications/resources/courier/client/Client.ts">upsertPreferencesV1</a>({ ...params }) -> string</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Creates or updates notification preferences for the caller's courier organization. | (CourierNotificationPreferencesClientCreate1) -> (PydanticObjectId)
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.notifications.courier.upsertPreferencesV1({
-    schema_version: 1,
-});
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `Chrt.notifications.CourierNotificationPreferencesClientCreate1`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `Courier.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
 ## OrderDrafts TaskGroup
 
 <details><summary><code>client.orderDrafts.taskGroup.<a href="/src/api/resources/orderDrafts/resources/taskGroup/client/Client.ts">addV1</a>({ ...params }) -> string</code></summary>

package/dist/cjs/api/resources/notifications/resources/courier/client/Client.d.ts

@@ -1,59 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as environments from "../../../../../../environments.js";
-import * as core from "../../../../../../core/index.js";
-import * as Chrt from "../../../../../index.js";
-export declare namespace Courier {
-    interface Options {
-        environment?: core.Supplier<environments.ChrtEnvironment | string>;
-        /** Specify a custom URL to connect the client to. */
-        baseUrl?: core.Supplier<string>;
-        token?: core.Supplier<core.BearerToken | undefined>;
-        /** Additional headers to include in requests. */
-        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
-        fetcher?: core.FetchFunction;
-    }
-    interface RequestOptions {
-        /** The maximum time to wait for a response in seconds. */
-        timeoutInSeconds?: number;
-        /** The number of times to retry the request. Defaults to 2. */
-        maxRetries?: number;
-        /** A hook to abort the request. */
-        abortSignal?: AbortSignal;
-        /** Additional query string parameters to include in the request. */
-        queryParams?: Record<string, unknown>;
-        /** Additional headers to include in the request. */
-        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
-    }
-}
-export declare class Courier {
-    protected readonly _options: Courier.Options;
-    constructor(_options?: Courier.Options);
-    /**
-     * Retrieves notification preferences for the caller's courier organization. | () -> (CourierNotificationPreferences1)
-     *
-     * @param {Courier.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.notifications.courier.getPreferencesV1()
-     */
-    getPreferencesV1(requestOptions?: Courier.RequestOptions): core.HttpResponsePromise<Chrt.CourierNotificationPreferences1>;
-    private __getPreferencesV1;
-    /**
-     * Creates or updates notification preferences for the caller's courier organization. | (CourierNotificationPreferencesClientCreate1) -> (PydanticObjectId)
-     *
-     * @param {Chrt.notifications.CourierNotificationPreferencesClientCreate1} request
-     * @param {Courier.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.notifications.courier.upsertPreferencesV1({
-     *         schema_version: 1
-     *     })
-     */
-    upsertPreferencesV1(request: Chrt.notifications.CourierNotificationPreferencesClientCreate1, requestOptions?: Courier.RequestOptions): core.HttpResponsePromise<string>;
-    private __upsertPreferencesV1;
-    protected _getAuthorizationHeader(): Promise<string | undefined>;
-}

package/dist/cjs/api/resources/notifications/resources/courier/client/Client.js

@@ -1,183 +0,0 @@
-"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;
-    };
-})();
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Courier = void 0;
-const environments = __importStar(require("../../../../../../environments.js"));
-const core = __importStar(require("../../../../../../core/index.js"));
-const Chrt = __importStar(require("../../../../../index.js"));
-const headers_js_1 = require("../../../../../../core/headers.js");
-const errors = __importStar(require("../../../../../../errors/index.js"));
-class Courier {
-    constructor(_options = {}) {
-        this._options = _options;
-    }
-    /**
-     * Retrieves notification preferences for the caller's courier organization. | () -> (CourierNotificationPreferences1)
-     *
-     * @param {Courier.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.notifications.courier.getPreferencesV1()
-     */
-    getPreferencesV1(requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__getPreferencesV1(requestOptions));
-    }
-    __getPreferencesV1(requestOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d;
-            let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
-            const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
-                url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, "notifications/courier_preferences/v1"),
-                method: "GET",
-                headers: _headers,
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
-                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
-                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
-                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-            });
-            if (_response.ok) {
-                return { data: _response.body, rawResponse: _response.rawResponse };
-            }
-            if (_response.error.reason === "status-code") {
-                throw new errors.ChrtError({
-                    statusCode: _response.error.statusCode,
-                    body: _response.error.body,
-                    rawResponse: _response.rawResponse,
-                });
-            }
-            switch (_response.error.reason) {
-                case "non-json":
-                    throw new errors.ChrtError({
-                        statusCode: _response.error.statusCode,
-                        body: _response.error.rawBody,
-                        rawResponse: _response.rawResponse,
-                    });
-                case "timeout":
-                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /notifications/courier_preferences/v1.");
-                case "unknown":
-                    throw new errors.ChrtError({
-                        message: _response.error.errorMessage,
-                        rawResponse: _response.rawResponse,
-                    });
-            }
-        });
-    }
-    /**
-     * Creates or updates notification preferences for the caller's courier organization. | (CourierNotificationPreferencesClientCreate1) -> (PydanticObjectId)
-     *
-     * @param {Chrt.notifications.CourierNotificationPreferencesClientCreate1} request
-     * @param {Courier.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.notifications.courier.upsertPreferencesV1({
-     *         schema_version: 1
-     *     })
-     */
-    upsertPreferencesV1(request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__upsertPreferencesV1(request, requestOptions));
-    }
-    __upsertPreferencesV1(request, requestOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d;
-            let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
-            const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
-                url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, "notifications/courier_preferences/upsert/v1"),
-                method: "POST",
-                headers: _headers,
-                contentType: "application/json",
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
-                requestType: "json",
-                body: request,
-                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
-                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
-                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-            });
-            if (_response.ok) {
-                return { data: _response.body, rawResponse: _response.rawResponse };
-            }
-            if (_response.error.reason === "status-code") {
-                switch (_response.error.statusCode) {
-                    case 422:
-                        throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
-                    default:
-                        throw new errors.ChrtError({
-                            statusCode: _response.error.statusCode,
-                            body: _response.error.body,
-                            rawResponse: _response.rawResponse,
-                        });
-                }
-            }
-            switch (_response.error.reason) {
-                case "non-json":
-                    throw new errors.ChrtError({
-                        statusCode: _response.error.statusCode,
-                        body: _response.error.rawBody,
-                        rawResponse: _response.rawResponse,
-                    });
-                case "timeout":
-                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /notifications/courier_preferences/upsert/v1.");
-                case "unknown":
-                    throw new errors.ChrtError({
-                        message: _response.error.errorMessage,
-                        rawResponse: _response.rawResponse,
-                    });
-            }
-        });
-    }
-    _getAuthorizationHeader() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const bearer = yield core.Supplier.get(this._options.token);
-            if (bearer != null) {
-                return `Bearer ${bearer}`;
-            }
-            return undefined;
-        });
-    }
-}
-exports.Courier = Courier;

package/dist/cjs/api/resources/notifications/resources/courier/client/index.d.ts

@@ -1,2 +0,0 @@
-export {};
-export * from "./requests/index.js";

package/dist/cjs/api/resources/notifications/resources/courier/client/index.js

@@ -1,17 +0,0 @@
-"use strict";
-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 __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./requests/index.js"), exports);

package/dist/cjs/api/resources/notifications/resources/courier/client/requests/CourierNotificationPreferencesClientCreate1.d.ts

@@ -1,18 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Chrt from "../../../../../../index.js";
-/**
- * @example
- *     {
- *         schema_version: 1
- *     }
- */
-export interface CourierNotificationPreferencesClientCreate1 {
-    schema_version: number;
-    email_addresses?: string[];
-    sms_phone_numbers?: string[];
-    voice_phone_numbers?: string[];
-    /** For each CourierNotificationEventEnum, which channels (email/sms/push/phone_call) are enabled */
-    preferences?: Record<string, Chrt.NotificationChannelEnum[]>;
-}

package/dist/cjs/api/resources/notifications/resources/courier/client/requests/index.d.ts

@@ -1 +0,0 @@
-export { type CourierNotificationPreferencesClientCreate1 } from "./CourierNotificationPreferencesClientCreate1.js";

package/dist/cjs/api/resources/notifications/resources/courier/index.d.ts

@@ -1 +0,0 @@
-export * from "./client/index.js";

package/dist/cjs/api/resources/notifications/resources/courier/index.js

@@ -1,17 +0,0 @@
-"use strict";
-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 __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./client/index.js"), exports);

package/dist/cjs/api/resources/notifications/resources/index.d.ts

@@ -1,4 +0,0 @@
-export * as shipper from "./shipper/index.js";
-export * as courier from "./courier/index.js";
-export * from "./shipper/client/requests/index.js";
-export * from "./courier/client/requests/index.js";