@fonoster/sdk 0.6.5 → 0.7.0

package/dist/node/Domains.d.ts

@@ -10,11 +10,11 @@ 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";
+ *   const API_KEY = "your-api-key";
+ *   const ACCESS_KEY_ID = "00000000-0000-0000-0000-000000000000";
  *
- *  try {
- *     const client = SDK.Client({ accessKeyId });
+ *   try {
+ *     const client = SDK.Client({ accessKeyId: ACCESS_KEY_ID });
  *     await client.loginWithApiKey(apiKey);
  *
  *     const domains = new SDK.Domains(client);
@@ -55,17 +55,17 @@ declare class Domains {
      * @param {string} request.egressPolicy[].numberRef - The Number that will be used to send the call to the PSTN
      * @return {Promise<BaseApiObject>} - The response object that contains the reference to the created Domain
      * @example
+     * const domains = new SDK.Domains(client); // Existing client object
      *
      * const request = {
-     *  name: "My Domain",
-     *  domainUri: "sip.project.fonoster.io"
+     *   name: "My Domain",
+     *   domainUri: "sip.project.fonoster.io"
      * };
      *
-     * const domains = new SDK.Domains(client); // Existing client object
-     *
-     * domains.createDomain(request)
-     *  .then(console.log) // successful response
-     *  .catch(console.error); // an error occurred
+     * domains
+     *   .createDomain(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     createDomain(request: CreateDomainRequest): Promise<BaseApiObject>;
     /**
@@ -74,14 +74,14 @@ declare class Domains {
      * @param {string} ref - The reference of the Domain to retrieve
      * @return {Promise<Acl>} - The response object that contains the Domain
      * @example
-     *
-     * const ref = "00000000-0000-0000-0000-000000000000"
-     *
      * const domains = new SDK.Domains(client); // Existing client object
      *
-     * domains.getDomain(ref)
-     *  .then(console.log) // successful response
-     *  .catch(console.error); // an error occurred
+     * const ref = "00000000-0000-0000-0000-000000000000";
+     *
+     * domains
+     *   .getDomain(ref)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     getDomain(ref: string): Promise<Domain>;
     /**
@@ -97,17 +97,17 @@ declare class Domains {
      * @param {string} request.egressPolicy[].numberRef - The Number that will be used to send the call to the PSTN
      * @return {Promise<BaseApiObject>} - The response object that contains the reference to the updated Domain
      * @example
+     * const domains = new SDK.Domains(client); // Existing client object
      *
      * const request = {
-     *  ref: "00000000-0000-0000-0000-000000000000",
-     *  accessControlListRef: "00000000-0000-0000-0000-000000000001"
+     *   ref: "00000000-0000-0000-0000-000000000000",
+     *   accessControlListRef: "00000000-0000-0000-0000-000000000001"
      * };
      *
-     * const domains = new SDK.Domains(client); // Existing client object
-     *
-     * domains.updateDomain(request)
-     *  .then(console.log) // successful response
-     *  .catch(console.error); // an error occurred
+     * domains
+     *   .updateDomain(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     updateDomain(request: UpdateDomainRequest): Promise<BaseApiObject>;
     /**
@@ -118,17 +118,17 @@ declare class Domains {
      * @param {string} request.pageToken - The token to retrieve the next page of Domains
      * @return {Promise<ListDomainsResponse>} - The response object that contains the list of Domains
      * @example
+     * const domains = new SDK.Domains(client); // Existing client object
      *
      * const request = {
-     *  pageSize: 10,
-     *  pageToken: "00000000-0000-0000-0000-000000000000"
+     *   pageSize: 10,
+     *   pageToken: "00000000-0000-0000-0000-000000000000"
      * };
      *
-     * const domains = new SDK.Domains(client); // Existing client object
-     *
-     * domains.listDomains(request)
-     *  .then(console.log) // successful response
-     *  .catch(console.error); // an error occurred
+     * domains
+     *   .listDomains(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     listDomains(request: ListDomainsRequest): Promise<ListDomainsResponse>;
     /**
@@ -138,14 +138,14 @@ declare class Domains {
      * @param {string} ref - The reference of the Domain to delete
      * @return {Promise<BaseApiObject>} - The response object that contains the reference to the deleted Domain
      * @example
-     *
-     * const ref =  "00000000-0000-0000-0000-000000000000"
-     *
      * const domains = new SDK.Domains(client); // Existing client object
      *
-     * domains.deleteDomain(ref)
-     *  .then(console.log) // successful response
-     *  .catch(console.error); // an error occurred
+     * const ref = "00000000-0000-0000-0000-000000000000";
+     *
+     * domains
+     *   .deleteDomain(ref)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     deleteDomain(ref: string): Promise<BaseApiObject>;
 }

package/dist/node/Domains.js

@@ -13,11 +13,11 @@ const domains_pb_1 = require("./generated/node/domains_pb");
  * const SDK = require("@fonoster/sdk");
  *
  * async function main(request) {
- *  const apiKey = "your-api-key";
- *  const accessKeyId = "00000000-0000-0000-0000-000000000000";
+ *   const API_KEY = "your-api-key";
+ *   const ACCESS_KEY_ID = "00000000-0000-0000-0000-000000000000";
  *
- *  try {
- *     const client = SDK.Client({ accessKeyId });
+ *   try {
+ *     const client = SDK.Client({ accessKeyId: ACCESS_KEY_ID });
  *     await client.loginWithApiKey(apiKey);
  *
  *     const domains = new SDK.Domains(client);
@@ -60,17 +60,17 @@ class Domains {
      * @param {string} request.egressPolicy[].numberRef - The Number that will be used to send the call to the PSTN
      * @return {Promise<BaseApiObject>} - The response object that contains the reference to the created Domain
      * @example
+     * const domains = new SDK.Domains(client); // Existing client object
      *
      * const request = {
-     *  name: "My Domain",
-     *  domainUri: "sip.project.fonoster.io"
+     *   name: "My Domain",
+     *   domainUri: "sip.project.fonoster.io"
      * };
      *
-     * const domains = new SDK.Domains(client); // Existing client object
-     *
-     * domains.createDomain(request)
-     *  .then(console.log) // successful response
-     *  .catch(console.error); // an error occurred
+     * domains
+     *   .createDomain(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     async createDomain(request) {
         const client = this.client.getDomainsClient();
@@ -87,14 +87,14 @@ class Domains {
      * @param {string} ref - The reference of the Domain to retrieve
      * @return {Promise<Acl>} - The response object that contains the Domain
      * @example
-     *
-     * const ref = "00000000-0000-0000-0000-000000000000"
-     *
      * const domains = new SDK.Domains(client); // Existing client object
      *
-     * domains.getDomain(ref)
-     *  .then(console.log) // successful response
-     *  .catch(console.error); // an error occurred
+     * const ref = "00000000-0000-0000-0000-000000000000";
+     *
+     * domains
+     *   .getDomain(ref)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     async getDomain(ref) {
         const client = this.client.getDomainsClient();
@@ -118,17 +118,17 @@ class Domains {
      * @param {string} request.egressPolicy[].numberRef - The Number that will be used to send the call to the PSTN
      * @return {Promise<BaseApiObject>} - The response object that contains the reference to the updated Domain
      * @example
+     * const domains = new SDK.Domains(client); // Existing client object
      *
      * const request = {
-     *  ref: "00000000-0000-0000-0000-000000000000",
-     *  accessControlListRef: "00000000-0000-0000-0000-000000000001"
+     *   ref: "00000000-0000-0000-0000-000000000000",
+     *   accessControlListRef: "00000000-0000-0000-0000-000000000001"
      * };
      *
-     * const domains = new SDK.Domains(client); // Existing client object
-     *
-     * domains.updateDomain(request)
-     *  .then(console.log) // successful response
-     *  .catch(console.error); // an error occurred
+     * domains
+     *   .updateDomain(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     async updateDomain(request) {
         const client = this.client.getDomainsClient();
@@ -147,17 +147,17 @@ class Domains {
      * @param {string} request.pageToken - The token to retrieve the next page of Domains
      * @return {Promise<ListDomainsResponse>} - The response object that contains the list of Domains
      * @example
+     * const domains = new SDK.Domains(client); // Existing client object
      *
      * const request = {
-     *  pageSize: 10,
-     *  pageToken: "00000000-0000-0000-0000-000000000000"
+     *   pageSize: 10,
+     *   pageToken: "00000000-0000-0000-0000-000000000000"
      * };
      *
-     * const domains = new SDK.Domains(client); // Existing client object
-     *
-     * domains.listDomains(request)
-     *  .then(console.log) // successful response
-     *  .catch(console.error); // an error occurred
+     * domains
+     *   .listDomains(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     async listDomains(request) {
         const client = this.client.getDomainsClient();
@@ -176,14 +176,14 @@ class Domains {
      * @param {string} ref - The reference of the Domain to delete
      * @return {Promise<BaseApiObject>} - The response object that contains the reference to the deleted Domain
      * @example
-     *
-     * const ref =  "00000000-0000-0000-0000-000000000000"
-     *
      * const domains = new SDK.Domains(client); // Existing client object
      *
-     * domains.deleteDomain(ref)
-     *  .then(console.log) // successful response
-     *  .catch(console.error); // an error occurred
+     * const ref = "00000000-0000-0000-0000-000000000000";
+     *
+     * domains
+     *   .deleteDomain(ref)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     async deleteDomain(ref) {
         const applicationsClient = this.client.getDomainsClient();

package/dist/node/Numbers.d.ts

@@ -10,11 +10,11 @@ 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";
+ *   const API_KEY = "your-api-key";
+ *   const ACCESS_KEY_ID = "00000000-0000-0000-0000-000000000000";
  *
- *  try {
- *     const client = SDK.Client({ accessKeyId });
+ *   try {
+ *     const client = SDK.Client({ accessKeyId: ACCESS_KEY_ID });
  *     await client.loginWithApiKey(apiKey);
  *
  *     const numbers = new SDK.Numbers(client);
@@ -57,20 +57,20 @@ declare class Numbers {
      * @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 numbers = new SDK.Numbers(client); // Existing client object
      *
      * const request = {
-     *  name: "My Number",
-     *  telUrl: "tel:+17853178070",
-     *  city: "Asheville",
-     *  country: "United States",
-     *  countryIsoCode: "US"
+     *   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
+     * numbers
+     *   .createNumber(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     createNumber(request: CreateNumberRequest): Promise<BaseApiObject>;
     /**
@@ -79,14 +79,14 @@ declare class Numbers {
      * @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
+     * const ref = "00000000-0000-0000-0000-000000000000";
+     *
+     * numbers
+     *   .getNumber(ref)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     getNumber(ref: string): Promise<INumber>;
     /**
@@ -97,17 +97,17 @@ declare class Numbers {
      * @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 numbers = new SDK.Numbers(client); // Existing client object
      *
      * const request = {
-     *  ref: "00000000-0000-0000-0000-000000000000",
-     *  name: "My Number"
+     *   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
+     * numbers
+     *   .updateNumber(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     updateNumber(request: UpdateNumberRequest): Promise<BaseApiObject>;
     /**
@@ -118,17 +118,17 @@ declare class Numbers {
      * @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 numbers = new SDK.Numbers(client); // Existing client object
      *
      * const request = {
-     *  pageSize: 10,
-     *  pageToken: "00000000-0000-0000-0000-000000000000"
+     *   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
+     * numbers
+     *   .listNumbers(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     listNumbers(request: ListNumbersRequest): Promise<ListNumbersResponse>;
     /**
@@ -138,14 +138,14 @@ declare class Numbers {
      * @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
+     * const ref = "00000000-0000-0000-0000-000000000000";
+     *
+     * numbers
+     *   .deleteNumber(ref)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     deleteNumber(ref: string): Promise<BaseApiObject>;
 }

package/dist/node/Numbers.js

@@ -13,11 +13,11 @@ const numbers_pb_1 = require("./generated/node/numbers_pb");
  * const SDK = require("@fonoster/sdk");
  *
  * async function main(request) {
- *  const apiKey = "your-api-key";
- *  const accessKeyId = "00000000-0000-0000-0000-000000000000";
+ *   const API_KEY = "your-api-key";
+ *   const ACCESS_KEY_ID = "00000000-0000-0000-0000-000000000000";
  *
- *  try {
- *     const client = SDK.Client({ accessKeyId });
+ *   try {
+ *     const client = SDK.Client({ accessKeyId: ACCESS_KEY_ID });
  *     await client.loginWithApiKey(apiKey);
  *
  *     const numbers = new SDK.Numbers(client);
@@ -62,20 +62,20 @@ class Numbers {
      * @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 numbers = new SDK.Numbers(client); // Existing client object
      *
      * const request = {
-     *  name: "My Number",
-     *  telUrl: "tel:+17853178070",
-     *  city: "Asheville",
-     *  country: "United States",
-     *  countryIsoCode: "US"
+     *   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
+     * numbers
+     *   .createNumber(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     async createNumber(request) {
         const client = this.client.getNumbersClient();
@@ -92,14 +92,14 @@ class Numbers {
      * @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
+     * const ref = "00000000-0000-0000-0000-000000000000";
+     *
+     * numbers
+     *   .getNumber(ref)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     async getNumber(ref) {
         const client = this.client.getNumbersClient();
@@ -118,17 +118,17 @@ class Numbers {
      * @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 numbers = new SDK.Numbers(client); // Existing client object
      *
      * const request = {
-     *  ref: "00000000-0000-0000-0000-000000000000",
-     *  name: "My Number"
+     *   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
+     * numbers
+     *   .updateNumber(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     async updateNumber(request) {
         const client = this.client.getNumbersClient();
@@ -147,17 +147,17 @@ class Numbers {
      * @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 numbers = new SDK.Numbers(client); // Existing client object
      *
      * const request = {
-     *  pageSize: 10,
-     *  pageToken: "00000000-0000-0000-0000-000000000000"
+     *   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
+     * numbers
+     *   .listNumbers(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     async listNumbers(request) {
         const client = this.client.getNumbersClient();
@@ -176,14 +176,14 @@ class Numbers {
      * @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
+     * const ref = "00000000-0000-0000-0000-000000000000";
+     *
+     * numbers
+     *   .deleteNumber(ref)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     async deleteNumber(ref) {
         const applicationsClient = this.client.getNumbersClient();