@routr/sdk 2.0.8-alpha.20

package/dist/credentials/types.d.ts

@@ -0,0 +1,11 @@
+import { CommonConnect as CC } from "@routr/common";
+import { CreateBaseOmit } from "../types";
+export type CreateCredentialsRequest = Omit<CC.Credentials, CreateBaseOmit>;
+export type CreateCredentialsResponse = CC.Credentials;
+export type UpdateCredentialsRequest = {
+    ref: string;
+} & Partial<CreateCredentialsRequest>;
+export type UpdateCredentialsResponse = CC.Credentials;
+export type ListCredentialsRequest = CC.ListRequest;
+export type ListCredentialsResponse = CC.ListResponse<CC.Credentials>;
+export type GetCredentialsResponse = CC.Credentials;

package/dist/credentials/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/domains/domains.d.ts

@@ -0,0 +1,138 @@
+import { APIClient } from "../client";
+import { ClientOptions } from "../types";
+import { CreateDomainRequest, CreateDomainResponse, GetDomainResponse, ListDomainRequest, ListDomainResponse, UpdateDomainRequest, UpdateDomainResponse } from "./types";
+/**
+ * @classdesc Use Routr Domains, a capability of Routr SIP Proxy, to create, update, get
+ * and delete Domains. The Domains API requires of a running Routr deployment.
+ *
+ * @extends APIClient
+ * @example
+ *
+ * const SDK = require("@routr/sdk")
+ * const domains = new SDK.Domains()
+ *
+ * const request = {
+ *   name: "Local domain",
+ *   domainUri: "sip.local",
+ *   accessControlListRef: "4671371b-ff5d-48b1-aabe-d3c5ca5317a3",
+ *   egressPolicies: [{
+ *     rule: ".*",
+ *     numberRef: "4671371b-ff5d-48b1-aabe-d3c5ca5317a3"
+ *   }],
+ *   extended: {
+ *     "key": "value"
+ *   }
+ * }
+ *
+ * domains.createDomain(request)
+ *   .then(console.log)
+ *   .catch(console.error)   // an error occurred
+ */
+export declare class Domains extends APIClient {
+    /**
+     * Constructs a new Domain API object.
+     *
+     * @param {ClientOptions} options - Options to indicate the objects endpoint
+     * @see module:core:APIClient
+     */
+    constructor(options: ClientOptions);
+    /**
+     * Creates a new Domain on Routr.
+     *
+     * @param {CreateDomainRequest} request - The request to create an Domain
+     * @param {string} request.name - Name of the Domain
+     * @param {string} request.domainUri - The FQDN of the Domain
+     * @param {string} request.accessControlListRef - The reference to the AccessControlList for the Domain
+     * @param {CC.EgressPolicy[]} request.egressPolicies - The list of EgressPolicies for the Domain
+     * @param {string} request.extended - Optional extended attributes
+     * @return {Promise<CreateDomainResponse>} The newly created Domain
+     * @throws if request is null
+     * @example
+     *
+     * const request = {
+     *   name: "Local domain",
+     *   domainUri: "sip.local",
+     *   accessControlListRef: "4671371b-ff5d-48b1-aabe-d3c5ca5317a3",
+     *   egressPolicies: [{
+     *     rule: ".*",
+     *     numberRef: "4671371b-ff5d-48b1-aabe-d3c5ca5317a3"
+     *   }],
+     *   extended: {
+     *     "key": "value"
+     *   }
+     * }
+     *
+     * domains.createDomain(request)
+     *   .then(console.log)
+     *   .catch(console.error)   // an error occurred
+     */
+    createDomain(request: CreateDomainRequest): Promise<CreateDomainResponse>;
+    /**
+     * Updates an already existing Domain on Routr.
+     *
+     * @param {UpdateDomainRequest} request - Partial with the fields to update
+     * @param {string} request.name - Name of the Domain
+     * @param {string} request.domainUri - The FQDN of the Domain
+     * @param {string} request.accessControlListRef - The reference to the AccessControlList for the Domain
+     * @param {CC.EgressPolicy[]} request.egressPolicies - The list of EgressPolicies for the Domain
+     * @param {string} request.extended - Optional extended attributes
+     * @return {Promise<UpdateDomainResponse>} The updated Domain
+     * @example
+     *
+     * const request = {
+     *   name: "Local domain updated",
+     *   accessControlListRef: "4671371b-ff5d-48b1-aabe-d3c5ca5317a3"
+     * }
+     *
+     * domains.updateDomain(request)
+     *   .then(console.log)
+     *   .catch(console.error)   // an error occurred
+     */
+    updateDomain(request: UpdateDomainRequest): Promise<UpdateDomainResponse>;
+    /**
+     * Gets a Domain from Routr.
+     *
+     * @param {string} ref - The Domain's reference
+     * @return {Promise<GetDomainResponse>} The Domain
+     * @example
+     *
+     * const ref = "4671371b-ff5d-48b1-aabe-d3c5ca5317a3"
+     *
+     * domains.getDomain(ref)
+     *   .then(console.log)
+     *   .catch(console.error)   // an error occurred
+     */
+    getDomain(ref: string): Promise<GetDomainResponse>;
+    /**
+     * Deletes a Domain from Routr.
+     *
+     * @param {string} ref - The Domain's reference
+     * @return {Promise<void>}
+     * @example
+     *
+     * const ref = "4671371b-ff5d-48b1-aabe-d3c5ca5317a3"
+     *
+     * domains.deleteDomain(ref)
+     *   .then(console.log)
+     *   .catch(console.error)   // an error occurred
+     */
+    deleteDomain(ref: string): Promise<void>;
+    /**
+     * Lists all Domains from Routr with pagination.
+     *
+     * @param {ListDomainRequest} request - The request to list Domains
+     * @param {number} request.pageSize - The number of Domains to return
+     * @param {string} request.pageToken - The page token to use for pagination
+     * @return {Promise<ListDomainResponse>} The list of Domains
+     * @example
+     *
+     * const request = {
+     *   pageSize: 10
+     * }
+     *
+     * domains.listDomains(request)
+     *   .then(console.log)
+     *   .catch(console.error)   // an error occurred
+     */
+    listDomains(request: ListDomainRequest): Promise<ListDomainResponse>;
+}

