@fonoster/sdk 0.6.1 → 0.6.2

package/dist/node/Agents.js

@@ -0,0 +1,211 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Agents = void 0;
+const makeRpcRequest_1 = require("./client/makeRpcRequest");
+const agents_pb_1 = require("./generated/node/agents_pb");
+/**
+ * @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);
+ */
+class Agents {
+    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) {
+        this.client = client;
+    }
+    /**
+     * 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
+     */
+    async createAgent(request) {
+        const client = this.client.getAgentsClient();
+        return await (0, makeRpcRequest_1.makeRpcRequest)({
+            method: client.createAgent.bind(client),
+            requestPBObjectConstructor: agents_pb_1.CreateAgentRequest,
+            metadata: this.client.getMetadata(),
+            request,
+            enumMapping: [["privacy", agents_pb_1.Privacy]]
+        });
+    }
+    /**
+     * 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
+     */
+    async getAgent(ref) {
+        const client = this.client.getAgentsClient();
+        return await (0, makeRpcRequest_1.makeRpcRequest)({
+            method: client.getAgent.bind(client),
+            requestPBObjectConstructor: agents_pb_1.GetAgentRequest,
+            metadata: this.client.getMetadata(),
+            request: { ref }
+        });
+    }
+    /**
+     * 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
+     */
+    async updateAgent(request) {
+        const client = this.client.getAgentsClient();
+        return await (0, makeRpcRequest_1.makeRpcRequest)({
+            method: client.updateAgent.bind(client),
+            requestPBObjectConstructor: agents_pb_1.UpdateAgentRequest,
+            metadata: this.client.getMetadata(),
+            request,
+            enumMapping: [["privacy", agents_pb_1.Privacy]]
+        });
+    }
+    /**
+     * 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
+     */
+    async listAgents(request) {
+        const client = this.client.getAgentsClient();
+        return await (0, makeRpcRequest_1.makeRpcRequest)({
+            method: client.listAgents.bind(client),
+            requestPBObjectConstructor: agents_pb_1.ListAgentsRequest,
+            metadata: this.client.getMetadata(),
+            request,
+            repeatableObjectMapping: [["itemsList", agents_pb_1.Agent]]
+        });
+    }
+    /**
+     * 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
+     */
+    async deleteAgent(ref) {
+        const applicationsClient = this.client.getAgentsClient();
+        return await (0, makeRpcRequest_1.makeRpcRequest)({
+            method: applicationsClient.deleteAgent.bind(applicationsClient),
+            requestPBObjectConstructor: agents_pb_1.DeleteAgentRequest,
+            metadata: this.client.getMetadata(),
+            request: { ref }
+        });
+    }
+}
+exports.Agents = Agents;

package/dist/node/ApiKeys.d.ts

