@fonoster/sdk 0.6.5 → 0.7.0

package/dist/node/Secrets.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 secrets = new SDK.Secrets(client);
@@ -51,17 +51,17 @@ declare class Secrets {
      * @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 secrets = new SDK.Secrets(client); // Existing client object
      *
      * const request = {
-     *  name: "FRIENDLY_NAME",
-     *  secret: "mysecret"
+     *   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
+     * secrets
+     *   .createSecret(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     createSecret(request: CreateSecretRequest): Promise<BaseApiObject>;
     /**
@@ -70,14 +70,14 @@ declare class Secrets {
      * @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
+     * const ref = "00000000-0000-0000-0000-000000000000";
+     *
+     * secrets
+     *   .getSecret(ref)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     getSecret(ref: string): Promise<Secret>;
     /**
@@ -89,17 +89,17 @@ declare class Secrets {
      * @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 secrets = new SDK.Secrets(client); // Existing client object
      *
      * const request = {
-     *  ref: "00000000-0000-0000-0000-000000000000",
-     *  secret: "mysecret"
+     *   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
+     * secrets
+     *   .updateSecret(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     updateSecret(request: UpdateSecretRequest): Promise<BaseApiObject>;
     /**
@@ -110,17 +110,17 @@ declare class Secrets {
      * @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 secrets = new SDK.Secrets(client); // Existing client object
      *
      * const request = {
-     *  pageSize: 10,
-     *  pageToken: "00000000-0000-0000-0000-000000000000"
+     *   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
+     * secrets
+     *   .listSecrets(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     listSecrets(request: ListSecretsRequest): Promise<ListSecretsResponse>;
     /**
@@ -130,14 +130,14 @@ declare class Secrets {
      * @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
+     * const ref = "00000000-0000-0000-0000-000000000000";
+     *
+     * secrets
+     *   .deleteSecret(ref)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     deleteSecret(ref: string): Promise<BaseApiObject>;
 }

package/dist/node/Secrets.js

@@ -13,11 +13,11 @@ const secrets_pb_1 = require("./generated/node/secrets_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 secrets = new SDK.Secrets(client);
@@ -56,17 +56,17 @@ class Secrets {
      * @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 secrets = new SDK.Secrets(client); // Existing client object
      *
      * const request = {
-     *  name: "FRIENDLY_NAME",
-     *  secret: "mysecret"
+     *   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
+     * secrets
+     *   .createSecret(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     async createSecret(request) {
         const client = this.client.getSecretsClient();
@@ -83,14 +83,14 @@ class Secrets {
      * @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
+     * const ref = "00000000-0000-0000-0000-000000000000";
+     *
+     * secrets
+     *   .getSecret(ref)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     async getSecret(ref) {
         const client = this.client.getSecretsClient();
@@ -110,17 +110,17 @@ class Secrets {
      * @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 secrets = new SDK.Secrets(client); // Existing client object
      *
      * const request = {
-     *  ref: "00000000-0000-0000-0000-000000000000",
-     *  secret: "mysecret"
+     *   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
+     * secrets
+     *   .updateSecret(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     async updateSecret(request) {
         const client = this.client.getSecretsClient();
@@ -139,17 +139,17 @@ class Secrets {
      * @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 secrets = new SDK.Secrets(client); // Existing client object
      *
      * const request = {
-     *  pageSize: 10,
-     *  pageToken: "00000000-0000-0000-0000-000000000000"
+     *   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
+     * secrets
+     *   .listSecrets(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     async listSecrets(request) {
         const client = this.client.getSecretsClient();
@@ -168,14 +168,14 @@ class Secrets {
      * @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
+     * const ref = "00000000-0000-0000-0000-000000000000";
+     *
+     * secrets
+     *   .deleteSecret(ref)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     async deleteSecret(ref) {
         const applicationsClient = this.client.getSecretsClient();

package/dist/node/Trunks.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 trunks = new SDK.Trunks(client);
@@ -63,27 +63,27 @@ declare class Trunks {
      * @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 trunks = new SDK.Trunks(client); // Existing client object
      *
      * 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
-     *  }]
+     *   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
+     * trunks
+     *   .createTrunk(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     createTrunk(request: CreateTrunkRequest): Promise<BaseApiObject>;
     /**
@@ -92,14 +92,14 @@ declare class Trunks {
      * @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
+     * const ref = "00000000-0000-0000-0000-000000000000";
+     *
+     * trunks
+     *   .getTrunk(ref)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     getTrunk(ref: string): Promise<unknown>;
     /**
@@ -122,21 +122,27 @@ declare class Trunks {
      * @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 trunks = new SDK.Trunks(client); // Existing client object
      *
      * 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
-     *  }]
+     *   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
+     *   }]
      * };
+     *
+     * trunks
+     *   .updateTrunk(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     updateTrunk(request: UpdateTrunkRequest): Promise<BaseApiObject>;
     /**
@@ -147,17 +153,17 @@ declare class Trunks {
      * @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 trunks = new SDK.Trunks(client); // Existing client object
      *
      * const request = {
-     *  pageSize: 10,
-     *  pageToken: "00000000-0000-0000-0000-000000000000"
+     *   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
+     * trunks
+     *   .listTrunks(request)
+     *   .then(console.log) // successful response
+     *   .catch(console.error); // an error occurred
      */
     listTrunks(request: ListTrunksRequest): Promise<ListTrunksResponse>;
     /**
@@ -167,14 +173,14 @@ declare class Trunks {
      * @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
+     * const ref = "00000000-0000-0000-0000-000000000000";
+     *
+     * trunks
+     *    .deleteTrunk(ref)
+     *    .then(console.log) // successful response
+     *    .catch(console.error); // an error occurred
      */
     deleteTrunk(ref: string): Promise<BaseApiObject>;
 }