package/dist/domains/domains.js

@@ -0,0 +1,189 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Domains = void 0;
+/*
+ * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster
+ *
+ * This file is part of Routr.
+ *
+ * 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 client_1 = require("../client");
+/**
+ * @classdesc Use Routr Domains, a capability of Routr SIP Proxy, to create, update, get
+ * and delete Domains. The Domains API requires of a running Routr deployment.
+ *
+ * @extends APIClient
+ * @example
+ *
+ * const SDK = require("@routr/sdk")
+ * const domains = new SDK.Domains()
+ *
+ * const request = {
+ *   name: "Local domain",
+ *   domainUri: "sip.local",
+ *   accessControlListRef: "4671371b-ff5d-48b1-aabe-d3c5ca5317a3",
+ *   egressPolicies: [{
+ *     rule: ".*",
+ *     numberRef: "4671371b-ff5d-48b1-aabe-d3c5ca5317a3"
+ *   }],
+ *   extended: {
+ *     "key": "value"
+ *   }
+ * }
+ *
+ * domains.createDomain(request)
+ *   .then(console.log)
+ *   .catch(console.error)   // an error occurred
+ */
+class Domains extends client_1.APIClient {
+    /**
+     * Constructs a new Domain API object.
+     *
+     * @param {ClientOptions} options - Options to indicate the objects endpoint
+     * @see module:core:APIClient
+     */
+    constructor(options) {
+        super(options);
+    }
+    /**
+     * Creates a new Domain on Routr.
+     *
+     * @param {CreateDomainRequest} request - The request to create an Domain
+     * @param {string} request.name - Name of the Domain
+     * @param {string} request.domainUri - The FQDN of the Domain
+     * @param {string} request.accessControlListRef - The reference to the AccessControlList for the Domain
+     * @param {CC.EgressPolicy[]} request.egressPolicies - The list of EgressPolicies for the Domain
+     * @param {string} request.extended - Optional extended attributes
+     * @return {Promise<CreateDomainResponse>} The newly created Domain
+     * @throws if request is null
+     * @example
+     *
+     * const request = {
+     *   name: "Local domain",
+     *   domainUri: "sip.local",
+     *   accessControlListRef: "4671371b-ff5d-48b1-aabe-d3c5ca5317a3",
+     *   egressPolicies: [{
+     *     rule: ".*",
+     *     numberRef: "4671371b-ff5d-48b1-aabe-d3c5ca5317a3"
+     *   }],
+     *   extended: {
+     *     "key": "value"
+     *   }
+     * }
+     *
+     * domains.createDomain(request)
+     *   .then(console.log)
+     *   .catch(console.error)   // an error occurred
+     */
+    createDomain(request) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.client.domains.create(request);
+        });
+    }
+    /**
+     * Updates an already existing Domain on Routr.
+     *
+     * @param {UpdateDomainRequest} request - Partial with the fields to update
+     * @param {string} request.name - Name of the Domain
+     * @param {string} request.domainUri - The FQDN of the Domain
+     * @param {string} request.accessControlListRef - The reference to the AccessControlList for the Domain
+     * @param {CC.EgressPolicy[]} request.egressPolicies - The list of EgressPolicies for the Domain
+     * @param {string} request.extended - Optional extended attributes
+     * @return {Promise<UpdateDomainResponse>} The updated Domain
+     * @example
+     *
+     * const request = {
+     *   name: "Local domain updated",
+     *   accessControlListRef: "4671371b-ff5d-48b1-aabe-d3c5ca5317a3"
+     * }
+     *
+     * domains.updateDomain(request)
+     *   .then(console.log)
+     *   .catch(console.error)   // an error occurred
+     */
+    updateDomain(request) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.client.domains.update(request);
+        });
+    }
+    /**
+     * Gets a Domain from Routr.
+     *
+     * @param {string} ref - The Domain's reference
+     * @return {Promise<GetDomainResponse>} The Domain
+     * @example
+     *
+     * const ref = "4671371b-ff5d-48b1-aabe-d3c5ca5317a3"
+     *
+     * domains.getDomain(ref)
+     *   .then(console.log)
+     *   .catch(console.error)   // an error occurred
+     */
+    getDomain(ref) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.client.domains.get(ref);
+        });
+    }
+    /**
+     * Deletes a Domain from Routr.
+     *
+     * @param {string} ref - The Domain's reference
+     * @return {Promise<void>}
+     * @example
+     *
+     * const ref = "4671371b-ff5d-48b1-aabe-d3c5ca5317a3"
+     *
+     * domains.deleteDomain(ref)
+     *   .then(console.log)
+     *   .catch(console.error)   // an error occurred
+     */
+    deleteDomain(ref) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.client.domains.del(ref);
+        });
+    }
+    /**
+     * Lists all Domains from Routr with pagination.
+     *
+     * @param {ListDomainRequest} request - The request to list Domains
+     * @param {number} request.pageSize - The number of Domains to return
+     * @param {string} request.pageToken - The page token to use for pagination
+     * @return {Promise<ListDomainResponse>} The list of Domains
+     * @example
+     *
+     * const request = {
+     *   pageSize: 10
+     * }
+     *
+     * domains.listDomains(request)
+     *   .then(console.log)
+     *   .catch(console.error)   // an error occurred
+     */
+    listDomains(request) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.client.domains.list(request);
+        });
+    }
+}
+exports.Domains = Domains;

