@routr/sdk 2.0.8-alpha.20

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Fonoster Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/acl/acl.d.ts

@@ -0,0 +1,122 @@
+import { APIClient } from "../client";
+import { ClientOptions } from "../types";
+import { CreateACLRequest, CreateACLResponse, GetACLResponse, ListACLRequest, ListACLResponse, UpdateACLRequest, UpdateACLResponse } from "./types";
+/**
+ * @classdesc Use Routr ACL, a capability of Routr SIP Proxy, to create, update, get
+ * and delete Access Control Lists. The ACL API requires of a running Routr deployment.
+ *
+ * @extends APIClient
+ * @example
+ *
+ * const SDK = require("@routr/sdk")
+ * const acl = new SDK.ACL()
+ *
+ * const request = {
+ *   name: "Peer network",
+ *   allow: "27.116.56.0/22",
+ *   deny: "0.0.0.0/0"
+ * }
+ *
+ * acl.createACL(request)
+ *   .then(console.log)
+ *   .catch(console.error)   // an error occurred
+ */
+export declare class ACL extends APIClient {
+    /**
+     * Constructs a new ACL API object.
+     *
+     * @param {ClientOptions} options - Options to indicate the objects endpoint
+     * @see module:core:APIClient
+     */
+    constructor(options: ClientOptions);
+    /**
+     * Creates a new AccessControlList on Routr.
+     *
+     * @param {CreateACLRequest} request - The request to create an ACL
+     * @param {string} request.name - Name of the ACL
+     * @param {string[]} request.allow - List of IP addresses or CIDR blocks to allow
+     * @param {string[]} request.deny - List of IP addresses or CIDR blocks to deny
+     * @param {JsonObject} request.extended - Optional extended attributes
+     * @return {Promise<CreateACLResponse>} The newly created AccessControlList
+     * @throws if request is null
+     * @example
+     *
+     * const request = {
+     *   name: "Peer network",
+     *   allow: "27.116.56.0/22",
+     *   deny: "0.0.0.0/0"
+     * }
+     *
+     * acl.createACL(request)
+     *   .then(console.log)
+     *   .catch(console.error)   // an error occurred
+     */
+    createACL(request: CreateACLRequest): Promise<CreateACLResponse>;
+    /**
+     * Updates an already existing AccessControlList on Routr.
+     *
+     * @param {UpdateACLRequest} request - Partial with the fields to update
+     * @param {string} request.name - Name of the ACL
+     * @param {string[]} request.allow - List of IP addresses or CIDR blocks to allow
+     * @param {string[]} request.deny - List of IP addresses or CIDR blocks to deny
+     * @param {JsonObject} request.extended - Optional extended attributes
+     * @return {Promise<UpdateACLResponse>} The AccessControlList
+     * @example
+     *
+     * const request = {
+     *   ref: "4671371b-ff5d-48b1-aabe-d3c5ca5317a3",
+     *   name: "Peer network updated",
+     * }
+     *
+     * acl.updateACL(request)
+     *   .then(console.log)
+     *   .catch(console.error)   // an error occurred
+     */
+    updateACL(request: UpdateACLRequest): Promise<UpdateACLResponse>;
+    /**
+     * Gets an AccessControlList from Routr.
+     *
+     * @param {string} ref - The ACL reference
+     * @return {Promise<GetACLResponse>} The AccessControlList
+     * @example
+     *
+     * const ref = "4671371b-ff5d-48b1-aabe-d3c5ca5317a3"
+     *
+     * acl.getACL(ref)
+     *   .then(console.log)
+     *   .catch(console.error)   // an error occurred
+     */
+    getACL(ref: string): Promise<GetACLResponse>;
+    /**
+     * Deletes an AccessControlList from Routr.
+     *
+     * @param {string} ref - The ACL reference
+     * @return {Promise<void>}
+     * @example
+     *
+     * const ref = "4671371b-ff5d-48b1-aabe-d3c5ca5317a3"
+     *
+     * acl.deleteACL(ref)
+     *   .then(console.log)
+     *   .catch(console.error)   // an error occurred
+     */
+    deleteACL(ref: string): Promise<void>;
+    /**
+     * Lists all AccessControlLists from Routr with pagination.
+     *
+     * @param {ListACLRequest} request - The request to list ACLs
+     * @param {number} request.pageSize - The number of ACLs to return
+     * @param {string} request.pageToken - The page token to use for pagination
+     * @return {Promise<ListACLResponse>} The list of AccessControlLists
+     * @example
+     *
+     * const request = {
+     *  pageSize: 10
+     * }
+     *
+     * acl.listACLs(request)
+     *   .then(console.log)
+     *   .catch(console.error)   // an error occurred
+     */
+    listACLs(request: ListACLRequest): Promise<ListACLResponse>;
+}

