@fonoster/sdk 0.6.1 → 0.6.2

package/dist/node/Acls.d.ts

@@ -0,0 +1,150 @@
+import { Acl, BaseApiObject, CreateAclRequest, ListAclsRequest, ListAclsResponse, UpdateAclRequest } from "@fonoster/types";
+import { FonosterClient } from "./client/types";
+/**
+ * @classdesc Fonoster Acls, part of the Fonoster SIP Proxy subsystem,
+ * allows you to create, update, retrieve, and delete Access Control Lists (ACLs) rules for your deployment.
+ * Note that an active Fonoster deployment is required.
+ *
+ * @example
+ *
+ * const SDK = require("@fonoster/sdk");
+ *
+ * async function main(request) {
+ *  const apiKey = "your-api-key";
+ *  const accessKeyId = "00000000-0000-0000-0000-000000000000";
+ *
+ *  try {
+ *     const client = SDK.Client({ accessKeyId });
+ *     await client.loginWithApiKey(apiKey);
+ *
+ *     const acls = new SDK.Acls(client);
+ *     const response = await acls.createAcl(request);
+ *
+ *     console.log(response); // successful response
+ *   } catch (e) {
+ *     console.error(e); // an error occurred
+ *   }
+ * }
+ *
+ * const request = {
+ *   name: "My ACL",
+ *   allow: ["47.132.130.31"], // Allow only this IP
+ *   deny: ["0.0.0.0/0"] // Deny all other IPs
+ * };
+ *
+ * main(request).catch(console.error);
+ */
+declare class Acls {
+    private client;
+    /**
+     * Constructs a new Acls object.
+     *
+     * @param {FonosterClient} client - Client object with underlying implementations to make requests to Fonoster's API
+     * @see AbstractClient
+     * @see FonosterClient
+     */
+    constructor(client: FonosterClient);
+    /**
+     * Creates a new Acl in the Workspace.
+     *
+     * @param {CreateAclRequest} request - The request object that contains the necessary information to create a new Acl
+     * @param {string} request.name - The name of the Acl
+     * @param {string[]} request.allow - The list of IPs to allow
+     * @param {string[]} request.deny - The list of IPs to deny
+     * @return {Promise<BaseApiObject>} - The response object that contains the reference to the created Acl
+     * @example
+     *
+     * const request = {
+     *  name: "My ACL",
+     *  allow: ["47.132.130.31"], // Allow only this IP
+     *  deny: ["0.0.0.0/0"] // Deny all other IPs
+     * };
+     *
+     * const acls = new SDK.Acls(client); // Existing client object
+     *
+     * acls.createAcl(request)
+     * .then(console.log) // successful response
+     * .catch(console.error); // an error occurred
+     */
+    createAcl(request: CreateAclRequest): Promise<BaseApiObject>;
+    /**
+     * Retrieves an existing Acl in the Workspace.
+     *
+     * @param {string} ref - The reference of the Acl to retrieve
+     * @return {Promise<Acl>} - The response object that contains the Acl information
+     * @example
+     *
+     * const ref = "00000000-0000-0000-0000-000000000000"
+     *
+     * const acls = new SDK.Acls(client); // Existing client object
+     *
+     * acls.getAcl(ref)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    getAcl(ref: string): Promise<Acl>;
+    /**
+     * Updates an existing Acl in the Workspace.
+     *
+     * @param {UpdateAclRequest} request - The request object that contains the necessary information to update an existing Acl
+     * @param {string} request.ref - The reference of the Acl to update
+     * @param {string} request.name - The name of the Acl
+     * @param {string[]} request.allow - The list of IPs to allow
+     * @param {string[]} request.deny - The list of IPs to deny
+     * @return {Promise<BaseApiObject>} - The response object that contains the reference to the updated Acl
+     * @example
+     *
+     * const request = {
+     *  ref: "00000000-0000-0000-0000-000000000000",
+     *  name: "My ACL",
+     *  allow: ["47.132.130.31"] // Allow only this IP
+     *  deny: ["0.0.0.0/0"] // Deny all other IPs
+     * };
+     *
+     * const acls = new SDK.Acls(client); // Existing client object
+     *
+     * acl.updateAcl(request)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    updateAcl(request: UpdateAclRequest): Promise<BaseApiObject>;
+    /**
+     * Retrieves a list of Acls from a Workspace.
+     *
+     * @param {ListAclsRequest} request - The request object that contains the necessary information to retrieve a list of Acls
+     * @param {number} request.pageSize - The number of Acls to retrieve
+     * @param {string} request.pageToken - The token to retrieve the next page of Acls
+     * @return {Promise<ListAclsResponse>} - The response object that contains the list of Acls
+     * @example
+     *
+     * const request = {
+     *  pageSize: 10,
+     *  pageToken: "00000000-0000-0000-0000-000000000000"
+     * };
+     *
+     * const acls = new SDK.Acls(client); // Existing client object
+     *
+     * acls.listAcls(request)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    listAcls(request: ListAclsRequest): Promise<ListAclsResponse>;
+    /**
+     * Deletes an existing Acl from Fonoster.
+     * Note that this operation is irreversible.
+     *
+     * @param {string} ref - The reference of the Acl to delete
+     * @return {Promise<BaseApiObject>} - The response object that contains the reference to the deleted Acl
+     * @example
+     *
+     * const ref =  "00000000-0000-0000-0000-000000000000"
+     *
+     * const acls = new SDK.Acls(client); // Existing client object
+     *
+     * acls.deleteAcl(ref)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    deleteAcl(ref: string): Promise<BaseApiObject>;
+}
+export { Acls };

package/dist/node/Acls.js

@@ -0,0 +1,227 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Acls = void 0;
+const makeRpcRequest_1 = require("./client/makeRpcRequest");
+const acls_pb_1 = require("./generated/node/acls_pb");
+/**
+ * @classdesc Fonoster Acls, part of the Fonoster SIP Proxy subsystem,
+ * allows you to create, update, retrieve, and delete Access Control Lists (ACLs) rules for your deployment.
+ * Note that an active Fonoster deployment is required.
+ *
+ * @example
+ *
+ * const SDK = require("@fonoster/sdk");
+ *
+ * async function main(request) {
+ *  const apiKey = "your-api-key";
+ *  const accessKeyId = "00000000-0000-0000-0000-000000000000";
+ *
+ *  try {
+ *     const client = SDK.Client({ accessKeyId });
+ *     await client.loginWithApiKey(apiKey);
+ *
+ *     const acls = new SDK.Acls(client);
+ *     const response = await acls.createAcl(request);
+ *
+ *     console.log(response); // successful response
+ *   } catch (e) {
+ *     console.error(e); // an error occurred
+ *   }
+ * }
+ *
+ * const request = {
+ *   name: "My ACL",
+ *   allow: ["47.132.130.31"], // Allow only this IP
+ *   deny: ["0.0.0.0/0"] // Deny all other IPs
+ * };
+ *
+ * main(request).catch(console.error);
+ */
+class Acls {
+    client;
+    /**
+     * Constructs a new Acls object.
+     *
+     * @param {FonosterClient} client - Client object with underlying implementations to make requests to Fonoster's API
+     * @see AbstractClient
+     * @see FonosterClient
+     */
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Creates a new Acl in the Workspace.
+     *
+     * @param {CreateAclRequest} request - The request object that contains the necessary information to create a new Acl
+     * @param {string} request.name - The name of the Acl
+     * @param {string[]} request.allow - The list of IPs to allow
+     * @param {string[]} request.deny - The list of IPs to deny
+     * @return {Promise<BaseApiObject>} - The response object that contains the reference to the created Acl
+     * @example
+     *
+     * const request = {
+     *  name: "My ACL",
+     *  allow: ["47.132.130.31"], // Allow only this IP
+     *  deny: ["0.0.0.0/0"] // Deny all other IPs
+     * };
+     *
+     * const acls = new SDK.Acls(client); // Existing client object
+     *
+     * acls.createAcl(request)
+     * .then(console.log) // successful response
+     * .catch(console.error); // an error occurred
+     */
+    async createAcl(request) {
+        const client = this.client.getAclsClient();
+        const createAclRequest = new acls_pb_1.CreateAclRequest();
+        createAclRequest.setName(request.name);
+        createAclRequest.setAllowList(request.allow);
+        createAclRequest.setDenyList(request.deny);
+        return new Promise((resolve, reject) => {
+            client.createAcl(createAclRequest, this.client.getMetadata(), (err, response) => {
+                if (err) {
+                    reject(err);
+                    return;
+                }
+                resolve(response.toObject());
+            });
+        });
+    }
+    /**
+     * Retrieves an existing Acl in the Workspace.
+     *
+     * @param {string} ref - The reference of the Acl to retrieve
+     * @return {Promise<Acl>} - The response object that contains the Acl information
+     * @example
+     *
+     * const ref = "00000000-0000-0000-0000-000000000000"
+     *
+     * const acls = new SDK.Acls(client); // Existing client object
+     *
+     * acls.getAcl(ref)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    async getAcl(ref) {
+        const client = this.client.getAclsClient();
+        return await (0, makeRpcRequest_1.makeRpcRequest)({
+            method: client.getAcl.bind(client),
+            requestPBObjectConstructor: acls_pb_1.GetAclRequest,
+            metadata: this.client.getMetadata(),
+            request: { ref }
+        });
+    }
+    /**
+     * Updates an existing Acl in the Workspace.
+     *
+     * @param {UpdateAclRequest} request - The request object that contains the necessary information to update an existing Acl
+     * @param {string} request.ref - The reference of the Acl to update
+     * @param {string} request.name - The name of the Acl
+     * @param {string[]} request.allow - The list of IPs to allow
+     * @param {string[]} request.deny - The list of IPs to deny
+     * @return {Promise<BaseApiObject>} - The response object that contains the reference to the updated Acl
+     * @example
+     *
+     * const request = {
+     *  ref: "00000000-0000-0000-0000-000000000000",
+     *  name: "My ACL",
+     *  allow: ["47.132.130.31"] // Allow only this IP
+     *  deny: ["0.0.0.0/0"] // Deny all other IPs
+     * };
+     *
+     * const acls = new SDK.Acls(client); // Existing client object
+     *
+     * acl.updateAcl(request)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    async updateAcl(request) {
+        const client = this.client.getAclsClient();
+        const updateAclRequest = new acls_pb_1.UpdateAclRequest();
+        updateAclRequest.setRef(request.ref);
+        updateAclRequest.setName(request.name);
+        updateAclRequest.setAllowList(request.allow);
+        updateAclRequest.setDenyList(request.deny);
+        return new Promise((resolve, reject) => {
+            client.updateAcl(updateAclRequest, this.client.getMetadata(), (err, response) => {
+                if (err) {
+                    reject(err);
+                    return;
+                }
+                resolve(response.toObject());
+            });
+        });
+    }
+    /**
+     * Retrieves a list of Acls from a Workspace.
+     *
+     * @param {ListAclsRequest} request - The request object that contains the necessary information to retrieve a list of Acls
+     * @param {number} request.pageSize - The number of Acls to retrieve
+     * @param {string} request.pageToken - The token to retrieve the next page of Acls
+     * @return {Promise<ListAclsResponse>} - The response object that contains the list of Acls
+     * @example
+     *
+     * const request = {
+     *  pageSize: 10,
+     *  pageToken: "00000000-0000-0000-0000-000000000000"
+     * };
+     *
+     * const acls = new SDK.Acls(client); // Existing client object
+     *
+     * acls.listAcls(request)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    async listAcls(request) {
+        const client = this.client.getAclsClient();
+        const listAclsRequest = new acls_pb_1.ListAclsRequest();
+        listAclsRequest.setPageSize(request.pageSize);
+        listAclsRequest.setPageToken(request.pageToken);
+        return new Promise((resolve, reject) => {
+            client.listAcls(listAclsRequest, this.client.getMetadata(), (err, response) => {
+                if (err) {
+                    reject(err);
+                    return;
+                }
+                const items = response.getItemsList().map((item) => {
+                    const obj = item.toObject();
+                    return {
+                        ...obj,
+                        allow: obj.allowList,
+                        deny: obj.denyList
+                    };
+                });
+                resolve({
+                    items,
+                    nextPageToken: response.getNextPageToken()
+                });
+            });
+        });
+    }
+    /**
+     * Deletes an existing Acl from Fonoster.
+     * Note that this operation is irreversible.
+     *
+     * @param {string} ref - The reference of the Acl to delete
+     * @return {Promise<BaseApiObject>} - The response object that contains the reference to the deleted Acl
+     * @example
+     *
+     * const ref =  "00000000-0000-0000-0000-000000000000"
+     *
+     * const acls = new SDK.Acls(client); // Existing client object
+     *
+     * acls.deleteAcl(ref)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    async deleteAcl(ref) {
+        const client = this.client.getAclsClient();
+        return await (0, makeRpcRequest_1.makeRpcRequest)({
+            method: client.deleteAcl.bind(client),
+            requestPBObjectConstructor: acls_pb_1.DeleteAclRequest,
+            metadata: this.client.getMetadata(),
+            request: { ref }
+        });
+    }
+}
+exports.Acls = Acls;

package/dist/node/Agents.d.ts

@@ -0,0 +1,163 @@
+import { Agent, BaseApiObject, CreateAgentRequest, ListAgentsRequest, ListAgentsResponse, UpdateAgentRequest } from "@fonoster/types";
+import { FonosterClient } from "./client/types";
+/**
+ * @classdesc Fonoster Agents, part of the Fonoster SIP Proxy subsystem,
+ * allows you to create, update, retrieve, and delete SIP Agents for your deployment.
+ * Note that an active Fonoster deployment is required.
+ *
+ * @example
+ *
+ * const SDK = require("@fonoster/sdk");
+ *
+ * async function main(request) {
+ *  const apiKey = "your-api-key";
+ *  const accessKeyId = "00000000-0000-0000-0000-000000000000";
+ *
+ *  try {
+ *     const client = SDK.Client({ accessKeyId });
+ *     await client.loginWithApiKey(apiKey);
+ *
+ *     const agents = new SDK.Agents(client);
+ *     const response = await agents.createAgent(request);
+ *
+ *     console.log(response); // successful response
+ *   } catch (e) {
+ *     console.error(e); // an error occurred
+ *   }
+ * }
+ *
+ * const request = {
+ *   name: "John Doe",
+ *   username: "1001",
+ *   privacy: "PRIVATE",
+ *   enabled: true,
+ *   maxContacts: 3
+ *   domainRef: "00000000-0000-0000-0000-000000000000"
+ * };
+ *
+ * main(request).catch(console.error);
+ */
+declare class Agents {
+    private client;
+    /**
+     * Constructs a new Agents object.
+     *
+     * @param {FonosterClient} client - Client object with underlying implementations to make requests to Fonoster's API
+     * @see AbstractClient
+     * @see FonosterClient
+     */
+    constructor(client: FonosterClient);
+    /**
+     * Creates a new Agent in the Workspace.
+     *
+     * @param {CreateAgentRequest} request - The request object that contains the necessary information to create a new Agent
+     * @param {string} request.name - The name of the Agent
+     * @param {string} request.username - The username of the Agent
+     * @param {Privacy} request.privacy - The privacy of the Agent
+     * @param {boolean} request.enabled - The status of the Agent
+     * @param {number} request.maxContacts - The maximum number of contacts the Agent can have
+     * @param {string} request.domainRef - The reference of the Domain to associate the Agent
+     * @return {Promise<BaseApiObject>} - The response object that contains the reference to the created Agent
+     * @example
+     *
+     * const request = {
+     *  name: "John Doe",
+     *  username: "1001",
+     *  privacy: "PRIVATE",
+     *  enabled: true,
+     *  maxContacts: 3
+     *  domainRef: "00000000-0000-0000-0000-000000000000"
+     * };
+     *
+     * const agents = new SDK.Agents(client); // Existing client object
+     *
+     * agents.createAgent(request)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    createAgent(request: CreateAgentRequest): Promise<BaseApiObject>;
+    /**
+     * Retrieves an existing Agent in the Workspace.
+     *
+     * @param {string} ref - The reference of the Agent to retrieve
+     * @return {Promise<Acl>} - The response object that contains the Agent information
+     * @example
+     *
+     * const ref = "00000000-0000-0000-0000-000000000000"
+     *
+     * const agents = new SDK.Agents(client); // Existing client object
+     *
+     * agents.getAgent(ref)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    getAgent(ref: string): Promise<Agent>;
+    /**
+     * Updates an existing Agent in the Workspace.
+     *
+     * @param {UpdateAgentRequest} request - The request object that contains the necessary information to update an existing Agent
+     * @param {string} request.ref - The reference of the Agent to update
+     * @param {string} request.name - The name of the Agent
+     * @param {Privacy} request.privacy - The privacy of the Agent
+     * @param {boolean} request.enabled - The status of the Agent
+     * @param {number} request.maxContacts - The maximum number of contacts the Agent can have
+     * @param {string} request.domainRef - The reference of the Domain to associate the Agent
+     * @return {Promise<BaseApiObject>} - The response object that contains the reference to the updated Agent
+     * @example
+     *
+     * const request = {
+     *  ref: "00000000-0000-0000-0000-000000000000",
+     *  name: "John Doe",
+     *  privacy: "PRIVATE",
+     *  enabled: true,
+     *  maxContacts: 3
+     *  domainRef: "00000000-0000-0000-0000-000000000000"
+     * };
+     *
+     * const agents = new SDK.Agents(client); // Existing client object
+     *
+     * agents.updateAgent(request)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    updateAgent(request: UpdateAgentRequest): Promise<BaseApiObject>;
+    /**
+     * Retrieves a list of Agents from a Workspace.
+     *
+     * @param {ListAgentsRequest} request - The request object that contains the necessary information to retrieve a list of Agents
+     * @param {number} request.pageSize - The number of Agents to retrieve
+     * @param {string} request.pageToken - The token to retrieve the next page of Agents
+     * @return {Promise<ListAgentsResponse>} - The response object that contains the list of Agents
+     * @example
+     *
+     * const request = {
+     *  pageSize: 10,
+     *  pageToken: "00000000-0000-0000-0000-000000000000"
+     * };
+     *
+     * const agents = new SDK.Agents(client); // Existing client object
+     *
+     * agents.listAgents(request)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    listAgents(request: ListAgentsRequest): Promise<ListAgentsResponse>;
+    /**
+     * Deletes an existing Agent from Fonoster.
+     * Note that this operation is irreversible.
+     *
+     * @param {string} ref - The reference of the Agent to delete
+     * @return {Promise<BaseApiObject>} - The response object that contains the reference to the deleted Agent
+     * @example
+     *
+     * const ref =  "00000000-0000-0000-0000-000000000000"
+     *
+     * const agents = new SDK.Agents(client); // Existing client object
+     *
+     * agents.deleteAgent(ref)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    deleteAgent(ref: string): Promise<BaseApiObject>;
+}
+export { Agents };