package/dist/domains/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./domains";
+export { Domains as default } from "./domains";

package/dist/domains/index.js

@@ -0,0 +1,38 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = void 0;
+/*
+ * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster
+ *
+ * This file is part of Routr.
+ *
+ * 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.
+ */
+__exportStar(require("./domains"), exports);
+var domains_1 = require("./domains");
+Object.defineProperty(exports, "default", { enumerable: true, get: function () { return domains_1.Domains; } });

package/dist/domains/types.d.ts

@@ -0,0 +1,13 @@
+import { CommonConnect as CC } from "@routr/common";
+import { CreateBaseOmit } from "../types";
+export type CreateDomainRequest = Omit<CC.Domain, CreateBaseOmit | "accessControlList" | "egressPolicies"> & {
+    egressPolicies?: Omit<CC.EgressPolicy, "number">[];
+};
+export type CreateDomainResponse = CC.Domain;
+export type UpdateDomainRequest = {
+    ref: string;
+} & Partial<CreateDomainRequest>;
+export type UpdateDomainResponse = CC.Domain;
+export type ListDomainRequest = CC.ListRequest;
+export type ListDomainResponse = CC.ListResponse<CC.Domain>;
+export type GetDomainResponse = CC.Domain;

package/dist/domains/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/index.d.ts

