@itentialopensource/adapter-calix_support_cloud 0.3.6 → 0.4.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.
Files changed (45) hide show
  1. package/.eslintrc.js +1 -0
  2. package/AUTH.md +4 -4
  3. package/BROKER.md +4 -4
  4. package/CALLS.md +9 -9
  5. package/ENHANCE.md +3 -3
  6. package/PROPERTIES.md +24 -9
  7. package/README.md +24 -23
  8. package/SUMMARY.md +2 -2
  9. package/SYSTEMINFO.md +1 -1
  10. package/TAB1.md +1 -1
  11. package/TAB2.md +8 -4
  12. package/TROUBLESHOOT.md +10 -1
  13. package/UTILITIES.md +473 -0
  14. package/adapter.js +12 -12
  15. package/adapterBase.js +52 -16
  16. package/package.json +24 -28
  17. package/pronghorn.json +15 -13
  18. package/propertiesSchema.json +68 -7
  19. package/report/adapterInfo.json +7 -7
  20. package/report/auto-adapter-openapi.json +2195 -0
  21. package/report/updateReport1748551841478.json +120 -0
  22. package/sampleProperties.json +4 -0
  23. package/test/integration/adapterTestBasicGet.js +88 -54
  24. package/test/integration/adapterTestConnectivity.js +15 -16
  25. package/test/integration/adapterTestIntegration.js +12 -45
  26. package/test/unit/adapterBaseTestUnit.js +641 -39
  27. package/test/unit/adapterTestUnit.js +28 -61
  28. package/utils/adapterInfo.js +114 -164
  29. package/utils/argParser.js +44 -0
  30. package/utils/checkMigrate.js +77 -38
  31. package/utils/entitiesToDB.js +53 -42
  32. package/utils/logger.js +26 -0
  33. package/utils/modify.js +56 -55
  34. package/utils/mongoDbConnection.js +79 -0
  35. package/utils/mongoUtils.js +162 -0
  36. package/utils/taskMover.js +31 -32
  37. package/utils/tbScript.js +36 -172
  38. package/utils/tbUtils.js +84 -226
  39. package/utils/troubleshootingAdapter.js +68 -84
  40. package/utils/updateAdapterConfig.js +158 -0
  41. package/utils/addAuth.js +0 -94
  42. package/utils/artifactize.js +0 -146
  43. package/utils/basicGet.js +0 -50
  44. package/utils/packModificationScript.js +0 -35
  45. package/utils/patches2bundledDeps.js +0 -90
