@fonoster/sdk 0.6.2-alpha.0 → 0.6.2

package/dist/node/Numbers.d.ts

@@ -1,12 +1,152 @@
 import { BaseApiObject, CreateNumberRequest, INumber, ListNumbersRequest, ListNumbersResponse, UpdateNumberRequest } from "@fonoster/types";
 import { FonosterClient } from "./client/types";
+/**
+ * @classdesc Fonoster Numbers, part of the Fonoster SIP Proxy subsystem,
+ * allows you to create, update, retrieve, and delete SIP Number 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 numbers = new SDK.Numbers(client);
+ *     const response = await numbers.createNumber(request);
+ *
+ *     console.log(response); // successful response
+ *   } catch (e) {
+ *     console.error(e); // an error occurred
+ *   }
+ * }
+ *
+ * const request = {
+ *   name: "My Number",
+ *   telUrl: "tel:+17853178070",
+ *   city: "Asheville",
+ *   country: "United States",
+ *   countryIsoCode: "US"
+ * };
+ *
+ * main(request).catch(console.error);
+ */
 declare class Numbers {
     private client;
+    /**
+     * Constructs a new Numbers 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 Number in the Workspace.
+     *
+     * @param {CreateNumberRequest} request - The request object that contains the necessary information to create a new Number
+     * @param {string} request.name - The name of the Number
+     * @param {string} request.telUrl - The telUrl of the Number
+     * @param {string} request.city - The city of the Number
+     * @param {string} request.country - The country of the Number
+     * @param {string} request.countryIsoCode - The countryIsoCode of the Number
+     * @return {Promise<BaseApiObject>} - The response object that contains the reference to the created Number
+     * @example
+     *
+     * const request = {
+     *  name: "My Number",
+     *  telUrl: "tel:+17853178070",
+     *  city: "Asheville",
+     *  country: "United States",
+     *  countryIsoCode: "US"
+     * };
+     *
+     * const numbers = new SDK.Numbers(client); // Existing client object
+     *
+     * numbers.createNumber(request)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
     createNumber(request: CreateNumberRequest): Promise<BaseApiObject>;
+    /**
+     * Retrieves an existing Number in the Workspace.
+     *
+     * @param {string} ref - The reference of the Number to retrieve
+     * @return {Promise<Acl>} - The response object that contains the Number
+     * @example
+     *
+     * const ref = "00000000-0000-0000-0000-000000000000"
+     *
+     * const numbers = new SDK.Numbers(client); // Existing client object
+     *
+     * numbers.getNumber(ref)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
     getNumber(ref: string): Promise<INumber>;
+    /**
+     * Updates an existing Number in the Workspace.
+     *
+     * @param {UpdateNumberRequest} request - The request object that contains the necessary information to update an existing Number
+     * @param {string} request.ref - The reference of the Number to update
+     * @param {string} request.name - The name of the Number
+     * @return {Promise<BaseApiObject>} - The response object that contains the reference to the updated Number
+     * @example
+     *
+     * const request = {
+     *  ref: "00000000-0000-0000-0000-000000000000",
+     *  name: "My Number"
+     * };
+     *
+     * const numbers = new SDK.Numbers(client); // Existing client object
+     *
+     * numbers.updateNumber(request)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
     updateNumber(request: UpdateNumberRequest): Promise<BaseApiObject>;
+    /**
+     * Retrieves a list of Numbers from a Workspace.
+     *
+     * @param {ListNumbersRequest} request - The request object that contains the necessary information to retrieve a list of Numbers
+     * @param {number} request.pageSize - The number of Numbers to retrieve
+     * @param {string} request.pageToken - The token to retrieve the next page of Numbers
+     * @return {Promise<ListNumbersResponse>} - The response object that contains the list of Numbers
+     * @example
+     *
+     * const request = {
+     *  pageSize: 10,
+     *  pageToken: "00000000-0000-0000-0000-000000000000"
+     * };
+     *
+     * const numbers = new SDK.Numbers(client); // Existing client object
+     *
+     * numbers.listNumbers(request)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
     listNumbers(request: ListNumbersRequest): Promise<ListNumbersResponse>;
+    /**
+     * Deletes an existing Number from Fonoster.
+     * Note that this operation is irreversible.
+     *
+     * @param {string} ref - The reference of the Number to delete
+     * @return {Promise<BaseApiObject>} - The response object that contains the reference to the deleted Number
+     * @example
+     *
+     * const ref =  "00000000-0000-0000-0000-000000000000"
+     *
+     * const numbers = new SDK.Numbers(client); // Existing client object
+     *
+     * numbers.deleteDomain(ref)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
     deleteNumber(ref: string): Promise<BaseApiObject>;
 }
 export { Numbers };

package/dist/node/Numbers.js

@@ -3,11 +3,80 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Numbers = void 0;
 const makeRpcRequest_1 = require("./client/makeRpcRequest");
 const numbers_pb_1 = require("./generated/node/numbers_pb");
+/**
+ * @classdesc Fonoster Numbers, part of the Fonoster SIP Proxy subsystem,
+ * allows you to create, update, retrieve, and delete SIP Number 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 numbers = new SDK.Numbers(client);
+ *     const response = await numbers.createNumber(request);
+ *
+ *     console.log(response); // successful response
+ *   } catch (e) {
+ *     console.error(e); // an error occurred
+ *   }
+ * }
+ *
+ * const request = {
+ *   name: "My Number",
+ *   telUrl: "tel:+17853178070",
+ *   city: "Asheville",
+ *   country: "United States",
+ *   countryIsoCode: "US"
+ * };
+ *
+ * main(request).catch(console.error);
+ */
 class Numbers {
     client;
+    /**
+     * Constructs a new Numbers 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 Number in the Workspace.
+     *
+     * @param {CreateNumberRequest} request - The request object that contains the necessary information to create a new Number
+     * @param {string} request.name - The name of the Number
+     * @param {string} request.telUrl - The telUrl of the Number
+     * @param {string} request.city - The city of the Number
+     * @param {string} request.country - The country of the Number
+     * @param {string} request.countryIsoCode - The countryIsoCode of the Number
+     * @return {Promise<BaseApiObject>} - The response object that contains the reference to the created Number
+     * @example
+     *
+     * const request = {
+     *  name: "My Number",
+     *  telUrl: "tel:+17853178070",
+     *  city: "Asheville",
+     *  country: "United States",
+     *  countryIsoCode: "US"
+     * };
+     *
+     * const numbers = new SDK.Numbers(client); // Existing client object
+     *
+     * numbers.createNumber(request)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
     async createNumber(request) {
         const client = this.client.getNumbersClient();
         return await (0, makeRpcRequest_1.makeRpcRequest)({
@@ -17,6 +86,21 @@ class Numbers {
             request
         });
     }
+    /**
+     * Retrieves an existing Number in the Workspace.
+     *
+     * @param {string} ref - The reference of the Number to retrieve
+     * @return {Promise<Acl>} - The response object that contains the Number
+     * @example
+     *
+     * const ref = "00000000-0000-0000-0000-000000000000"
+     *
+     * const numbers = new SDK.Numbers(client); // Existing client object
+     *
+     * numbers.getNumber(ref)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
     async getNumber(ref) {
         const client = this.client.getNumbersClient();
         return await (0, makeRpcRequest_1.makeRpcRequest)({
@@ -26,6 +110,26 @@ class Numbers {
             request: { ref }
         });
     }
+    /**
+     * Updates an existing Number in the Workspace.
+     *
+     * @param {UpdateNumberRequest} request - The request object that contains the necessary information to update an existing Number
+     * @param {string} request.ref - The reference of the Number to update
+     * @param {string} request.name - The name of the Number
+     * @return {Promise<BaseApiObject>} - The response object that contains the reference to the updated Number
+     * @example
+     *
+     * const request = {
+     *  ref: "00000000-0000-0000-0000-000000000000",
+     *  name: "My Number"
+     * };
+     *
+     * const numbers = new SDK.Numbers(client); // Existing client object
+     *
+     * numbers.updateNumber(request)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
     async updateNumber(request) {
         const client = this.client.getNumbersClient();
         return await (0, makeRpcRequest_1.makeRpcRequest)({
@@ -35,6 +139,26 @@ class Numbers {
             request
         });
     }
+    /**
+     * Retrieves a list of Numbers from a Workspace.
+     *
+     * @param {ListNumbersRequest} request - The request object that contains the necessary information to retrieve a list of Numbers
+     * @param {number} request.pageSize - The number of Numbers to retrieve
+     * @param {string} request.pageToken - The token to retrieve the next page of Numbers
+     * @return {Promise<ListNumbersResponse>} - The response object that contains the list of Numbers
+     * @example
+     *
+     * const request = {
+     *  pageSize: 10,
+     *  pageToken: "00000000-0000-0000-0000-000000000000"
+     * };
+     *
+     * const numbers = new SDK.Numbers(client); // Existing client object
+     *
+     * numbers.listNumbers(request)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
     async listNumbers(request) {
         const client = this.client.getNumbersClient();
         return await (0, makeRpcRequest_1.makeRpcRequest)({
@@ -45,6 +169,22 @@ class Numbers {
             repeatableObjectMapping: [["itemsList", numbers_pb_1.Number]]
         });
     }
+    /**
+     * Deletes an existing Number from Fonoster.
+     * Note that this operation is irreversible.
+     *
+     * @param {string} ref - The reference of the Number to delete
+     * @return {Promise<BaseApiObject>} - The response object that contains the reference to the deleted Number
+     * @example
+     *
+     * const ref =  "00000000-0000-0000-0000-000000000000"
+     *
+     * const numbers = new SDK.Numbers(client); // Existing client object
+     *
+     * numbers.deleteDomain(ref)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
     async deleteNumber(ref) {
         const applicationsClient = this.client.getNumbersClient();
         return await (0, makeRpcRequest_1.makeRpcRequest)({

package/dist/node/Secrets.d.ts

@@ -1,12 +1,144 @@
 import { BaseApiObject, CreateSecretRequest, ListSecretsRequest, ListSecretsResponse, Secret, UpdateSecretRequest } from "@fonoster/types";
 import { FonosterClient } from "./client/types";
+/**
+ * @classdesc Fonoster Secrets, part of the Fonoster Core,
+ * allows you to create, update, retrieve, and delete Secrets 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 secrets = new SDK.Secrets(client);
+ *     const response = await secrets.creteSecret(request);
+ *
+ *     console.log(response); // successful response
+ *   } catch (e) {
+ *     console.error(e); // an error occurred
+ *   }
+ * }
+ *
+ * const request = {
+ *   name: "FRIENDLY_NAME",
+ *   secret: "mysecret"
+ * };
+ *
+ * main(request).catch(console.error);
+ */
 declare class Secrets {
     private client;
+    /**
+     * Constructs a new Secrets 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 Secret in the Workspace.
+     *
+     * @param {CreateSecretRequest} request - The request object that contains the necessary information to create a new Secret
+     * @param {string} request.name - The name of the Secret
+     * @param {string} request.secret - The secret of the Secret
+     * @return {Promise<BaseApiObject>} - The response object that contains the reference to the created Secret
+     * @example
+     *
+     * const request = {
+     *  name: "FRIENDLY_NAME",
+     *  secret: "mysecret"
+     * };
+     *
+     * const secrets = new SDK.Secrets(client); // Existing client object
+     *
+     * secrets.createSecret(request)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
     createSecret(request: CreateSecretRequest): Promise<BaseApiObject>;
+    /**
+     * Retrieves an existing Secret in the Workspace.
+     *
+     * @param {string} ref - The reference of the Secret to retrieve
+     * @return {Promise<Acl>} - The response object that contains the Secret
+     * @example
+     *
+     * const ref = "00000000-0000-0000-0000-000000000000"
+     *
+     * const secrets = new SDK.Secrets(client); // Existing client object
+     *
+     * secrets.getSecret(ref)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
     getSecret(ref: string): Promise<Secret>;
+    /**
+     * Updates an existing Secret in the Workspace.
+     *
+     * @param {UpdateSecretRequest} request - The request object that contains the necessary information to update an existing Secret
+     * @param {string} request.ref - The reference of the Secret to update
+     * @param {string} request.name - The name of the Secret
+     * @param {string} request.secret - The secret of the Secret
+     * @return {Promise<BaseApiObject>} - The response object that contains the reference to the updated Secret
+     * @example
+     *
+     * const request = {
+     *  ref: "00000000-0000-0000-0000-000000000000",
+     *  secret: "mysecret"
+     * };
+     *
+     * const secrets = new SDK.Secrets(client); // Existing client object
+     *
+     * secrets.updateSecret(request)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
     updateSecret(request: UpdateSecretRequest): Promise<BaseApiObject>;
+    /**
+     * Retrieves a list of Secrets from a Workspace.
+     *
+     * @param {ListSecretsRequest} request - The request object that contains the necessary information to retrieve a list of Secrets
+     * @param {number} request.pageSize - The secret of Secrets to retrieve
+     * @param {string} request.pageToken - The token to retrieve the next page of Secrets
+     * @return {Promise<ListSecretsResponse>} - The response object that contains the list of Secrets
+     * @example
+     *
+     * const request = {
+     *  pageSize: 10,
+     *  pageToken: "00000000-0000-0000-0000-000000000000"
+     * };
+     *
+     * const secrets = new SDK.Secrets(client); // Existing client object
+     *
+     * secrets.listSecrets(request)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
     listSecrets(request: ListSecretsRequest): Promise<ListSecretsResponse>;
+    /**
+     * Deletes an existing Secret from Fonoster.
+     * Note that this operation is irreversible.
+     *
+     * @param {string} ref - The reference of the Secret to delete
+     * @return {Promise<BaseApiObject>} - The response object that contains the reference to the deleted Secret
+     * @example
+     *
+     * const ref =  "00000000-0000-0000-0000-000000000000"
+     *
+     * const secrets = new SDK.Secrets(client); // Existing client object
+     *
+     * secrets.deleteSecret(ref)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
     deleteSecret(ref: string): Promise<BaseApiObject>;
 }
 export { Secrets };

package/dist/node/Secrets.js

@@ -3,11 +3,71 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Secrets = void 0;
 const makeRpcRequest_1 = require("./client/makeRpcRequest");
 const secrets_pb_1 = require("./generated/node/secrets_pb");
+/**
+ * @classdesc Fonoster Secrets, part of the Fonoster Core,
+ * allows you to create, update, retrieve, and delete Secrets 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 secrets = new SDK.Secrets(client);
+ *     const response = await secrets.creteSecret(request);
+ *
+ *     console.log(response); // successful response
+ *   } catch (e) {
+ *     console.error(e); // an error occurred
+ *   }
+ * }
+ *
+ * const request = {
+ *   name: "FRIENDLY_NAME",
+ *   secret: "mysecret"
+ * };
+ *
+ * main(request).catch(console.error);
+ */
 class Secrets {
     client;
+    /**
+     * Constructs a new Secrets 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 Secret in the Workspace.
+     *
+     * @param {CreateSecretRequest} request - The request object that contains the necessary information to create a new Secret
+     * @param {string} request.name - The name of the Secret
+     * @param {string} request.secret - The secret of the Secret
+     * @return {Promise<BaseApiObject>} - The response object that contains the reference to the created Secret
+     * @example
+     *
+     * const request = {
+     *  name: "FRIENDLY_NAME",
+     *  secret: "mysecret"
+     * };
+     *
+     * const secrets = new SDK.Secrets(client); // Existing client object
+     *
+     * secrets.createSecret(request)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
     async createSecret(request) {
         const client = this.client.getSecretsClient();
         return await (0, makeRpcRequest_1.makeRpcRequest)({
@@ -17,6 +77,21 @@ class Secrets {
             request
         });
     }
+    /**
+     * Retrieves an existing Secret in the Workspace.
+     *
+     * @param {string} ref - The reference of the Secret to retrieve
+     * @return {Promise<Acl>} - The response object that contains the Secret
+     * @example
+     *
+     * const ref = "00000000-0000-0000-0000-000000000000"
+     *
+     * const secrets = new SDK.Secrets(client); // Existing client object
+     *
+     * secrets.getSecret(ref)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
     async getSecret(ref) {
         const client = this.client.getSecretsClient();
         return await (0, makeRpcRequest_1.makeRpcRequest)({
@@ -26,6 +101,27 @@ class Secrets {
             request: { ref }
         });
     }
+    /**
+     * Updates an existing Secret in the Workspace.
+     *
+     * @param {UpdateSecretRequest} request - The request object that contains the necessary information to update an existing Secret
+     * @param {string} request.ref - The reference of the Secret to update
+     * @param {string} request.name - The name of the Secret
+     * @param {string} request.secret - The secret of the Secret
+     * @return {Promise<BaseApiObject>} - The response object that contains the reference to the updated Secret
+     * @example
+     *
+     * const request = {
+     *  ref: "00000000-0000-0000-0000-000000000000",
+     *  secret: "mysecret"
+     * };
+     *
+     * const secrets = new SDK.Secrets(client); // Existing client object
+     *
+     * secrets.updateSecret(request)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
     async updateSecret(request) {
         const client = this.client.getSecretsClient();
         return await (0, makeRpcRequest_1.makeRpcRequest)({
@@ -35,6 +131,26 @@ class Secrets {
             request
         });
     }
+    /**
+     * Retrieves a list of Secrets from a Workspace.
+     *
+     * @param {ListSecretsRequest} request - The request object that contains the necessary information to retrieve a list of Secrets
+     * @param {number} request.pageSize - The secret of Secrets to retrieve
+     * @param {string} request.pageToken - The token to retrieve the next page of Secrets
+     * @return {Promise<ListSecretsResponse>} - The response object that contains the list of Secrets
+     * @example
+     *
+     * const request = {
+     *  pageSize: 10,
+     *  pageToken: "00000000-0000-0000-0000-000000000000"
+     * };
+     *
+     * const secrets = new SDK.Secrets(client); // Existing client object
+     *
+     * secrets.listSecrets(request)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
     async listSecrets(request) {
         const client = this.client.getSecretsClient();
         return await (0, makeRpcRequest_1.makeRpcRequest)({
@@ -45,6 +161,22 @@ class Secrets {
             repeatableObjectMapping: [["itemsList", secrets_pb_1.Secret]]
         });
     }
+    /**
+     * Deletes an existing Secret from Fonoster.
+     * Note that this operation is irreversible.
+     *
+     * @param {string} ref - The reference of the Secret to delete
+     * @return {Promise<BaseApiObject>} - The response object that contains the reference to the deleted Secret
+     * @example
+     *
+     * const ref =  "00000000-0000-0000-0000-000000000000"
+     *
+     * const secrets = new SDK.Secrets(client); // Existing client object
+     *
+     * secrets.deleteSecret(ref)
+     *  .then(console.log) // successful response
+     *  .catch(console.error); // an error occurred
+     */
     async deleteSecret(ref) {
         const applicationsClient = this.client.getSecretsClient();
         return await (0, makeRpcRequest_1.makeRpcRequest)({