@fonoster/sdk 0.15.16 → 0.15.18

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.
@@ -68,17 +68,24 @@ declare class Domains {
68
68
  * @param {CreateDomainRequest} request - The request object that contains the necessary information to create a new Domain
69
69
  * @param {string} request.name - The name of the Domain
70
70
  * @param {string} request.domainUri - The URI of the Domain
71
- * @param {AccessControlListRef} request.accessControlListRef - The reference to the Access Control List (ACL) to associate with the Domain
72
- * @param {EgressPolicy[]} request.egressPolicy - The egress policy of the Domain
73
- * @param {string} request.egressPolicy[].rule - A regular expression that defines which calls to send to the PSTN
74
- * @param {string} request.egressPolicy[].numberRef - The Number that will be used to send the call to the PSTN
71
+ * @param {string} request.accessControlListRef - The reference to the Access Control List (ACL) to associate with the Domain
72
+ * @param {EgressPolicy[]} request.egressPolicies - The egress policy of the Domain
73
+ * @param {string} request.egressPolicies[].rule - A regular expression that defines which calls to send to the PSTN
74
+ * @param {string} request.egressPolicies[].numberRef - The Number that will be used to send the call to the PSTN
75
75
  * @return {Promise<BaseApiObject>} - The response object that contains the reference to the created Domain
76
76
  * @example
77
77
  * const domains = new SDK.Domains(client); // Existing client object
78
78
  *
79
79
  * const request = {
80
80
  * name: "My Domain",
81
- * domainUri: "sip.project.fonoster.io"
81
+ * domainUri: "sip.project.fonoster.io",
82
+ * accessControlListRef: "00000000-0000-0000-0000-000000000001",
83
+ * egressPolicies: [
84
+ * {
85
+ * rule: ".*",
86
+ * numberRef: "00000000-0000-0000-0000-000000000002"
87
+ * }
88
+ * ]
82
89
  * };
83
90
  *
84
91
  * domains
@@ -91,7 +98,7 @@ declare class Domains {
91
98
  * Retrieves an existing Domain in the Workspace.
92
99
  *
93
100
  * @param {string} ref - The reference of the Domain to retrieve
94
- * @return {Promise<Acl>} - The response object that contains the Domain
101
+ * @return {Promise<Domain>} - The response object that contains the Domain with full ACL object
95
102
  * @example
96
103
  * const domains = new SDK.Domains(client); // Existing client object
97
104
  *
@@ -99,7 +106,12 @@ declare class Domains {
99
106
  *
100
107
  * domains
101
108
  * .getDomain(ref)
102
- * .then(console.log) // successful response
109
+ * .then((domain) => {
110
+ * console.log("Domain:", domain.name);
111
+ * console.log("ACL:", domain.accessControlList?.name);
112
+ * console.log("Allowed IPs:", domain.accessControlList?.allow);
113
+ * console.log("Denied IPs:", domain.accessControlList?.deny);
114
+ * })
103
115
  * .catch(console.error); // an error occurred
104
116
  */
105
117
  getDomain(ref: string): Promise<Domain>;
@@ -110,17 +122,23 @@ declare class Domains {
110
122
  * @param {string} request.ref - The reference of the Domain to update
111
123
  * @param {string} request.name - The name of the Domain
112
124
  * @param {string} request.domainUri - The URI of the Domain
113
- * @param {AccessControlListRef} request.accessControlListRef - The reference to the Access Control List (ACL) to associate with the Domain
114
- * @param {EgressPolicy[]} request.egressPolicy - The egress policy of the Domain
115
- * @param {string} request.egressPolicy[].rule - A regular expression that defines which calls to send to the PSTN
116
- * @param {string} request.egressPolicy[].numberRef - The Number that will be used to send the call to the PSTN
125
+ * @param {string} request.accessControlListRef - The reference to the Access Control List (ACL) to associate with the Domain
126
+ * @param {EgressPolicy[]} request.egressPolicies - The egress policy of the Domain
127
+ * @param {string} request.egressPolicies[].rule - A regular expression that defines which calls to send to the PSTN
128
+ * @param {string} request.egressPolicies[].numberRef - The Number that will be used to send the call to the PSTN
117
129
  * @return {Promise<BaseApiObject>} - The response object that contains the reference to the updated Domain
118
130
  * @example
119
131
  * const domains = new SDK.Domains(client); // Existing client object
120
132
  *
121
133
  * const request = {
122
134
  * ref: "00000000-0000-0000-0000-000000000000",
123
- * accessControlListRef: "00000000-0000-0000-0000-000000000001"
135
+ * accessControlListRef: "00000000-0000-0000-0000-000000000001",
136
+ * egressPolicies: [
137
+ * {
138
+ * rule: ".*",
139
+ * numberRef: "00000000-0000-0000-0000-000000000002"
140
+ * }
141
+ * ]
124
142
  * };
125
143
  *
126
144
  * domains
@@ -55,17 +55,24 @@ class Domains {
55
55
  * @param {CreateDomainRequest} request - The request object that contains the necessary information to create a new Domain
56
56
  * @param {string} request.name - The name of the Domain
57
57
  * @param {string} request.domainUri - The URI of the Domain
58
- * @param {AccessControlListRef} request.accessControlListRef - The reference to the Access Control List (ACL) to associate with the Domain
59
- * @param {EgressPolicy[]} request.egressPolicy - The egress policy of the Domain
60
- * @param {string} request.egressPolicy[].rule - A regular expression that defines which calls to send to the PSTN
61
- * @param {string} request.egressPolicy[].numberRef - The Number that will be used to send the call to the PSTN
58
+ * @param {string} request.accessControlListRef - The reference to the Access Control List (ACL) to associate with the Domain
59
+ * @param {EgressPolicy[]} request.egressPolicies - The egress policy of the Domain
60
+ * @param {string} request.egressPolicies[].rule - A regular expression that defines which calls to send to the PSTN
61
+ * @param {string} request.egressPolicies[].numberRef - The Number that will be used to send the call to the PSTN
62
62
  * @return {Promise<BaseApiObject>} - The response object that contains the reference to the created Domain
63
63
  * @example
64
64
  * const domains = new SDK.Domains(client); // Existing client object
65
65
  *
66
66
  * const request = {
67
67
  * name: "My Domain",
68
- * domainUri: "sip.project.fonoster.io"
68
+ * domainUri: "sip.project.fonoster.io",
69
+ * accessControlListRef: "00000000-0000-0000-0000-000000000001",
70
+ * egressPolicies: [
71
+ * {
72
+ * rule: ".*",
73
+ * numberRef: "00000000-0000-0000-0000-000000000002"
74
+ * }
75
+ * ]
69
76
  * };
70
77
  *
71
78
  * domains
@@ -86,7 +93,7 @@ class Domains {
86
93
  * Retrieves an existing Domain in the Workspace.
87
94
  *
88
95
  * @param {string} ref - The reference of the Domain to retrieve
89
- * @return {Promise<Acl>} - The response object that contains the Domain
96
+ * @return {Promise<Domain>} - The response object that contains the Domain with full ACL object
90
97
  * @example
91
98
  * const domains = new SDK.Domains(client); // Existing client object
92
99
  *
@@ -94,7 +101,12 @@ class Domains {
94
101
  *
95
102
  * domains
96
103
  * .getDomain(ref)
97
- * .then(console.log) // successful response
104
+ * .then((domain) => {
105
+ * console.log("Domain:", domain.name);
106
+ * console.log("ACL:", domain.accessControlList?.name);
107
+ * console.log("Allowed IPs:", domain.accessControlList?.allow);
108
+ * console.log("Denied IPs:", domain.accessControlList?.deny);
109
+ * })
98
110
  * .catch(console.error); // an error occurred
99
111
  */
100
112
  async getDomain(ref) {
@@ -113,17 +125,23 @@ class Domains {
113
125
  * @param {string} request.ref - The reference of the Domain to update
114
126
  * @param {string} request.name - The name of the Domain
115
127
  * @param {string} request.domainUri - The URI of the Domain
116
- * @param {AccessControlListRef} request.accessControlListRef - The reference to the Access Control List (ACL) to associate with the Domain
117
- * @param {EgressPolicy[]} request.egressPolicy - The egress policy of the Domain
118
- * @param {string} request.egressPolicy[].rule - A regular expression that defines which calls to send to the PSTN
119
- * @param {string} request.egressPolicy[].numberRef - The Number that will be used to send the call to the PSTN
128
+ * @param {string} request.accessControlListRef - The reference to the Access Control List (ACL) to associate with the Domain
129
+ * @param {EgressPolicy[]} request.egressPolicies - The egress policy of the Domain
130
+ * @param {string} request.egressPolicies[].rule - A regular expression that defines which calls to send to the PSTN
131
+ * @param {string} request.egressPolicies[].numberRef - The Number that will be used to send the call to the PSTN
120
132
  * @return {Promise<BaseApiObject>} - The response object that contains the reference to the updated Domain
121
133
  * @example
122
134
  * const domains = new SDK.Domains(client); // Existing client object
123
135
  *
124
136
  * const request = {
125
137
  * ref: "00000000-0000-0000-0000-000000000000",
126
- * accessControlListRef: "00000000-0000-0000-0000-000000000001"
138
+ * accessControlListRef: "00000000-0000-0000-0000-000000000001",
139
+ * egressPolicies: [
140
+ * {
141
+ * rule: ".*",
142
+ * numberRef: "00000000-0000-0000-0000-000000000002"
143
+ * }
144
+ * ]
127
145
  * };
128
146
  *
129
147
  * domains
@@ -241,7 +241,7 @@ deleteApplication: {
241
241
  responseSerialize: serialize_fonoster_applications_v1beta2_DeleteApplicationResponse,
242
242
  responseDeserialize: deserialize_fonoster_applications_v1beta2_DeleteApplicationResponse,
243
243
  },
244
- // Evaluate the intellgence for an Autopilot application
244
+ // Evaluate the intelligence for an Autopilot application
245
245
  evaluateIntelligence: {
246
246
  path: '/fonoster.applications.v1beta2.Applications/EvaluateIntelligence',
247
247
  requestStream: false,
@@ -43,7 +43,7 @@ goog.exportSymbol('proto.fonoster.domains.v1beta2.UpdateDomainResponse', null, g
43
43
  * @constructor
44
44
  */
45
45
  proto.fonoster.domains.v1beta2.Domain = function(opt_data) {
46
- jspb.Message.initialize(this, opt_data, 0, -1, null, null);
46
+ jspb.Message.initialize(this, opt_data, 0, -1, proto.fonoster.domains.v1beta2.Domain.repeatedFields_, null);
47
47
  };
48
48
  goog.inherits(proto.fonoster.domains.v1beta2.Domain, jspb.Message);
49
49
  if (goog.DEBUG && !COMPILED) {
@@ -264,6 +264,13 @@ if (goog.DEBUG && !COMPILED) {
264
264
  proto.fonoster.domains.v1beta2.ListDomainsResponse.displayName = 'proto.fonoster.domains.v1beta2.ListDomainsResponse';
265
265
  }
266
266
 
267
+ /**
268
+ * List of repeated fields within this message type.
269
+ * @private {!Array<number>}
270
+ * @const
271
+ */
272
+ proto.fonoster.domains.v1beta2.Domain.repeatedFields_ = [7];
273
+
267
274
 
268
275
 
269
276
  if (jspb.Message.GENERATE_TO_OBJECT) {
@@ -299,7 +306,10 @@ ref: jspb.Message.getFieldWithDefault(msg, 1, ""),
299
306
  name: jspb.Message.getFieldWithDefault(msg, 2, ""),
300
307
  domainUri: jspb.Message.getFieldWithDefault(msg, 3, ""),
301
308
  createdAt: jspb.Message.getFieldWithDefault(msg, 4, 0),
302
- updatedAt: jspb.Message.getFieldWithDefault(msg, 5, 0)
309
+ updatedAt: jspb.Message.getFieldWithDefault(msg, 5, 0),
310
+ accessControlListRef: jspb.Message.getFieldWithDefault(msg, 6, ""),
311
+ egressPoliciesList: jspb.Message.toObjectList(msg.getEgressPoliciesList(),
312
+ proto.fonoster.domains.v1beta2.EgressPolicy.toObject, includeInstance)
303
313
  };
304
314
 
305
315
  if (includeInstance) {
@@ -356,6 +366,15 @@ proto.fonoster.domains.v1beta2.Domain.deserializeBinaryFromReader = function(msg
356
366
  var value = /** @type {number} */ (reader.readInt32());
357
367
  msg.setUpdatedAt(value);
358
368
  break;
369
+ case 6:
370
+ var value = /** @type {string} */ (reader.readString());
371
+ msg.setAccessControlListRef(value);
372
+ break;
373
+ case 7:
374
+ var value = new proto.fonoster.domains.v1beta2.EgressPolicy;
375
+ reader.readMessage(value,proto.fonoster.domains.v1beta2.EgressPolicy.deserializeBinaryFromReader);
376
+ msg.addEgressPolicies(value);
377
+ break;
359
378
  default:
360
379
  reader.skipField();
361
380
  break;
@@ -420,6 +439,21 @@ proto.fonoster.domains.v1beta2.Domain.serializeBinaryToWriter = function(message
420
439
  f
421
440
  );
422
441
  }
442
+ f = message.getAccessControlListRef();
443
+ if (f.length > 0) {
444
+ writer.writeString(
445
+ 6,
446
+ f
447
+ );
448
+ }
449
+ f = message.getEgressPoliciesList();
450
+ if (f.length > 0) {
451
+ writer.writeRepeatedMessage(
452
+ 7,
453
+ f,
454
+ proto.fonoster.domains.v1beta2.EgressPolicy.serializeBinaryToWriter
455
+ );
456
+ }
423
457
  };
424
458
 
425
459
 
@@ -513,6 +547,62 @@ proto.fonoster.domains.v1beta2.Domain.prototype.setUpdatedAt = function(value) {
513
547
  };
514
548
 
515
549
 
550
+ /**
551
+ * optional string access_control_list_ref = 6;
552
+ * @return {string}
553
+ */
554
+ proto.fonoster.domains.v1beta2.Domain.prototype.getAccessControlListRef = function() {
555
+ return /** @type {string} */ (jspb.Message.getFieldWithDefault(this, 6, ""));
556
+ };
557
+
558
+
559
+ /**
560
+ * @param {string} value
561
+ * @return {!proto.fonoster.domains.v1beta2.Domain} returns this
562
+ */
563
+ proto.fonoster.domains.v1beta2.Domain.prototype.setAccessControlListRef = function(value) {
564
+ return jspb.Message.setProto3StringField(this, 6, value);
565
+ };
566
+
567
+
568
+ /**
569
+ * repeated EgressPolicy egress_policies = 7;
570
+ * @return {!Array<!proto.fonoster.domains.v1beta2.EgressPolicy>}
571
+ */
572
+ proto.fonoster.domains.v1beta2.Domain.prototype.getEgressPoliciesList = function() {
573
+ return /** @type{!Array<!proto.fonoster.domains.v1beta2.EgressPolicy>} */ (
574
+ jspb.Message.getRepeatedWrapperField(this, proto.fonoster.domains.v1beta2.EgressPolicy, 7));
575
+ };
576
+
577
+
578
+ /**
579
+ * @param {!Array<!proto.fonoster.domains.v1beta2.EgressPolicy>} value
580
+ * @return {!proto.fonoster.domains.v1beta2.Domain} returns this
581
+ */
582
+ proto.fonoster.domains.v1beta2.Domain.prototype.setEgressPoliciesList = function(value) {
583
+ return jspb.Message.setRepeatedWrapperField(this, 7, value);
584
+ };
585
+
586
+
587
+ /**
588
+ * @param {!proto.fonoster.domains.v1beta2.EgressPolicy=} opt_value
589
+ * @param {number=} opt_index
590
+ * @return {!proto.fonoster.domains.v1beta2.EgressPolicy}
591
+ */
592
+ proto.fonoster.domains.v1beta2.Domain.prototype.addEgressPolicies = function(opt_value, opt_index) {
593
+ return jspb.Message.addToRepeatedWrapperField(this, 7, opt_value, proto.fonoster.domains.v1beta2.EgressPolicy, opt_index);
594
+ };
595
+
596
+
597
+ /**
598
+ * Clears the list making it empty but non-null.
599
+ * @return {!proto.fonoster.domains.v1beta2.Domain} returns this
600
+ */
601
+ proto.fonoster.domains.v1beta2.Domain.prototype.clearEgressPoliciesList = function() {
602
+ return this.setEgressPoliciesList([]);
603
+ };
604
+
605
+
516
606
 
517
607
 
518
608
 
@@ -18,6 +18,14 @@ export class Domain extends jspb.Message {
18
18
  getUpdatedAt(): number;
19
19
  setUpdatedAt(value: number): Domain;
20
20
 
21
+ getAccessControlListRef(): string;
22
+ setAccessControlListRef(value: string): Domain;
23
+
24
+ getEgressPoliciesList(): Array<EgressPolicy>;
25
+ setEgressPoliciesList(value: Array<EgressPolicy>): Domain;
26
+ clearEgressPoliciesList(): Domain;
27
+ addEgressPolicies(value?: EgressPolicy, index?: number): EgressPolicy;
28
+
21
29
  serializeBinary(): Uint8Array;
22
30
  toObject(includeInstance?: boolean): Domain.AsObject;
23
31
  static toObject(includeInstance: boolean, msg: Domain): Domain.AsObject;
@@ -33,6 +41,8 @@ export namespace Domain {
33
41
  domainUri: string,
34
42
  createdAt: number,
35
43
  updatedAt: number,
44
+ accessControlListRef: string,
45
+ egressPoliciesList: Array<EgressPolicy.AsObject>,
36
46
  }
37
47
  }
38
48
 
@@ -43,7 +43,7 @@ goog.exportSymbol('proto.fonoster.domains.v1beta2.UpdateDomainResponse', null, g
43
43
  * @constructor
44
44
  */
45
45
  proto.fonoster.domains.v1beta2.Domain = function(opt_data) {
46
- jspb.Message.initialize(this, opt_data, 0, -1, null, null);
46
+ jspb.Message.initialize(this, opt_data, 0, -1, proto.fonoster.domains.v1beta2.Domain.repeatedFields_, null);
47
47
  };
48
48
  goog.inherits(proto.fonoster.domains.v1beta2.Domain, jspb.Message);
49
49
  if (goog.DEBUG && !COMPILED) {
@@ -264,6 +264,13 @@ if (goog.DEBUG && !COMPILED) {
264
264
  proto.fonoster.domains.v1beta2.ListDomainsResponse.displayName = 'proto.fonoster.domains.v1beta2.ListDomainsResponse';
265
265
  }
266
266
 
267
+ /**
268
+ * List of repeated fields within this message type.
269
+ * @private {!Array<number>}
270
+ * @const
271
+ */
272
+ proto.fonoster.domains.v1beta2.Domain.repeatedFields_ = [7];
273
+
267
274
 
268
275
 
269
276
  if (jspb.Message.GENERATE_TO_OBJECT) {
@@ -299,7 +306,10 @@ ref: jspb.Message.getFieldWithDefault(msg, 1, ""),
299
306
  name: jspb.Message.getFieldWithDefault(msg, 2, ""),
300
307
  domainUri: jspb.Message.getFieldWithDefault(msg, 3, ""),
301
308
  createdAt: jspb.Message.getFieldWithDefault(msg, 4, 0),
302
- updatedAt: jspb.Message.getFieldWithDefault(msg, 5, 0)
309
+ updatedAt: jspb.Message.getFieldWithDefault(msg, 5, 0),
310
+ accessControlListRef: jspb.Message.getFieldWithDefault(msg, 6, ""),
311
+ egressPoliciesList: jspb.Message.toObjectList(msg.getEgressPoliciesList(),
312
+ proto.fonoster.domains.v1beta2.EgressPolicy.toObject, includeInstance)
303
313
  };
304
314
 
305
315
  if (includeInstance) {
@@ -356,6 +366,15 @@ proto.fonoster.domains.v1beta2.Domain.deserializeBinaryFromReader = function(msg
356
366
  var value = /** @type {number} */ (reader.readInt32());
357
367
  msg.setUpdatedAt(value);
358
368
  break;
369
+ case 6:
370
+ var value = /** @type {string} */ (reader.readString());
371
+ msg.setAccessControlListRef(value);
372
+ break;
373
+ case 7:
374
+ var value = new proto.fonoster.domains.v1beta2.EgressPolicy;
375
+ reader.readMessage(value,proto.fonoster.domains.v1beta2.EgressPolicy.deserializeBinaryFromReader);
376
+ msg.addEgressPolicies(value);
377
+ break;
359
378
  default:
360
379
  reader.skipField();
361
380
  break;
@@ -420,6 +439,21 @@ proto.fonoster.domains.v1beta2.Domain.serializeBinaryToWriter = function(message
420
439
  f
421
440
  );
422
441
  }
442
+ f = message.getAccessControlListRef();
443
+ if (f.length > 0) {
444
+ writer.writeString(
445
+ 6,
446
+ f
447
+ );
448
+ }
449
+ f = message.getEgressPoliciesList();
450
+ if (f.length > 0) {
451
+ writer.writeRepeatedMessage(
452
+ 7,
453
+ f,
454
+ proto.fonoster.domains.v1beta2.EgressPolicy.serializeBinaryToWriter
455
+ );
456
+ }
423
457
  };
424
458
 
425
459
 
@@ -513,6 +547,62 @@ proto.fonoster.domains.v1beta2.Domain.prototype.setUpdatedAt = function(value) {
513
547
  };
514
548
 
515
549
 
550
+ /**
551
+ * optional string access_control_list_ref = 6;
552
+ * @return {string}
553
+ */
554
+ proto.fonoster.domains.v1beta2.Domain.prototype.getAccessControlListRef = function() {
555
+ return /** @type {string} */ (jspb.Message.getFieldWithDefault(this, 6, ""));
556
+ };
557
+
558
+
559
+ /**
560
+ * @param {string} value
561
+ * @return {!proto.fonoster.domains.v1beta2.Domain} returns this
562
+ */
563
+ proto.fonoster.domains.v1beta2.Domain.prototype.setAccessControlListRef = function(value) {
564
+ return jspb.Message.setProto3StringField(this, 6, value);
565
+ };
566
+
567
+
568
+ /**
569
+ * repeated EgressPolicy egress_policies = 7;
570
+ * @return {!Array<!proto.fonoster.domains.v1beta2.EgressPolicy>}
571
+ */
572
+ proto.fonoster.domains.v1beta2.Domain.prototype.getEgressPoliciesList = function() {
573
+ return /** @type{!Array<!proto.fonoster.domains.v1beta2.EgressPolicy>} */ (
574
+ jspb.Message.getRepeatedWrapperField(this, proto.fonoster.domains.v1beta2.EgressPolicy, 7));
575
+ };
576
+
577
+
578
+ /**
579
+ * @param {!Array<!proto.fonoster.domains.v1beta2.EgressPolicy>} value
580
+ * @return {!proto.fonoster.domains.v1beta2.Domain} returns this
581
+ */
582
+ proto.fonoster.domains.v1beta2.Domain.prototype.setEgressPoliciesList = function(value) {
583
+ return jspb.Message.setRepeatedWrapperField(this, 7, value);
584
+ };
585
+
586
+
587
+ /**
588
+ * @param {!proto.fonoster.domains.v1beta2.EgressPolicy=} opt_value
589
+ * @param {number=} opt_index
590
+ * @return {!proto.fonoster.domains.v1beta2.EgressPolicy}
591
+ */
592
+ proto.fonoster.domains.v1beta2.Domain.prototype.addEgressPolicies = function(opt_value, opt_index) {
593
+ return jspb.Message.addToRepeatedWrapperField(this, 7, opt_value, proto.fonoster.domains.v1beta2.EgressPolicy, opt_index);
594
+ };
595
+
596
+
597
+ /**
598
+ * Clears the list making it empty but non-null.
599
+ * @return {!proto.fonoster.domains.v1beta2.Domain} returns this
600
+ */
601
+ proto.fonoster.domains.v1beta2.Domain.prototype.clearEgressPoliciesList = function() {
602
+ return this.setEgressPoliciesList([]);
603
+ };
604
+
605
+
516
606
 
517
607
 
518
608