@fonoster/sdk 0.6.1 → 0.6.2

package/dist/node/Credentials.js

@@ -0,0 +1,194 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Credentials = void 0;
+const makeRpcRequest_1 = require("./client/makeRpcRequest");
+const credentials_pb_1 = require("./generated/node/credentials_pb");
+/**
+ * @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);
+ */
+class Credentials {
+    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) {
+        this.client = client;
+    }
+    /**
+     * 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
+     */
+    async createCredentials(request) {
+        const client = this.client.getCredentialsClient();
+        return await (0, makeRpcRequest_1.makeRpcRequest)({
+            method: client.createCredentials.bind(client),
+            requestPBObjectConstructor: credentials_pb_1.CreateCredentialsRequest,
+            metadata: this.client.getMetadata(),
+            request
+        });
+    }
+    /**
+     * 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
+     */
+    async getCredentials(ref) {
+        const client = this.client.getCredentialsClient();
+        return await (0, makeRpcRequest_1.makeRpcRequest)({
+            method: client.getCredentials.bind(client),
+            requestPBObjectConstructor: credentials_pb_1.GetCredentialsRequest,
+            metadata: this.client.getMetadata(),
+            request: { ref }
+        });
+    }
+    /**
+     * 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
+     */
+    async updateCredentials(request) {
+        const client = this.client.getCredentialsClient();
+        return await (0, makeRpcRequest_1.makeRpcRequest)({
+            method: client.updateCredentials.bind(client),
+            requestPBObjectConstructor: credentials_pb_1.UpdateCredentialsRequest,
+            metadata: this.client.getMetadata(),
+            request
+        });
+    }
+    /**
+     * 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
+     */
+    async listCredentials(request) {
+        const client = this.client.getCredentialsClient();
+        return await (0, makeRpcRequest_1.makeRpcRequest)({
+            method: client.listCredentials.bind(client),
+            requestPBObjectConstructor: credentials_pb_1.ListCredentialsRequest,
+            metadata: this.client.getMetadata(),
+            request,
+            repeatableObjectMapping: [["itemsList", credentials_pb_1.Credentials]]
+        });
+    }
+    /**
+     * 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
+     */
+    async deleteCredentials(ref) {
+        const applicationsClient = this.client.getCredentialsClient();
+        return await (0, makeRpcRequest_1.makeRpcRequest)({
+            method: applicationsClient.deleteCredentials.bind(applicationsClient),
+            requestPBObjectConstructor: credentials_pb_1.DeleteCredentialsRequest,
+            metadata: this.client.getMetadata(),
+            request: { ref }
+        });
+    }
+}
+exports.Credentials = Credentials;

package/dist/node/Domains.d.ts

@@ -0,0 +1,152 @@
+import { BaseApiObject, CreateDomainRequest, Domain, ListDomainsRequest, ListDomainsResponse, UpdateDomainRequest } from "@fonoster/types";
+import { FonosterClient } from "./client/types";
+/**
+ * @classdesc Fonoster Domains, part of the Fonoster SIP Proxy subsystem,
+ * allows you to create, update, retrieve, and delete SIP Domain 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 domains = new SDK.Domains(client);
+ *     const response = await domains.createDomain(request);
+ *
+ *     console.log(response); // successful response
+ *   } catch (e) {
+ *     console.error(e); // an error occurred
+ *   }
+ * }
+ *
+ * const request = {
+ *   name: "My Domain",
+ *   domainUri: "sip.project.fonoster.io"
+ * };
+ *
+ * main(request).catch(console.error);
+ */
+declare class Domains {
+    private client;
+    /**
+     * Constructs a new Domains 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 Domain in the Workspace.
+     *
+     * @param {CreateDomainRequest} request - The request object that contains the necessary information to create a new Domain
+     * @param {string} request.name - The name of the Domain
+     * @param {string} request.domainUri - The URI of the Domain
+     * @param {AccessControlListRef} request.accessControlListRef - The reference to the Access Control List (ACL) to associate with the Domain
+     * @param {EgressPolicy[]} request.egressPolicy - The egress policy of the Domain
+     * @param {string} request.egressPolicy[].rule - A regular expression that defines which calls to send to the PSTN
+     * @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 request = {
+     *  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
+     */
+    createDomain(request: CreateDomainRequest): Promise<BaseApiObject>;
+    /**
+     * Retrieves an existing Domain in the Workspace.
+     *
+     * @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
+     */
+    getDomain(ref: string): Promise<Domain>;
+    /**
+     * Updates an existing Domain in the Workspace.
+     *
+     * @param {UpdateDomainRequest} request - The request object that contains the necessary information to update an existing Domain
+     * @param {string} request.ref - The reference of the Domain to update
+     * @param {string} request.name - The name of the Domain
+     * @param {string} request.domainUri - The URI of the Domain
+     * @param {AccessControlListRef} request.accessControlListRef - The reference to the Access Control List (ACL) to associate with the Domain
+     * @param {EgressPolicy[]} request.egressPolicy - The egress policy of the Domain
+     * @param {string} request.egressPolicy[].rule - A regular expression that defines which calls to send to the PSTN
+     * @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 request = {
+     *  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
+     */
+    updateDomain(request: UpdateDomainRequest): Promise<BaseApiObject>;
+    /**
+     * Retrieves a list of Domains from a Workspace.
+     *
+     * @param {ListDomainsRequest} request - The request object that contains the necessary information to retrieve a list of Domains
+     * @param {number} request.pageSize - The number of Domains to retrieve
+     * @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 request = {
+     *  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
+     */
+    listDomains(request: ListDomainsRequest): Promise<ListDomainsResponse>;
+    /**
+     * Deletes an existing Domain from Fonoster.
+     * Note that this operation is irreversible.
+     *
+     * @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
+     */
+    deleteDomain(ref: string): Promise<BaseApiObject>;
+}
+export { Domains };

