@fonoster/sdk 0.6.1 → 0.6.2

package/dist/node/Applications.js

@@ -13,6 +13,23 @@ const utils_1 = require("./utils");
  *
  * 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",
@@ -40,18 +57,7 @@ const utils_1 = require("./utils");
  *   }
  * };
  *
- * 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);
  */
 class Applications {
     client;
@@ -135,19 +141,17 @@ class Applications {
         });
     }
     /**
-     * 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
      */
@@ -209,12 +213,12 @@ class Applications {
         });
     }
     /**
-     * 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 = {
@@ -239,10 +243,10 @@ class Applications {
         });
     }
     /**
-     * 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
      *

package/dist/node/Calls.d.ts

@@ -0,0 +1,109 @@
+import { CallDetailRecord, CreateCallRequest, CreateCallResponse, ListCallsRequest, ListCallsResponse } from "@fonoster/types";
+import { FonosterClient } from "./client/types";
+/**
+ * @classdesc Fonoster Calls, part of the Fonoster Media subsystem,
+ * allows you to create, list, and track calls in your deployment.
+ * Note that an active Fonoster deployment is required.
+ *
+ * @example
+ *
+ * const SDK = require("@fonoster/sdk");
+ *
+ * async function main(request) {
+ *  const username = "admin";
+ *  const password = "yourpassword";
+ *  const accessKeyId = "00000000-0000-0000-0000-000000000000";
+ *
+ *  try {
+ *     const client = SDK.Client({ accessKeyId });
+ *     await client.login({ username, password });
+ *
+ *     const calls = new SDK.Calls(client);
+ *     const response = await apiKeys.createCall(request);
+ *
+ *     console.log(response); // successful response
+ *   } catch (e) {
+ *     console.error(e); // an error occurred
+ *   }
+ * }
+ *
+ * const request = {
+ *   from: "8287854037",
+ *   to: "+17853178070",
+ *   appRef: "00000000-0000-0000-0000-000000000000"
+ * };
+ *
+ * main(request).catch(console.error);
+ */
+declare class Calls {
+    private client;
+    /**
+     * Constructs a new Calls 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 Call in the Workspace.
+     *
+     * @param {CreateCallRequest} request - The request object that contains the necessary information to create a new Call
+     * @param {string} request.from - The number that originated the call
+     * @param {string} request.to - The number that received the call
+     * @param {string} request.appRef - The reference of the App that will handle the call
+     * @return {Promise<CreateCallResponse>} - The response object that contains the reference to the created Call
+     * @example
+     *
+     * const request = {
+     *  from: "8287854037",
+     *  to: "+17853178070",
+     *  appRef: "00000000-0000-0000-0000-000000000000"
+     * };
+     *
+     * const calls = new SDK.Calls(client); // Existing client object
+     *
+     * calls.createCall(request)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    createCall(request: CreateCallRequest): Promise<CreateCallResponse>;
+    /**
+     * Retrieves an existing Call in the Workspace.
+     *
+     * @param {string} ref - The reference of the Call to retrieve
+     * @return {Promise<Acl>} - The response object that contains the Call detail
+     * @example
+     *
+     * const ref = "00000000-0000-0000-0000-000000000000"
+     *
+     * const calls = new SDK.Calls(client); // Existing client object
+     *
+     * calls.getCall(ref)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    getCall(ref: string): Promise<CallDetailRecord>;
+    /**
+     * Retrieves a list of Calls from a Workspace.
+     *
+     * @param {ListCallsRequest} request - The request object that contains the necessary information to retrieve a list of Calls
+     * @param {number} request.pageSize - The number of Calls to retrieve
+     * @param {string} request.pageToken - The token to retrieve the next page of Calls
+     * @return {Promise<ListCallsResponse>} - The response object that contains the list of Calls
+     * @example
+     *
+     * const request = {
+     *  pageSize: 10,
+     *  pageToken: "00000000-0000-0000-0000-000000000000"
+     * };
+     *
+     * const calls = new SDK.Calls(client); // Existing client object
+     *
+     * calls.listCalls(request)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    listCalls(request: ListCallsRequest): Promise<ListCallsResponse>;
+}
+export { Calls };

package/dist/node/Calls.js

@@ -0,0 +1,165 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Calls = 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 calls_pb_1 = require("./generated/node/calls_pb");
+/**
+ * @classdesc Fonoster Calls, part of the Fonoster Media subsystem,
+ * allows you to create, list, and track calls in your deployment.
+ * Note that an active Fonoster deployment is required.
+ *
+ * @example
+ *
+ * const SDK = require("@fonoster/sdk");
+ *
+ * async function main(request) {
+ *  const username = "admin";
+ *  const password = "yourpassword";
+ *  const accessKeyId = "00000000-0000-0000-0000-000000000000";
+ *
+ *  try {
+ *     const client = SDK.Client({ accessKeyId });
+ *     await client.login({ username, password });
+ *
+ *     const calls = new SDK.Calls(client);
+ *     const response = await apiKeys.createCall(request);
+ *
+ *     console.log(response); // successful response
+ *   } catch (e) {
+ *     console.error(e); // an error occurred
+ *   }
+ * }
+ *
+ * const request = {
+ *   from: "8287854037",
+ *   to: "+17853178070",
+ *   appRef: "00000000-0000-0000-0000-000000000000"
+ * };
+ *
+ * main(request).catch(console.error);
+ */
+class Calls {
+    client;
+    /**
+     * Constructs a new Calls 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 Call in the Workspace.
+     *
+     * @param {CreateCallRequest} request - The request object that contains the necessary information to create a new Call
+     * @param {string} request.from - The number that originated the call
+     * @param {string} request.to - The number that received the call
+     * @param {string} request.appRef - The reference of the App that will handle the call
+     * @return {Promise<CreateCallResponse>} - The response object that contains the reference to the created Call
+     * @example
+     *
+     * const request = {
+     *  from: "8287854037",
+     *  to: "+17853178070",
+     *  appRef: "00000000-0000-0000-0000-000000000000"
+     * };
+     *
+     * const calls = new SDK.Calls(client); // Existing client object
+     *
+     * calls.createCall(request)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    async createCall(request) {
+        const client = this.client.getCallsClient();
+        return await (0, makeRpcRequest_1.makeRpcRequest)({
+            method: client.createCall.bind(client),
+            requestPBObjectConstructor: calls_pb_1.CreateCallRequest,
+            metadata: this.client.getMetadata(),
+            request,
+            enumMapping: [["type", types_1.CallType]]
+        });
+    }
+    /**
+     * Retrieves an existing Call in the Workspace.
+     *
+     * @param {string} ref - The reference of the Call to retrieve
+     * @return {Promise<Acl>} - The response object that contains the Call detail
+     * @example
+     *
+     * const ref = "00000000-0000-0000-0000-000000000000"
+     *
+     * const calls = new SDK.Calls(client); // Existing client object
+     *
+     * calls.getCall(ref)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    async getCall(ref) {
+        const client = this.client.getCallsClient();
+        return await (0, makeRpcRequest_1.makeRpcRequest)({
+            method: client.getCall.bind(client),
+            requestPBObjectConstructor: calls_pb_1.GetCallRequest,
+            metadata: this.client.getMetadata(),
+            request: { ref },
+            enumMapping: [
+                ["type", types_1.CallType],
+                ["callStatus", types_1.CallStatus],
+                ["hangupCause", types_1.HangupCause],
+                ["callDirection", types_1.CallDirection]
+            ]
+        });
+    }
+    /**
+     * Retrieves a list of Calls from a Workspace.
+     *
+     * @param {ListCallsRequest} request - The request object that contains the necessary information to retrieve a list of Calls
+     * @param {number} request.pageSize - The number of Calls to retrieve
+     * @param {string} request.pageToken - The token to retrieve the next page of Calls
+     * @return {Promise<ListCallsResponse>} - The response object that contains the list of Calls
+     * @example
+     *
+     * const request = {
+     *  pageSize: 10,
+     *  pageToken: "00000000-0000-0000-0000-000000000000"
+     * };
+     *
+     * const calls = new SDK.Calls(client); // Existing client object
+     *
+     * calls.listCalls(request)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    async listCalls(request) {
+        const client = this.client.getCallsClient();
+        return await (0, makeRpcRequest_1.makeRpcRequest)({
+            method: client.listCalls.bind(client),
+            requestPBObjectConstructor: calls_pb_1.ListCallsRequest,
+            metadata: this.client.getMetadata(),
+            request,
+            repeatableObjectMapping: [["itemsList", calls_pb_1.Call]]
+        });
+    }
+}
+exports.Calls = Calls;

package/dist/node/Credentials.d.ts

@@ -0,0 +1,148 @@
+import { BaseApiObject, CreateCredentialsRequest, Credentials as CredentialsType, ListCredentialsRequest, ListCredentialsResponse, UpdateCredentialsRequest } from "@fonoster/types";
+import { FonosterClient } from "./client/types";
+/**
+ * @classdesc Fonoster Credentials, part of the Fonoster SIP Proxy subsystem,
+ * allows you to create, update, retrieve, and delete SIP Credentials 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 credentials = new SDK.Credentials(client);
+ *     const response = await apiKeys.createCredentials(request);
+ *
+ *     console.log(response); // successful response
+ *   } catch (e) {
+ *     console.error(e); // an error occurred
+ *   }
+ * }
+ *
+ * const request = {
+ *   name: "My Credentials",
+ *   username: "myusername",
+ *   password: "mysecret"
+ * };
+ *
+ * main(request).catch(console.error);
+ */
+declare class Credentials {
+    private client;
+    /**
+     * Constructs a new Credentials 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 set of Credentials in the Workspace.
+     *
+     * @param {CreateCredentialsRequest} request - The request object that contains the necessary information to create a new set of Credentials
+     * @param {string} request.name - The name of the Credentials
+     * @param {string} request.username - The username of the Credentials
+     * @param {string} request.password - The password of the Credentials
+     * @return {Promise<BaseApiObject>} - The response object that contains the reference to the created Credentials
+     * @example
+     *
+     * const request = {
+     *  name: "My Credentials",
+     *  username: "myusername",
+     *  password: "mysecret"
+     * };
+     *
+     * const credentials = new SDK.Credentials(client); // Existing client object
+     *
+     * credentials.createCredentials(request)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    createCredentials(request: CreateCredentialsRequest): Promise<BaseApiObject>;
+    /**
+     * Retrieves an existing set of Credentials in the Workspace.
+     *
+     * @param {string} ref - The reference of the Credentials to retrieve
+     * @return {Promise<Acl>} - The response object that contains the Credentials
+     * @example
+     *
+     * const ref = "00000000-0000-0000-0000-000000000000"
+     *
+     * const credentials = new SDK.Credentials(client); // Existing client object
+     *
+     * credentials.getCredentials(ref)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    getCredentials(ref: string): Promise<CredentialsType>;
+    /**
+     * Updates an existing set of Credentials in the Workspace.
+     *
+     * @param {UpdateCredentialsRequest} request - The request object that contains the necessary information to update an existing set of Credentials
+     * @param {string} request.ref - The reference of the Credentials to update
+     * @param {string} request.name - The name of the Credentials
+     * @param {string} request.password - The password of the Credentials
+     * @return {Promise<BaseApiObject>} - The response object that contains the reference to the updated Credentials
+     * @example
+     *
+     * const request = {
+     *  ref: "00000000-0000-0000-0000-000000000000",
+     *  name: "My Credentials",
+     *  password: "mysecret"
+     * };
+     *
+     * const credentials = new SDK.Credentials(client); // Existing client object
+     *
+     * credentials.updateCredentials(request)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    updateCredentials(request: UpdateCredentialsRequest): Promise<BaseApiObject>;
+    /**
+     * Retrieves a list of Credentials from a Workspace.
+     *
+     * @param {ListCredentialsRequest} request - The request object that contains the necessary information to retrieve a list of Credentials
+     * @param {number} request.pageSize - The number of Credentials to retrieve
+     * @param {string} request.pageToken - The token to retrieve the next page of Credentials
+     * @return {Promise<ListCredentialsResponse>} - The response object that contains the list of Credentials
+     * @example
+     *
+     * const request = {
+     *  pageSize: 10,
+     *  pageToken: "00000000-0000-0000-0000-000000000000"
+     * };
+     *
+     * const credentials = new SDK.Credentials(client); // Existing client object
+     *
+     * credentials.listCredentials(request)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    listCredentials(request: ListCredentialsRequest): Promise<ListCredentialsResponse>;
+    /**
+     * Deletes an existing set of Credentials from Fonoster.
+     * Note that this operation is irreversible.
+     *
+     * @param {string} ref - The reference of the Credentials to delete
+     * @return {Promise<BaseApiObject>} - The response object that contains the reference to the deleted Credentials
+     * @example
+     *
+     * const ref =  "00000000-0000-0000-0000-000000000000"
+     *
+     * const credentials = new SDK.Credentials(client); // Existing client object
+     *
+     * credentials.deleteCredentials(ref)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
+    deleteCredentials(ref: string): Promise<BaseApiObject>;
+}
+export { Credentials };