@@ -0,0 +1,17 @@
+import ACL from "./acl";
+import Agents from "./agents";
+import Domains from "./domains";
+import Credentials from "./credentials";
+import Peers from "./peers";
+import Numbers from "./numbers";
+import Trunks from "./trunks";
+declare const SDK: {
+    ACL: typeof ACL;
+    Agents: typeof Agents;
+    Domains: typeof Domains;
+    Numbers: typeof Numbers;
+    Peers: typeof Peers;
+    Trunks: typeof Trunks;
+    Credentials: typeof Credentials;
+};
+export { SDK as default };

package/dist/index.js

@@ -0,0 +1,41 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = void 0;
+/*
+ * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster
+ *
+ * This file is part of Routr.
+ *
+ * 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 acl_1 = __importDefault(require("./acl"));
+const agents_1 = __importDefault(require("./agents"));
+const domains_1 = __importDefault(require("./domains"));
+const credentials_1 = __importDefault(require("./credentials"));
+const peers_1 = __importDefault(require("./peers"));
+const numbers_1 = __importDefault(require("./numbers"));
+const trunks_1 = __importDefault(require("./trunks"));
+const SDK = {
+    ACL: acl_1.default,
+    Agents: agents_1.default,
+    Domains: domains_1.default,
+    Numbers: numbers_1.default,
+    Peers: peers_1.default,
+    Trunks: trunks_1.default,
+    Credentials: credentials_1.default
+};
+exports.default = SDK;

package/dist/numbers/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./numbers";
+export { Numbers as default } from "./numbers";

package/dist/numbers/index.js

@@ -0,0 +1,38 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = void 0;
+/*
+ * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster
+ *
+ * This file is part of Routr.
+ *
+ * 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.
+ */
+__exportStar(require("./numbers"), exports);
+var numbers_1 = require("./numbers");
+Object.defineProperty(exports, "default", { enumerable: true, get: function () { return numbers_1.Numbers; } });

package/dist/numbers/numbers.d.ts