package/dist/acl/acl.js

@@ -0,0 +1,173 @@
+"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.ACL = 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 ACL, a capability of Routr SIP Proxy, to create, update, get
+ * and delete Access Control Lists. The ACL API requires of a running Routr deployment.
+ *
+ * @extends APIClient
+ * @example
+ *
+ * const SDK = require("@routr/sdk")
+ * const acl = new SDK.ACL()
+ *
+ * const request = {
+ *   name: "Peer network",
+ *   allow: "27.116.56.0/22",
+ *   deny: "0.0.0.0/0"
+ * }
+ *
+ * acl.createACL(request)
+ *   .then(console.log)
+ *   .catch(console.error)   // an error occurred
+ */
+class ACL extends client_1.APIClient {
+    /**
+     * Constructs a new ACL API object.
+     *
+     * @param {ClientOptions} options - Options to indicate the objects endpoint
+     * @see module:core:APIClient
+     */
+    constructor(options) {
+        super(options);
+    }
+    /**
+     * Creates a new AccessControlList on Routr.
+     *
+     * @param {CreateACLRequest} request - The request to create an ACL
+     * @param {string} request.name - Name of the ACL
+     * @param {string[]} request.allow - List of IP addresses or CIDR blocks to allow
+     * @param {string[]} request.deny - List of IP addresses or CIDR blocks to deny
+     * @param {JsonObject} request.extended - Optional extended attributes
+     * @return {Promise<CreateACLResponse>} The newly created AccessControlList
+     * @throws if request is null
+     * @example
+     *
+     * const request = {
+     *   name: "Peer network",
+     *   allow: "27.116.56.0/22",
+     *   deny: "0.0.0.0/0"
+     * }
+     *
+     * acl.createACL(request)
+     *   .then(console.log)
+     *   .catch(console.error)   // an error occurred
+     */
+    createACL(request) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.client.acl.create(request);
+        });
+    }
+    /**
+     * Updates an already existing AccessControlList on Routr.
+     *
+     * @param {UpdateACLRequest} request - Partial with the fields to update
+     * @param {string} request.name - Name of the ACL
+     * @param {string[]} request.allow - List of IP addresses or CIDR blocks to allow
+     * @param {string[]} request.deny - List of IP addresses or CIDR blocks to deny
+     * @param {JsonObject} request.extended - Optional extended attributes
+     * @return {Promise<UpdateACLResponse>} The AccessControlList
+     * @example
+     *
+     * const request = {
+     *   ref: "4671371b-ff5d-48b1-aabe-d3c5ca5317a3",
+     *   name: "Peer network updated",
+     * }
+     *
+     * acl.updateACL(request)
+     *   .then(console.log)
+     *   .catch(console.error)   // an error occurred
+     */
+    updateACL(request) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.client.acl.update(request);
+        });
+    }
+    /**
+     * Gets an AccessControlList from Routr.
+     *
+     * @param {string} ref - The ACL reference
+     * @return {Promise<GetACLResponse>} The AccessControlList
+     * @example
+     *
+     * const ref = "4671371b-ff5d-48b1-aabe-d3c5ca5317a3"
+     *
+     * acl.getACL(ref)
+     *   .then(console.log)
+     *   .catch(console.error)   // an error occurred
+     */
+    getACL(ref) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.client.acl.get(ref);
+        });
+    }
+    /**
+     * Deletes an AccessControlList from Routr.
+     *
+     * @param {string} ref - The ACL reference
+     * @return {Promise<void>}
+     * @example
+     *
+     * const ref = "4671371b-ff5d-48b1-aabe-d3c5ca5317a3"
+     *
+     * acl.deleteACL(ref)
+     *   .then(console.log)
+     *   .catch(console.error)   // an error occurred
+     */
+    deleteACL(ref) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.client.acl.del(ref);
+        });
+    }
+    /**
+     * Lists all AccessControlLists from Routr with pagination.
+     *
+     * @param {ListACLRequest} request - The request to list ACLs
+     * @param {number} request.pageSize - The number of ACLs to return
+     * @param {string} request.pageToken - The page token to use for pagination
+     * @return {Promise<ListACLResponse>} The list of AccessControlLists
+     * @example
+     *
+     * const request = {
+     *  pageSize: 10
+     * }
+     *
+     * acl.listACLs(request)
+     *   .then(console.log)
+     *   .catch(console.error)   // an error occurred
+     */
+    listACLs(request) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.client.acl.list(request);
+        });
+    }
+}
+exports.ACL = ACL;

