@routr/sdk 2.0.8-alpha.20

package/dist/trunks/trunks.d.ts

@@ -0,0 +1,153 @@
+import { APIClient } from "../client";
+import { ClientOptions } from "../types";
+import { CreateTrunkRequest, CreateTrunkResponse, GetTrunkResponse, ListTrunkRequest, ListTrunkResponse, UpdateTrunkRequest, UpdateTrunkResponse } from "./types";
+/**
+ * @classdesc Use Routr Trunks, a capability of Routr SIP Proxy, to create, update, get
+ * and delete Trunks. The Trunks API requires of a running Routr deployment.
+ *
+ * @extends APIClient
+ * @example
+ *
+ * const SDK = require("@routr/sdk")
+ * const trunks = new SDK.Trunks()
+ *
+ * const request = {
+ *   name: "Trunk from Twilio",
+ *   inboundUri: "sip:twilio.sip.acme.io",
+ *   accessControlListRef: "4671371b-ff5d-48b1-aabe-d3c5ca5317a3",
+ *   inboundCredentialsRef: "4671371b-ff5d-48b1-aabe-d3c5ca5317a3",
+ *   outboundCredentialsRef: "4671371b-ff5d-48b1-aabe-d3c5ca5317a3",
+ *   uris: [{
+ *     host: "acme.sip.twilio.com",
+ *     port: 5060,
+ *     transport: "udp",
+ *     user: "AC1234567890",
+ *     weight: 1,
+ *     priority: 1
+ *   }],
+ *   extended: {
+ *     "key": "value"
+ *   }
+ * }
+ *
+ * trunks.createTrunk(request)
+ *   .then(console.log)
+ *   .catch(console.error)   // an error occurred
+ */
+export declare class Trunks extends APIClient {
+    /**
+     * Constructs a new Trunk API object.
+     *
+     * @param {ClientOptions} options - Options to indicate the objects endpoint
+     * @see module:core:APIClient
+     */
+    constructor(options: ClientOptions);
+    /**
+     * Creates a new Trunk on Routr.
+     *
+     * @param {CreateTrunkRequest} request - The request to create an Trunk
+     * @param {string} request.name - Name of the Trunk
+     * @param {string} request.inboundUri - Inbound URI of the Trunk
+     * @param {string} request.accessControlListRef - Access Control List reference
+     * @param {string} request.inboundCredentialsRef - The reference of the inbound credentials
+     * @param {string} request.outboundCredentialsRef - The reference of the outbound credentials
+     * @param {TrunkURI[]} request.uris - The outbound URIs of the Trunk
+     * @return {Promise<CreateTrunkResponse>} The newly created Trunk
+     * @throws if request is null
+     * @example
+     *
+     * const request = {
+     *   name: "Trunk from Twilio",
+     *   inboundUri: "sip:twilio.sip.acme.io",
+     *   accessControlListRef: "4671371b-ff5d-48b1-aabe-d3c5ca5317a3",
+     *   inboundCredentialsRef: "4671371b-ff5d-48b1-aabe-d3c5ca5317a3",
+     *   outboundCredentialsRef: "4671371b-ff5d-48b1-aabe-d3c5ca5317a3",
+     *   uris: [{
+     *     host: "acme.sip.twilio.com",
+     *     port: 5060,
+     *     transport: "udp",
+     *     user: "AC1234567890",
+     *     weight: 1,
+     *     priority: 1
+     *   }],
+     *   extended: {
+     *     "key": "value"
+     *   }
+     * }
+     *
+     * trunks.createTrunk(request)
+     *   .then(console.log)
+     *   .catch(console.error)   // an error occurred
+     */
+    createTrunk(request: CreateTrunkRequest): Promise<CreateTrunkResponse>;
+    /**
+     * Updates an already existing Trunk on Routr.
+     *
+     * @param {UpdateTrunkRequest} request - Partial with the fields to update
+     * @param {string} request.name - Name of the Trunk
+     * @param {string} request.inboundUri - Inbound URI of the Trunk
+     * @param {string} request.accessControlListRef - Access Control List reference
+     * @param {string} request.inboundCredentialsRef - The reference of the inbound credentials
+     * @param {string} request.outboundCredentialsRef - The reference of the outbound credentials
+     * @param {TrunkURI[]} request.uris - The outbound URIs of the Trunk
+     * @param {JsonObject} request.extended - Optional extended attributes
+     * @return {Promise<UpdateTrunkResponse>} The updated Trunk
+     * @example
+     *
+     * const request = {
+     *   ref: "4671371b-ff5d-48b1-aabe-d3c5ca5317a3",
+     *   name: "Trunk from Twilio (US-East)",
+     * }
+     *
+     * trunks.updateTrunk(request)
+     *   .then(console.log)
+     *   .catch(console.error)   // an error occurred
+     */
+    updateTrunk(request: UpdateTrunkRequest): Promise<UpdateTrunkResponse>;
+    /**
+     * Gets an Trunk from Routr.
+     *
+     * @param {string} ref - The Trunk's reference
+     * @return {Promise<GetTrunkResponse>} The Trunk
+     * @example
+     *
+     * const ref = "4671371b-ff5d-48b1-aabe-d3c5ca5317a3"
+     *
+     * trunks.getTrunk(ref)
+     *   .then(console.log)
+     *   .catch(console.error)   // an error occurred
+     */
+    getTrunk(ref: string): Promise<GetTrunkResponse>;
+    /**
+     * Deletes an Trunk from Routr.
+     *
+     * @param {string} ref - The Trunk's reference
+     * @return {Promise<void>}
+     * @example
+     *
+     * const ref = "4671371b-ff5d-48b1-aabe-d3c5ca5317a3"
+     *
+     * trunks.deleteTrunk(ref)
+     *   .then(console.log)
+     *   .catch(console.error)   // an error occurred
+     */
+    deleteTrunk(ref: string): Promise<void>;
+    /**
+     * Lists all Trunks from Routr with pagination.
+     *
+     * @param {ListTrunkRequest} request - The request to list Trunks
+     * @param {number} request.pageSize - The number of Trunks to return
+     * @param {string} request.pageToken - The page token to use for pagination
+     * @return {Promise<ListTrunkResponse>} The list of Trunks in the current page
+     * @example
+     *
+     * const request = {
+     *  pageSize: 10
+     * }
+     *
+     * trunks.listTrunks(request)
+     *   .then(console.log)
+     *   .catch(console.error)   // an error occurred
+     */
+    listTrunks(request: ListTrunkRequest): Promise<ListTrunkResponse>;
+}