@@ -0,0 +1,156 @@
+import { APIClient } from "../client";
+import { ClientOptions } from "../types";
+import { CreateNumberRequest, CreateNumberResponse, GetNumberResponse, ListNumberRequest, ListNumberResponse, UpdateNumberRequest, UpdateNumberResponse } from "./types";
+/**
+ * @classdesc Use Routr Numbers, a capability of Routr SIP Proxy, to create, update, get
+ * and delete Numbers. The Number API requires of a running Routr deployment.
+ *
+ * @extends APIClient
+ * @example
+ *
+ * const SDK = require("@routr/sdk")
+ * const numbers = new SDK.Numbers()
+ *
+ * const request = {
+ *   name: "(415) 555-1212",
+ *   telUrl: "teL:+14155551212",
+ *   aorLink: "sip:100@sip.local",
+ *   city: "San Francisco",
+ *   country: "United States",
+ *   countryISOCode: "US",
+ *   sessionAffinityHeader: "X-Room-Id"
+ *   extraHeaders: [{
+ *     name: "X-Room-Id",
+ *     value: "abc-us-123"
+ *   }],
+ *   extended: {
+ *     "key": "value"
+ *   }
+ * }
+ *
+ * numbers.createNumber(request)
+ *   .then(console.log)
+ *   .catch(console.error)   // an error occurred
+ */
+export declare class Numbers extends APIClient {
+    /**
+     * Constructs a new Number API object.
+     *
+     * @param {ClientOptions} options - Options to indicate the objects endpoint
+     * @see module:core:APIClient
+     */
+    constructor(options: ClientOptions);
+    /**
+     * Creates a new Number on Routr.
+     *
+     * @param {CreateNumberRequest} request - The request to create an Number
+     * @param {string} request.name - Name of the Number
+     * @param {string} request.telUrl - The number URI to be used (e.g. te:+1234567890)
+     * @param {string} request.aorLink - The AOR link to be used (e.g. sip:1001@sip.local)
+     * @param {string} request.city - The city where the number is located
+     * @param {string} request.country - The country where the number is located
+     * @param {string} request.countryISOCode - The country ISO code where the number is located
+     * @param {{ name: string, value: string}[]} request.extraHeaders - Extra headers to be used
+     * @param {string} request.trunkRef - The trunk reference to be used
+     * @param {string} request.sessionAffinityHeader - Optional session affinity header
+     * @param {string} request.extended - Optional extended attributes
+     * @return {Promise<CreateNumberResponse>} The newly created Number
+     * @throws if request is null
+     * @example
+     *
+     * const request = {
+     *   name: "(415) 555-1212",
+     *   telUrl: "teL:+14155551212",
+     *   aorLink: "sip:100@sip.local",
+     *   city: "San Francisco",
+     *   country: "United States",
+     *   countryISOCode: "US",
+     *   sessionAffinityHeader: "X-Room-Id"
+     *   extraHeaders: [{
+     *     name: "X-Room-Id",
+     *     value: "abc-us-123"
+     *   }],
+     *   extended: {
+     *     "key": "value"
+     *   }
+     * }
+     *
+     * numbers.createNumber(request)
+     *   .then(console.log)
+     *   .catch(console.error)   // an error occurred
+     */
+    createNumber(request: CreateNumberRequest): Promise<CreateNumberResponse>;
+    /**
+     * Updates an already existing Number on Routr.
+     *
+     * @param {UpdateNumberRequest} request - Partial with the fields to update
+     * @param {string} request.name - Name of the Number
+     * @param {string} request.telUrl - The number URI to be used (e.g. te:+1234567890)
+     * @param {string} request.aorLink - The AOR link to be used (e.g. sip:1001@sip.local)
+     * @param {string} request.city - The city where the number is located
+     * @param {string} request.country - The country where the number is located
+     * @param {string} request.countryISOCode - The country ISO code where the number is located
+     * @param {{ name: string, value: string}[]} request.extraHeaders - Extra headers to be used
+     * @param {string} request.trunkRef - The trunk reference to be used
+     * @param {string} request.sessionAffinityHeader - Optional session affinity header
+     * @param {string} request.extended - Optional extended attributes
+     * @return {Promise<UpdateNumberResponse>} The updated Number
+     * @example
+     *
+     * const request = {
+     *   name: "(415) 555-1212 (friendly name)",
+     *   aorLink: "sip:2001@sip.local"
+     * }
+     *
+     * numbers.updateNumber(request)
+     *   .then(console.log)
+     *   .catch(console.error)   // an error occurred
+     */
+    updateNumber(request: UpdateNumberRequest): Promise<UpdateNumberResponse>;
+    /**
+     * Gets a Number from Routr.
+     *
+     * @param {string} ref - The Number's reference
+     * @return {Promise<GetNumberResponse>} The Number
+     * @example
+     *
+     * const ref = "4671371b-ff5d-48b1-aabe-d3c5ca5317a3"
+     *
+     * numbers.getNumber(ref)
+     *   .then(console.log)
+     *   .catch(console.error)   // an error occurred
+     */
+    getNumber(ref: string): Promise<GetNumberResponse>;
+    /**
+     * Deletes a Number from Routr.
+     *
+     * @param {string} ref - The Number's reference
+     * @return {Promise<void>}
+     * @example
+     *
+     * const ref = "4671371b-ff5d-48b1-aabe-d3c5ca5317a3"
+     *
+     * numbers.deleteNumber(ref)
+     *   .then(console.log)
+     *   .catch(console.error)   // an error occurred
+     */
+    deleteNumber(ref: string): Promise<void>;
+    /**
+     * Lists all Numbers from Routr with pagination.
+     *
+     * @param {ListNumberRequest} request - The request to list Numbers
+     * @param {number} request.pageSize - The number of Numbers to return
+     * @param {string} request.pageToken - The page token to use for pagination
+     * @return {Promise<ListNumberResponse>} The list of Numbers
+     * @example
+     *
+     * const request = {
+     *  pageSize: 10
+     * }
+     *
+     * numbers.listNumbers(request)
+     *   .then(console.log)
+     *   .catch(console.error)   // an error occurred
+     */
+    listNumbers(request: ListNumberRequest): Promise<ListNumberResponse>;
+}