package/dist/acl/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./acl";
+export { ACL as default } from "./acl";

package/dist/acl/index.js

@@ -0,0 +1,38 @@
+"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 });
+exports.default = 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.
+ */
+__exportStar(require("./acl"), exports);
+var acl_1 = require("./acl");
+Object.defineProperty(exports, "default", { enumerable: true, get: function () { return acl_1.ACL; } });

package/dist/acl/types.d.ts

@@ -0,0 +1,11 @@
+import { CommonConnect as CC } from "@routr/common";
+import { CreateBaseOmit } from "../types";
+export type CreateACLRequest = Omit<CC.AccessControlList, CreateBaseOmit>;
+export type CreateACLResponse = CC.AccessControlList;
+export type UpdateACLRequest = {
+    ref: string;
+} & Partial<CreateACLRequest>;
+export type UpdateACLResponse = CC.AccessControlList;
+export type ListACLRequest = CC.ListRequest;
+export type ListACLResponse = CC.ListResponse<CC.AccessControlList>;
+export type GetACLResponse = CC.AccessControlList;

package/dist/acl/types.js

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

package/dist/agents/agents.d.ts

@@ -0,0 +1,141 @@
+import { APIClient } from "../client";
+import { ClientOptions } from "../types";
+import { CreateAgentRequest, CreateAgentResponse, GetAgentResponse, ListAgentRequest, ListAgentResponse, UpdateAgentRequest, UpdateAgentResponse } from "./types";
+/**
+ * @classdesc Use Routr Agents, a capability of Routr SIP Proxy, to create, update, get
+ * and delete Agents. The Agents API requires of a running Routr deployment.
+ *
+ * @extends APIClient
+ * @example
+ *
+ * const SDK = require("@routr/sdk")
+ * const agents = new SDK.Agents()
+ *
+ * const request = {
+ *   name: "Jonh Doe",
+ *   username: "jdoe",
+ *   privacy: Privacy.PRIVATE,
+ *   domainRef: "4671371b-ff5d-48b1-aabe-d3c5ca5317a3",
+ *   credentialsRef: "4671371b-ff5d-48b1-aabe-d3c5ca5317a3",
+ *   enabled: true,
+ *   extended: {
+ *     "key": "value"
+ *   }
+ * }
+ *
+ * agents.createAgent(request)
+ *   .then(console.log)
+ *   .catch(console.error)   // an error occurred
+ */
+export declare class Agents extends APIClient {
+    /**
+     * Constructs a new Agent API object.
+     *
+     * @param {ClientOptions} options - Options to indicate the objects endpoint
+     * @see module:core:APIClient
+     */
+    constructor(options: ClientOptions);
+    /**
+     * Creates a new Agent on Routr.
+     *
+     * @param {CreateAgentRequest} request - The request to create an Agent
+     * @param {string} request.name - Name of the Agent
+     * @param {string} request.username - Username of the Agent
+     * @param {Privacy} request.privacy - Privacy of the Agent (e.g. Privacy.PRIVATE)
+     * @param {string} request.domainRef - Domain reference of the Domain the Agent belongs to
+     * @param {string} request.credentialsRef - Credentials reference of the Credentials for the Agent
+     * @param {boolean} request.enabled - Whether the Agent is enabled or not (for future use)
+     * @param {JsonObject} request.extended - Optional extended attributes
+     * @return {Promise<CreateAgentResponse>} The newly created Agent
+     * @throws if request is null
+     * @example
+     *
+     * const request = {
+     *   name: "Jonh Doe",
+     *   username: "jdoe",
+     *   privacy: Privacy.PRIVATE,
+     *   domainRef: "4671371b-ff5d-48b1-aabe-d3c5ca5317a3",
+     *   credentialsRef: "4671371b-ff5d-48b1-aabe-d3c5ca5317a3",
+     *   enabled: true,
+     *   extended: {
+     *     "key": "value"
+     *   }
+     * }
+     *
+     * agents.createAgent(request)
+     *   .then(console.log)
+     *   .catch(console.error)   // an error occurred
+     */
+    createAgent(request: CreateAgentRequest): Promise<CreateAgentResponse>;
+    /**
+     * Updates an already existing Agent on Routr.
+     *
+     * @param {UpdateAgentRequest} request - Partial with the fields to update
+     * @param {string} request.name - Name of the Agent
+     * @param {string} request.username - Username of the Agent
+     * @param {Privacy} request.privacy - Privacy of the Agent (e.g. Privacy.PRIVATE)
+     * @param {string} request.domainRef - Domain reference of the Domain the Agent belongs to
+     * @param {string} request.credentialsRef - Credentials reference of the Credentials for the Agent
+     * @param {boolean} request.enabled - Whether the Agent is enabled or not (for future use)
+     * @param {JsonObject} request.extended - Optional extended attributes
+     * @return {Promise<UpdateAgentResponse>} The updated Agent
+     * @example
+     *
+     * const request = {
+     *   ref: "4671371b-ff5d-48b1-aabe-d3c5ca5317a3",
+     *   name: "John D Doe",
+     *   enabled: false
+     * }
+     *
+     * agents.updateAgent(request)
+     *   .then(console.log)
+     *   .catch(console.error)   // an error occurred
+     */
+    updateAgent(request: UpdateAgentRequest): Promise<UpdateAgentResponse>;
+    /**
+     * Gets an Agent from Routr.
+     *
+     * @param {string} ref - The Agent's reference
+     * @return {Promise<GetAgentResponse>} The Agent
+     * @example
+     *
+     * const ref = "4671371b-ff5d-48b1-aabe-d3c5ca5317a3"
+     *
+     * agents.getAgent(ref)
+     *   .then(console.log)
+     *   .catch(console.error)   // an error occurred
+     */
+    getAgent(ref: string): Promise<GetAgentResponse>;
+    /**
+     * Deletes an Agent from Routr.
+     *
+     * @param {string} ref - The Agent's reference
+     * @return {Promise<void>}
+     * @example
+     *
+     * const ref = "4671371b-ff5d-48b1-aabe-d3c5ca5317a3"
+     *
+     * agents.deleteAgent(ref)
+     *   .then(console.log)
+     *   .catch(console.error)   // an error occurred
+     */
+    deleteAgent(ref: string): Promise<void>;
+    /**
+     * Lists all Agents from Routr with pagination.
+     *
+     * @param {ListAgentRequest} request - The request to list Agents
+     * @param {number} request.pageSize - The number of Agents to return
+     * @param {string} request.pageToken - The page token to use for pagination
+     * @return {Promise<ListAgentResponse>} The list of Agents in the current page
+     * @example
+     *
+     * const request = {
+     *  pageSize: 10
+     * }
+     *
+     * agents.listAgents(request)
+     *   .then(console.log)
+     *   .catch(console.error)   // an error occurred
+     */
+    listAgents(request: ListAgentRequest): Promise<ListAgentResponse>;
+}