@fonoster/sdk 0.6.1 → 0.6.2

package/dist/node/Trunks.d.ts

@@ -0,0 +1,181 @@
+import { BaseApiObject, CreateTrunkRequest, ListTrunksRequest, ListTrunksResponse, UpdateTrunkRequest } from "@fonoster/types";
+import { FonosterClient } from "./client/types";
+/**
+ * @classdesc Fonoster Trunks, part of the Fonoster SIP Proxy subsystem,
+ * allows you to create, update, retrieve, and delete SIP Trunks 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 trunks = new SDK.Trunks(client);
+ *     const response = await trunks.createTrunk(request);
+ *
+ *     console.log(response); // successful response
+ *   } catch (e) {
+ *     console.error(e); // an error occurred
+ *   }
+ * }
+ *
+ * const request = {
+ *   name: "My Trunk",
+ *   inboundUri: "sip.company.fonoster.io"
+ * };
+ *
+ * main(request).catch(console.error);
+ */
+declare class Trunks {
+    private client;
+    /**
+     * Constructs a new Trunks 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 Trunk in the Workspace.
+     *
+     * @param {CreateTrunkRequest} request - The request object that contains the necessary information to create a new Trunk
+     * @param {string} request.name - The name of the Trunk
+     * @param {string} request.inboundUri - The inboundUri of the Trunk
+     * @param {boolean} request.sendRegister - The sendRegister of the Trunk
+     * @param {string} request.accessControlListRef - The accessControlListRef of the Trunk
+     * @param {string} request.inboundCredentialsRef - The inboundCredentialsRef of the Trunk
+     * @param {string} request.outboundCredentialsRef - The outboundCredentialsRef of the Trunk
+     * @param {TrunkUri[]} request.uris - The uris of the Trunk
+     * @param {string} request.uris[].host - The host of the Trunk
+     * @param {number} request.uris[].port - The port of the Trunk
+     * @param {Transport} request.uris[].transport - The transport of the Trunk
+     * @param {string} request.uris[].user - Optional user of the Trunk
+     * @param {number} request.uris[].weight - Optional weight of the Trunk
+     * @param {number} request.uris[].priority - Optional priority of the Trunk
+     * @param {boolean} request.uris[].enabled - Optional enabled of the Trunk
+     * @return {Promise<BaseApiObject>} - The response object that contains the reference to the created Trunk
+     * @example
+     *
+     * const request = {
+     *  name: "My Trunk",
+     *  inboundUri: "sip.company.fonoster.io"
+     *  sendRegister: true
+     *  uris: [{
+     *    host: "sip.company.fonoster.io",
+     *    port: 5060,
+     *    transport: "UDP",
+     *    user: "user",
+     *    weight: 0,
+     *    priority: 0,
+     *    enabled: true
+     *  }]
+     * };
+     *
+     * const trunks = new SDK.Trunks(client); // Existing client object
+     *
+     * trunks.createTrunk(request)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    createTrunk(request: CreateTrunkRequest): Promise<BaseApiObject>;
+    /**
+     * Retrieves an existing Trunk in the Workspace.
+     *
+     * @param {string} ref - The reference of the Trunk to retrieve
+     * @return {Promise<Acl>} - The response object that contains the Trunk
+     * @example
+     *
+     * const ref = "00000000-0000-0000-0000-000000000000"
+     *
+     * const trunks = new SDK.Trunks(client); // Existing client object
+     *
+     * trunks.getTrunk(ref)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    getTrunk(ref: string): Promise<unknown>;
+    /**
+     * Updates an existing Trunk in the Workspace.
+     *
+     * @param {UpdateTrunkRequest} request - The request object that contains the necessary information to update an existing Trunk
+     * @param {string} request.ref - The reference of the Trunk to update
+     * @param {string} request.name - The name of the Trunk
+     * @param {boolean} request.sendRegister - The sendRegister of the Trunk
+     * @param {string} request.accessControlListRef - The accessControlListRef of the Trunk
+     * @param {string} request.inboundCredentialsRef - The inboundCredentialsRef of the Trunk
+     * @param {string} request.outboundCredentialsRef - The outboundCredentialsRef of the Trunk
+     * @param {TrunkUri[]} request.uris - The uris of the Trunk
+     * @param {string} request.uris[].host - The host of the Trunk
+     * @param {number} request.uris[].port - The port of the Trunk
+     * @param {Transport} request.uris[].transport - The transport of the Trunk
+     * @param {string} request.uris[].user - Optional user of the Trunk
+     * @param {number} request.uris[].weight - Optional weight of the Trunk
+     * @param {number} request.uris[].priority - Optional priority of the Trunk
+     * @param {boolean} request.uris[].enabled - Optional enabled of the Trunk
+     * @return {Promise<BaseApiObject>} - The response object that contains the reference to the updated Trunk
+     * @example
+     *
+     * const request = {
+     *  ref: "00000000-0000-0000-0000-000000000000",
+     *  name: "My Trunk",
+     *  sendRegister: true
+     *  uris: [{
+     *    host: "sip.company.fonoster.io",
+     *    port: 5060,
+     *    transport: "UDP",
+     *    user: "user",
+     *    weight: 0,
+     *    priority: 0,
+     *    enabled: true
+     *  }]
+     * };
+     */
+    updateTrunk(request: UpdateTrunkRequest): Promise<BaseApiObject>;
+    /**
+     * Retrieves a list of Trunks from a Workspace.
+     *
+     * @param {ListTrunksRequest} request - The request object that contains the necessary information to retrieve a list of Trunks
+     * @param {number} request.pageSize - The trunk of Trunks to retrieve
+     * @param {string} request.pageToken - The token to retrieve the next page of Trunks
+     * @return {Promise<ListTrunksResponse>} - The response object that contains the list of Trunks
+     * @example
+     *
+     * const request = {
+     *  pageSize: 10,
+     *  pageToken: "00000000-0000-0000-0000-000000000000"
+     * };
+     *
+     * const trunks = new SDK.Trunks(client); // Existing client object
+     *
+     * trunks.listTrunks(request)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    listTrunks(request: ListTrunksRequest): Promise<ListTrunksResponse>;
+    /**
+     * Deletes an existing Trunk from Fonoster.
+     * Note that this operation is irreversible.
+     *
+     * @param {string} ref - The reference of the Trunk to delete
+     * @return {Promise<BaseApiObject>} - The response object that contains the reference to the deleted Trunk
+     * @example
+     *
+     * const ref =  "00000000-0000-0000-0000-000000000000"
+     *
+     * const trunks = new SDK.Trunks(client); // Existing client object
+     *
+     * trunks.deleteTrunk(ref)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    deleteTrunk(ref: string): Promise<BaseApiObject>;
+}
+export { Trunks };

package/dist/node/Trunks.js

@@ -0,0 +1,275 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Trunks = void 0;
+const makeRpcRequest_1 = require("./client/makeRpcRequest");
+const trunks_pb_1 = require("./generated/node/trunks_pb");
+/**
+ * @classdesc Fonoster Trunks, part of the Fonoster SIP Proxy subsystem,
+ * allows you to create, update, retrieve, and delete SIP Trunks 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 trunks = new SDK.Trunks(client);
+ *     const response = await trunks.createTrunk(request);
+ *
+ *     console.log(response); // successful response
+ *   } catch (e) {
+ *     console.error(e); // an error occurred
+ *   }
+ * }
+ *
+ * const request = {
+ *   name: "My Trunk",
+ *   inboundUri: "sip.company.fonoster.io"
+ * };
+ *
+ * main(request).catch(console.error);
+ */
+class Trunks {
+    client;
+    /**
+     * Constructs a new Trunks 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 Trunk in the Workspace.
+     *
+     * @param {CreateTrunkRequest} request - The request object that contains the necessary information to create a new Trunk
+     * @param {string} request.name - The name of the Trunk
+     * @param {string} request.inboundUri - The inboundUri of the Trunk
+     * @param {boolean} request.sendRegister - The sendRegister of the Trunk
+     * @param {string} request.accessControlListRef - The accessControlListRef of the Trunk
+     * @param {string} request.inboundCredentialsRef - The inboundCredentialsRef of the Trunk
+     * @param {string} request.outboundCredentialsRef - The outboundCredentialsRef of the Trunk
+     * @param {TrunkUri[]} request.uris - The uris of the Trunk
+     * @param {string} request.uris[].host - The host of the Trunk
+     * @param {number} request.uris[].port - The port of the Trunk
+     * @param {Transport} request.uris[].transport - The transport of the Trunk
+     * @param {string} request.uris[].user - Optional user of the Trunk
+     * @param {number} request.uris[].weight - Optional weight of the Trunk
+     * @param {number} request.uris[].priority - Optional priority of the Trunk
+     * @param {boolean} request.uris[].enabled - Optional enabled of the Trunk
+     * @return {Promise<BaseApiObject>} - The response object that contains the reference to the created Trunk
+     * @example
+     *
+     * const request = {
+     *  name: "My Trunk",
+     *  inboundUri: "sip.company.fonoster.io"
+     *  sendRegister: true
+     *  uris: [{
+     *    host: "sip.company.fonoster.io",
+     *    port: 5060,
+     *    transport: "UDP",
+     *    user: "user",
+     *    weight: 0,
+     *    priority: 0,
+     *    enabled: true
+     *  }]
+     * };
+     *
+     * const trunks = new SDK.Trunks(client); // Existing client object
+     *
+     * trunks.createTrunk(request)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    async createTrunk(request) {
+        const client = this.client.getTrunksClient();
+        const createTrunkRequest = new trunks_pb_1.CreateTrunkRequest();
+        createTrunkRequest.setName(request.name);
+        createTrunkRequest.setInboundUri(request.inboundUri);
+        createTrunkRequest.setSendRegister(request.sendRegister);
+        // createAclRequest.setAccessControlListRef(?);
+        // createAclRequest.setInboundCredentialsRef(?);
+        // createAclRequest.setOutboundCredentialsRef(?);
+        // request.uris.forEach(uri => {
+        //   const uri = new CreateTrunkRequestPB.Uris();
+        //   createTrunkRequest.addUris(uri);
+        // }
+        return new Promise((resolve, reject) => {
+            client.createTrunk(createTrunkRequest, this.client.getMetadata(), (err, response) => {
+                if (err) {
+                    reject(err);
+                    return;
+                }
+                resolve(response.toObject());
+            });
+        });
+    }
+    /**
+     * Retrieves an existing Trunk in the Workspace.
+     *
+     * @param {string} ref - The reference of the Trunk to retrieve
+     * @return {Promise<Acl>} - The response object that contains the Trunk
+     * @example
+     *
+     * const ref = "00000000-0000-0000-0000-000000000000"
+     *
+     * const trunks = new SDK.Trunks(client); // Existing client object
+     *
+     * trunks.getTrunk(ref)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    async getTrunk(ref) {
+        const client = this.client.getTrunksClient();
+        const getTrunkRequest = new trunks_pb_1.GetTrunkRequest();
+        getTrunkRequest.setRef(ref);
+        return new Promise((resolve, reject) => {
+            client.getTrunk(getTrunkRequest, this.client.getMetadata(), (err, response) => {
+                if (err) {
+                    reject(err);
+                    return;
+                }
+                resolve(response.toObject());
+            });
+        });
+    }
+    /**
+     * Updates an existing Trunk in the Workspace.
+     *
+     * @param {UpdateTrunkRequest} request - The request object that contains the necessary information to update an existing Trunk
+     * @param {string} request.ref - The reference of the Trunk to update
+     * @param {string} request.name - The name of the Trunk
+     * @param {boolean} request.sendRegister - The sendRegister of the Trunk
+     * @param {string} request.accessControlListRef - The accessControlListRef of the Trunk
+     * @param {string} request.inboundCredentialsRef - The inboundCredentialsRef of the Trunk
+     * @param {string} request.outboundCredentialsRef - The outboundCredentialsRef of the Trunk
+     * @param {TrunkUri[]} request.uris - The uris of the Trunk
+     * @param {string} request.uris[].host - The host of the Trunk
+     * @param {number} request.uris[].port - The port of the Trunk
+     * @param {Transport} request.uris[].transport - The transport of the Trunk
+     * @param {string} request.uris[].user - Optional user of the Trunk
+     * @param {number} request.uris[].weight - Optional weight of the Trunk
+     * @param {number} request.uris[].priority - Optional priority of the Trunk
+     * @param {boolean} request.uris[].enabled - Optional enabled of the Trunk
+     * @return {Promise<BaseApiObject>} - The response object that contains the reference to the updated Trunk
+     * @example
+     *
+     * const request = {
+     *  ref: "00000000-0000-0000-0000-000000000000",
+     *  name: "My Trunk",
+     *  sendRegister: true
+     *  uris: [{
+     *    host: "sip.company.fonoster.io",
+     *    port: 5060,
+     *    transport: "UDP",
+     *    user: "user",
+     *    weight: 0,
+     *    priority: 0,
+     *    enabled: true
+     *  }]
+     * };
+     */
+    async updateTrunk(request) {
+        const client = this.client.getTrunksClient();
+        const updateTrunkRequest = new trunks_pb_1.UpdateTrunkRequest();
+        updateTrunkRequest.setRef(request.ref);
+        updateTrunkRequest.setName(request.name);
+        updateTrunkRequest.setSendRegister(request.sendRegister);
+        // updateAclRequest.setAccessControlListRef(?);
+        // updateAclRequest.setInboundCredentialsRef(?);
+        // updateAclRequest.setOutboundCredentialsRef(?);
+        // request.uris.forEach(uri => {
+        //   const uri = new UpdateTrunkRequestPB.Uris();
+        //   updateTrunkRequest.addUris(uri);
+        // }
+        return new Promise((resolve, reject) => {
+            client.updateTrunk(updateTrunkRequest, this.client.getMetadata(), (err, response) => {
+                if (err) {
+                    reject(err);
+                    return;
+                }
+                resolve(response.toObject());
+            });
+        });
+    }
+    /**
+     * Retrieves a list of Trunks from a Workspace.
+     *
+     * @param {ListTrunksRequest} request - The request object that contains the necessary information to retrieve a list of Trunks
+     * @param {number} request.pageSize - The trunk of Trunks to retrieve
+     * @param {string} request.pageToken - The token to retrieve the next page of Trunks
+     * @return {Promise<ListTrunksResponse>} - The response object that contains the list of Trunks
+     * @example
+     *
+     * const request = {
+     *  pageSize: 10,
+     *  pageToken: "00000000-0000-0000-0000-000000000000"
+     * };
+     *
+     * const trunks = new SDK.Trunks(client); // Existing client object
+     *
+     * trunks.listTrunks(request)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    async listTrunks(request) {
+        const client = this.client.getTrunksClient();
+        const listTrunksRequest = new trunks_pb_1.ListTrunksRequest();
+        listTrunksRequest.setPageSize(request.pageSize);
+        listTrunksRequest.setPageToken(request.pageToken);
+        return new Promise((resolve, reject) => {
+            client.listTrunks(listTrunksRequest, this.client.getMetadata(), (err, response) => {
+                if (err) {
+                    reject(err);
+                    return;
+                }
+                const items = response.getItemsList().map((item) => {
+                    const obj = item.toObject();
+                    return {
+                        ...obj
+                    };
+                });
+                resolve({
+                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                    items: items,
+                    nextPageToken: response.getNextPageToken()
+                });
+            });
+        });
+    }
+    /**
+     * Deletes an existing Trunk from Fonoster.
+     * Note that this operation is irreversible.
+     *
+     * @param {string} ref - The reference of the Trunk to delete
+     * @return {Promise<BaseApiObject>} - The response object that contains the reference to the deleted Trunk
+     * @example
+     *
+     * const ref =  "00000000-0000-0000-0000-000000000000"
+     *
+     * const trunks = new SDK.Trunks(client); // Existing client object
+     *
+     * trunks.deleteTrunk(ref)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    async deleteTrunk(ref) {
+        const applicationsClient = this.client.getTrunksClient();
+        return await (0, makeRpcRequest_1.makeRpcRequest)({
+            method: applicationsClient.deleteTrunk.bind(applicationsClient),
+            requestPBObjectConstructor: trunks_pb_1.DeleteTrunkRequest,
+            metadata: this.client.getMetadata(),
+            request: { ref }
+        });
+    }
+}
+exports.Trunks = Trunks;

package/dist/node/Users.d.ts

@@ -0,0 +1,132 @@
+import { BaseApiObject, CreateUserRequest, UpdateUserRequest, User } from "@fonoster/types";
+import { FonosterClient } from "./client/types";
+/**
+ * @classdesc Fonoster Users, part of the Fonoster Identity subsystem,
+ * allows you to create, update, retrieve, and delete a Users in the system.
+ * 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 users = new SDK.Users(client);
+ *     const response = await users.createUser(request);
+ *
+ *     console.log(response); // successful response
+ *   } catch (e) {
+ *     console.error(e); // an error occurred
+ *   }
+ * }
+ *
+ * const request = {
+ *   name: "John Doe",
+ *   email: "john.doe@example.com",
+ *   password: "password",
+ *   avatar: "https://example.com/avatar.jpg"
+ * };
+ *
+ * main(request).catch(console.error);
+ */
+declare class Users {
+    private client;
+    /**
+     * Constructs a new Users 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 User in the Workspace.
+     *
+     * @param {CreateUserRequest} request - The request object that contains the necessary information to create a new User
+     * @param {string} request.name - The name of the User
+     * @param {string} request.email - The email of the User
+     * @param {string} request.password - The password of the User
+     * @param {string} request.avatar - The avatar of the User
+     * @return {Promise<BaseApiObject>} - The response object that contains the reference to the created User
+     * @example
+     *
+     * const request = {
+     *  name: "John Doe",
+     *  email: "john.doe@example.com",
+     *  password: "password",
+     *  avatar: "https://example.com/avatar.jpg"
+     * };
+     *
+     * const users = new SDK.Users(client); // Existing client object
+     *
+     * users.createUser(request)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    createUser(request: CreateUserRequest): Promise<BaseApiObject>;
+    /**
+     * Retrieves an existing User in the Workspace.
+     *
+     * @param {string} ref - The reference of the User to retrieve
+     * @return {Promise<Acl>} - The response object that contains the User
+     * @example
+     *
+     * const ref = "00000000-0000-0000-0000-000000000000"
+     *
+     * const users = new SDK.Users(client); // Existing client object
+     *
+     * users.getUser(ref)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    getUser(ref: string): Promise<User>;
+    /**
+     * Updates an existing User in the Workspace.
+     *
+     * @param {UpdateUserRequest} request - The request object that contains the necessary information to update a User
+     * @param {string} request.ref - The reference of the User to update
+     * @param {string} request.name - The name of the User
+     * @param {string} request.password - The password of the User
+     * @param {string} request.avatar - The avatar of the User
+     * @return {Promise<BaseApiObject>} - The response object that contains the reference to the updated User
+     * @example
+     *
+     * const request = {
+     *  ref: "00000000-0000-0000-0000-000000000000",
+     *  name: "John Doe",
+     *  password: "password",
+     *  avatar: "https://example.com/avatar.jpg"
+     * };
+     *
+     * const users = new SDK.Users(client); // Existing client object
+     *
+     * users.updateUser(request)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    updateUser(request: UpdateUserRequest): Promise<BaseApiObject>;
+    /**
+     * Deletes an existing User from Fonoster.
+     * Note that this operation is irreversible.
+     *
+     * @param {string} ref - The reference of the User to delete
+     * @return {Promise<BaseApiObject>} - The response object that contains the reference to the deleted User
+     * @example
+     *
+     * const ref =  "00000000-0000-0000-0000-000000000000"
+     *
+     * const users = new SDK.Users(client); // Existing client object
+     *
+     * users.deleteUser(ref)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    deleteUser(ref: string): Promise<BaseApiObject>;
+}
+export { Users };