@routr/sdk 2.1.11 → 2.1.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (14) hide show
  1. package/README.md +1323 -0
  2. package/dist/acl/acl.d.ts +2 -2
  3. package/dist/acl/acl.js +2 -2
  4. package/dist/agents/agents.d.ts +4 -4
  5. package/dist/agents/agents.js +4 -4
  6. package/dist/credentials/credentials.d.ts +2 -2
  7. package/dist/credentials/credentials.js +2 -2
  8. package/dist/numbers/numbers.d.ts +5 -5
  9. package/dist/numbers/numbers.js +5 -5
  10. package/dist/peers/peers.d.ts +2 -2
  11. package/dist/peers/peers.js +2 -2
  12. package/dist/trunks/trunks.d.ts +1 -1
  13. package/dist/trunks/trunks.js +1 -1
  14. package/package.json +4 -3
package/dist/acl/acl.d.ts CHANGED
@@ -36,7 +36,7 @@ export declare class ACL extends APIClient {
36
36
  * @param {string} request.name - Name of the ACL
37
37
  * @param {string[]} request.allow - List of IP addresses or CIDR blocks to allow
38
38
  * @param {string[]} request.deny - List of IP addresses or CIDR blocks to deny
39
- * @param {JsonObject} request.extended - Optional extended attributes
39
+ * @param {Object} request.extended - Optional extended attributes
40
40
  * @return {Promise<CreateACLResponse>} The newly created AccessControlList
41
41
  * @throws if request is null
42
42
  * @example
@@ -59,7 +59,7 @@ export declare class ACL extends APIClient {
59
59
  * @param {string} request.name - Name of the ACL
60
60
  * @param {string[]} request.allow - List of IP addresses or CIDR blocks to allow
61
61
  * @param {string[]} request.deny - List of IP addresses or CIDR blocks to deny
62
- * @param {JsonObject} request.extended - Optional extended attributes
62
+ * @param {Object} request.extended - Optional extended attributes
63
63
  * @return {Promise<UpdateACLResponse>} The AccessControlList
64
64
  * @example
65
65
  *
package/dist/acl/acl.js CHANGED
@@ -66,7 +66,7 @@ class ACL extends client_1.APIClient {
66
66
  * @param {string} request.name - Name of the ACL
67
67
  * @param {string[]} request.allow - List of IP addresses or CIDR blocks to allow
68
68
  * @param {string[]} request.deny - List of IP addresses or CIDR blocks to deny
69
- * @param {JsonObject} request.extended - Optional extended attributes
69
+ * @param {Object} request.extended - Optional extended attributes
70
70
  * @return {Promise<CreateACLResponse>} The newly created AccessControlList
71
71
  * @throws if request is null
72
72
  * @example
@@ -93,7 +93,7 @@ class ACL extends client_1.APIClient {
93
93
  * @param {string} request.name - Name of the ACL
94
94
  * @param {string[]} request.allow - List of IP addresses or CIDR blocks to allow
95
95
  * @param {string[]} request.deny - List of IP addresses or CIDR blocks to deny
96
- * @param {JsonObject} request.extended - Optional extended attributes
96
+ * @param {Object} request.extended - Optional extended attributes
97
97
  * @return {Promise<UpdateACLResponse>} The AccessControlList
98
98
  * @example
99
99
  *
package/dist/agents/agents.d.ts CHANGED
@@ -41,11 +41,11 @@ export declare class Agents extends APIClient {
41
41
  * @param {CreateAgentRequest} request - The request to create an Agent
42
42
  * @param {string} request.name - Name of the Agent
43
43
  * @param {string} request.username - Username of the Agent
44
- * @param {Privacy} request.privacy - Privacy of the Agent (e.g. Privacy.PRIVATE)
44
+ * @param {Privacy} request.privacy - Privacy of the Agent (e.g., Privacy.PRIVATE)
45
45
  * @param {string} request.domainRef - Domain reference of the Domain the Agent belongs to
46
46
  * @param {string} request.credentialsRef - Credentials reference of the Credentials for the Agent
47
47
  * @param {boolean} request.enabled - Whether the Agent is enabled or not (for future use)
48
- * @param {JsonObject} request.extended - Optional extended attributes
48
+ * @param {Object} request.extended - Optional extended attributes
49
49
  * @return {Promise<CreateAgentResponse>} The newly created Agent
50
50
  * @throws if request is null
51
51
  * @example
@@ -72,11 +72,11 @@ export declare class Agents extends APIClient {
72
72
  *
73
73
  * @param {UpdateAgentRequest} request - Partial with the fields to update
74
74
  * @param {string} request.name - Name of the Agent
75
- * @param {Privacy} request.privacy - Privacy of the Agent (e.g. Privacy.PRIVATE)
75
+ * @param {Privacy} request.privacy - Privacy of the Agent (e.g., Privacy.PRIVATE)
76
76
  * @param {string} request.domainRef - Domain reference of the Domain the Agent belongs to
77
77
  * @param {string} request.credentialsRef - Credentials reference of the Credentials for the Agent
78
78
  * @param {boolean} request.enabled - Whether the Agent is enabled or not (for future use)
79
- * @param {JsonObject} request.extended - Optional extended attributes
79
+ * @param {Object} request.extended - Optional extended attributes
80
80
  * @return {Promise<UpdateAgentResponse>} The updated Agent
81
81
  * @example
82
82
  *
package/dist/agents/agents.js CHANGED
@@ -71,11 +71,11 @@ class Agents extends client_1.APIClient {
71
71
  * @param {CreateAgentRequest} request - The request to create an Agent
72
72
  * @param {string} request.name - Name of the Agent
73
73
  * @param {string} request.username - Username of the Agent
74
- * @param {Privacy} request.privacy - Privacy of the Agent (e.g. Privacy.PRIVATE)
74
+ * @param {Privacy} request.privacy - Privacy of the Agent (e.g., Privacy.PRIVATE)
75
75
  * @param {string} request.domainRef - Domain reference of the Domain the Agent belongs to
76
76
  * @param {string} request.credentialsRef - Credentials reference of the Credentials for the Agent
77
77
  * @param {boolean} request.enabled - Whether the Agent is enabled or not (for future use)
78
- * @param {JsonObject} request.extended - Optional extended attributes
78
+ * @param {Object} request.extended - Optional extended attributes
79
79
  * @return {Promise<CreateAgentResponse>} The newly created Agent
80
80
  * @throws if request is null
81
81
  * @example
@@ -106,11 +106,11 @@ class Agents extends client_1.APIClient {
106
106
  *
107
107
  * @param {UpdateAgentRequest} request - Partial with the fields to update
108
108
  * @param {string} request.name - Name of the Agent
109
- * @param {Privacy} request.privacy - Privacy of the Agent (e.g. Privacy.PRIVATE)
109
+ * @param {Privacy} request.privacy - Privacy of the Agent (e.g., Privacy.PRIVATE)
110
110
  * @param {string} request.domainRef - Domain reference of the Domain the Agent belongs to
111
111
  * @param {string} request.credentialsRef - Credentials reference of the Credentials for the Agent
112
112
  * @param {boolean} request.enabled - Whether the Agent is enabled or not (for future use)
113
- * @param {JsonObject} request.extended - Optional extended attributes
113
+ * @param {Object} request.extended - Optional extended attributes
114
114
  * @return {Promise<UpdateAgentResponse>} The updated Agent
115
115
  * @example
116
116
  *
package/dist/credentials/credentials.d.ts CHANGED
@@ -39,7 +39,7 @@ export declare class Credentials extends APIClient {
39
39
  * @param {string} request.name - The friendly name of the Credentials
40
40
  * @param {string} request.username - Username of the Credentials
41
41
  * @param {string} request.password - Password of the Credentials
42
- * @param {JsonObject} request.extended - Optional extended attributes
42
+ * @param {Object} request.extended - Optional extended attributes
43
43
  * @return {Promise<CreateCredentialsResponse>} The newly created Credentials
44
44
  * @throws if request is null
45
45
  * @example
@@ -65,7 +65,7 @@ export declare class Credentials extends APIClient {
65
65
  * @param {string} request.name - The friendly name of the Credentials
66
66
  * @param {string} request.username - Username of the Credentials
67
67
  * @param {string} request.password - Password of the Credentials
68
- * @param {JsonObject} request.extended - Optional extended attributes
68
+ * @param {Object} request.extended - Optional extended attributes
69
69
  * @return {Promise<UpdateCredentialsResponse>} The updated Credentials
70
70
  * @example
71
71
  *
package/dist/credentials/credentials.js CHANGED
@@ -69,7 +69,7 @@ class Credentials extends client_1.APIClient {
69
69
  * @param {string} request.name - The friendly name of the Credentials
70
70
  * @param {string} request.username - Username of the Credentials
71
71
  * @param {string} request.password - Password of the Credentials
72
- * @param {JsonObject} request.extended - Optional extended attributes
72
+ * @param {Object} request.extended - Optional extended attributes
73
73
  * @return {Promise<CreateCredentialsResponse>} The newly created Credentials
74
74
  * @throws if request is null
75
75
  * @example
@@ -99,7 +99,7 @@ class Credentials extends client_1.APIClient {
99
99
  * @param {string} request.name - The friendly name of the Credentials
100
100
  * @param {string} request.username - Username of the Credentials
101
101
  * @param {string} request.password - Password of the Credentials
102
- * @param {JsonObject} request.extended - Optional extended attributes
102
+ * @param {Object} request.extended - Optional extended attributes
103
103
  * @return {Promise<UpdateCredentialsResponse>} The updated Credentials
104
104
  * @example
105
105
  *
package/dist/numbers/numbers.d.ts CHANGED
@@ -46,12 +46,12 @@ export declare class Numbers extends APIClient {
46
46
  *
47
47
  * @param {CreateNumberRequest} request - The request to create an Number
48
48
  * @param {string} request.name - Name of the Number
49
- * @param {string} request.telUrl - The number URI to be used (e.g. te:+1234567890)
50
- * @param {string} request.aorLink - The AOR link to be used (e.g. sip:1001@sip.local)
49
+ * @param {string} request.telUrl - The number URI to be used (e.g., te:+1234567890)
50
+ * @param {string} request.aorLink - The AOR link to be used (e.g., sip:1001@sip.local)
51
51
  * @param {string} request.city - The city where the number is located
52
52
  * @param {string} request.country - The country where the number is located
53
53
  * @param {string} request.countryISOCode - The country ISO code where the number is located
54
- * @param {{ name: string, value: string}[]} request.extraHeaders - Extra headers to be used
54
+ * @param {Object[]} request.extraHeaders - Extra headers to be used (e.g., [{name: "X-Room-Id", value: "abc-us-123"}])
55
55
  * @param {string} request.trunkRef - The Trunk reference to be used
56
56
  * @param {string} request.sessionAffinityHeader - Optional session affinity header
57
57
  * @param {string} request.extended - Optional extended attributes
@@ -87,8 +87,8 @@ export declare class Numbers extends APIClient {
87
87
  *
88
88
  * @param {UpdateNumberRequest} request - Partial with the fields to update
89
89
  * @param {string} request.name - Name of the Number
90
- * @param {string} request.aorLink - The AOR link to be used (e.g. sip:1001@sip.local)
91
- * @param {{ name: string, value: string}[]} request.extraHeaders - Extra headers to be used
90
+ * @param {string} request.aorLink - The AOR link to be used (e.g., sip:1001@sip.local)
91
+ * @param {Object[]} request.extraHeaders - Extra headers to be used (e.g., [{name: "X-Room-Id", value: "abc-us-123"}])
92
92
  * @param {string} request.trunkRef - The Trunk reference to be used
93
93
  * @param {string} request.sessionAffinityHeader - Optional session affinity header
94
94
  * @param {string} request.extended - Optional extended attributes
package/dist/numbers/numbers.js CHANGED
@@ -76,12 +76,12 @@ class Numbers extends client_1.APIClient {
76
76
  *
77
77
  * @param {CreateNumberRequest} request - The request to create an Number
78
78
  * @param {string} request.name - Name of the Number
79
- * @param {string} request.telUrl - The number URI to be used (e.g. te:+1234567890)
80
- * @param {string} request.aorLink - The AOR link to be used (e.g. sip:1001@sip.local)
79
+ * @param {string} request.telUrl - The number URI to be used (e.g., te:+1234567890)
80
+ * @param {string} request.aorLink - The AOR link to be used (e.g., sip:1001@sip.local)
81
81
  * @param {string} request.city - The city where the number is located
82
82
  * @param {string} request.country - The country where the number is located
83
83
  * @param {string} request.countryISOCode - The country ISO code where the number is located
84
- * @param {{ name: string, value: string}[]} request.extraHeaders - Extra headers to be used
84
+ * @param {Object[]} request.extraHeaders - Extra headers to be used (e.g., [{name: "X-Room-Id", value: "abc-us-123"}])
85
85
  * @param {string} request.trunkRef - The Trunk reference to be used
86
86
  * @param {string} request.sessionAffinityHeader - Optional session affinity header
87
87
  * @param {string} request.extended - Optional extended attributes
@@ -121,8 +121,8 @@ class Numbers extends client_1.APIClient {
121
121
  *
122
122
  * @param {UpdateNumberRequest} request - Partial with the fields to update
123
123
  * @param {string} request.name - Name of the Number
124
- * @param {string} request.aorLink - The AOR link to be used (e.g. sip:1001@sip.local)
125
- * @param {{ name: string, value: string}[]} request.extraHeaders - Extra headers to be used
124
+ * @param {string} request.aorLink - The AOR link to be used (e.g., sip:1001@sip.local)
125
+ * @param {Object[]} request.extraHeaders - Extra headers to be used (e.g., [{name: "X-Room-Id", value: "abc-us-123"}])
126
126
  * @param {string} request.trunkRef - The Trunk reference to be used
127
127
  * @param {string} request.sessionAffinityHeader - Optional session affinity header
128
128
  * @param {string} request.extended - Optional extended attributes
package/dist/peers/peers.d.ts CHANGED
@@ -50,7 +50,7 @@ export declare class Peers extends APIClient {
50
50
  * @param {LoadBalancingAlgorithm} request.balancingAlgorithm - Optional balancing algorithm for the Peer (defaults to "round-robin")
51
51
  * @param {boolean} request.withSessionAffinity - Whether the Peer has session affinity or not (defaults to false)
52
52
  * @param {boolean} request.enabled - Whether the Peer is enabled or not (for future use)
53
- * @param {JsonObject} request.extended - Optional extended attributes
53
+ * @param {Object} request.extended - Optional extended attributes
54
54
  * @return {Promise<CreatePeerResponse>} The newly created Peer
55
55
  * @throws if request is null
56
56
  * @example
@@ -87,7 +87,7 @@ export declare class Peers extends APIClient {
87
87
  * @param {LoadBalancingAlgorithm} request.balancingAlgorithm - Optional balancing algorithm for the Peer (defaults to "round-robin")
88
88
  * @param {boolean} request.withSessionAffinity - Whether the Peer has session affinity or not (defaults to false)
89
89
  * @param {boolean} request.enabled - Whether the Peer is enabled or not (for future use)
90
- * @param {JsonObject} request.extended - Optional extended attributes
90
+ * @param {Object} request.extended - Optional extended attributes
91
91
  * @return {Promise<UpdatePeerResponse>} The updated Peer
92
92
  * @example
93
93
  *
package/dist/peers/peers.js CHANGED
@@ -80,7 +80,7 @@ class Peers extends client_1.APIClient {
80
80
  * @param {LoadBalancingAlgorithm} request.balancingAlgorithm - Optional balancing algorithm for the Peer (defaults to "round-robin")
81
81
  * @param {boolean} request.withSessionAffinity - Whether the Peer has session affinity or not (defaults to false)
82
82
  * @param {boolean} request.enabled - Whether the Peer is enabled or not (for future use)
83
- * @param {JsonObject} request.extended - Optional extended attributes
83
+ * @param {Object} request.extended - Optional extended attributes
84
84
  * @return {Promise<CreatePeerResponse>} The newly created Peer
85
85
  * @throws if request is null
86
86
  * @example
@@ -121,7 +121,7 @@ class Peers extends client_1.APIClient {
121
121
  * @param {LoadBalancingAlgorithm} request.balancingAlgorithm - Optional balancing algorithm for the Peer (defaults to "round-robin")
122
122
  * @param {boolean} request.withSessionAffinity - Whether the Peer has session affinity or not (defaults to false)
123
123
  * @param {boolean} request.enabled - Whether the Peer is enabled or not (for future use)
124
- * @param {JsonObject} request.extended - Optional extended attributes
124
+ * @param {Object} request.extended - Optional extended attributes
125
125
  * @return {Promise<UpdatePeerResponse>} The updated Peer
126
126
  * @example
127
127
  *
package/dist/trunks/trunks.d.ts CHANGED
@@ -90,7 +90,7 @@ export declare class Trunks extends APIClient {
90
90
  * @param {string} request.inboundCredentialsRef - The reference of the inbound credentials
91
91
  * @param {string} request.outboundCredentialsRef - The reference of the outbound credentials
92
92
  * @param {TrunkURI[]} request.uris - The outbound URIs of the Trunk
93
- * @param {JsonObject} request.extended - Optional extended attributes
93
+ * @param {Object} request.extended - Optional extended attributes
94
94
  * @return {Promise<UpdateTrunkResponse>} The updated Trunk
95
95
  * @example
96
96
  *
package/dist/trunks/trunks.js CHANGED
@@ -124,7 +124,7 @@ class Trunks extends client_1.APIClient {
124
124
  * @param {string} request.inboundCredentialsRef - The reference of the inbound credentials
125
125
  * @param {string} request.outboundCredentialsRef - The reference of the outbound credentials
126
126
  * @param {TrunkURI[]} request.uris - The outbound URIs of the Trunk
127
- * @param {JsonObject} request.extended - Optional extended attributes
127
+ * @param {Object} request.extended - Optional extended attributes
128
128
  * @return {Promise<UpdateTrunkResponse>} The updated Trunk
129
129
  * @example
130
130
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@routr/sdk",
3
- "version": "2.1.11",
3
+ "version": "2.1.13",
4
4
  "description": "The Routr SDK for Node.js",
5
5
  "author": "Pedro Sanders <psanders@fonoster.com>",
6
6
  "homepage": "https://github.com/fonoster/routr#readme",
@@ -13,7 +13,8 @@
13
13
  },
14
14
  "scripts": {
15
15
  "prebuild": "rimraf ./dist tsconfig.tsbuildinfo",
16
- "build": "tsc -b tsconfig.json"
16
+ "build": "tsc -b tsconfig.json",
17
+ "gen:readme": "node ../../.scripts/gen-readme.js"
17
18
  },
18
19
  "dependencies": {
19
20
  "@fonoster/logger": "0.3.20",
@@ -46,5 +47,5 @@
46
47
  "devDependencies": {
47
48
  "@types/google-protobuf": "^3.15.6"
48
49
  },
49
- "gitHead": "7c3161336c29feb497a256018a08b65c1dedd0fd"
50
+ "gitHead": "a39e814fd1bdb15b59b61350680577609a6e7445"
50
51
  }