package/dist/trunks/trunks.js

@@ -0,0 +1,204 @@
+"use strict";
+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.Trunks = void 0;
+/*
+ * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster
+ *
+ * This file is part of Routr.
+ *
+ * Licensed under the MIT License (the "License");
+ * you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    https://opensource.org/licenses/MIT
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+const client_1 = require("../client");
+/**
+ * @classdesc Use Routr Trunks, a capability of Routr SIP Proxy, to create, update, get
+ * and delete Trunks. The Trunks API requires of a running Routr deployment.
+ *
+ * @extends APIClient
+ * @example
+ *
+ * const SDK = require("@routr/sdk")
+ * const trunks = new SDK.Trunks()
+ *
+ * const request = {
+ *   name: "Trunk from Twilio",
+ *   inboundUri: "sip:twilio.sip.acme.io",
+ *   accessControlListRef: "4671371b-ff5d-48b1-aabe-d3c5ca5317a3",
+ *   inboundCredentialsRef: "4671371b-ff5d-48b1-aabe-d3c5ca5317a3",
+ *   outboundCredentialsRef: "4671371b-ff5d-48b1-aabe-d3c5ca5317a3",
+ *   uris: [{
+ *     host: "acme.sip.twilio.com",
+ *     port: 5060,
+ *     transport: "udp",
+ *     user: "AC1234567890",
+ *     weight: 1,
+ *     priority: 1
+ *   }],
+ *   extended: {
+ *     "key": "value"
+ *   }
+ * }
+ *
+ * trunks.createTrunk(request)
+ *   .then(console.log)
+ *   .catch(console.error)   // an error occurred
+ */
+class Trunks extends client_1.APIClient {
+    /**
+     * Constructs a new Trunk API object.
+     *
+     * @param {ClientOptions} options - Options to indicate the objects endpoint
+     * @see module:core:APIClient
+     */
+    constructor(options) {
+        super(options);
+    }
+    /**
+     * Creates a new Trunk on Routr.
+     *
+     * @param {CreateTrunkRequest} request - The request to create an Trunk
+     * @param {string} request.name - Name of the Trunk
+     * @param {string} request.inboundUri - Inbound URI of the Trunk
+     * @param {string} request.accessControlListRef - Access Control List reference
+     * @param {string} request.inboundCredentialsRef - The reference of the inbound credentials
+     * @param {string} request.outboundCredentialsRef - The reference of the outbound credentials
+     * @param {TrunkURI[]} request.uris - The outbound URIs of the Trunk
+     * @return {Promise<CreateTrunkResponse>} The newly created Trunk
+     * @throws if request is null
+     * @example
+     *
+     * const request = {
+     *   name: "Trunk from Twilio",
+     *   inboundUri: "sip:twilio.sip.acme.io",
+     *   accessControlListRef: "4671371b-ff5d-48b1-aabe-d3c5ca5317a3",
+     *   inboundCredentialsRef: "4671371b-ff5d-48b1-aabe-d3c5ca5317a3",
+     *   outboundCredentialsRef: "4671371b-ff5d-48b1-aabe-d3c5ca5317a3",
+     *   uris: [{
+     *     host: "acme.sip.twilio.com",
+     *     port: 5060,
+     *     transport: "udp",
+     *     user: "AC1234567890",
+     *     weight: 1,
+     *     priority: 1
+     *   }],
+     *   extended: {
+     *     "key": "value"
+     *   }
+     * }
+     *
+     * trunks.createTrunk(request)
+     *   .then(console.log)
+     *   .catch(console.error)   // an error occurred
+     */
+    createTrunk(request) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.client.trunks.create(request);
+        });
+    }
+    /**
+     * Updates an already existing Trunk on Routr.
+     *
+     * @param {UpdateTrunkRequest} request - Partial with the fields to update
+     * @param {string} request.name - Name of the Trunk
+     * @param {string} request.inboundUri - Inbound URI of the Trunk
+     * @param {string} request.accessControlListRef - Access Control List reference
+     * @param {string} request.inboundCredentialsRef - The reference of the inbound credentials
+     * @param {string} request.outboundCredentialsRef - The reference of the outbound credentials
+     * @param {TrunkURI[]} request.uris - The outbound URIs of the Trunk
+     * @param {JsonObject} request.extended - Optional extended attributes
+     * @return {Promise<UpdateTrunkResponse>} The updated Trunk
+     * @example
+     *
+     * const request = {
+     *   ref: "4671371b-ff5d-48b1-aabe-d3c5ca5317a3",
+     *   name: "Trunk from Twilio (US-East)",
+     * }
+     *
+     * trunks.updateTrunk(request)
+     *   .then(console.log)
+     *   .catch(console.error)   // an error occurred
+     */
+    updateTrunk(request) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.client.trunks.update(request);
+        });
+    }
+    /**
+     * Gets an Trunk from Routr.
+     *
+     * @param {string} ref - The Trunk's reference
+     * @return {Promise<GetTrunkResponse>} The Trunk
+     * @example
+     *
+     * const ref = "4671371b-ff5d-48b1-aabe-d3c5ca5317a3"
+     *
+     * trunks.getTrunk(ref)
+     *   .then(console.log)
+     *   .catch(console.error)   // an error occurred
+     */
+    getTrunk(ref) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.client.trunks.get(ref);
+        });
+    }
+    /**
+     * Deletes an Trunk from Routr.
+     *
+     * @param {string} ref - The Trunk's reference
+     * @return {Promise<void>}
+     * @example
+     *
+     * const ref = "4671371b-ff5d-48b1-aabe-d3c5ca5317a3"
+     *
+     * trunks.deleteTrunk(ref)
+     *   .then(console.log)
+     *   .catch(console.error)   // an error occurred
+     */
+    deleteTrunk(ref) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.client.trunks.del(ref);
+        });
+    }
+    /**
+     * Lists all Trunks from Routr with pagination.
+     *
+     * @param {ListTrunkRequest} request - The request to list Trunks
+     * @param {number} request.pageSize - The number of Trunks to return
+     * @param {string} request.pageToken - The page token to use for pagination
+     * @return {Promise<ListTrunkResponse>} The list of Trunks in the current page
+     * @example
+     *
+     * const request = {
+     *  pageSize: 10
+     * }
+     *
+     * trunks.listTrunks(request)
+     *   .then(console.log)
+     *   .catch(console.error)   // an error occurred
+     */
+    listTrunks(request) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.client.trunks.list(request);
+        });
+    }
+}
+exports.Trunks = Trunks;