@@ -0,0 +1,120 @@
+import { BaseApiObject, CreateApiKeyRequest, CreateApiKeyResponse, ListApiKeysRequest, ListApiKeysResponse } from "@fonoster/types";
+import { FonosterClient } from "./client/types";
+/**
+ * @classdesc Fonoster ApiKeys, part of the Fonoster Identity subsystem,
+ * allows you to create, update, retrieve, and delete ApiKeys 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 apiKeys = new SDK.ApiKeys(client);
+ *     const response = await apiKeys.createApiKey(request);
+ *
+ *     console.log(response); // successful response
+ *   } catch (e) {
+ *     console.error(e); // an error occurred
+ *   }
+ * }
+ *
+ * const request = {
+ *   role: "WORKSPACE_ADMIN"
+ * };
+ *
+ * main(request).catch(console.error);
+ */
+declare class ApiKeys {
+    private client;
+    /**
+     * Constructs a new ApiKeys 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 ApiKey for a Workspace.
+     *
+     * @param {CreateApiKeyRequest} request - The request object that contains the necessary information to create a new ApiKey
+     * @param {ApiRoleEnum} request.role - The role of the ApiKey
+     * @return {Promise<CreateApiKeyResponse>} - The response object that contains the reference to the created ApiKey
+     * @example
+     *
+     * const request = {
+     *  role: "WORKSPACE_ADMIN"
+     * };
+     *
+     * const apiKeys = new SDK.ApiKeys(client); // Existing client object
+     *
+     * apiKeys.createApiKey(request)
+     * .then(console.log) // successful response
+     * .catch(console.error); // an error occurred
+     */
+    createApiKey(request: CreateApiKeyRequest): Promise<CreateApiKeyResponse>;
+    /**
+     * Regenerates an existing ApiKey for a Workspace.
+     * Note that this operation is irreversible.
+     *
+     * @param {string} ref - The reference of the ApiKey to regenerate
+     * @return {Promise<CreateApiKeyResponse>} - The response object that contains the reference to the regenerated ApiKey
+     * @example
+     *
+     * const ref =  "00000000-0000-0000-0000-000000000000"
+     *
+     * const apiKeys = new SDK.ApiKeys(client); // Existing client object
+     *
+     * apiKeys.regenerateApiKey(ref)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    regenerateApiKey(ref: string): Promise<CreateApiKeyResponse>;
+    /**
+     * Retrieves a list of ApiKeys from a Workspace.
+     *
+     * @param {ListApiKeysRequest} request - The request object that contains the necessary information to retrieve a list of ApiKeys
+     * @param {number} request.pageSize - The number of ApiKeys to retrieve
+     * @param {string} request.pageToken - The token to retrieve the next page of ApiKeys
+     * @return {Promise<ListApiKeysResponse>} - The response object that contains the list of ApiKeys
+     * @example
+     *
+     * const request = {
+     *  pageSize: 10,
+     *  pageToken: "00000000-0000-0000-0000-000000000000"
+     * };
+     *
+     * const apiKeys = new SDK.ApiKeys(client); // Existing client object
+     *
+     * apiKeys.listApiKeys(request)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    listApiKeys(request: ListApiKeysRequest): Promise<ListApiKeysResponse>;
+    /**
+     * Deletes an existing ApiKey from Fonoster.
+     * Note that this operation is irreversible.
+     *
+     * @param {string} ref - The reference of the ApiKey to delete
+     * @return {Promise<BaseApiObject>} - The response object that contains the reference to the deleted ApiKey
+     * @example
+     *
+     * const ref =  "00000000-0000-0000-0000-000000000000"
+     *
+     * const apiKeys = new SDK.ApiKeys(client); // Existing client object
+     *
+     * apiKeys.deleteApiKey(ref)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    deleteApiKey(ref: string): Promise<BaseApiObject>;
+}
+export { ApiKeys };

package/dist/node/ApiKeys.js

@@ -0,0 +1,178 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiKeys = void 0;
+/*
+ * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster/fonoster
+ *
+ * This file is part of Fonoster
+ *
+ * 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 types_1 = require("@fonoster/types");
+const makeRpcRequest_1 = require("./client/makeRpcRequest");
+const identity_pb_1 = require("./generated/node/identity_pb");
+/**
+ * @classdesc Fonoster ApiKeys, part of the Fonoster Identity subsystem,
+ * allows you to create, update, retrieve, and delete ApiKeys 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 apiKeys = new SDK.ApiKeys(client);
+ *     const response = await apiKeys.createApiKey(request);
+ *
+ *     console.log(response); // successful response
+ *   } catch (e) {
+ *     console.error(e); // an error occurred
+ *   }
+ * }
+ *
+ * const request = {
+ *   role: "WORKSPACE_ADMIN"
+ * };
+ *
+ * main(request).catch(console.error);
+ */
+class ApiKeys {
+    client;
+    /**
+     * Constructs a new ApiKeys 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 ApiKey for a Workspace.
+     *
+     * @param {CreateApiKeyRequest} request - The request object that contains the necessary information to create a new ApiKey
+     * @param {ApiRoleEnum} request.role - The role of the ApiKey
+     * @return {Promise<CreateApiKeyResponse>} - The response object that contains the reference to the created ApiKey
+     * @example
+     *
+     * const request = {
+     *  role: "WORKSPACE_ADMIN"
+     * };
+     *
+     * const apiKeys = new SDK.ApiKeys(client); // Existing client object
+     *
+     * apiKeys.createApiKey(request)
+     * .then(console.log) // successful response
+     * .catch(console.error); // an error occurred
+     */
+    async createApiKey(request) {
+        const client = this.client.getIdentityClient();
+        return await (0, makeRpcRequest_1.makeRpcRequest)({
+            method: client.createApiKey.bind(client),
+            requestPBObjectConstructor: identity_pb_1.CreateApiKeyRequest,
+            metadata: this.client.getMetadata(),
+            request,
+            enumMapping: [["role", types_1.ApiRoleEnum]]
+        });
+    }
+    /**
+     * Regenerates an existing ApiKey for a Workspace.
+     * Note that this operation is irreversible.
+     *
+     * @param {string} ref - The reference of the ApiKey to regenerate
+     * @return {Promise<CreateApiKeyResponse>} - The response object that contains the reference to the regenerated ApiKey
+     * @example
+     *
+     * const ref =  "00000000-0000-0000-0000-000000000000"
+     *
+     * const apiKeys = new SDK.ApiKeys(client); // Existing client object
+     *
+     * apiKeys.regenerateApiKey(ref)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    async regenerateApiKey(ref) {
+        const client = this.client.getIdentityClient();
+        return await (0, makeRpcRequest_1.makeRpcRequest)({
+            method: client.regenerateApiKey.bind(client),
+            requestPBObjectConstructor: identity_pb_1.RegenerateApiKeyRequest,
+            metadata: this.client.getMetadata(),
+            request: { ref }
+        });
+    }
+    /**
+     * Retrieves a list of ApiKeys from a Workspace.
+     *
+     * @param {ListApiKeysRequest} request - The request object that contains the necessary information to retrieve a list of ApiKeys
+     * @param {number} request.pageSize - The number of ApiKeys to retrieve
+     * @param {string} request.pageToken - The token to retrieve the next page of ApiKeys
+     * @return {Promise<ListApiKeysResponse>} - The response object that contains the list of ApiKeys
+     * @example
+     *
+     * const request = {
+     *  pageSize: 10,
+     *  pageToken: "00000000-0000-0000-0000-000000000000"
+     * };
+     *
+     * const apiKeys = new SDK.ApiKeys(client); // Existing client object
+     *
+     * apiKeys.listApiKeys(request)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    async listApiKeys(request) {
+        const applicationsClient = this.client.getIdentityClient();
+        return await (0, makeRpcRequest_1.makeRpcRequest)({
+            method: applicationsClient.listApiKeys.bind(applicationsClient),
+            requestPBObjectConstructor: identity_pb_1.ListApiKeysRequest,
+            metadata: this.client.getMetadata(),
+            request,
+            repeatableObjectMapping: [["itemsList", identity_pb_1.ApiKey]]
+        });
+    }
+    /**
+     * Deletes an existing ApiKey from Fonoster.
+     * Note that this operation is irreversible.
+     *
+     * @param {string} ref - The reference of the ApiKey to delete
+     * @return {Promise<BaseApiObject>} - The response object that contains the reference to the deleted ApiKey
+     * @example
+     *
+     * const ref =  "00000000-0000-0000-0000-000000000000"
+     *
+     * const apiKeys = new SDK.ApiKeys(client); // Existing client object
+     *
+     * apiKeys.deleteApiKey(ref)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    async deleteApiKey(ref) {
+        const client = this.client.getIdentityClient();
+        return await (0, makeRpcRequest_1.makeRpcRequest)({
+            method: client.deleteApiKey.bind(client),
+            requestPBObjectConstructor: identity_pb_1.DeleteApiKeyRequest,
+            metadata: this.client.getMetadata(),
+            request: { ref }
+        });
+    }
+}
+exports.ApiKeys = ApiKeys;

package/dist/node/Applications.d.ts

@@ -1,4 +1,4 @@
-import { Application, BaseApiObject, CreateApplicationRequest, CreateApplicationResponse, ListApplicationsRequest, ListApplicationsResponse, UpdateApplicationRequest } from "@fonoster/common";
+import { Application, BaseApiObject, CreateApplicationRequest, CreateApplicationResponse, ListApplicationsRequest, ListApplicationsResponse, UpdateApplicationRequest } from "@fonoster/types";
 import { FonosterClient } from "./client/types";
 /**
  * @classdesc Fonoster Applications, part of the Fonoster Voice Subsystem,
@@ -9,6 +9,23 @@ import { FonosterClient } from "./client/types";
  *
  * 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 apps = new SDK.Applications(client);
+ *     const response = await apps.createApplication(request);
+ *
+ *     console.log(response); // successful response
+ *   } catch (e) {
+ *     console.error(e); // an error occurred
+ *   }
+ * }
+ *
  * const request = {
  *   name: "My application",
  *   type: "PROGRAMMABLE_VOICE",
@@ -36,18 +53,7 @@ import { FonosterClient } from "./client/types";
  *   }
  * };
  *
- * const username = "admin@fonoster.local";
- * const password = "changeme";
- * const accessKeyId = "WO00000000000000000000000000000000";
- *
- * const client = new SDK.Client({ accessKeyId });
- *
- * client.login(username, password)
- *  .then(async () => {
- *    const apps = new SDK.Applications(client);
- *    const result = await apps.createApplication(request);
- *    console.log(result);  // successful response
- *  }).catch(console.error); // an error occurred
+ * main(request).catch(console.error);
  */
 declare class Applications {
     private client;
@@ -114,19 +120,17 @@ declare class Applications {
      */
     createApplication(request: CreateApplicationRequest): Promise<CreateApplicationResponse>;
     /**
-     * Retrieves an existing application from Fonoster.
+     * Retrieves an existing Application in the Workspace.
      *
-     * @param {string} ref - The reference of the application to retrieve
-     * @return {Promise<Application>} - The response object that contains the application information
+     * @param {string} ref - The reference of the Application to retrieve
+     * @return {Promise<Application>} - The response object that contains the Application information
      * @example
      *
-     * const request = {
-     *  ref: "00000000-0000-0000-0000-000000000000"
-     * };
+     * const ref = "00000000-0000-0000-0000-000000000000"
      *
      * const apps = new SDK.Applications(client); // Existing client object
      *
-     * apps.getApplication(request)
+     * apps.getApplication(ref)
      *  .then(console.log) // successful response
      *  .catch(console.error); // an error occurred
      */
@@ -165,12 +169,12 @@ declare class Applications {
      */
     updateApplication(request: UpdateApplicationRequest): Promise<BaseApiObject>;
     /**
-     * Retrieves a list of applications from Fonoster.
+     * Retrieves a list of Applications from Fonoster.
      *
-     * @param {ListApplicationsRequest} request - The request object that contains the necessary information to retrieve a list of applications
-     * @param {number} request.pageSize - The number of applications to retrieve
-     * @param {string} request.pageToken - The token to retrieve the next page of applications
-     * @return {Promise<ListApplicationsResponse>} - The response object that contains the list of applications
+     * @param {ListApplicationsRequest} request - The request object that contains the necessary information to retrieve a list of Applications
+     * @param {number} request.pageSize - The number of Applications to retrieve
+     * @param {string} request.pageToken - The token to retrieve the next page of Applications
+     * @return {Promise<ListApplicationsResponse>} - The response object that contains the list of Applications
      * @example
      *
      * const request = {
@@ -186,10 +190,10 @@ declare class Applications {
      */
     listApplications(request: ListApplicationsRequest): Promise<ListApplicationsResponse>;
     /**
-     * Deletes an existing application from Fonoster.
+     * Deletes an existing Application from Fonoster.
      * Note that this operation is irreversible.
      *
-     * @param {string} ref - The reference of the application to delete
+     * @param {string} ref - The reference of the Application to delete
      * @return {Promise<BaseApiObject>} - The response object that contains the reference to the deleted application
      * @example
      *