package/report/auto-adapter-openapi.json ADDED
@@ -0,0 +1,2195 @@
1
+ {
2
+ "openapi": "3.1.0",
3
+ "info": {
4
+ "title": "",
5
+ "version": "1.0.0"
6
+ },
7
+ "paths": {
8
+ "/device": {
9
+ "get": {
10
+ "tags": [
11
+ "DeviceDataManagement"
12
+ ],
13
+ "operationId": "retrieveAllDevices",
14
+ "description": "The parameters and request body are for method: retrieveAllDevices. Same endpoint also used in methods:<br> retrieveDeviceBySerialNumber (serialNumber : string)<br> retrieveDeviceByMACAddress (macAddress : string)<br> retrieveDeviceByRegistrationID (registrationId : string)<br> retrieveDeviceByIPAddress (ipAddress : string)",
15
+ "responses": {
16
+ "200": {
17
+ "description": "Successful operation",
18
+ "content": {
19
+ "application/json": {
20
+ "schema": {
21
+ "type": "array",
22
+ "items": {
23
+ "type": "object",
24
+ "properties": {
25
+ "_id": {
26
+ "type": "string"
27
+ },
28
+ "manufacturer": {
29
+ "type": "string"
30
+ },
31
+ "manufacturerOUI": {
32
+ "type": "string"
33
+ },
34
+ "productClass": {
35
+ "type": "string"
36
+ },
37
+ "modelName": {
38
+ "type": "string"
39
+ },
40
+ "hardwareVersion": {
41
+ "type": "string"
42
+ },
43
+ "softwareVersion": {
44
+ "type": "string"
45
+ },
46
+ "serialNumber": {
47
+ "type": "string"
48
+ },
49
+ "registrationId": {
50
+ "type": "string"
51
+ },
52
+ "macAddress": {
53
+ "type": "string"
54
+ },
55
+ "periodicInformInterval": {
56
+ "type": "number"
57
+ },
58
+ "dataModelName": {
59
+ "type": "string"
60
+ },
61
+ "timezoneOffset": {
62
+ "type": "string"
63
+ },
64
+ "ipAddress": {
65
+ "type": "string"
66
+ },
67
+ "changeCounter": {
68
+ "type": "number"
69
+ },
70
+ "defaultGateway": {
71
+ "type": "string"
72
+ },
73
+ "subnetMask": {
74
+ "type": "string"
75
+ },
76
+ "wapGatewaySn": {
77
+ "type": "string"
78
+ },
79
+ "provRecordStatus": {
80
+ "type": "string"
81
+ },
82
+ "opMode": {
83
+ "type": "string"
84
+ },
85
+ "wanAccessType": {
86
+ "type": "string"
87
+ },
88
+ "stunEnabled": {
89
+ "type": "boolean"
90
+ },
91
+ "udpConnectionRequestAddr": {
92
+ "type": "string"
93
+ },
94
+ "lastInformTime": {
95
+ "type": "string"
96
+ },
97
+ "createTime": {
98
+ "type": "string"
99
+ },
100
+ "hardwareSerialNumber": {
101
+ "type": "string"
102
+ }
103
+ }
104
+ }
105
+ },
106
+ "example": [
107
+ {
108
+ "_id": "12837558-000631-CXNK001D9030",
109
+ "manufacturer": "Calix",
110
+ "manufacturerOUI": "000631",
111
+ "productClass": "ENT",
112
+ "modelName": "844E-1",
113
+ "hardwareVersion": "3000219601",
114
+ "softwareVersion": "12.2.8.1.11",
115
+ "serialNumber": "CXNK001D9030",
116
+ "registrationId": "",
117
+ "macAddress": "00:06:31:ed:f7:b0",
118
+ "periodicInformInterval": 86400,
119
+ "dataModelName": "tr098",
120
+ "timezoneOffset": "-08:00",
121
+ "ipAddress": "192.168.92.2",
122
+ "changeCounter": 24,
123
+ "defaultGateway": "192.168.92.1",
124
+ "subnetMask": "255.255.255.0",
125
+ "wapGatewaySn": "FTX133981PW",
126
+ "provRecordStatus": "Succeeded",
127
+ "opMode": "RG",
128
+ "wanAccessType": "CopperEthernet",
129
+ "stunEnabled": true,
130
+ "udpConnectionRequestAddr": "99.111.154.74:30005",
131
+ "lastInformTime": "2019-04-17T05:40:38.904Z",
132
+ "createTime": "2019-03-20T13:36:00.657Z",
133
+ "hardwareSerialNumber": "261503000429"
134
+ },
135
+ {
136
+ "_id": "12837558-000631-CXNK001D9031",
137
+ "manufacturerOUI": "000631",
138
+ "serialNumber": "CXNK001D9031",
139
+ "createTime": "2019-04-09T16:04:36.630Z"
140
+ },
141
+ {
142
+ "_id": "12837558-CCBE59-CXNK005763A3",
143
+ "manufacturer": "Calix",
144
+ "manufacturerOUI": "CCBE59",
145
+ "productClass": "GigaSpire",
146
+ "modelName": "GS2020E",
147
+ "hardwareVersion": "3000282601",
148
+ "softwareVersion": "19.1.0.1.4",
149
+ "serialNumber": "CXNK005763A3",
150
+ "registrationId": "",
151
+ "macAddress": "cc:be:59:fc:07:70",
152
+ "periodicInformInterval": 86400,
153
+ "dataModelName": "tr098",
154
+ "timezoneOffset": "-04:00",
155
+ "ipAddress": "192.168.10.191",
156
+ "changeCounter": 1,
157
+ "opRole": "Controller",
158
+ "defaultGateway": "192.168.10.1",
159
+ "subnetMask": "255.255.255.0",
160
+ "opMode": "RG",
161
+ "wanAccessType": "CopperEthernet",
162
+ "stunEnabled": true,
163
+ "lastInformTime": "2019-05-20T18:13:01.371Z",
164
+ "createTime": "2019-05-10T18:53:59.776Z",
165
+ "hardwareSerialNumber": "391806000136"
166
+ },
167
+ {
168
+ "_id": "12837558-44657F-CXNK005A77A9",
169
+ "manufacturer": "Calix",
170
+ "manufacturerOUI": "44657F",
171
+ "productClass": "GigaSpire",
172
+ "modelName": "GS2026E",
173
+ "hardwareVersion": "3000281011",
174
+ "softwareVersion": "19.1.0.1.4",
175
+ "serialNumber": "CXNK005A77A9",
176
+ "registrationId": "",
177
+ "macAddress": "44:65:7f:14:8f:60",
178
+ "periodicInformInterval": 86400,
179
+ "dataModelName": "tr098",
180
+ "timezoneOffset": "-04:00",
181
+ "ipAddress": "192.168.1.71",
182
+ "changeCounter": 15,
183
+ "opRole": "Controller",
184
+ "defaultGateway": "192.168.1.254",
185
+ "subnetMask": "255.255.255.0",
186
+ "opMode": "RG",
187
+ "wanAccessType": "CopperEthernet",
188
+ "stunEnabled": true,
189
+ "udpConnectionRequestAddr": "99.111.154.74:60018",
190
+ "lastInformTime": "2019-05-21T13:18:01.219Z",
191
+ "createTime": "2019-04-08T20:55:53.295Z",
192
+ "hardwareSerialNumber": "391809000281"
193
+ }
194
+ ]
195
+ }
196
+ }
197
+ }
198
+ },
199
+ "requestBody": {
200
+ "content": {
201
+ "application/json": {
202
+ "schema": {
203
+ "type": "object"
204
+ },
205
+ "example": {}
206
+ }
207
+ }
208
+ }
209
+ }
210
+ },
211
+ "/device/{deviceid}": {
212
+ "get": {
213
+ "tags": [
214
+ "DeviceDataManagement"
215
+ ],
216
+ "operationId": "retrieveDeviceByID",
217
+ "description": "The parameters and request body are for method: retrieveDeviceByID. Same endpoint also used in methods:",
218
+ "responses": {
219
+ "200": {
220
+ "description": "Successful operation",
221
+ "content": {
222
+ "application/json": {
223
+ "schema": {
224
+ "type": "object",
225
+ "properties": {
226
+ "_id": {
227
+ "type": "string"
228
+ },
229
+ "manufacturer": {
230
+ "type": "string"
231
+ },
232
+ "manufacturerOUI": {
233
+ "type": "string"
234
+ },
235
+ "productClass": {
236
+ "type": "string"
237
+ },
238
+ "modelName": {
239
+ "type": "string"
240
+ },
241
+ "hardwareVersion": {
242
+ "type": "string"
243
+ },
244
+ "softwareVersion": {
245
+ "type": "string"
246
+ },
247
+ "serialNumber": {
248
+ "type": "string"
249
+ },
250
+ "registrationId": {
251
+ "type": "string"
252
+ },
253
+ "macAddress": {
254
+ "type": "string"
255
+ },
256
+ "periodicInformInterval": {
257
+ "type": "number"
258
+ },
259
+ "dataModelName": {
260
+ "type": "string"
261
+ },
262
+ "timezoneOffset": {
263
+ "type": "string"
264
+ },
265
+ "ipAddress": {
266
+ "type": "string"
267
+ },
268
+ "changeCounter": {
269
+ "type": "number"
270
+ },
271
+ "defaultGateway": {
272
+ "type": "string"
273
+ },
274
+ "subnetMask": {
275
+ "type": "string"
276
+ },
277
+ "wapGatewaySn": {
278
+ "type": "string"
279
+ },
280
+ "provRecordStatus": {
281
+ "type": "string"
282
+ },
283
+ "opMode": {
284
+ "type": "string"
285
+ },
286
+ "wanAccessType": {
287
+ "type": "string"
288
+ },
289
+ "stunEnabled": {
290
+ "type": "boolean"
291
+ },
292
+ "udpConnectionRequestAddr": {
293
+ "type": "string"
294
+ },
295
+ "lastInformTime": {
296
+ "type": "string"
297
+ },
298
+ "createTime": {
299
+ "type": "string"
300
+ },
301
+ "hardwareSerialNumber": {
302
+ "type": "string"
303
+ }
304
+ }
305
+ },
306
+ "example": {
307
+ "_id": "12837558-000631-CXNK001D9030",
308
+ "manufacturer": "Calix",
309
+ "manufacturerOUI": "000631",
310
+ "productClass": "ENT",
311
+ "modelName": "844E-1",
312
+ "hardwareVersion": "3000219601",
313
+ "softwareVersion": "12.2.8.1.11",
314
+ "serialNumber": "CXNK001D9030",
315
+ "registrationId": "",
316
+ "macAddress": "00:06:31:ed:f7:b0",
317
+ "periodicInformInterval": 86400,
318
+ "dataModelName": "tr098",
319
+ "timezoneOffset": "-08:00",
320
+ "ipAddress": "192.168.92.2",
321
+ "changeCounter": 24,
322
+ "defaultGateway": "192.168.92.1",
323
+ "subnetMask": "255.255.255.0",
324
+ "wapGatewaySn": "FTX133981PW",
325
+ "provRecordStatus": "Succeeded",
326
+ "opMode": "RG",
327
+ "wanAccessType": "CopperEthernet",
328
+ "stunEnabled": true,
329
+ "udpConnectionRequestAddr": "99.111.154.74:30005",
330
+ "lastInformTime": "2019-04-17T05:40:38.904Z",
331
+ "createTime": "2019-03-20T13:36:00.657Z",
332
+ "hardwareSerialNumber": "261503000429"
333
+ }
334
+ }
335
+ }
336
+ }
337
+ },
338
+ "parameters": [
339
+ {
340
+ "name": "deviceid",
341
+ "in": "path",
342
+ "required": true,
343
+ "schema": {
344
+ "title": "deviceid",
345
+ "type": "string"
346
+ }
347
+ }
348
+ ],
349
+ "requestBody": {
350
+ "content": {
351
+ "application/json": {
352
+ "schema": {
353
+ "type": "object"
354
+ },
355
+ "example": {}
356
+ }
357
+ }
358
+ }
359
+ },
360
+ "delete": {
361
+ "tags": [
362
+ "DeviceDataManagement"
363
+ ],
364
+ "operationId": "deleteDevice",
365
+ "description": "The parameters and request body are for method: deleteDevice. Same endpoint also used in methods:",
366
+ "responses": {
367
+ "200": {
368
+ "description": "Successful operation",
369
+ "content": {
370
+ "application/json": {
371
+ "schema": {
372
+ "title": "result",
373
+ "type": "object"
374
+ }
375
+ }
376
+ }
377
+ }
378
+ },
379
+ "parameters": [
380
+ {
381
+ "name": "deviceid",
382
+ "in": "path",
383
+ "required": true,
384
+ "schema": {
385
+ "title": "deviceid",
386
+ "type": "string"
387
+ }
388
+ }
389
+ ],
390
+ "requestBody": {
391
+ "content": {
392
+ "application/json": {
393
+ "schema": {
394
+ "type": "object"
395
+ },
396
+ "example": {}
397
+ }
398
+ }
399
+ }
400
+ }
401
+ },
402
+ "/subscriber": {
403
+ "post": {
404
+ "tags": [
405
+ "SubscriberManagement"
406
+ ],
407
+ "operationId": "createSubscriber",
408
+ "description": "The parameters and request body are for method: createSubscriber. Same endpoint also used in methods:",
409
+ "responses": {
410
+ "200": {
411
+ "description": "Successful operation",
412
+ "content": {
413
+ "application/json": {
414
+ "schema": {
415
+ "title": "result",
416
+ "type": "object"
417
+ }
418
+ }
419
+ }
420
+ }
421
+ },
422
+ "requestBody": {
423
+ "description": "indeterminate body object",
424
+ "content": {
425
+ "application/json": {
426
+ "schema": {
427
+ "type": "object"
428
+ }
429
+ }
430
+ }
431
+ }
432
+ },
433
+ "get": {
434
+ "tags": [
435
+ "SubscriberManagement"
436
+ ],
437
+ "operationId": "retrieveAllSubscribers",
438
+ "description": "The parameters and request body are for method: retrieveAllSubscribers. Same endpoint also used in methods:",
439
+ "responses": {
440
+ "200": {
441
+ "description": "Successful operation",
442
+ "content": {
443
+ "application/json": {
444
+ "schema": {
445
+ "type": "array",
446
+ "items": {
447
+ "type": "object",
448
+ "properties": {
449
+ "_id": {
450
+ "type": "string"
451
+ },
452
+ "customId": {
453
+ "type": "string"
454
+ },
455
+ "name": {
456
+ "type": "string"
457
+ },
458
+ "locations": {
459
+ "type": "array",
460
+ "items": {
461
+ "type": "object",
462
+ "properties": {
463
+ "address": {
464
+ "type": "object",
465
+ "properties": {
466
+ "streetLine1": {
467
+ "type": "string"
468
+ },
469
+ "city": {
470
+ "type": "string"
471
+ },
472
+ "state": {
473
+ "type": "string"
474
+ },
475
+ "zip": {
476
+ "type": "string"
477
+ },
478
+ "country": {
479
+ "type": "string"
480
+ }
481
+ }
482
+ },
483
+ "contacts": {
484
+ "type": "array",
485
+ "items": {
486
+ "type": "object",
487
+ "properties": {
488
+ "phone": {
489
+ "type": "string"
490
+ },
491
+ "email": {
492
+ "type": "string"
493
+ }
494
+ }
495
+ }
496
+ },
497
+ "devices": {
498
+ "type": "array",
499
+ "items": {
500
+ "type": "string"
501
+ }
502
+ }
503
+ }
504
+ }
505
+ }
506
+ }
507
+ }
508
+ },
509
+ "example": [
510
+ {
511
+ "_id": "7317b27e-528f-4c40-83bc-6d8a46edd0a3",
512
+ "customId": "67890",
513
+ "name": "Test user",
514
+ "locations": [
515
+ {
516
+ "address": {
517
+ "streetLine1": "123 Oak St",
518
+ "city": "Anytown",
519
+ "state": "ZZ",
520
+ "zip": "00000",
521
+ "country": "USA"
522
+ },
523
+ "contacts": [
524
+ {
525
+ "phone": "919-123-4567",
526
+ "email": "some@user.org"
527
+ }
528
+ ],
529
+ "devices": [
530
+ "CXNK00001234"
531
+ ]
532
+ }
533
+ ]
534
+ }
535
+ ]
536
+ }
537
+ }
538
+ }
539
+ },
540
+ "requestBody": {
541
+ "content": {
542
+ "application/json": {
543
+ "schema": {
544
+ "type": "object"
545
+ },
546
+ "example": {}
547
+ }
548
+ }
549
+ }
550
+ }
551
+ },
552
+ "/subscriber/{id}": {
553
+ "get": {
554
+ "tags": [
555
+ "SubscriberManagement"
556
+ ],
557
+ "operationId": "retrieveSubscriberByInternalID",
558
+ "description": "The parameters and request body are for method: retrieveSubscriberByInternalID. Same endpoint also used in methods:",
559
+ "responses": {
560
+ "200": {
561
+ "description": "Successful operation",
562
+ "content": {
563
+ "application/json": {
564
+ "schema": {
565
+ "type": "object",
566
+ "properties": {
567
+ "_id": {
568
+ "type": "string"
569
+ },
570
+ "customId": {
571
+ "type": "string"
572
+ },
573
+ "name": {
574
+ "type": "string"
575
+ },
576
+ "locations": {
577
+ "type": "array",
578
+ "items": {
579
+ "type": "object",
580
+ "properties": {
581
+ "address": {
582
+ "type": "object",
583
+ "properties": {
584
+ "streetLine1": {
585
+ "type": "string"
586
+ },
587
+ "city": {
588
+ "type": "string"
589
+ },
590
+ "state": {
591
+ "type": "string"
592
+ },
593
+ "zip": {
594
+ "type": "string"
595
+ },
596
+ "country": {
597
+ "type": "string"
598
+ }
599
+ }
600
+ },
601
+ "contacts": {
602
+ "type": "array",
603
+ "items": {
604
+ "type": "object",
605
+ "properties": {
606
+ "phone": {
607
+ "type": "string"
608
+ },
609
+ "email": {
610
+ "type": "string"
611
+ }
612
+ }
613
+ }
614
+ },
615
+ "devices": {
616
+ "type": "array",
617
+ "items": {
618
+ "type": "string"
619
+ }
620
+ }
621
+ }
622
+ }
623
+ }
624
+ }
625
+ },
626
+ "example": {
627
+ "_id": "7317b27e-528f-4c40-83bc-6d8a46edd0a3",
628
+ "customId": "67890",
629
+ "name": "Test user",
630
+ "locations": [
631
+ {
632
+ "address": {
633
+ "streetLine1": "123 Oak St",
634
+ "city": "Anytown",
635
+ "state": "ZZ",
636
+ "zip": "00000",
637
+ "country": "USA"
638
+ },
639
+ "contacts": [
640
+ {
641
+ "phone": "919-123-4567",
642
+ "email": "some@user.org"
643
+ }
644
+ ],
645
+ "devices": [
646
+ "CXNK00001234"
647
+ ]
648
+ }
649
+ ]
650
+ }
651
+ }
652
+ }
653
+ }
654
+ },
655
+ "parameters": [
656
+ {
657
+ "name": "id",
658
+ "in": "path",
659
+ "required": true,
660
+ "schema": {
661
+ "title": "id",
662
+ "type": "string"
663
+ }
664
+ }
665
+ ],
666
+ "requestBody": {
667
+ "content": {
668
+ "application/json": {
669
+ "schema": {
670
+ "type": "object"
671
+ },
672
+ "example": {}
673
+ }
674
+ }
675
+ }
676
+ },
677
+ "delete": {
678
+ "tags": [
679
+ "SubscriberManagement"
680
+ ],
681
+ "operationId": "deleteSubscriber",
682
+ "description": "The parameters and request body are for method: deleteSubscriber. Same endpoint also used in methods:",
683
+ "responses": {
684
+ "200": {
685
+ "description": "Successful operation",
686
+ "content": {
687
+ "application/json": {
688
+ "schema": {
689
+ "title": "result",
690
+ "type": "object"
691
+ }
692
+ }
693
+ }
694
+ }
695
+ },
696
+ "parameters": [
697
+ {
698
+ "name": "id",
699
+ "in": "path",
700
+ "required": true,
701
+ "schema": {
702
+ "title": "id",
703
+ "type": "string"
704
+ }
705
+ }
706
+ ],
707
+ "requestBody": {
708
+ "content": {
709
+ "application/json": {
710
+ "schema": {
711
+ "type": "object"
712
+ },
713
+ "example": {}
714
+ }
715
+ }
716
+ }
717
+ }
718
+ },
719
+ "/subscriber/": {
720
+ "get": {
721
+ "tags": [
722
+ "SubscriberManagement"
723
+ ],
724
+ "operationId": "retrieveSubscriberByCustomIdSubscriberID",
725
+ "description": "The parameters and request body are for method: retrieveSubscriberByCustomIdSubscriberID. Same endpoint also used in methods:<br> retrieveSubscriberByName (name : string)<br> retrieveSubscribersByPhoneNumber (phone : string)<br> retrieveSubscriberByEmailAddress (email : string)",
726
+ "responses": {
727
+ "200": {
728
+ "description": "Successful operation",
729
+ "content": {
730
+ "application/json": {
731
+ "schema": {
732
+ "type": "object",
733
+ "properties": {
734
+ "_id": {
735
+ "type": "string"
736
+ },
737
+ "customId": {
738
+ "type": "string"
739
+ },
740
+ "name": {
741
+ "type": "string"
742
+ },
743
+ "locations": {
744
+ "type": "array",
745
+ "items": {
746
+ "type": "object",
747
+ "properties": {
748
+ "address": {
749
+ "type": "object",
750
+ "properties": {
751
+ "streetLine1": {
752
+ "type": "string"
753
+ },
754
+ "city": {
755
+ "type": "string"
756
+ },
757
+ "state": {
758
+ "type": "string"
759
+ },
760
+ "zip": {
761
+ "type": "string"
762
+ },
763
+ "country": {
764
+ "type": "string"
765
+ }
766
+ }
767
+ },
768
+ "contacts": {
769
+ "type": "array",
770
+ "items": {
771
+ "type": "object",
772
+ "properties": {
773
+ "phone": {
774
+ "type": "string"
775
+ },
776
+ "email": {
777
+ "type": "string"
778
+ }
779
+ }
780
+ }
781
+ },
782
+ "devices": {
783
+ "type": "array",
784
+ "items": {
785
+ "type": "string"
786
+ }
787
+ }
788
+ }
789
+ }
790
+ }
791
+ }
792
+ },
793
+ "example": {
794
+ "_id": "7317b27e-528f-4c40-83bc-6d8a46edd0a3",
795
+ "customId": "67890",
796
+ "name": "Test user",
797
+ "locations": [
798
+ {
799
+ "address": {
800
+ "streetLine1": "123 Oak St",
801
+ "city": "Anytown",
802
+ "state": "ZZ",
803
+ "zip": "00000",
804
+ "country": "USA"
805
+ },
806
+ "contacts": [
807
+ {
808
+ "phone": "919-123-4567",
809
+ "email": "some@user.org"
810
+ }
811
+ ],
812
+ "devices": [
813
+ "CXNK00001234"
814
+ ]
815
+ }
816
+ ]
817
+ }
818
+ }
819
+ }
820
+ }
821
+ },
822
+ "parameters": [
823
+ {
824
+ "name": "customId",
825
+ "in": "query",
826
+ "required": true,
827
+ "schema": {
828
+ "type": "string"
829
+ }
830
+ }
831
+ ],
832
+ "requestBody": {
833
+ "content": {
834
+ "application/json": {
835
+ "schema": {
836
+ "type": "object"
837
+ },
838
+ "example": {}
839
+ }
840
+ }
841
+ }
842
+ },
843
+ "put": {
844
+ "tags": [
845
+ "SubscriberManagement"
846
+ ],
847
+ "operationId": "updateSubscriberOrReplaceAssociatedSystem",
848
+ "description": "The parameters and request body are for method: updateSubscriberOrReplaceAssociatedSystem. Same endpoint also used in methods:",
849
+ "responses": {
850
+ "200": {
851
+ "description": "Successful operation",
852
+ "content": {
853
+ "application/json": {
854
+ "schema": {
855
+ "type": "object",
856
+ "properties": {
857
+ "_id": {
858
+ "type": "string"
859
+ },
860
+ "customId": {
861
+ "type": "string"
862
+ },
863
+ "name": {
864
+ "type": "string"
865
+ },
866
+ "locations": {
867
+ "type": "array",
868
+ "items": {
869
+ "type": "object",
870
+ "properties": {
871
+ "address": {
872
+ "type": "object",
873
+ "properties": {
874
+ "streetLine1": {
875
+ "type": "string"
876
+ },
877
+ "city": {
878
+ "type": "string"
879
+ },
880
+ "state": {
881
+ "type": "string"
882
+ },
883
+ "zip": {
884
+ "type": "string"
885
+ },
886
+ "country": {
887
+ "type": "string"
888
+ }
889
+ }
890
+ },
891
+ "contacts": {
892
+ "type": "array",
893
+ "items": {
894
+ "type": "object",
895
+ "properties": {
896
+ "phone": {
897
+ "type": "string"
898
+ },
899
+ "email": {
900
+ "type": "string"
901
+ }
902
+ }
903
+ }
904
+ },
905
+ "devices": {
906
+ "type": "array",
907
+ "items": {
908
+ "type": "string"
909
+ }
910
+ }
911
+ }
912
+ }
913
+ }
914
+ }
915
+ },
916
+ "example": {
917
+ "_id": "7317b27e-528f-4c40-83bc-6d8a46edd0a3",
918
+ "customId": "67890",
919
+ "name": "Test user",
920
+ "locations": [
921
+ {
922
+ "address": {
923
+ "streetLine1": "123 Oak St",
924
+ "city": "Anytown",
925
+ "state": "ZZ",
926
+ "zip": "00000",
927
+ "country": "USA"
928
+ },
929
+ "contacts": [
930
+ {
931
+ "phone": "919-123-4567",
932
+ "email": "some@user.org"
933
+ }
934
+ ],
935
+ "devices": [
936
+ "CXNK00001234"
937
+ ]
938
+ }
939
+ ]
940
+ }
941
+ }
942
+ }
943
+ }
944
+ },
945
+ "parameters": [
946
+ {
947
+ "name": "customId",
948
+ "in": "query",
949
+ "required": true,
950
+ "schema": {
951
+ "type": "string"
952
+ }
953
+ }
954
+ ],
955
+ "requestBody": {
956
+ "description": "indeterminate body object",
957
+ "content": {
958
+ "application/json": {
959
+ "schema": {
960
+ "type": "object"
961
+ }
962
+ }
963
+ }
964
+ }
965
+ }
966
+ },
967
+ "/provisioning-record": {
968
+ "post": {
969
+ "tags": [
970
+ "DeviceProvisioningRecordManagement"
971
+ ],
972
+ "operationId": "createProvisioningRecord",
973
+ "description": "The parameters and request body are for method: createProvisioningRecord. Same endpoint also used in methods:",
974
+ "responses": {
975
+ "200": {
976
+ "description": "Successful operation",
977
+ "content": {
978
+ "application/json": {
979
+ "schema": {
980
+ "title": "result",
981
+ "type": "object"
982
+ }
983
+ }
984
+ }
985
+ }
986
+ },
987
+ "requestBody": {
988
+ "description": "indeterminate body object",
989
+ "content": {
990
+ "application/json": {
991
+ "schema": {
992
+ "type": "object"
993
+ }
994
+ }
995
+ }
996
+ }
997
+ },
998
+ "get": {
999
+ "tags": [
1000
+ "DeviceProvisioningRecordManagement"
1001
+ ],
1002
+ "operationId": "retrieveAllProvisioningRecords",
1003
+ "description": "The parameters and request body are for method: retrieveAllProvisioningRecords. Same endpoint also used in methods:<br> retrieveProvisioningRecordsByDevice (deviceId : string)<br> retrieveProvisioningRecordsBySubscriber (subscriberId : string)",
1004
+ "responses": {
1005
+ "200": {
1006
+ "description": "Successful operation",
1007
+ "content": {
1008
+ "application/json": {
1009
+ "schema": {
1010
+ "type": "array",
1011
+ "items": {
1012
+ "type": "object",
1013
+ "properties": {
1014
+ "_id": {
1015
+ "type": "string"
1016
+ },
1017
+ "orgId": {
1018
+ "type": "string"
1019
+ },
1020
+ "opMode": {
1021
+ "type": "string"
1022
+ },
1023
+ "deviceId": {
1024
+ "type": "string"
1025
+ },
1026
+ "subscriberId": {
1027
+ "type": "string"
1028
+ },
1029
+ "data": {
1030
+ "type": "object",
1031
+ "properties": {
1032
+ "Enable": {
1033
+ "type": "boolean"
1034
+ },
1035
+ "pppoe": {
1036
+ "type": "object",
1037
+ "properties": {
1038
+ "Username": {
1039
+ "type": "string"
1040
+ },
1041
+ "Password": {
1042
+ "type": "string"
1043
+ }
1044
+ }
1045
+ },
1046
+ "VlanId": {
1047
+ "type": "number"
1048
+ },
1049
+ "Pbit": {
1050
+ "type": "number"
1051
+ }
1052
+ }
1053
+ },
1054
+ "video": {
1055
+ "type": "object",
1056
+ "properties": {
1057
+ "Enable": {
1058
+ "type": "boolean"
1059
+ },
1060
+ "VlanId": {
1061
+ "type": "number"
1062
+ },
1063
+ "Pbit": {
1064
+ "type": "number"
1065
+ }
1066
+ }
1067
+ },
1068
+ "voice": {
1069
+ "type": "object",
1070
+ "properties": {
1071
+ "ServiceType": {
1072
+ "type": "string"
1073
+ },
1074
+ "FaxT38": {
1075
+ "type": "object",
1076
+ "properties": {
1077
+ "Enable": {
1078
+ "type": "boolean"
1079
+ }
1080
+ }
1081
+ },
1082
+ "DialPlan": {
1083
+ "type": "string"
1084
+ },
1085
+ "Line": {
1086
+ "type": "object",
1087
+ "properties": {
1088
+ "1": {
1089
+ "type": "object",
1090
+ "properties": {
1091
+ "Enable": {
1092
+ "type": "string"
1093
+ },
1094
+ "SIP": {
1095
+ "type": "object",
1096
+ "properties": {
1097
+ "AuthUserName": {
1098
+ "type": "string"
1099
+ },
1100
+ "AuthPassword": {
1101
+ "type": "string"
1102
+ },
1103
+ "URI": {
1104
+ "type": "string"
1105
+ }
1106
+ }
1107
+ },
1108
+ "CallingFeatures": {
1109
+ "type": "object",
1110
+ "properties": {
1111
+ "CallerIDEnable": {
1112
+ "type": "boolean"
1113
+ },
1114
+ "CallWaitingEnable": {
1115
+ "type": "boolean"
1116
+ },
1117
+ "X_000631_ThreewayCallingEnable": {
1118
+ "type": "boolean"
1119
+ },
1120
+ "MWIEnable": {
1121
+ "type": "boolean"
1122
+ },
1123
+ "X_000631_DirectConnectEnable": {
1124
+ "type": "boolean"
1125
+ },
1126
+ "X_000631_DirectConnectNumber": {
1127
+ "type": "string"
1128
+ },
1129
+ "X_000631_DirectConnectTimer": {
1130
+ "type": "number"
1131
+ }
1132
+ }
1133
+ },
1134
+ "VoiceProcessing": {
1135
+ "type": "object",
1136
+ "properties": {
1137
+ "ReceiveGain": {
1138
+ "type": "number"
1139
+ },
1140
+ "TransmitGain": {
1141
+ "type": "number"
1142
+ }
1143
+ }
1144
+ }
1145
+ }
1146
+ },
1147
+ "2": {
1148
+ "type": "object",
1149
+ "properties": {
1150
+ "Enable": {
1151
+ "type": "string"
1152
+ }
1153
+ }
1154
+ }
1155
+ }
1156
+ }
1157
+ }
1158
+ },
1159
+ "wifi": {
1160
+ "type": "object",
1161
+ "properties": {
1162
+ "1": {
1163
+ "type": "object",
1164
+ "properties": {
1165
+ "Enable": {
1166
+ "type": "boolean"
1167
+ },
1168
+ "SSID": {
1169
+ "type": "string"
1170
+ },
1171
+ "SSIDAdvertisementEnabled": {
1172
+ "type": "boolean"
1173
+ },
1174
+ "BeaconType": {
1175
+ "type": "string"
1176
+ },
1177
+ "IEEE11iEncryptionModes": {
1178
+ "type": "string"
1179
+ },
1180
+ "WPAEncryptionModes": {
1181
+ "type": "string"
1182
+ },
1183
+ "KeyPassphrase": {
1184
+ "type": "string"
1185
+ }
1186
+ }
1187
+ },
1188
+ "9": {
1189
+ "type": "object",
1190
+ "properties": {
1191
+ "Enable": {
1192
+ "type": "boolean"
1193
+ },
1194
+ "SSID": {
1195
+ "type": "string"
1196
+ },
1197
+ "SSIDAdvertisementEnabled": {
1198
+ "type": "boolean"
1199
+ },
1200
+ "BeaconType": {
1201
+ "type": "string"
1202
+ },
1203
+ "IEEE11iEncryptionModes": {
1204
+ "type": "string"
1205
+ },
1206
+ "WPAEncryptionModes": {
1207
+ "type": "string"
1208
+ },
1209
+ "KeyPassphrase": {
1210
+ "type": "string"
1211
+ }
1212
+ }
1213
+ }
1214
+ }
1215
+ },
1216
+ "modelName": {
1217
+ "type": "string"
1218
+ }
1219
+ }
1220
+ }
1221
+ },
1222
+ "example": [
1223
+ {
1224
+ "_id": "b2fe4b73-a7f9-45c5-82d2-9d38247e0edf",
1225
+ "orgId": "12837558",
1226
+ "opMode": "RG",
1227
+ "deviceId": "CXNK00001234",
1228
+ "subscriberId": "45600aa6-ee09-4c0d-98e3-9569bc908673",
1229
+ "data": {
1230
+ "Enable": true,
1231
+ "pppoe": {
1232
+ "Username": "some@user.org",
1233
+ "Password": "my-ppp-password"
1234
+ },
1235
+ "VlanId": 888,
1236
+ "Pbit": 0
1237
+ },
1238
+ "video": {
1239
+ "Enable": true,
1240
+ "VlanId": 999,
1241
+ "Pbit": 4
1242
+ },
1243
+ "voice": {
1244
+ "ServiceType": "SIP",
1245
+ "FaxT38": {
1246
+ "Enable": false
1247
+ },
1248
+ "DialPlan": "system-default",
1249
+ "Line": {
1250
+ "1": {
1251
+ "Enable": "Enabled",
1252
+ "SIP": {
1253
+ "AuthUserName": "9191234567",
1254
+ "AuthPassword": "my-sip-password",
1255
+ "URI": "9191234567"
1256
+ },
1257
+ "CallingFeatures": {
1258
+ "CallerIDEnable": true,
1259
+ "CallWaitingEnable": true,
1260
+ "X_000631_ThreewayCallingEnable": true,
1261
+ "MWIEnable": true,
1262
+ "X_000631_DirectConnectEnable": false,
1263
+ "X_000631_DirectConnectNumber": "",
1264
+ "X_000631_DirectConnectTimer": 0
1265
+ },
1266
+ "VoiceProcessing": {
1267
+ "ReceiveGain": -90,
1268
+ "TransmitGain": -30
1269
+ }
1270
+ },
1271
+ "2": {
1272
+ "Enable": "Disabled"
1273
+ }
1274
+ }
1275
+ },
1276
+ "wifi": {
1277
+ "1": {
1278
+ "Enable": true,
1279
+ "SSID": "Test User Home",
1280
+ "SSIDAdvertisementEnabled": true,
1281
+ "BeaconType": "WPAand11i",
1282
+ "IEEE11iEncryptionModes": "AESEncryption",
1283
+ "WPAEncryptionModes": "AESEncryption",
1284
+ "KeyPassphrase": "s3crets!!"
1285
+ },
1286
+ "9": {
1287
+ "Enable": true,
1288
+ "SSID": "Test User Home",
1289
+ "SSIDAdvertisementEnabled": true,
1290
+ "BeaconType": "WPAand11i",
1291
+ "IEEE11iEncryptionModes": "AESEncryption",
1292
+ "WPAEncryptionModes": "AESEncryption",
1293
+ "KeyPassphrase": "s3crets!!"
1294
+ }
1295
+ },
1296
+ "modelName": "844E-1"
1297
+ }
1298
+ ]
1299
+ }
1300
+ }
1301
+ }
1302
+ },
1303
+ "requestBody": {
1304
+ "content": {
1305
+ "application/json": {
1306
+ "schema": {
1307
+ "type": "object"
1308
+ },
1309
+ "example": {}
1310
+ }
1311
+ }
1312
+ }
1313
+ }
1314
+ },
1315
+ "/provisioning-record/{provisioningRecordId}": {
1316
+ "get": {
1317
+ "tags": [
1318
+ "DeviceProvisioningRecordManagement"
1319
+ ],
1320
+ "operationId": "retrieveProvisioningRecordByInternalID",
1321
+ "description": "The parameters and request body are for method: retrieveProvisioningRecordByInternalID. Same endpoint also used in methods:",
1322
+ "responses": {
1323
+ "200": {
1324
+ "description": "Successful operation",
1325
+ "content": {
1326
+ "application/json": {
1327
+ "schema": {
1328
+ "type": "object",
1329
+ "properties": {
1330
+ "_id": {
1331
+ "type": "string"
1332
+ },
1333
+ "opMode": {
1334
+ "type": "string"
1335
+ },
1336
+ "deviceId": {
1337
+ "type": "string"
1338
+ },
1339
+ "subscriberId": {
1340
+ "type": "string"
1341
+ },
1342
+ "data": {
1343
+ "type": "object",
1344
+ "properties": {
1345
+ "Enable": {
1346
+ "type": "boolean"
1347
+ },
1348
+ "pppoe": {
1349
+ "type": "object",
1350
+ "properties": {
1351
+ "Username": {
1352
+ "type": "string"
1353
+ },
1354
+ "Password": {
1355
+ "type": "string"
1356
+ }
1357
+ }
1358
+ },
1359
+ "VlanId": {
1360
+ "type": "number"
1361
+ },
1362
+ "Pbit": {
1363
+ "type": "number"
1364
+ }
1365
+ }
1366
+ },
1367
+ "video": {
1368
+ "type": "object",
1369
+ "properties": {
1370
+ "Enable": {
1371
+ "type": "boolean"
1372
+ },
1373
+ "VlanId": {
1374
+ "type": "number"
1375
+ },
1376
+ "Pbit": {
1377
+ "type": "number"
1378
+ }
1379
+ }
1380
+ },
1381
+ "voice": {
1382
+ "type": "object",
1383
+ "properties": {
1384
+ "ServiceType": {
1385
+ "type": "string"
1386
+ },
1387
+ "FaxT38": {
1388
+ "type": "object",
1389
+ "properties": {
1390
+ "Enable": {
1391
+ "type": "boolean"
1392
+ }
1393
+ }
1394
+ },
1395
+ "DialPlan": {
1396
+ "type": "string"
1397
+ },
1398
+ "Line": {
1399
+ "type": "object",
1400
+ "properties": {
1401
+ "1": {
1402
+ "type": "object",
1403
+ "properties": {
1404
+ "Enable": {
1405
+ "type": "string"
1406
+ },
1407
+ "SIP": {
1408
+ "type": "object",
1409
+ "properties": {
1410
+ "AuthUserName": {
1411
+ "type": "string"
1412
+ },
1413
+ "AuthPassword": {
1414
+ "type": "string"
1415
+ },
1416
+ "URI": {
1417
+ "type": "string"
1418
+ }
1419
+ }
1420
+ },
1421
+ "CallingFeatures": {
1422
+ "type": "object",
1423
+ "properties": {
1424
+ "CallerIDEnable": {
1425
+ "type": "boolean"
1426
+ },
1427
+ "CallWaitingEnable": {
1428
+ "type": "boolean"
1429
+ },
1430
+ "X_000631_ThreewayCallingEnable": {
1431
+ "type": "boolean"
1432
+ },
1433
+ "MWIEnable": {
1434
+ "type": "boolean"
1435
+ },
1436
+ "X_000631_DirectConnectEnable": {
1437
+ "type": "boolean"
1438
+ },
1439
+ "X_000631_DirectConnectNumber": {
1440
+ "type": "string"
1441
+ },
1442
+ "X_000631_DirectConnectTimer": {
1443
+ "type": "number"
1444
+ }
1445
+ }
1446
+ },
1447
+ "VoiceProcessing": {
1448
+ "type": "object",
1449
+ "properties": {
1450
+ "ReceiveGain": {
1451
+ "type": "number"
1452
+ },
1453
+ "TransmitGain": {
1454
+ "type": "number"
1455
+ }
1456
+ }
1457
+ }
1458
+ }
1459
+ },
1460
+ "2": {
1461
+ "type": "object",
1462
+ "properties": {
1463
+ "Enable": {
1464
+ "type": "string"
1465
+ }
1466
+ }
1467
+ }
1468
+ }
1469
+ }
1470
+ }
1471
+ },
1472
+ "wifi": {
1473
+ "type": "object",
1474
+ "properties": {
1475
+ "1": {
1476
+ "type": "object",
1477
+ "properties": {
1478
+ "Enable": {
1479
+ "type": "boolean"
1480
+ },
1481
+ "SSID": {
1482
+ "type": "string"
1483
+ },
1484
+ "SSIDAdvertisementEnabled": {
1485
+ "type": "boolean"
1486
+ },
1487
+ "BeaconType": {
1488
+ "type": "string"
1489
+ },
1490
+ "IEEE11iEncryptionModes": {
1491
+ "type": "string"
1492
+ },
1493
+ "WPAEncryptionModes": {
1494
+ "type": "string"
1495
+ },
1496
+ "KeyPassphrase": {
1497
+ "type": "string"
1498
+ },
1499
+ "RadioEnabled": {
1500
+ "type": "boolean"
1501
+ }
1502
+ }
1503
+ },
1504
+ "9": {
1505
+ "type": "object",
1506
+ "properties": {
1507
+ "Enable": {
1508
+ "type": "boolean"
1509
+ },
1510
+ "SSID": {
1511
+ "type": "string"
1512
+ },
1513
+ "SSIDAdvertisementEnabled": {
1514
+ "type": "boolean"
1515
+ },
1516
+ "BeaconType": {
1517
+ "type": "string"
1518
+ },
1519
+ "IEEE11iEncryptionModes": {
1520
+ "type": "string"
1521
+ },
1522
+ "WPAEncryptionModes": {
1523
+ "type": "string"
1524
+ },
1525
+ "KeyPassphrase": {
1526
+ "type": "string"
1527
+ },
1528
+ "RadioEnabled": {
1529
+ "type": "boolean"
1530
+ }
1531
+ }
1532
+ }
1533
+ }
1534
+ },
1535
+ "modelName": {
1536
+ "type": "string"
1537
+ },
1538
+ "orgId": {
1539
+ "type": "string"
1540
+ }
1541
+ }
1542
+ },
1543
+ "example": {
1544
+ "_id": "cdfc1c38-5836-4264-94d2-af0be7cf51bd",
1545
+ "opMode": "RG",
1546
+ "deviceId": "CXNK00001234",
1547
+ "subscriberId": "45600aa6-ee09-4c0d-98e3-9569bc908673",
1548
+ "data": {
1549
+ "Enable": true,
1550
+ "pppoe": {
1551
+ "Username": "some@user.org",
1552
+ "Password": "my-ppp-password"
1553
+ },
1554
+ "VlanId": 888,
1555
+ "Pbit": 0
1556
+ },
1557
+ "video": {
1558
+ "Enable": true,
1559
+ "VlanId": 999,
1560
+ "Pbit": 4
1561
+ },
1562
+ "voice": {
1563
+ "ServiceType": "SIP",
1564
+ "FaxT38": {
1565
+ "Enable": false
1566
+ },
1567
+ "DialPlan": "system-default",
1568
+ "Line": {
1569
+ "1": {
1570
+ "Enable": "Enabled",
1571
+ "SIP": {
1572
+ "AuthUserName": "9191234567",
1573
+ "AuthPassword": "my-sip-password",
1574
+ "URI": "9191234567"
1575
+ },
1576
+ "CallingFeatures": {
1577
+ "CallerIDEnable": true,
1578
+ "CallWaitingEnable": true,
1579
+ "X_000631_ThreewayCallingEnable": true,
1580
+ "MWIEnable": true,
1581
+ "X_000631_DirectConnectEnable": false,
1582
+ "X_000631_DirectConnectNumber": "",
1583
+ "X_000631_DirectConnectTimer": 0
1584
+ },
1585
+ "VoiceProcessing": {
1586
+ "ReceiveGain": -90,
1587
+ "TransmitGain": -30
1588
+ }
1589
+ },
1590
+ "2": {
1591
+ "Enable": "Disabled"
1592
+ }
1593
+ }
1594
+ },
1595
+ "wifi": {
1596
+ "1": {
1597
+ "Enable": true,
1598
+ "SSID": "Test User Home",
1599
+ "SSIDAdvertisementEnabled": true,
1600
+ "BeaconType": "WPAand11i",
1601
+ "IEEE11iEncryptionModes": "AESEncryption",
1602
+ "WPAEncryptionModes": "AESEncryption",
1603
+ "KeyPassphrase": "s3crets!!",
1604
+ "RadioEnabled": true
1605
+ },
1606
+ "9": {
1607
+ "Enable": true,
1608
+ "SSID": "Test User Home",
1609
+ "SSIDAdvertisementEnabled": true,
1610
+ "BeaconType": "WPAand11i",
1611
+ "IEEE11iEncryptionModes": "AESEncryption",
1612
+ "WPAEncryptionModes": "AESEncryption",
1613
+ "KeyPassphrase": "s3crets!!",
1614
+ "RadioEnabled": true
1615
+ }
1616
+ },
1617
+ "modelName": "844E-1",
1618
+ "orgId": "12837558"
1619
+ }
1620
+ }
1621
+ }
1622
+ }
1623
+ },
1624
+ "parameters": [
1625
+ {
1626
+ "name": "provisioningRecordId",
1627
+ "in": "path",
1628
+ "required": true,
1629
+ "schema": {
1630
+ "title": "provisioningRecordId",
1631
+ "type": "string"
1632
+ }
1633
+ }
1634
+ ],
1635
+ "requestBody": {
1636
+ "content": {
1637
+ "application/json": {
1638
+ "schema": {
1639
+ "type": "object"
1640
+ },
1641
+ "example": {}
1642
+ }
1643
+ }
1644
+ }
1645
+ },
1646
+ "delete": {
1647
+ "tags": [
1648
+ "DeviceProvisioningRecordManagement"
1649
+ ],
1650
+ "operationId": "deleteProvisioningRecord",
1651
+ "description": "The parameters and request body are for method: deleteProvisioningRecord. Same endpoint also used in methods:",
1652
+ "responses": {
1653
+ "200": {
1654
+ "description": "Successful operation",
1655
+ "content": {
1656
+ "application/json": {
1657
+ "schema": {
1658
+ "title": "result",
1659
+ "type": "object"
1660
+ }
1661
+ }
1662
+ }
1663
+ }
1664
+ },
1665
+ "parameters": [
1666
+ {
1667
+ "name": "provisioningRecordId",
1668
+ "in": "path",
1669
+ "required": true,
1670
+ "schema": {
1671
+ "title": "provisioningRecordId",
1672
+ "type": "string"
1673
+ }
1674
+ }
1675
+ ],
1676
+ "requestBody": {
1677
+ "content": {
1678
+ "application/json": {
1679
+ "schema": {
1680
+ "type": "object"
1681
+ },
1682
+ "example": {}
1683
+ }
1684
+ }
1685
+ }
1686
+ }
1687
+ },
1688
+ "/provisioning-record/{provRecordId}": {
1689
+ "put": {
1690
+ "tags": [
1691
+ "DeviceProvisioningRecordManagement"
1692
+ ],
1693
+ "operationId": "modifyProvisioningRecord",
1694
+ "description": "The parameters and request body are for method: modifyProvisioningRecord. Same endpoint also used in methods:",
1695
+ "responses": {
1696
+ "200": {
1697
+ "description": "Successful operation",
1698
+ "content": {
1699
+ "application/json": {
1700
+ "schema": {
1701
+ "title": "result",
1702
+ "type": "object"
1703
+ }
1704
+ }
1705
+ }
1706
+ }
1707
+ },
1708
+ "parameters": [
1709
+ {
1710
+ "name": "provRecordId",
1711
+ "in": "path",
1712
+ "required": true,
1713
+ "schema": {
1714
+ "title": "provRecordId",
1715
+ "type": "string"
1716
+ }
1717
+ }
1718
+ ],
1719
+ "requestBody": {
1720
+ "description": "indeterminate body object",
1721
+ "content": {
1722
+ "application/json": {
1723
+ "schema": {
1724
+ "type": "object"
1725
+ }
1726
+ }
1727
+ }
1728
+ }
1729
+ }
1730
+ },
1731
+ "/device-op": {
1732
+ "post": {
1733
+ "tags": [
1734
+ "TR69DeviceOperations"
1735
+ ],
1736
+ "operationId": "operateTR69Device",
1737
+ "description": "The parameters and request body are for method: operateTR69Device. Same endpoint also used in methods:",
1738
+ "responses": {
1739
+ "200": {
1740
+ "description": "Successful operation",
1741
+ "content": {
1742
+ "application/json": {
1743
+ "schema": {
1744
+ "title": "result",
1745
+ "type": "object"
1746
+ }
1747
+ }
1748
+ }
1749
+ }
1750
+ },
1751
+ "requestBody": {
1752
+ "description": "indeterminate body object",
1753
+ "content": {
1754
+ "application/json": {
1755
+ "schema": {
1756
+ "type": "object"
1757
+ }
1758
+ }
1759
+ }
1760
+ }
1761
+ }
1762
+ },
1763
+ "/group": {
1764
+ "get": {
1765
+ "tags": [
1766
+ "DeviceGroupManagement"
1767
+ ],
1768
+ "operationId": "retrieveAllDeviceGroups",
1769
+ "description": "The parameters and request body are for method: retrieveAllDeviceGroups. Same endpoint also used in methods:",
1770
+ "responses": {
1771
+ "200": {
1772
+ "description": "Successful operation",
1773
+ "content": {
1774
+ "application/json": {
1775
+ "schema": {
1776
+ "type": "array",
1777
+ "items": {
1778
+ "type": "object",
1779
+ "properties": {
1780
+ "_id": {
1781
+ "type": "string"
1782
+ },
1783
+ "name": {
1784
+ "type": "string"
1785
+ },
1786
+ "description": {
1787
+ "type": "string"
1788
+ },
1789
+ "type": {
1790
+ "type": "string"
1791
+ }
1792
+ }
1793
+ }
1794
+ },
1795
+ "example": [
1796
+ {
1797
+ "_id": "4a942d03-1b7c-4c7f-9771-b19f143907f5",
1798
+ "name": "All 844E",
1799
+ "description": "Dynamic group containing all Calix 844E devices",
1800
+ "type": "dynamic"
1801
+ },
1802
+ {
1803
+ "_id": "e66c8389-e62e-453e-ae84-9029783937b3",
1804
+ "name": "844E PPPoE",
1805
+ "description": "Group for all PPPoE-provisioned devices",
1806
+ "type": "static",
1807
+ "allowInheritance": true
1808
+ },
1809
+ {
1810
+ "_id": "243d890b-9e41-473e-baa6-5196390ab062",
1811
+ "name": "All GigaSpire Blast GS2020E",
1812
+ "description": "",
1813
+ "type": "dynamic"
1814
+ },
1815
+ {
1816
+ "_id": "ded2dd56-0d74-4c54-969a-dad4e55b1e46",
1817
+ "name": "All GigaSpire Max GS2026E",
1818
+ "description": "",
1819
+ "type": "dynamic"
1820
+ },
1821
+ {
1822
+ "_id": "9110ebfb-97d7-4f0f-8738-8a5b014a0a8a",
1823
+ "name": "Lab Test GigaSpires",
1824
+ "description": "Static group for all initial testing of new GigaSpire software",
1825
+ "type": "static",
1826
+ "allowInheritance": true
1827
+ }
1828
+ ]
1829
+ }
1830
+ }
1831
+ }
1832
+ },
1833
+ "requestBody": {
1834
+ "content": {
1835
+ "application/json": {
1836
+ "schema": {
1837
+ "type": "object"
1838
+ },
1839
+ "example": {}
1840
+ }
1841
+ }
1842
+ }
1843
+ }
1844
+ },
1845
+ "/group/{groupId}": {
1846
+ "get": {
1847
+ "tags": [
1848
+ "DeviceGroupManagement"
1849
+ ],
1850
+ "operationId": "retrieveDeviceGroupByID",
1851
+ "description": "The parameters and request body are for method: retrieveDeviceGroupByID. Same endpoint also used in methods:",
1852
+ "responses": {
1853
+ "200": {
1854
+ "description": "Successful operation",
1855
+ "content": {
1856
+ "application/json": {
1857
+ "schema": {
1858
+ "type": "object",
1859
+ "properties": {
1860
+ "_id": {
1861
+ "type": "string"
1862
+ },
1863
+ "name": {
1864
+ "type": "string"
1865
+ },
1866
+ "description": {
1867
+ "type": "string"
1868
+ },
1869
+ "type": {
1870
+ "type": "string"
1871
+ },
1872
+ "allowInheritance": {
1873
+ "type": "boolean"
1874
+ }
1875
+ }
1876
+ },
1877
+ "example": {
1878
+ "_id": "9110ebfb-97d7-4f0f-8738-8a5b014a0a8a",
1879
+ "name": "Lab Test GigaSpires",
1880
+ "description": "",
1881
+ "type": "static",
1882
+ "allowInheritance": true
1883
+ }
1884
+ }
1885
+ }
1886
+ }
1887
+ },
1888
+ "parameters": [
1889
+ {
1890
+ "name": "groupId",
1891
+ "in": "path",
1892
+ "required": true,
1893
+ "schema": {
1894
+ "title": "groupId",
1895
+ "type": "string"
1896
+ }
1897
+ }
1898
+ ],
1899
+ "requestBody": {
1900
+ "content": {
1901
+ "application/json": {
1902
+ "schema": {
1903
+ "type": "object"
1904
+ },
1905
+ "example": {}
1906
+ }
1907
+ }
1908
+ }
1909
+ }
1910
+ },
1911
+ "/static-group-member": {
1912
+ "get": {
1913
+ "tags": [
1914
+ "DeviceGroupManagement"
1915
+ ],
1916
+ "operationId": "retrieveAllStaticGroupMemberships",
1917
+ "description": "The parameters and request body are for method: retrieveAllStaticGroupMemberships. Same endpoint also used in methods:<br> retrieveStaticGroupMembershipsByDevice (memberInfo : string)",
1918
+ "responses": {
1919
+ "200": {
1920
+ "description": "Successful operation",
1921
+ "content": {
1922
+ "application/json": {
1923
+ "schema": {
1924
+ "type": "array",
1925
+ "items": {
1926
+ "type": "object",
1927
+ "properties": {
1928
+ "_id": {
1929
+ "type": "string"
1930
+ },
1931
+ "groupId": {
1932
+ "type": "string"
1933
+ },
1934
+ "type": {
1935
+ "type": "string"
1936
+ },
1937
+ "memberInfo": {
1938
+ "type": "string"
1939
+ },
1940
+ "orgId": {
1941
+ "type": "string"
1942
+ },
1943
+ "deviceRecordId": {
1944
+ "type": "string"
1945
+ },
1946
+ "createTime": {
1947
+ "type": "string"
1948
+ }
1949
+ }
1950
+ }
1951
+ },
1952
+ "example": [
1953
+ {
1954
+ "_id": "6a747bc9-d2e6-4d99-82cd-25a84057e93e",
1955
+ "groupId": "e66c8389-e62e-453e-ae84-9029783937b3",
1956
+ "type": "FSAN",
1957
+ "memberInfo": "CXNK001D9030",
1958
+ "orgId": "12837558",
1959
+ "deviceRecordId": "12837558-000631-CXNK001D9030",
1960
+ "createTime": "2019-04-15T15:23:57.047Z"
1961
+ }
1962
+ ]
1963
+ }
1964
+ }
1965
+ }
1966
+ },
1967
+ "parameters": [
1968
+ {
1969
+ "name": "bDiscovered",
1970
+ "in": "query",
1971
+ "required": true,
1972
+ "schema": {
1973
+ "type": "string"
1974
+ }
1975
+ },
1976
+ {
1977
+ "name": "bUndiscovered",
1978
+ "in": "query",
1979
+ "required": true,
1980
+ "schema": {
1981
+ "type": "string"
1982
+ }
1983
+ }
1984
+ ],
1985
+ "requestBody": {
1986
+ "content": {
1987
+ "application/json": {
1988
+ "schema": {
1989
+ "type": "object"
1990
+ },
1991
+ "example": {}
1992
+ }
1993
+ }
1994
+ }
1995
+ },
1996
+ "post": {
1997
+ "tags": [
1998
+ "DeviceGroupManagement"
1999
+ ],
2000
+ "operationId": "addADeviceOrProvisioningRecordToAStaticGroup",
2001
+ "description": "The parameters and request body are for method: addADeviceOrProvisioningRecordToAStaticGroup. Same endpoint also used in methods:",
2002
+ "responses": {
2003
+ "200": {
2004
+ "description": "Successful operation",
2005
+ "content": {
2006
+ "application/json": {
2007
+ "schema": {
2008
+ "title": "result",
2009
+ "type": "object"
2010
+ }
2011
+ }
2012
+ }
2013
+ }
2014
+ },
2015
+ "requestBody": {
2016
+ "description": "indeterminate body object",
2017
+ "content": {
2018
+ "application/json": {
2019
+ "schema": {
2020
+ "type": "object"
2021
+ }
2022
+ }
2023
+ }
2024
+ }
2025
+ },
2026
+ "delete": {
2027
+ "tags": [
2028
+ "DeviceGroupManagement"
2029
+ ],
2030
+ "operationId": "removeADeviceFromAllStaticGroups",
2031
+ "description": "The parameters and request body are for method: removeADeviceFromAllStaticGroups. Same endpoint also used in methods:<br> removeADeviceFromAStaticGroupByGroupIDAndDevice (groupId : string,memberInfo : string)",
2032
+ "responses": {
2033
+ "200": {
2034
+ "description": "Successful operation",
2035
+ "content": {
2036
+ "application/json": {
2037
+ "schema": {
2038
+ "type": "object",
2039
+ "properties": {
2040
+ "numberOfRecords": {
2041
+ "type": "number"
2042
+ }
2043
+ }
2044
+ },
2045
+ "example": {
2046
+ "numberOfRecords": 1
2047
+ }
2048
+ }
2049
+ }
2050
+ }
2051
+ },
2052
+ "parameters": [
2053
+ {
2054
+ "name": "memberInfo",
2055
+ "in": "query",
2056
+ "required": true,
2057
+ "schema": {
2058
+ "type": "string"
2059
+ }
2060
+ }
2061
+ ],
2062
+ "requestBody": {
2063
+ "content": {
2064
+ "application/json": {
2065
+ "schema": {
2066
+ "type": "object"
2067
+ },
2068
+ "example": {}
2069
+ }
2070
+ }
2071
+ }
2072
+ }
2073
+ },
2074
+ "/static-group-member/{groupMembershipId}": {
2075
+ "get": {
2076
+ "tags": [
2077
+ "DeviceGroupManagement"
2078
+ ],
2079
+ "operationId": "retrieveSingleStaticGroupMembershipRecord",
2080
+ "description": "The parameters and request body are for method: retrieveSingleStaticGroupMembershipRecord. Same endpoint also used in methods:",
2081
+ "responses": {
2082
+ "200": {
2083
+ "description": "Successful operation",
2084
+ "content": {
2085
+ "application/json": {
2086
+ "schema": {
2087
+ "type": "object",
2088
+ "properties": {
2089
+ "_id": {
2090
+ "type": "string"
2091
+ },
2092
+ "groupId": {
2093
+ "type": "string"
2094
+ },
2095
+ "type": {
2096
+ "type": "string"
2097
+ },
2098
+ "memberInfo": {
2099
+ "type": "string"
2100
+ },
2101
+ "orgId": {
2102
+ "type": "string"
2103
+ },
2104
+ "deviceRecordId": {
2105
+ "type": "string"
2106
+ },
2107
+ "createTime": {
2108
+ "type": "string"
2109
+ }
2110
+ }
2111
+ },
2112
+ "example": {
2113
+ "_id": "d74d3aa2-bbb5-4af7-8365-3262ddddf0f5",
2114
+ "groupId": "e66c8389-e62e-453e-ae84-9029783937b3",
2115
+ "type": "FSAN",
2116
+ "memberInfo": "CXNK001D9031",
2117
+ "orgId": "12837558",
2118
+ "deviceRecordId": "12837558-000631-CXNK001D9031",
2119
+ "createTime": "2019-05-22T15:39:07.329Z"
2120
+ }
2121
+ }
2122
+ }
2123
+ }
2124
+ },
2125
+ "parameters": [
2126
+ {
2127
+ "name": "groupMembershipId",
2128
+ "in": "path",
2129
+ "required": true,
2130
+ "schema": {
2131
+ "title": "groupMembershipId",
2132
+ "type": "string"
2133
+ }
2134
+ }
2135
+ ],
2136
+ "requestBody": {
2137
+ "content": {
2138
+ "application/json": {
2139
+ "schema": {
2140
+ "type": "object"
2141
+ },
2142
+ "example": {}
2143
+ }
2144
+ }
2145
+ }
2146
+ }
2147
+ },
2148
+ "/static-group-member/{membershipId}": {
2149
+ "delete": {
2150
+ "tags": [
2151
+ "DeviceGroupManagement"
2152
+ ],
2153
+ "operationId": "removeADeviceFromAStaticGroupByMembershipID",
2154
+ "description": "The parameters and request body are for method: removeADeviceFromAStaticGroupByMembershipID. Same endpoint also used in methods:",
2155
+ "responses": {
2156
+ "200": {
2157
+ "description": "Successful operation",
2158
+ "content": {
2159
+ "application/json": {
2160
+ "schema": {
2161
+ "title": "result",
2162
+ "type": "object"
2163
+ }
2164
+ }
2165
+ }
2166
+ }
2167
+ },
2168
+ "parameters": [
2169
+ {
2170
+ "name": "membershipId",
2171
+ "in": "path",
2172
+ "required": true,
2173
+ "schema": {
2174
+ "title": "membershipId",
2175
+ "type": "string"
2176
+ }
2177
+ }
2178
+ ],
2179
+ "requestBody": {
2180
+ "content": {
2181
+ "application/json": {
2182
+ "schema": {
2183
+ "type": "object"
2184
+ },
2185
+ "example": {}
2186
+ }
2187
+ }
2188
+ }
2189
+ }
2190
+ }
2191
+ },
2192
+ "components": {
2193
+ "schemas": {}
2194
+ }
2195
+ }