package/dist/node/Domains.js

@@ -0,0 +1,198 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Domains = void 0;
+const makeRpcRequest_1 = require("./client/makeRpcRequest");
+const domains_pb_1 = require("./generated/node/domains_pb");
+/**
+ * @classdesc Fonoster Domains, part of the Fonoster SIP Proxy subsystem,
+ * allows you to create, update, retrieve, and delete SIP Domain 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 domains = new SDK.Domains(client);
+ *     const response = await domains.createDomain(request);
+ *
+ *     console.log(response); // successful response
+ *   } catch (e) {
+ *     console.error(e); // an error occurred
+ *   }
+ * }
+ *
+ * const request = {
+ *   name: "My Domain",
+ *   domainUri: "sip.project.fonoster.io"
+ * };
+ *
+ * main(request).catch(console.error);
+ */
+class Domains {
+    client;
+    /**
+     * Constructs a new Domains 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 Domain in the Workspace.
+     *
+     * @param {CreateDomainRequest} request - The request object that contains the necessary information to create a new Domain
+     * @param {string} request.name - The name of the Domain
+     * @param {string} request.domainUri - The URI of the Domain
+     * @param {AccessControlListRef} request.accessControlListRef - The reference to the Access Control List (ACL) to associate with the Domain
+     * @param {EgressPolicy[]} request.egressPolicy - The egress policy of the Domain
+     * @param {string} request.egressPolicy[].rule - A regular expression that defines which calls to send to the PSTN
+     * @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 request = {
+     *  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
+     */
+    async createDomain(request) {
+        const client = this.client.getDomainsClient();
+        return await (0, makeRpcRequest_1.makeRpcRequest)({
+            method: client.createDomain.bind(client),
+            requestPBObjectConstructor: domains_pb_1.CreateDomainRequest,
+            metadata: this.client.getMetadata(),
+            request
+        });
+    }
+    /**
+     * Retrieves an existing Domain in the Workspace.
+     *
+     * @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
+     */
+    async getDomain(ref) {
+        const client = this.client.getDomainsClient();
+        return await (0, makeRpcRequest_1.makeRpcRequest)({
+            method: client.getDomain.bind(client),
+            requestPBObjectConstructor: domains_pb_1.GetDomainRequest,
+            metadata: this.client.getMetadata(),
+            request: { ref }
+        });
+    }
+    /**
+     * Updates an existing Domain in the Workspace.
+     *
+     * @param {UpdateDomainRequest} request - The request object that contains the necessary information to update an existing Domain
+     * @param {string} request.ref - The reference of the Domain to update
+     * @param {string} request.name - The name of the Domain
+     * @param {string} request.domainUri - The URI of the Domain
+     * @param {AccessControlListRef} request.accessControlListRef - The reference to the Access Control List (ACL) to associate with the Domain
+     * @param {EgressPolicy[]} request.egressPolicy - The egress policy of the Domain
+     * @param {string} request.egressPolicy[].rule - A regular expression that defines which calls to send to the PSTN
+     * @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 request = {
+     *  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
+     */
+    async updateDomain(request) {
+        const client = this.client.getDomainsClient();
+        return await (0, makeRpcRequest_1.makeRpcRequest)({
+            method: client.updateDomain.bind(client),
+            requestPBObjectConstructor: domains_pb_1.UpdateDomainRequest,
+            metadata: this.client.getMetadata(),
+            request
+        });
+    }
+    /**
+     * Retrieves a list of Domains from a Workspace.
+     *
+     * @param {ListDomainsRequest} request - The request object that contains the necessary information to retrieve a list of Domains
+     * @param {number} request.pageSize - The number of Domains to retrieve
+     * @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 request = {
+     *  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
+     */
+    async listDomains(request) {
+        const client = this.client.getDomainsClient();
+        return await (0, makeRpcRequest_1.makeRpcRequest)({
+            method: client.listDomains.bind(client),
+            requestPBObjectConstructor: domains_pb_1.ListDomainsRequest,
+            metadata: this.client.getMetadata(),
+            request,
+            repeatableObjectMapping: [["itemsList", domains_pb_1.Domain]]
+        });
+    }
+    /**
+     * Deletes an existing Domain from Fonoster.
+     * Note that this operation is irreversible.
+     *
+     * @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
+     */
+    async deleteDomain(ref) {
+        const applicationsClient = this.client.getDomainsClient();
+        return await (0, makeRpcRequest_1.makeRpcRequest)({
+            method: applicationsClient.deleteDomain.bind(applicationsClient),
+            requestPBObjectConstructor: domains_pb_1.DeleteDomainRequest,
+            metadata: this.client.getMetadata(),
+            request: { ref }
+        });
+    }
+}
+exports.Domains = Domains;

package/dist/node/Numbers.d.ts

@@ -0,0 +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 };