package/dist/trunks/types.d.ts

@@ -0,0 +1,11 @@
+import { CommonConnect as CC } from "@routr/common";
+import { CreateBaseOmit } from "../types";
+export type CreateTrunkRequest = Omit<CC.Trunk, CreateBaseOmit | "accessControlList" | "inboundCredentials" | "outboundCredentials">;
+export type CreateTrunkResponse = CC.Trunk;
+export type UpdateTrunkRequest = {
+    ref: string;
+} & Partial<CreateTrunkRequest>;
+export type UpdateTrunkResponse = CC.Trunk;
+export type ListTrunkRequest = CC.ListRequest;
+export type ListTrunkResponse = CC.ListResponse<CC.Trunk>;
+export type GetTrunkResponse = CC.Trunk;

package/dist/trunks/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types.d.ts

@@ -0,0 +1,6 @@
+export interface ClientOptions {
+    endpoint: string;
+    username?: string;
+    password?: string;
+}
+export type CreateBaseOmit = "ref" | "apiVersion" | "createdAt" | "updatedAt";

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@routr/sdk",
+  "version": "2.0.8-alpha.20",
+  "description": "The Routr SDK for Node.js",
+  "author": "Pedro Sanders <psanders@fonoster.com>",
+  "homepage": "https://github.com/fonoster/routr#readme",
+  "license": "MIT",
+  "main": "dist/sdk",
+  "types": "dist/sdk",
+  "directories": {
+    "src": "src",
+    "test": "test"
+  },
+  "scripts": {
+    "prebuild": "rimraf ./dist tsconfig.tsbuildinfo",
+    "build": "tsc -b tsconfig.json"
+  },
+  "dependencies": {
+    "@fonoster/logger": "0.3.18",
+    "@grpc/grpc-js": "^1.8.4",
+    "@opentelemetry/api": "^1.0.4",
+    "@opentelemetry/exporter-jaeger": "^1.0.4",
+    "@opentelemetry/instrumentation": "^0.27.0",
+    "@opentelemetry/instrumentation-grpc": "^0.27.0",
+    "@opentelemetry/resources": "^1.0.4",
+    "@opentelemetry/sdk-trace-base": "^1.0.4",
+    "@opentelemetry/sdk-trace-node": "^1.0.4",
+    "@opentelemetry/semantic-conventions": "^1.0.4",
+    "@routr/common": "^2.0.8-alpha.20",
+    "google-protobuf": "^3.9.2",
+    "pb-util": "^1.0.3"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/fonoster/routr.git"
+  },
+  "bugs": {
+    "url": "https://github.com/fonoster/routr/issues"
+  },
+  "devDependencies": {
+    "@types/google-protobuf": "^3.15.6"
+  },
+  "gitHead": "a22ee8342d03f5dfe46fddba89ffe3e6d0d5deb6"
+}