UNPKG

phonic

Version:

[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2FPhonic-Co%2Fphonic-node) [![npm shield](htt

607 lines (606 loc) 31.9 kB
"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()); }); }; var __rest = (this && this.__rest) || function (s, e) { var t = {}; for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0) t[p] = s[p]; if (s != null && typeof Object.getOwnPropertySymbols === "function") for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) { if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i])) t[p[i]] = s[p[i]]; } return t; }; Object.defineProperty(exports, "__esModule", { value: true }); exports.Agents = void 0; const environments = __importStar(require("../../../../environments.js")); const core = __importStar(require("../../../../core/index.js")); const Phonic = __importStar(require("../../../index.js")); const headers_js_1 = require("../../../../core/headers.js"); const errors = __importStar(require("../../../../errors/index.js")); class Agents { constructor(_options = {}) { this._options = _options; } /** * Returns all agents in a project. * * @param {Phonic.AgentsListRequest} request * @param {Agents.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Phonic.NotFoundError} * @throws {@link Phonic.InternalServerError} * * @example * await client.agents.list() */ list(request = {}, requestOptions) { return core.HttpResponsePromise.fromPromise(this.__list(request, requestOptions)); } __list() { return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) { var _a, _b, _c, _d; const { project } = request; const _queryParams = {}; if (project != null) { _queryParams["project"] = project; } 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((_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : ((_d = (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.PhonicEnvironment.Default) .base, "agents"), method: "GET", headers: _headers, queryParameters: Object.assign(Object.assign({}, _queryParams), 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") { switch (_response.error.statusCode) { case 404: throw new Phonic.NotFoundError(_response.error.body, _response.rawResponse); case 500: throw new Phonic.InternalServerError(_response.error.body, _response.rawResponse); default: throw new errors.PhonicError({ statusCode: _response.error.statusCode, body: _response.error.body, rawResponse: _response.rawResponse, }); } } switch (_response.error.reason) { case "non-json": throw new errors.PhonicError({ statusCode: _response.error.statusCode, body: _response.error.rawBody, rawResponse: _response.rawResponse, }); case "timeout": throw new errors.PhonicTimeoutError("Timeout exceeded when calling GET /agents."); case "unknown": throw new errors.PhonicError({ message: _response.error.errorMessage, rawResponse: _response.rawResponse, }); } }); } /** * Creates a new agent in a project. * * @param {Phonic.AgentsCreateRequest} request * @param {Agents.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Phonic.BadRequestError} * @throws {@link Phonic.UnauthorizedError} * @throws {@link Phonic.NotFoundError} * @throws {@link Phonic.InternalServerError} * * @example * await client.agents.create({ * project: "main", * name: "support-agent", * phone_number: "assign-automatically", * timezone: "America/Los_Angeles", * voice_id: "grant", * audio_speed: 1, * background_noise_level: 0, * generate_welcome_message: false, * welcome_message: "Hi {{customer_name}}. How can I help you today?", * system_prompt: "You are an expert in {{subject}}. Be friendly, helpful and concise.", * template_variables: { * "customer_name": { * default_value: null * }, * "subject": { * default_value: "Chess" * } * }, * tools: ["keypad_input"], * no_input_poke_sec: 30, * no_input_poke_text: "Are you still there?", * languages: ["en", "es"], * boosted_keywords: ["Load ID", "dispatch"], * configuration_endpoint: { * url: "https://api.example.com/config", * headers: { * "Authorization": "Bearer token123" * }, * timeout_ms: 7000 * } * }) */ create(request, requestOptions) { return core.HttpResponsePromise.fromPromise(this.__create(request, requestOptions)); } __create(request, requestOptions) { return __awaiter(this, void 0, void 0, function* () { var _a, _b, _c, _d; const { project } = request, _body = __rest(request, ["project"]); const _queryParams = {}; if (project != null) { _queryParams["project"] = project; } 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((_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : ((_d = (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.PhonicEnvironment.Default) .base, "agents"), method: "POST", headers: _headers, contentType: "application/json", queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams), requestType: "json", body: _body, 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 400: throw new Phonic.BadRequestError(_response.error.body, _response.rawResponse); case 401: throw new Phonic.UnauthorizedError(_response.error.body, _response.rawResponse); case 404: throw new Phonic.NotFoundError(_response.error.body, _response.rawResponse); case 500: throw new Phonic.InternalServerError(_response.error.body, _response.rawResponse); default: throw new errors.PhonicError({ statusCode: _response.error.statusCode, body: _response.error.body, rawResponse: _response.rawResponse, }); } } switch (_response.error.reason) { case "non-json": throw new errors.PhonicError({ statusCode: _response.error.statusCode, body: _response.error.rawBody, rawResponse: _response.rawResponse, }); case "timeout": throw new errors.PhonicTimeoutError("Timeout exceeded when calling POST /agents."); case "unknown": throw new errors.PhonicError({ message: _response.error.errorMessage, rawResponse: _response.rawResponse, }); } }); } /** * Upserts an agent by name. If an agent with the same name already exists, it will be updated. Otherwise, it will be created. * * @param {Phonic.UpsertAgentRequest} request * @param {Agents.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Phonic.BadRequestError} * @throws {@link Phonic.NotFoundError} * * @example * await client.agents.upsert({ * project: "main", * name: "support-agent", * phone_number: "assign-automatically", * timezone: "America/Los_Angeles", * voice_id: "grant", * audio_speed: 1, * background_noise_level: 0, * generate_welcome_message: false, * welcome_message: "Hi {{customer_name}}. How can I help you today?", * system_prompt: "You are an expert in {{subject}}. Be friendly, helpful and concise.", * template_variables: { * "customer_name": { * default_value: null * }, * "subject": { * default_value: "Chess" * } * }, * tools: ["keypad_input"], * no_input_poke_sec: 30, * no_input_poke_text: "Are you still there?", * languages: ["en", "es"], * boosted_keywords: ["Load ID", "dispatch"], * configuration_endpoint: { * url: "https://api.example.com/config", * headers: { * "Authorization": "Bearer token123" * }, * timeout_ms: 7000 * } * }) */ upsert(request, requestOptions) { return core.HttpResponsePromise.fromPromise(this.__upsert(request, requestOptions)); } __upsert(request, requestOptions) { return __awaiter(this, void 0, void 0, function* () { var _a, _b, _c, _d; const { project } = request, _body = __rest(request, ["project"]); const _queryParams = {}; if (project != null) { _queryParams["project"] = project; } 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((_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : ((_d = (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.PhonicEnvironment.Default) .base, "agents/upsert"), method: "PUT", headers: _headers, contentType: "application/json", queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams), requestType: "json", body: _body, 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 400: throw new Phonic.BadRequestError(_response.error.body, _response.rawResponse); case 404: throw new Phonic.NotFoundError(_response.error.body, _response.rawResponse); default: throw new errors.PhonicError({ statusCode: _response.error.statusCode, body: _response.error.body, rawResponse: _response.rawResponse, }); } } switch (_response.error.reason) { case "non-json": throw new errors.PhonicError({ statusCode: _response.error.statusCode, body: _response.error.rawBody, rawResponse: _response.rawResponse, }); case "timeout": throw new errors.PhonicTimeoutError("Timeout exceeded when calling PUT /agents/upsert."); case "unknown": throw new errors.PhonicError({ message: _response.error.errorMessage, rawResponse: _response.rawResponse, }); } }); } /** * Returns an agent by name or ID. * * @param {string} nameOrId - The name or the ID of the agent to get. * @param {Phonic.AgentsGetRequest} request * @param {Agents.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Phonic.ForbiddenError} * @throws {@link Phonic.NotFoundError} * * @example * await client.agents.get("nameOrId", { * project: "main" * }) */ get(nameOrId, request = {}, requestOptions) { return core.HttpResponsePromise.fromPromise(this.__get(nameOrId, request, requestOptions)); } __get(nameOrId_1) { return __awaiter(this, arguments, void 0, function* (nameOrId, request = {}, requestOptions) { var _a, _b, _c, _d; const { project } = request; const _queryParams = {}; if (project != null) { _queryParams["project"] = project; } 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((_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : ((_d = (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.PhonicEnvironment.Default) .base, `agents/${encodeURIComponent(nameOrId)}`), method: "GET", headers: _headers, queryParameters: Object.assign(Object.assign({}, _queryParams), 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") { switch (_response.error.statusCode) { case 403: throw new Phonic.ForbiddenError(_response.error.body, _response.rawResponse); case 404: throw new Phonic.NotFoundError(_response.error.body, _response.rawResponse); default: throw new errors.PhonicError({ statusCode: _response.error.statusCode, body: _response.error.body, rawResponse: _response.rawResponse, }); } } switch (_response.error.reason) { case "non-json": throw new errors.PhonicError({ statusCode: _response.error.statusCode, body: _response.error.rawBody, rawResponse: _response.rawResponse, }); case "timeout": throw new errors.PhonicTimeoutError("Timeout exceeded when calling GET /agents/{nameOrId}."); case "unknown": throw new errors.PhonicError({ message: _response.error.errorMessage, rawResponse: _response.rawResponse, }); } }); } /** * Deletes an agent by name or ID. * * @param {string} nameOrId - The name or the ID of the agent to delete. * @param {Phonic.AgentsDeleteRequest} request * @param {Agents.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Phonic.ForbiddenError} * @throws {@link Phonic.NotFoundError} * * @example * await client.agents.delete("nameOrId", { * project: "main" * }) */ delete(nameOrId, request = {}, requestOptions) { return core.HttpResponsePromise.fromPromise(this.__delete(nameOrId, request, requestOptions)); } __delete(nameOrId_1) { return __awaiter(this, arguments, void 0, function* (nameOrId, request = {}, requestOptions) { var _a, _b, _c, _d; const { project } = request; const _queryParams = {}; if (project != null) { _queryParams["project"] = project; } 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((_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : ((_d = (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.PhonicEnvironment.Default) .base, `agents/${encodeURIComponent(nameOrId)}`), method: "DELETE", headers: _headers, queryParameters: Object.assign(Object.assign({}, _queryParams), 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") { switch (_response.error.statusCode) { case 403: throw new Phonic.ForbiddenError(_response.error.body, _response.rawResponse); case 404: throw new Phonic.NotFoundError(_response.error.body, _response.rawResponse); default: throw new errors.PhonicError({ statusCode: _response.error.statusCode, body: _response.error.body, rawResponse: _response.rawResponse, }); } } switch (_response.error.reason) { case "non-json": throw new errors.PhonicError({ statusCode: _response.error.statusCode, body: _response.error.rawBody, rawResponse: _response.rawResponse, }); case "timeout": throw new errors.PhonicTimeoutError("Timeout exceeded when calling DELETE /agents/{nameOrId}."); case "unknown": throw new errors.PhonicError({ message: _response.error.errorMessage, rawResponse: _response.rawResponse, }); } }); } /** * Updates an agent by name or ID. * * @param {string} nameOrId - The name or the ID of the agent to update. * @param {Phonic.UpdateAgentRequest} request * @param {Agents.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Phonic.BadRequestError} * @throws {@link Phonic.ForbiddenError} * @throws {@link Phonic.NotFoundError} * * @example * await client.agents.update("nameOrId", { * project: "main", * name: "updated-support-agent", * phone_number: "assign-automatically", * timezone: "America/Los_Angeles", * voice_id: "grant", * audio_speed: 1, * background_noise_level: 0, * generate_welcome_message: false, * welcome_message: "Hi {{customer_name}}. How can I help you today?", * system_prompt: "You are an expert in {{subject}}. Be friendly, helpful and concise.", * template_variables: { * "customer_name": { * default_value: null * }, * "subject": { * default_value: "Chess" * } * }, * tools: ["keypad_input"], * no_input_poke_sec: 30, * no_input_poke_text: "Are you still there?", * languages: ["en", "es"], * boosted_keywords: ["Load ID", "dispatch"], * configuration_endpoint: { * url: "https://api.example.com/config", * headers: { * "Authorization": "Bearer token123" * }, * timeout_ms: 7000 * } * }) */ update(nameOrId, request, requestOptions) { return core.HttpResponsePromise.fromPromise(this.__update(nameOrId, request, requestOptions)); } __update(nameOrId, request, requestOptions) { return __awaiter(this, void 0, void 0, function* () { var _a, _b, _c, _d; const { project } = request, _body = __rest(request, ["project"]); const _queryParams = {}; if (project != null) { _queryParams["project"] = project; } 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((_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : ((_d = (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.PhonicEnvironment.Default) .base, `agents/${encodeURIComponent(nameOrId)}`), method: "PATCH", headers: _headers, contentType: "application/json", queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams), requestType: "json", body: _body, 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 400: throw new Phonic.BadRequestError(_response.error.body, _response.rawResponse); case 403: throw new Phonic.ForbiddenError(_response.error.body, _response.rawResponse); case 404: throw new Phonic.NotFoundError(_response.error.body, _response.rawResponse); default: throw new errors.PhonicError({ statusCode: _response.error.statusCode, body: _response.error.body, rawResponse: _response.rawResponse, }); } } switch (_response.error.reason) { case "non-json": throw new errors.PhonicError({ statusCode: _response.error.statusCode, body: _response.error.rawBody, rawResponse: _response.rawResponse, }); case "timeout": throw new errors.PhonicTimeoutError("Timeout exceeded when calling PATCH /agents/{nameOrId}."); case "unknown": throw new errors.PhonicError({ message: _response.error.errorMessage, rawResponse: _response.rawResponse, }); } }); } _getAuthorizationHeader() { return __awaiter(this, void 0, void 0, function* () { var _a; const bearer = (_a = (yield core.Supplier.get(this._options.apiKey))) !== null && _a !== void 0 ? _a : process === null || process === void 0 ? void 0 : process.env["PHONIC_API_KEY"]; if (bearer != null) { return `Bearer ${bearer}`; } return undefined; }); } } exports.Agents = Agents;