@routr/sdk 2.32.3 → 2.34.0

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.
package/README.md CHANGED
@@ -810,6 +810,7 @@ Creates a new Number on Routr.
810
810
  | request.countryIsoCode | <code>string</code> | The country ISO code where the number is located |
811
811
  | | <code>Array.&lt;{name: string, value: string}&gt;</code> | Extra headers to be used (e.g., [\{name: "X-Room-Id", value: "abc-us-123"\}]) |
812
812
  | request.trunkRef | <code>string</code> | The Trunk reference to be used |
813
+ | request.aliases | <code>Array.&lt;string&gt;</code> | Optional identifiers the Trunk sends instead of the number (e.g., ["01234"]); unique within the Trunk |
813
814
  | request.sessionAffinityHeader | <code>string</code> | Optional session affinity header |
814
815
  | request.extended | <code>string</code> | Optional extended attributes |
815
816
 
@@ -818,6 +819,7 @@ Creates a new Number on Routr.
818
819
  const request = {
819
820
  name: "(415) 555-1212",
820
821
  telUrl: "teL:+14155551212",
822
+ aliases: ["01234"],
821
823
  trunkRef: "6f941c63-880c-419a-a72a-4a107cbaf5c5",
822
824
  aorLink: "sip:100@sip.local",
823
825
  city: "San Francisco",
@@ -852,6 +854,8 @@ Updates an already existing Number on Routr.
852
854
  | request.aorLink | <code>string</code> | The AOR link to be used (e.g., sip:1001@sip.local) |
853
855
  | 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"\}]) |
854
856
  | request.trunkRef | <code>string</code> | The Trunk reference to be used |
857
+ | request.aliases | <code>Array.&lt;string&gt;</code> | A non-empty list replaces the Number's aliases; an empty list keeps them |
858
+ | request.clearAliases | <code>boolean</code> | Set to true to remove every alias |
855
859
  | request.sessionAffinityHeader | <code>string</code> | Optional session affinity header |
856
860
  | request.extended | <code>string</code> | Optional extended attributes |
857
861
 
@@ -53,6 +53,7 @@ export declare class Numbers extends APIClient {
53
53
  * @param {string} request.countryIsoCode - The country ISO code where the number is located
54
54
  * @param {Array<{name: string, value: string}>} - 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
+ * @param {string[]} request.aliases - Optional identifiers the Trunk sends instead of the number (e.g., ["01234"]); unique within the Trunk
56
57
  * @param {string} request.sessionAffinityHeader - Optional session affinity header
57
58
  * @param {string} request.extended - Optional extended attributes
58
59
  * @return {Promise<CreateNumberResponse>} The newly created Number
@@ -62,6 +63,7 @@ export declare class Numbers extends APIClient {
62
63
  * const request = {
63
64
  * name: "(415) 555-1212",
64
65
  * telUrl: "teL:+14155551212",
66
+ * aliases: ["01234"],
65
67
  * trunkRef: "6f941c63-880c-419a-a72a-4a107cbaf5c5",
66
68
  * aorLink: "sip:100@sip.local",
67
69
  * city: "San Francisco",
@@ -90,6 +92,8 @@ export declare class Numbers extends APIClient {
90
92
  * @param {string} request.aorLink - The AOR link to be used (e.g., sip:1001@sip.local)
91
93
  * @param {Array<{name: string, value: string}>} request.extraHeaders - Extra headers to be used (e.g., [\{name: "X-Room-Id", value: "abc-us-123"\}])
92
94
  * @param {string} request.trunkRef - The Trunk reference to be used
95
+ * @param {string[]} request.aliases - A non-empty list replaces the Number's aliases; an empty list keeps them
96
+ * @param {boolean} request.clearAliases - Set to true to remove every alias
93
97
  * @param {string} request.sessionAffinityHeader - Optional session affinity header
94
98
  * @param {string} request.extended - Optional extended attributes
95
99
  * @return {Promise<UpdateNumberResponse>} The updated Number
@@ -83,6 +83,7 @@ class Numbers extends client_1.APIClient {
83
83
  * @param {string} request.countryIsoCode - The country ISO code where the number is located
84
84
  * @param {Array<{name: string, value: string}>} - 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
+ * @param {string[]} request.aliases - Optional identifiers the Trunk sends instead of the number (e.g., ["01234"]); unique within the Trunk
86
87
  * @param {string} request.sessionAffinityHeader - Optional session affinity header
87
88
  * @param {string} request.extended - Optional extended attributes
88
89
  * @return {Promise<CreateNumberResponse>} The newly created Number
@@ -92,6 +93,7 @@ class Numbers extends client_1.APIClient {
92
93
  * const request = {
93
94
  * name: "(415) 555-1212",
94
95
  * telUrl: "teL:+14155551212",
96
+ * aliases: ["01234"],
95
97
  * trunkRef: "6f941c63-880c-419a-a72a-4a107cbaf5c5",
96
98
  * aorLink: "sip:100@sip.local",
97
99
  * city: "San Francisco",
@@ -124,6 +126,8 @@ class Numbers extends client_1.APIClient {
124
126
  * @param {string} request.aorLink - The AOR link to be used (e.g., sip:1001@sip.local)
125
127
  * @param {Array<{name: string, value: string}>} request.extraHeaders - Extra headers to be used (e.g., [\{name: "X-Room-Id", value: "abc-us-123"\}])
126
128
  * @param {string} request.trunkRef - The Trunk reference to be used
129
+ * @param {string[]} request.aliases - A non-empty list replaces the Number's aliases; an empty list keeps them
130
+ * @param {boolean} request.clearAliases - Set to true to remove every alias
127
131
  * @param {string} request.sessionAffinityHeader - Optional session affinity header
128
132
  * @param {string} request.extended - Optional extended attributes
129
133
  * @return {Promise<UpdateNumberResponse>} The updated Number
@@ -4,6 +4,7 @@ export type CreateNumberRequest = Omit<CC.INumber, CreateBaseOmit | "trunk">;
4
4
  export type CreateNumberResponse = CC.INumber;
5
5
  export type UpdateNumberRequest = {
6
6
  ref: string;
7
+ clearAliases?: boolean;
7
8
  } & Partial<Omit<CreateNumberRequest, "telUrl" | "city" | "country" | "countryIsoCode">>;
8
9
  export type UpdateNumberResponse = CC.INumber;
9
10
  export type ListNumberRequest = CC.ListRequest;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@routr/sdk",
3
- "version": "2.32.3",
3
+ "version": "2.34.0",
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",
@@ -19,7 +19,7 @@
19
19
  "dependencies": {
20
20
  "@fonoster/logger": "0.6.0",
21
21
  "@grpc/grpc-js": "~1.14.6",
22
- "@routr/common": "^2.32.3",
22
+ "@routr/common": "^2.34.0",
23
23
  "google-protobuf": "^3.21.4",
24
24
  "pb-util": "^1.0.3"
25
25
  },
@@ -39,5 +39,5 @@
39
39
  "devDependencies": {
40
40
  "@types/google-protobuf": "^3.15.6"
41
41
  },
42
- "gitHead": "88199378914c62dbd44cf187c7892ce8435c3ca3"
42
+ "gitHead": "7d2faf42bc43b7f3f1ac7d77097ffbca1b7cf4d2"
43
43
  }