@routr/sdk 2.12.1 → 2.13.0

package/README.md

@@ -20,7 +20,7 @@ $ npm install --save @routr/sdk
 <!-- usagestop -->
 # APIs
 <!-- apis -->
-* [`Access Control List`](#acl--apiclient)
+* [`Acls`](#acl--apiclient)
 * [`Agents`](#agents--apiclient)
 * [`Credentials`](#credentials--apiclient)
 * [`Domains`](#domains--apiclient)
@@ -29,9 +29,9 @@ $ npm install --save @routr/sdk
 * [`Trunks`](#trunks--apiclient)
 
 
-<a name="ACL"></a>
+<a name="Acls"></a>
 
-## ACL ⇐ <code>APIClient</code>
+## Acls ⇐ <code>APIClient</code>
 Use Routr ACL, a capability of Routr SIP Proxy, to create, update, get
 and delete Access Control Lists. The ACL API requires of a running Routr deployment.
 
@@ -39,18 +39,18 @@ and delete Access Control Lists. The ACL API requires of a running Routr deploym
 **Extends**: <code>APIClient</code>  
 **See**: module:core:APIClient  
 
-* [ACL](#ACL) ⇐ <code>APIClient</code>
-    * [new ACL(options)](#new_ACL_new)
-    * [.createACL(request)](#ACL+createACL) ⇒ <code>Promise.&lt;CreateACLResponse&gt;</code>
-    * [.updateACL(request)](#ACL+updateACL) ⇒ <code>Promise.&lt;UpdateACLResponse&gt;</code>
-    * [.getACL(ref)](#ACL+getACL) ⇒ <code>Promise.&lt;GetACLResponse&gt;</code>
-    * [.deleteACL(ref)](#ACL+deleteACL) ⇒ <code>Promise.&lt;void&gt;</code>
-    * [.listACLs(request)](#ACL+listACLs) ⇒ <code>Promise.&lt;ListACLResponse&gt;</code>
+* [Acls](#Acls) ⇐ <code>APIClient</code>
+    * [new Acls(options)](#new_Acls_new)
+    * [.createAcl(request)](#Acls+createAcl) ⇒ <code>Promise.&lt;CreateAclResponse&gt;</code>
+    * [.updateAcl(request)](#Acls+updateAcl) ⇒ <code>Promise.&lt;UpdateAclResponse&gt;</code>
+    * [.getAcl(ref)](#Acls+getAcl) ⇒ <code>Promise.&lt;GetAclResponse&gt;</code>
+    * [.deleteAcl(ref)](#Acls+deleteAcl) ⇒ <code>Promise.&lt;void&gt;</code>
+    * [.listAcls(request)](#Acls+listAcls) ⇒ <code>Promise.&lt;ListAclResponse&gt;</code>
 
-<a name="new_ACL_new"></a>
+<a name="new_Acls_new"></a>
 
-### new ACL(options)
-Constructs a new ACL API object.
+### new Acls(options)
+Constructs a new API object.
 
 
 | Param | Type | Description |
@@ -60,7 +60,7 @@ Constructs a new ACL API object.
 **Example**  
 ```js
 const SDK = require("@routr/sdk")
-const acl = new SDK.ACL()
+const acl = new SDK.Acls()
 
 const request = {
   name: "Peer network",
@@ -68,17 +68,17 @@ const request = {
   deny: "0.0.0.0/0"
 }
 
-acl.createACL(request)
+acl.createAcl(request)
   .then(console.log)
   .catch(console.error)   // an error occurred
 ```
-<a name="ACL+createACL"></a>
+<a name="Acls+createAcl"></a>
 
-### acL.createACL(request) ⇒ <code>Promise.&lt;CreateACLResponse&gt;</code>
+### acls.createAcl(request) ⇒ <code>Promise.&lt;CreateAclResponse&gt;</code>
 Creates a new AccessControlList on Routr.
 
-**Kind**: instance method of [<code>ACL</code>](#ACL)  
-**Returns**: <code>Promise.&lt;CreateACLResponse&gt;</code> - The newly created AccessControlList  
+**Kind**: instance method of [<code>Acls</code>](#Acls)  
+**Returns**: <code>Promise.&lt;CreateAclResponse&gt;</code> - The newly created AccessControlList  
 **Throws**:
 
 - if request is null
@@ -86,7 +86,7 @@ Creates a new AccessControlList on Routr.
 
 | Param | Type | Description |
 | --- | --- | --- |
-| request | <code>CreateACLRequest</code> | The request to create an ACL |
+| request | <code>CreateAclRequest</code> | The request to create an ACL |
 | request.name | <code>string</code> | Name of the ACL |
 | request.allow | <code>Array.&lt;string&gt;</code> | List of IP addresses or CIDR blocks to allow |
 | request.deny | <code>Array.&lt;string&gt;</code> | List of IP addresses or CIDR blocks to deny |
@@ -100,21 +100,21 @@ const request = {
   deny: "0.0.0.0/0"
 }
 
-acl.createACL(request)
+acl.createAcl(request)
   .then(console.log)
   .catch(console.error)   // an error occurred
 ```
-<a name="ACL+updateACL"></a>
+<a name="Acls+updateAcl"></a>
 
-### acL.updateACL(request) ⇒ <code>Promise.&lt;UpdateACLResponse&gt;</code>
+### acls.updateAcl(request) ⇒ <code>Promise.&lt;UpdateAclResponse&gt;</code>
 Updates an already existing AccessControlList on Routr.
 
-**Kind**: instance method of [<code>ACL</code>](#ACL)  
-**Returns**: <code>Promise.&lt;UpdateACLResponse&gt;</code> - The AccessControlList  
+**Kind**: instance method of [<code>Acls</code>](#Acls)  
+**Returns**: <code>Promise.&lt;UpdateAclResponse&gt;</code> - The AccessControlList  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| request | <code>UpdateACLRequest</code> | Partial with the fields to update |
+| request | <code>UpdateAclRequest</code> | Partial with the fields to update |
 | request.name | <code>string</code> | Name of the ACL |
 | request.allow | <code>Array.&lt;string&gt;</code> | List of IP addresses or CIDR blocks to allow |
 | request.deny | <code>Array.&lt;string&gt;</code> | List of IP addresses or CIDR blocks to deny |
@@ -127,17 +127,17 @@ const request = {
   name: "Peer network updated",
 }
 
-acl.updateACL(request)
+acl.updateAcl(request)
   .then(console.log)
   .catch(console.error)   // an error occurred
 ```
-<a name="ACL+getACL"></a>
+<a name="Acls+getAcl"></a>
 
-### acL.getACL(ref) ⇒ <code>Promise.&lt;GetACLResponse&gt;</code>
+### acls.getAcl(ref) ⇒ <code>Promise.&lt;GetAclResponse&gt;</code>
 Gets an AccessControlList from Routr.
 
-**Kind**: instance method of [<code>ACL</code>](#ACL)  
-**Returns**: <code>Promise.&lt;GetACLResponse&gt;</code> - The AccessControlList  
+**Kind**: instance method of [<code>Acls</code>](#Acls)  
+**Returns**: <code>Promise.&lt;GetAclResponse&gt;</code> - The AccessControlList  
 
 | Param | Type | Description |
 | --- | --- | --- |
@@ -147,16 +147,16 @@ Gets an AccessControlList from Routr.
 ```js
 const ref = "4671371b-ff5d-48b1-aabe-d3c5ca5317a3"
 
-acl.getACL(ref)
+acl.getAcl(ref)
   .then(console.log)
   .catch(console.error)   // an error occurred
 ```
-<a name="ACL+deleteACL"></a>
+<a name="Acls+deleteAcl"></a>
 
-### acL.deleteACL(ref) ⇒ <code>Promise.&lt;void&gt;</code>
+### acls.deleteAcl(ref) ⇒ <code>Promise.&lt;void&gt;</code>
 Deletes an AccessControlList from Routr.
 
-**Kind**: instance method of [<code>ACL</code>](#ACL)  
+**Kind**: instance method of [<code>Acls</code>](#Acls)  
 
 | Param | Type | Description |
 | --- | --- | --- |
@@ -166,21 +166,21 @@ Deletes an AccessControlList from Routr.
 ```js
 const ref = "4671371b-ff5d-48b1-aabe-d3c5ca5317a3"
 
-acl.deleteACL(ref)
+acl.deleteAcl(ref)
   .then(console.log)
   .catch(console.error)   // an error occurred
 ```
-<a name="ACL+listACLs"></a>
+<a name="Acls+listAcls"></a>
 
-### acL.listACLs(request) ⇒ <code>Promise.&lt;ListACLResponse&gt;</code>
+### acls.listAcls(request) ⇒ <code>Promise.&lt;ListAclResponse&gt;</code>
 Lists all AccessControlLists from Routr with pagination.
 
-**Kind**: instance method of [<code>ACL</code>](#ACL)  
-**Returns**: <code>Promise.&lt;ListACLResponse&gt;</code> - The list of AccessControlLists  
+**Kind**: instance method of [<code>Acls</code>](#Acls)  
+**Returns**: <code>Promise.&lt;ListAclResponse&gt;</code> - The list of AccessControlLists  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| request | <code>ListACLRequest</code> | The request to list ACLs |
+| request | <code>ListAclRequest</code> | The request to list ACLs |
 | request.pageSize | <code>number</code> | The number of ACLs to return |
 | request.pageToken | <code>string</code> | The page token to use for pagination |
 
@@ -190,7 +190,7 @@ const request = {
  pageSize: 10
 }
 
-acl.listACLs(request)
+acl.listAcls(request)
   .then(console.log)
   .catch(console.error)   // an error occurred
 ```
@@ -808,7 +808,7 @@ Creates a new Number on Routr.
 | request.city | <code>string</code> | The city where the number is located |
 | request.country | <code>string</code> | The country where the number is located |
 | request.countryIsoCode | <code>string</code> | The country ISO code where the number is located |
-| request.extraHeaders | <code>Array.&lt;JsonObject&gt;</code> | Extra headers to be used (e.g., [\{name: "X-Room-Id", value: "abc-us-123"\}]) |
+|  | <code>Array.&lt;{name: string, value: string}&gt;</code> | Extra headers to be used (e.g., [\{name: "X-Room-Id", value: "abc-us-123"\}]) |
 | request.trunkRef | <code>string</code> | The Trunk reference to be used |
 | request.sessionAffinityHeader | <code>string</code> | Optional session affinity header |
 | request.extended | <code>string</code> | Optional extended attributes |
@@ -850,7 +850,7 @@ Updates an already existing Number on Routr.
 | request | <code>UpdateNumberRequest</code> | Partial with the fields to update |
 | request.name | <code>string</code> | Name of the Number |
 | request.aorLink | <code>string</code> | The AOR link to be used (e.g., sip:1001@sip.local) |
-| request.extraHeaders | <code>Array.&lt;JsonObject&gt;</code> | Extra headers to be used (e.g., [\{name: "X-Room-Id", value: "abc-us-123"\}]) |
+| request.extraHeaders | <code>Array.&lt;{name: string, value: string}&gt;</code> | Extra headers to be used (e.g., [\{name: "X-Room-Id", value: "abc-us-123"\}]) |
 | request.trunkRef | <code>string</code> | The Trunk reference to be used |
 | request.sessionAffinityHeader | <code>string</code> | Optional session affinity header |
 | request.extended | <code>string</code> | Optional extended attributes |

package/dist/{acl → acls}/acl.d.ts

@@ -1,6 +1,6 @@
 import { APIClient } from "../client";
 import { ClientOptions } from "../types";
-import { CreateACLRequest, CreateACLResponse, GetACLResponse, ListACLRequest, ListACLResponse, UpdateACLRequest, UpdateACLResponse } from "./types";
+import { CreateAclRequest, CreateAclResponse, GetAclResponse, ListAclRequest, ListAclResponse, UpdateAclRequest, UpdateAclResponse } from "./types";
 /**
  * @classdesc Use Routr ACL, a capability of Routr SIP Proxy, to create, update, get
  * and delete Access Control Lists. The ACL API requires of a running Routr deployment.
@@ -9,7 +9,7 @@ import { CreateACLRequest, CreateACLResponse, GetACLResponse, ListACLRequest, Li
  * @example
  *
  * const SDK = require("@routr/sdk")
- * const acl = new SDK.ACL()
+ * const acl = new SDK.Acls()
  *
  * const request = {
  *   name: "Peer network",
@@ -17,13 +17,13 @@ import { CreateACLRequest, CreateACLResponse, GetACLResponse, ListACLRequest, Li
  *   deny: "0.0.0.0/0"
  * }
  *
- * acl.createACL(request)
+ * acl.createAcl(request)
  *   .then(console.log)
  *   .catch(console.error)   // an error occurred
  */
-export declare class ACL extends APIClient {
+export declare class Acls extends APIClient {
     /**
-     * Constructs a new ACL API object.
+     * Constructs a new API object.
      *
      * @param {ClientOptions} options - Options to indicate the objects endpoint
      * @see module:core:APIClient
@@ -32,12 +32,12 @@ export declare class ACL extends APIClient {
     /**
      * Creates a new AccessControlList on Routr.
      *
-     * @param {CreateACLRequest} request - The request to create an ACL
+     * @param {CreateAclRequest} request - The request to create an ACL
      * @param {string} request.name - Name of the ACL
      * @param {string[]} request.allow - List of IP addresses or CIDR blocks to allow
      * @param {string[]} request.deny - List of IP addresses or CIDR blocks to deny
      * @param {Object} request.extended - Optional extended attributes
-     * @return {Promise<CreateACLResponse>} The newly created AccessControlList
+     * @return {Promise<CreateAclResponse>} The newly created AccessControlList
      * @throws if request is null
      * @example
      *
@@ -47,20 +47,20 @@ export declare class ACL extends APIClient {
      *   deny: "0.0.0.0/0"
      * }
      *
-     * acl.createACL(request)
+     * acl.createAcl(request)
      *   .then(console.log)
      *   .catch(console.error)   // an error occurred
      */
-    createACL(request: CreateACLRequest): Promise<CreateACLResponse>;
+    createAcl(request: CreateAclRequest): Promise<CreateAclResponse>;
     /**
      * Updates an already existing AccessControlList on Routr.
      *
-     * @param {UpdateACLRequest} request - Partial with the fields to update
+     * @param {UpdateAclRequest} request - Partial with the fields to update
      * @param {string} request.name - Name of the ACL
      * @param {string[]} request.allow - List of IP addresses or CIDR blocks to allow
      * @param {string[]} request.deny - List of IP addresses or CIDR blocks to deny
      * @param {Object} request.extended - Optional extended attributes
-     * @return {Promise<UpdateACLResponse>} The AccessControlList
+     * @return {Promise<UpdateAclResponse>} The AccessControlList
      * @example
      *
      * const request = {
@@ -68,25 +68,25 @@ export declare class ACL extends APIClient {
      *   name: "Peer network updated",
      * }
      *
-     * acl.updateACL(request)
+     * acl.updateAcl(request)
      *   .then(console.log)
      *   .catch(console.error)   // an error occurred
      */
-    updateACL(request: UpdateACLRequest): Promise<UpdateACLResponse>;
+    updateAcl(request: UpdateAclRequest): Promise<UpdateAclResponse>;
     /**
      * Gets an AccessControlList from Routr.
      *
      * @param {string} ref - The ACL reference
-     * @return {Promise<GetACLResponse>} The AccessControlList
+     * @return {Promise<GetAclResponse>} The AccessControlList
      * @example
      *
      * const ref = "4671371b-ff5d-48b1-aabe-d3c5ca5317a3"
      *
-     * acl.getACL(ref)
+     * acl.getAcl(ref)
      *   .then(console.log)
      *   .catch(console.error)   // an error occurred
      */
-    getACL(ref: string): Promise<GetACLResponse>;
+    getAcl(ref: string): Promise<GetAclResponse>;
     /**
      * Deletes an AccessControlList from Routr.
      *
@@ -96,27 +96,27 @@ export declare class ACL extends APIClient {
      *
      * const ref = "4671371b-ff5d-48b1-aabe-d3c5ca5317a3"
      *
-     * acl.deleteACL(ref)
+     * acl.deleteAcl(ref)
      *   .then(console.log)
      *   .catch(console.error)   // an error occurred
      */
-    deleteACL(ref: string): Promise<void>;
+    deleteAcl(ref: string): Promise<void>;
     /**
      * Lists all AccessControlLists from Routr with pagination.
      *
-     * @param {ListACLRequest} request - The request to list ACLs
+     * @param {ListAclRequest} request - The request to list ACLs
      * @param {number} request.pageSize - The number of ACLs to return
      * @param {string} request.pageToken - The page token to use for pagination
-     * @return {Promise<ListACLResponse>} The list of AccessControlLists
+     * @return {Promise<ListAclResponse>} The list of AccessControlLists
      * @example
      *
      * const request = {
      *  pageSize: 10
      * }
      *
-     * acl.listACLs(request)
+     * acl.listAcls(request)
      *   .then(console.log)
      *   .catch(console.error)   // an error occurred
      */
-    listACLs(request: ListACLRequest): Promise<ListACLResponse>;
+    listAcls(request: ListAclRequest): Promise<ListAclResponse>;
 }

package/dist/{acl → acls}/acl.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ACL = void 0;
+exports.Acls = void 0;
 /*
  * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
@@ -37,7 +37,7 @@ const client_1 = require("../client");
  * @example
  *
  * const SDK = require("@routr/sdk")
- * const acl = new SDK.ACL()
+ * const acl = new SDK.Acls()
  *
  * const request = {
  *   name: "Peer network",
@@ -45,13 +45,13 @@ const client_1 = require("../client");
  *   deny: "0.0.0.0/0"
  * }
  *
- * acl.createACL(request)
+ * acl.createAcl(request)
  *   .then(console.log)
  *   .catch(console.error)   // an error occurred
  */
-class ACL extends client_1.APIClient {
+class Acls extends client_1.APIClient {
     /**
-     * Constructs a new ACL API object.
+     * Constructs a new API object.
      *
      * @param {ClientOptions} options - Options to indicate the objects endpoint
      * @see module:core:APIClient
@@ -62,12 +62,12 @@ class ACL extends client_1.APIClient {
     /**
      * Creates a new AccessControlList on Routr.
      *
-     * @param {CreateACLRequest} request - The request to create an ACL
+     * @param {CreateAclRequest} request - The request to create an ACL
      * @param {string} request.name - Name of the ACL
      * @param {string[]} request.allow - List of IP addresses or CIDR blocks to allow
      * @param {string[]} request.deny - List of IP addresses or CIDR blocks to deny
      * @param {Object} request.extended - Optional extended attributes
-     * @return {Promise<CreateACLResponse>} The newly created AccessControlList
+     * @return {Promise<CreateAclResponse>} The newly created AccessControlList
      * @throws if request is null
      * @example
      *
@@ -77,24 +77,24 @@ class ACL extends client_1.APIClient {
      *   deny: "0.0.0.0/0"
      * }
      *
-     * acl.createACL(request)
+     * acl.createAcl(request)
      *   .then(console.log)
      *   .catch(console.error)   // an error occurred
      */
-    createACL(request) {
+    createAcl(request) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.client.acl.create(request);
+            return yield this.client.acl.create(request);
         });
     }
     /**
      * Updates an already existing AccessControlList on Routr.
      *
-     * @param {UpdateACLRequest} request - Partial with the fields to update
+     * @param {UpdateAclRequest} request - Partial with the fields to update
      * @param {string} request.name - Name of the ACL
      * @param {string[]} request.allow - List of IP addresses or CIDR blocks to allow
      * @param {string[]} request.deny - List of IP addresses or CIDR blocks to deny
      * @param {Object} request.extended - Optional extended attributes
-     * @return {Promise<UpdateACLResponse>} The AccessControlList
+     * @return {Promise<UpdateAclResponse>} The AccessControlList
      * @example
      *
      * const request = {
@@ -102,11 +102,11 @@ class ACL extends client_1.APIClient {
      *   name: "Peer network updated",
      * }
      *
-     * acl.updateACL(request)
+     * acl.updateAcl(request)
      *   .then(console.log)
      *   .catch(console.error)   // an error occurred
      */
-    updateACL(request) {
+    updateAcl(request) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.client.acl.update(request);
         });
@@ -115,18 +115,18 @@ class ACL extends client_1.APIClient {
      * Gets an AccessControlList from Routr.
      *
      * @param {string} ref - The ACL reference
-     * @return {Promise<GetACLResponse>} The AccessControlList
+     * @return {Promise<GetAclResponse>} The AccessControlList
      * @example
      *
      * const ref = "4671371b-ff5d-48b1-aabe-d3c5ca5317a3"
      *
-     * acl.getACL(ref)
+     * acl.getAcl(ref)
      *   .then(console.log)
      *   .catch(console.error)   // an error occurred
      */
-    getACL(ref) {
+    getAcl(ref) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.client.acl.get(ref);
+            return yield this.client.acl.get(ref);
         });
     }
     /**
@@ -138,11 +138,11 @@ class ACL extends client_1.APIClient {
      *
      * const ref = "4671371b-ff5d-48b1-aabe-d3c5ca5317a3"
      *
-     * acl.deleteACL(ref)
+     * acl.deleteAcl(ref)
      *   .then(console.log)
      *   .catch(console.error)   // an error occurred
      */
-    deleteACL(ref) {
+    deleteAcl(ref) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.client.acl.del(ref);
         });
@@ -150,24 +150,24 @@ class ACL extends client_1.APIClient {
     /**
      * Lists all AccessControlLists from Routr with pagination.
      *
-     * @param {ListACLRequest} request - The request to list ACLs
+     * @param {ListAclRequest} request - The request to list ACLs
      * @param {number} request.pageSize - The number of ACLs to return
      * @param {string} request.pageToken - The page token to use for pagination
-     * @return {Promise<ListACLResponse>} The list of AccessControlLists
+     * @return {Promise<ListAclResponse>} The list of AccessControlLists
      * @example
      *
      * const request = {
      *  pageSize: 10
      * }
      *
-     * acl.listACLs(request)
+     * acl.listAcls(request)
      *   .then(console.log)
      *   .catch(console.error)   // an error occurred
      */
-    listACLs(request) {
+    listAcls(request) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.client.acl.list(request);
         });
     }
 }
-exports.ACL = ACL;
+exports.Acls = Acls;

package/dist/acls/index.d.ts

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

package/dist/{acl → acls}/index.js

@@ -35,4 +35,4 @@ exports.default = void 0;
  */
 __exportStar(require("./acl"), exports);
 var acl_1 = require("./acl");
-Object.defineProperty(exports, "default", { enumerable: true, get: function () { return acl_1.ACL; } });
+Object.defineProperty(exports, "default", { enumerable: true, get: function () { return acl_1.Acls; } });

package/dist/acls/types.d.ts

@@ -0,0 +1,11 @@
+import { CommonConnect as CC } from "@routr/common";
+import { CreateBaseOmit, Flatten } from "../types";
+export type CreateAclRequest = Omit<CC.AccessControlList, CreateBaseOmit>;
+export type CreateAclResponse = Flatten<CC.AccessControlList>;
+export type UpdateAclRequest = Flatten<{
+    ref: string;
+} & Partial<CreateAclRequest>>;
+export type UpdateAclResponse = Flatten<CC.AccessControlList>;
+export type ListAclRequest = Flatten<CC.ListRequest>;
+export type ListAclResponse = Flatten<CC.ListResponse<CC.AccessControlList>>;
+export type GetAclResponse = Flatten<CC.AccessControlList>;

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import ACL from "./acl";
+import Acls from "./acls";
 import Agents from "./agents";
 import Domains from "./domains";
 import Credentials from "./credentials";
@@ -6,7 +6,7 @@ import Peers from "./peers";
 import Numbers from "./numbers";
 import Trunks from "./trunks";
 declare const SDK: {
-    ACL: typeof ACL;
+    Acls: typeof Acls;
     Agents: typeof Agents;
     Domains: typeof Domains;
     Numbers: typeof Numbers;

package/dist/index.js

@@ -22,7 +22,7 @@ exports.default = void 0;
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-const acl_1 = __importDefault(require("./acl"));
+const acls_1 = __importDefault(require("./acls"));
 const agents_1 = __importDefault(require("./agents"));
 const domains_1 = __importDefault(require("./domains"));
 const credentials_1 = __importDefault(require("./credentials"));
@@ -30,7 +30,7 @@ const peers_1 = __importDefault(require("./peers"));
 const numbers_1 = __importDefault(require("./numbers"));
 const trunks_1 = __importDefault(require("./trunks"));
 const SDK = {
-    ACL: acl_1.default,
+    Acls: acls_1.default,
     Agents: agents_1.default,
     Domains: domains_1.default,
     Numbers: numbers_1.default,

package/dist/numbers/numbers.d.ts

@@ -51,7 +51,7 @@ export declare class Numbers extends APIClient {
      * @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 {JsonObject[]} request.extraHeaders - Extra headers to be used (e.g., [\{name: "X-Room-Id", value: "abc-us-123"\}])
+     * @param {Array<{name: string, value: string}>} - Extra headers to be used (e.g., [\{name: "X-Room-Id", value: "abc-us-123"\}])
      * @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
@@ -88,7 +88,7 @@ export declare class Numbers extends APIClient {
      * @param {UpdateNumberRequest} request - Partial with the fields to update
      * @param {string} request.name - Name of the Number
      * @param {string} request.aorLink - The AOR link to be used (e.g., sip:1001@sip.local)
-     * @param {JsonObject[]} request.extraHeaders - Extra headers to be used (e.g., [\{name: "X-Room-Id", value: "abc-us-123"\}])
+     * @param {Array<{name: string, value: string}>} request.extraHeaders - Extra headers to be used (e.g., [\{name: "X-Room-Id", value: "abc-us-123"\}])
      * @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

package/dist/numbers/numbers.js

@@ -81,7 +81,7 @@ class Numbers extends client_1.APIClient {
      * @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 {JsonObject[]} request.extraHeaders - Extra headers to be used (e.g., [\{name: "X-Room-Id", value: "abc-us-123"\}])
+     * @param {Array<{name: string, value: string}>} - Extra headers to be used (e.g., [\{name: "X-Room-Id", value: "abc-us-123"\}])
      * @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
@@ -122,7 +122,7 @@ class Numbers extends client_1.APIClient {
      * @param {UpdateNumberRequest} request - Partial with the fields to update
      * @param {string} request.name - Name of the Number
      * @param {string} request.aorLink - The AOR link to be used (e.g., sip:1001@sip.local)
-     * @param {JsonObject[]} request.extraHeaders - Extra headers to be used (e.g., [\{name: "X-Room-Id", value: "abc-us-123"\}])
+     * @param {Array<{name: string, value: string}>} request.extraHeaders - Extra headers to be used (e.g., [\{name: "X-Room-Id", value: "abc-us-123"\}])
      * @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

package/dist/trunks/types.d.ts

@@ -1,11 +1,11 @@
 import { CommonConnect as CC } from "@routr/common";
-import { CreateBaseOmit } from "../types";
+import { CreateBaseOmit, Flatten } from "../types";
 export type CreateTrunkRequest = Omit<CC.Trunk, CreateBaseOmit | "accessControlList" | "inboundCredentials" | "outboundCredentials">;
-export type CreateTrunkResponse = CC.Trunk;
-export type UpdateTrunkRequest = {
+export type CreateTrunkResponse = Flatten<CC.Trunk>;
+export type UpdateTrunkRequest = Flatten<{
     ref: string;
-} & Partial<CreateTrunkRequest>;
-export type UpdateTrunkResponse = CC.Trunk;
-export type ListTrunkRequest = CC.ListRequest;
-export type ListTrunkResponse = CC.ListResponse<CC.Trunk>;
-export type GetTrunkResponse = CC.Trunk;
+} & Partial<CreateTrunkRequest>>;
+export type UpdateTrunkResponse = Flatten<CC.Trunk>;
+export type ListTrunkRequest = Flatten<CC.ListRequest>;
+export type ListTrunkResponse = Flatten<CC.ListResponse<CC.Trunk>>;
+export type GetTrunkResponse = Flatten<CC.Trunk>;

package/dist/types.d.ts

@@ -5,4 +5,7 @@ export interface ClientOptions {
     password?: string;
     cacert?: string;
 }
+export type Flatten<T> = {
+    [K in keyof T]: T[K];
+};
 export type CreateBaseOmit = "ref" | "apiVersion" | "createdAt" | "updatedAt";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@routr/sdk",
-  "version": "2.12.1",
+  "version": "2.13.0",
   "description": "The Routr SDK for Node.js",
   "author": "Pedro Sanders <psanders@fonoster.com>",
   "homepage": "https://github.com/fonoster/routr#readme",
@@ -27,7 +27,7 @@
     "@opentelemetry/sdk-trace-base": "^1.0.4",
     "@opentelemetry/sdk-trace-node": "^1.0.4",
     "@opentelemetry/semantic-conventions": "^1.0.4",
-    "@routr/common": "^2.12.1",
+    "@routr/common": "^2.13.0",
     "google-protobuf": "^3.9.2",
     "pb-util": "^1.0.3"
   },
@@ -47,5 +47,5 @@
   "devDependencies": {
     "@types/google-protobuf": "^3.15.6"
   },
-  "gitHead": "cf4c8276173ec4be0a8013e70935b6cffb29cda4"
+  "gitHead": "6272ef833472f0df1204073739c48eeb37ce705f"
 }

package/dist/acl/index.d.ts

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

package/dist/acl/types.d.ts

@@ -1,11 +0,0 @@
-import { CommonConnect as CC } from "@routr/common";
-import { CreateBaseOmit } from "../types";
-export type CreateACLRequest = Omit<CC.AccessControlList, CreateBaseOmit>;
-export type CreateACLResponse = CC.AccessControlList;
-export type UpdateACLRequest = {
-    ref: string;
-} & Partial<CreateACLRequest>;
-export type UpdateACLResponse = CC.AccessControlList;
-export type ListACLRequest = CC.ListRequest;
-export type ListACLResponse = CC.ListResponse<CC.AccessControlList>;
-export type GetACLResponse = CC.AccessControlList;