@itentialopensource/adapter-thingspace 0.1.3 → 0.2.1

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 (43) hide show
  1. package/.eslintignore +0 -1
  2. package/.jshintrc +3 -0
  3. package/CALLS.md +26 -26
  4. package/CHANGELOG.md +16 -0
  5. package/CONTRIBUTING.md +1 -160
  6. package/ENHANCE.md +2 -2
  7. package/README.md +31 -22
  8. package/adapter.js +159 -330
  9. package/adapterBase.js +538 -873
  10. package/changelogs/changelog.md +24 -0
  11. package/metadata.json +47 -0
  12. package/package.json +22 -25
  13. package/pronghorn.json +474 -142
  14. package/propertiesSchema.json +452 -40
  15. package/refs?service=git-upload-pack +0 -0
  16. package/report/adapter-openapi.json +4020 -0
  17. package/report/adapter-openapi.yaml +2994 -0
  18. package/report/adapterInfo.json +8 -8
  19. package/report/updateReport1691507577332.json +120 -0
  20. package/report/updateReport1692202573890.json +120 -0
  21. package/report/updateReport1694461772493.json +120 -0
  22. package/report/updateReport1698420941061.json +120 -0
  23. package/sampleProperties.json +63 -2
  24. package/test/integration/adapterTestBasicGet.js +1 -1
  25. package/test/integration/adapterTestConnectivity.js +91 -42
  26. package/test/integration/adapterTestIntegration.js +130 -2
  27. package/test/unit/adapterBaseTestUnit.js +388 -314
  28. package/test/unit/adapterTestUnit.js +306 -109
  29. package/utils/adapterInfo.js +1 -1
  30. package/utils/addAuth.js +1 -1
  31. package/utils/artifactize.js +1 -1
  32. package/utils/checkMigrate.js +1 -1
  33. package/utils/entitiesToDB.js +1 -0
  34. package/utils/findPath.js +1 -1
  35. package/utils/methodDocumentor.js +71 -23
  36. package/utils/modify.js +13 -15
  37. package/utils/packModificationScript.js +1 -1
  38. package/utils/taskMover.js +309 -0
  39. package/utils/tbScript.js +3 -10
  40. package/utils/tbUtils.js +2 -3
  41. package/utils/testRunner.js +1 -1
  42. package/utils/troubleshootingAdapter.js +1 -3
  43. package/workflows/README.md +0 -3
package/report/adapter-openapi.yaml ADDED
@@ -0,0 +1,2994 @@
1
+ openapi: 3.0.0
2
+ info:
3
+ title: ThingSpace Connectivity Management API
4
+ description: You can download the <a href="/content/dam/thingspace-portal/resources/documentation/swagger/m2m-all.json" download = "Connectivity_Management.json">JSON file here</a>.
5
+ contact: {}
6
+ version: 'v5.12'
7
+ servers:
8
+ - url: https://{host}/api/m2m/v1
9
+ variables:
10
+ host:
11
+ default: hostDefaultValue
12
+ - url: https://thingspace.verizon.com/api/ts/v1/oauth2
13
+ variables: {}
14
+ paths:
15
+ /devices/actions/activate:
16
+ post:
17
+ tags:
18
+ - devices
19
+ summary: activeUsingPOST
20
+ description: If the devices do not already exist in the account, this API resource adds them before activation.
21
+ operationId: activeUsingPOST
22
+ parameters:
23
+ - name: VZ-M2M-Token
24
+ in: header
25
+ description: VZ-M2M session token
26
+ required: true
27
+ style: simple
28
+ schema:
29
+ type: string
30
+ requestBody:
31
+ description: Activate request
32
+ content:
33
+ application/json:
34
+ schema:
35
+ allOf:
36
+ - $ref: '#/components/schemas/CarrierActivateRequest'
37
+ - description: Activate request
38
+ required: true
39
+ responses:
40
+ '200':
41
+ description: Request ID
42
+ headers: {}
43
+ content:
44
+ application/json:
45
+ schema:
46
+ $ref: '#/components/schemas/RequestResponse'
47
+ '400':
48
+ description: Error Response
49
+ headers: {}
50
+ content:
51
+ application/json:
52
+ schema:
53
+ $ref: '#/components/schemas/RestErrorResponse'
54
+ deprecated: false
55
+ /devices/actions/add:
56
+ post:
57
+ tags:
58
+ - devices
59
+ summary: addUsingPOST
60
+ description: Use this API if you want to manage some device settings before you are ready to activate service for the devices.
61
+ operationId: addUsingPOST
62
+ parameters:
63
+ - name: VZ-M2M-Token
64
+ in: header
65
+ description: VZ-M2M session token
66
+ required: true
67
+ style: simple
68
+ schema:
69
+ type: string
70
+ requestBody:
71
+ description: Devices to Add
72
+ content:
73
+ application/json:
74
+ schema:
75
+ allOf:
76
+ - $ref: '#/components/schemas/AddDevicesRequest'
77
+ - description: Devices to Add
78
+ required: true
79
+ responses:
80
+ '200':
81
+ description: For each device in the request, contains device identifiers and a success or failure response.
82
+ headers: {}
83
+ content:
84
+ application/json:
85
+ schema:
86
+ type: array
87
+ items:
88
+ $ref: '#/components/schemas/AddDevicesResponseMessage'
89
+ description: ''
90
+ '400':
91
+ description: Error Response
92
+ headers: {}
93
+ content:
94
+ application/json:
95
+ schema:
96
+ $ref: '#/components/schemas/RestErrorResponse'
97
+ deprecated: false
98
+ /devices/actions/contactinfo:
99
+ put:
100
+ tags:
101
+ - devices
102
+ summary: updateContactInfoUsingPUT
103
+ description: Sends a CarrierService callback message for each device in the request when the contact information has been changed, or if there was a problem and the change could not be completed.
104
+ operationId: updateContactInfoUsingPUT
105
+ parameters:
106
+ - name: VZ-M2M-Token
107
+ in: header
108
+ description: VZ-M2M session token
109
+ required: true
110
+ style: simple
111
+ schema:
112
+ type: string
113
+ requestBody:
114
+ description: Change contact info request
115
+ content:
116
+ application/json:
117
+ schema:
118
+ allOf:
119
+ - $ref: '#/components/schemas/ContactInfoUpdateRequest'
120
+ - description: Change contact info request
121
+ required: true
122
+ responses:
123
+ '200':
124
+ description: Request ID
125
+ headers: {}
126
+ content:
127
+ application/json:
128
+ schema:
129
+ $ref: '#/components/schemas/RequestResponse'
130
+ '400':
131
+ description: Error Response
132
+ headers: {}
133
+ content:
134
+ application/json:
135
+ schema:
136
+ $ref: '#/components/schemas/RestErrorResponse'
137
+ deprecated: false
138
+ /devices/actions/customFields:
139
+ put:
140
+ tags:
141
+ - devices
142
+ summary: updateCustomFieldsUsingPUT
143
+ description: Sends a CarrierService callback message for each device in the request when the custom fields have been changed, or if there was a problem and the change could not be completed.
144
+ operationId: updateCustomFieldsUsingPUT
145
+ parameters:
146
+ - name: VZ-M2M-Token
147
+ in: header
148
+ description: VZ-M2M session token
149
+ required: true
150
+ style: simple
151
+ schema:
152
+ type: string
153
+ requestBody:
154
+ description: Change custom fields request
155
+ content:
156
+ application/json:
157
+ schema:
158
+ allOf:
159
+ - $ref: '#/components/schemas/CustomFieldsUpdateRequest'
160
+ - description: Change custom fields request
161
+ required: true
162
+ responses:
163
+ '200':
164
+ description: Request ID
165
+ headers: {}
166
+ content:
167
+ application/json:
168
+ schema:
169
+ $ref: '#/components/schemas/RequestResponse'
170
+ '400':
171
+ description: Error Response
172
+ headers: {}
173
+ content:
174
+ application/json:
175
+ schema:
176
+ $ref: '#/components/schemas/RestErrorResponse'
177
+ deprecated: false
178
+ /devices/actions/deactivate:
179
+ post:
180
+ tags:
181
+ - devices
182
+ summary: deactiveUsingPOST
183
+ description: Deactivating service for a device may result in an early termination fee (ETF) being charged to the account, depending on the terms of the contract with Verizon. If your contract allows ETF waivers and if you want to use one for a particular deactivation, set the etfWaiver value to True.
184
+ operationId: deactiveUsingPOST
185
+ parameters:
186
+ - name: VZ-M2M-Token
187
+ in: header
188
+ description: VZ-M2M session token
189
+ required: true
190
+ style: simple
191
+ schema:
192
+ type: string
193
+ requestBody:
194
+ description: Deactivate request
195
+ content:
196
+ application/json:
197
+ schema:
198
+ allOf:
199
+ - $ref: '#/components/schemas/CarrierDeactivateRequest'
200
+ - description: Deactivate request
201
+ required: true
202
+ responses:
203
+ '200':
204
+ description: Request ID
205
+ headers: {}
206
+ content:
207
+ application/json:
208
+ schema:
209
+ $ref: '#/components/schemas/RequestResponse'
210
+ '400':
211
+ description: Error Response
212
+ headers: {}
213
+ content:
214
+ application/json:
215
+ schema:
216
+ $ref: '#/components/schemas/RestErrorResponse'
217
+ deprecated: false
218
+ /devices/actions/delete:
219
+ post:
220
+ tags:
221
+ - devices
222
+ summary: deleteUsingPOST
223
+ description: Use this API to remove unneeded devices from an account
224
+ operationId: deleteUsingPOST
225
+ parameters:
226
+ - name: VZ-M2M-Token
227
+ in: header
228
+ description: VZ-M2M session token
229
+ required: true
230
+ style: simple
231
+ schema:
232
+ type: string
233
+ requestBody:
234
+ description: Devices to delete
235
+ content:
236
+ application/json:
237
+ schema:
238
+ allOf:
239
+ - $ref: '#/components/schemas/DeleteDevicesRequest'
240
+ - description: Devices to delete
241
+ required: true
242
+ responses:
243
+ '200':
244
+ description: For each device in the request, contains device identifiers and a success or failure response.
245
+ headers: {}
246
+ content:
247
+ application/json:
248
+ schema:
249
+ type: array
250
+ items:
251
+ $ref: '#/components/schemas/DeleteDevicesResponseMessage'
252
+ description: ''
253
+ '400':
254
+ description: Error Response
255
+ headers: {}
256
+ content:
257
+ application/json:
258
+ schema:
259
+ $ref: '#/components/schemas/RestErrorResponse'
260
+ deprecated: false
261
+ /devices/actions/list:
262
+ post:
263
+ tags:
264
+ - devices
265
+ summary: listUsingPOST
266
+ description: ''
267
+ operationId: listUsingPOST
268
+ parameters:
269
+ - name: VZ-M2M-Token
270
+ in: header
271
+ description: VZ-M2M session token
272
+ required: true
273
+ style: simple
274
+ schema:
275
+ type: string
276
+ requestBody:
277
+ description: Device Query
278
+ content:
279
+ application/json:
280
+ schema:
281
+ allOf:
282
+ - $ref: '#/components/schemas/DeviceListRequest'
283
+ - description: Device Query
284
+ required: true
285
+ responses:
286
+ '200':
287
+ description: List of devices that match the request parameters, ordered by device creation date, oldest first.
288
+ headers: {}
289
+ content:
290
+ application/json:
291
+ schema:
292
+ $ref: '#/components/schemas/DeviceListResponse'
293
+ '202':
294
+ description: List of devices that match the request parameters, ordered by device creation date, oldest first. Additional devices remain.
295
+ headers: {}
296
+ content:
297
+ application/json:
298
+ schema:
299
+ $ref: '#/components/schemas/DeviceListResponse'
300
+ '400':
301
+ description: Error Response
302
+ headers: {}
303
+ content:
304
+ application/json:
305
+ schema:
306
+ $ref: '#/components/schemas/RestErrorResponse'
307
+ deprecated: false
308
+ /devices/actions/list/imeiiccidmismatch:
309
+ post:
310
+ tags:
311
+ - devices
312
+ summary: imeiIccidMismatchListUsingPOST
313
+ description: ''
314
+ operationId: imeiIccidMismatchListUsingPOST
315
+ parameters:
316
+ - name: VZ-M2M-Token
317
+ in: header
318
+ description: VZ-M2M session token
319
+ required: true
320
+ style: simple
321
+ schema:
322
+ type: string
323
+ requestBody:
324
+ description: Device Query
325
+ content:
326
+ application/json:
327
+ schema:
328
+ allOf:
329
+ - $ref: '#/components/schemas/DeviceMismatchListRequest'
330
+ - description: Device Query
331
+ required: true
332
+ responses:
333
+ '200':
334
+ description: List of devices that have mismatched IMEIs and ICCIDs.
335
+ headers: {}
336
+ content:
337
+ application/json:
338
+ schema:
339
+ $ref: '#/components/schemas/DeviceMismatchListResponse'
340
+ '400':
341
+ description: Error Response
342
+ headers: {}
343
+ content:
344
+ application/json:
345
+ schema:
346
+ $ref: '#/components/schemas/RestErrorResponse'
347
+ deprecated: false
348
+ /devices/actions/move:
349
+ put:
350
+ tags:
351
+ - devices
352
+ summary: moveUsingPut
353
+ description: Move active devices from one billing account to another within a customer profile.
354
+ operationId: moveUsingPut
355
+ parameters:
356
+ - name: VZ-M2M-Token
357
+ in: header
358
+ description: VZ-M2M session token
359
+ required: true
360
+ style: simple
361
+ schema:
362
+ type: string
363
+ requestBody:
364
+ description: Move request
365
+ content:
366
+ application/json:
367
+ schema:
368
+ allOf:
369
+ - $ref: '#/components/schemas/MoveDeviceRequest'
370
+ - description: Move request
371
+ required: true
372
+ responses:
373
+ '200':
374
+ description: Request ID
375
+ headers: {}
376
+ content:
377
+ application/json:
378
+ schema:
379
+ $ref: '#/components/schemas/RequestResponse'
380
+ '400':
381
+ description: Error Response
382
+ headers: {}
383
+ content:
384
+ application/json:
385
+ schema:
386
+ $ref: '#/components/schemas/RestErrorResponse'
387
+ deprecated: false
388
+ /devices/actions/gotostate:
389
+ put:
390
+ tags:
391
+ - devices
392
+ summary: gotostateUsingPut
393
+ description: Changes the provisioning state of one or more devices to a specified customer-defined service and state.
394
+ operationId: gotostateUsingPut
395
+ parameters:
396
+ - name: VZ-M2M-Token
397
+ in: header
398
+ description: VZ-M2M session token
399
+ required: true
400
+ style: simple
401
+ schema:
402
+ type: string
403
+ requestBody:
404
+ description: Move state request
405
+ content:
406
+ application/json:
407
+ schema:
408
+ allOf:
409
+ - $ref: '#/components/schemas/GoToStateRequest'
410
+ - description: Move state request
411
+ required: true
412
+ responses:
413
+ '200':
414
+ description: Request ID
415
+ headers: {}
416
+ content:
417
+ application/json:
418
+ schema:
419
+ $ref: '#/components/schemas/RequestResponse'
420
+ '400':
421
+ description: Error Response
422
+ headers: {}
423
+ content:
424
+ application/json:
425
+ schema:
426
+ $ref: '#/components/schemas/RestErrorResponse'
427
+ deprecated: false
428
+ /devices/actions/plan:
429
+ put:
430
+ tags:
431
+ - devices
432
+ summary: updateServicePlanUsingPUT
433
+ description: ''
434
+ operationId: updateServicePlanUsingPUT
435
+ parameters:
436
+ - name: VZ-M2M-Token
437
+ in: header
438
+ description: VZ-M2M session token
439
+ required: true
440
+ style: simple
441
+ schema:
442
+ type: string
443
+ requestBody:
444
+ description: Change service plan request
445
+ content:
446
+ application/json:
447
+ schema:
448
+ allOf:
449
+ - $ref: '#/components/schemas/ServicePlanUpdateRequest'
450
+ - description: Change service plan request
451
+ required: true
452
+ responses:
453
+ '200':
454
+ description: Request ID
455
+ headers: {}
456
+ content:
457
+ application/json:
458
+ schema:
459
+ $ref: '#/components/schemas/RequestResponse'
460
+ '400':
461
+ description: Error Response
462
+ headers: {}
463
+ content:
464
+ application/json:
465
+ schema:
466
+ $ref: '#/components/schemas/RestErrorResponse'
467
+ deprecated: false
468
+ /devices/actions/suspend:
469
+ post:
470
+ tags:
471
+ - devices
472
+ summary: suspendUsingPOST
473
+ description: ''
474
+ operationId: suspendUsingPOST
475
+ parameters:
476
+ - name: VZ-M2M-Token
477
+ in: header
478
+ description: VZ-M2M session token
479
+ required: true
480
+ style: simple
481
+ schema:
482
+ type: string
483
+ requestBody:
484
+ description: Suspend request
485
+ content:
486
+ application/json:
487
+ schema:
488
+ allOf:
489
+ - $ref: '#/components/schemas/CarrierActionsRequest'
490
+ - description: Suspend request
491
+ required: true
492
+ responses:
493
+ '200':
494
+ description: Request ID
495
+ headers: {}
496
+ content:
497
+ application/json:
498
+ schema:
499
+ $ref: '#/components/schemas/RequestResponse'
500
+ '400':
501
+ description: Error Response
502
+ headers: {}
503
+ content:
504
+ application/json:
505
+ schema:
506
+ $ref: '#/components/schemas/RestErrorResponse'
507
+ deprecated: false
508
+ /devices/actions/restore:
509
+ post:
510
+ tags:
511
+ - devices
512
+ summary: restoreUsingPOST
513
+ description: ''
514
+ operationId: restoreUsingPOST
515
+ parameters:
516
+ - name: VZ-M2M-Token
517
+ in: header
518
+ description: VZ-M2M session token
519
+ required: true
520
+ style: simple
521
+ schema:
522
+ type: string
523
+ requestBody:
524
+ description: Restore request
525
+ content:
526
+ application/json:
527
+ schema:
528
+ allOf:
529
+ - $ref: '#/components/schemas/CarrierActionsRequest'
530
+ - description: Restore request
531
+ required: true
532
+ responses:
533
+ '200':
534
+ description: Request ID
535
+ headers: {}
536
+ content:
537
+ application/json:
538
+ schema:
539
+ $ref: '#/components/schemas/RequestResponse'
540
+ '400':
541
+ description: Error Response
542
+ headers: {}
543
+ content:
544
+ application/json:
545
+ schema:
546
+ $ref: '#/components/schemas/RestErrorResponse'
547
+ deprecated: false
548
+ /devices/availability/actions/list:
549
+ post:
550
+ tags:
551
+ - devices
552
+ summary: deviceAvailabilityListUsingPOST
553
+ description: Checks whether specified devices are registered by the manufacturer with the Verizon network and are available to be activated.
554
+ operationId: deviceAvailabilityListUsingPOST
555
+ parameters:
556
+ - name: VZ-M2M-Token
557
+ in: header
558
+ description: VZ-M2M session token
559
+ required: true
560
+ style: simple
561
+ schema:
562
+ type: string
563
+ requestBody:
564
+ description: Device Query
565
+ content:
566
+ application/json:
567
+ schema:
568
+ allOf:
569
+ - $ref: '#/components/schemas/DeviceRequest'
570
+ - description: Device Query
571
+ required: true
572
+ responses:
573
+ '200':
574
+ description: Request ID
575
+ headers: {}
576
+ content:
577
+ application/json:
578
+ schema:
579
+ $ref: '#/components/schemas/RequestResponse'
580
+ '400':
581
+ description: Error Response
582
+ headers: {}
583
+ content:
584
+ application/json:
585
+ schema:
586
+ $ref: '#/components/schemas/RestErrorResponse'
587
+ deprecated: false
588
+ /devices/connections/actions/listHistory:
589
+ post:
590
+ tags:
591
+ - devices
592
+ summary: connectionListHistoryUsingPOST
593
+ description: Each response includes a maximum of 500 records. To obtain more records, you can call the API multiple times, adjusting the earliest value each time to start where the previous request finished.
594
+ operationId: connectionListHistoryUsingPOST
595
+ parameters:
596
+ - name: VZ-M2M-Token
597
+ in: header
598
+ description: VZ-M2M session token
599
+ required: true
600
+ style: simple
601
+ schema:
602
+ type: string
603
+ requestBody:
604
+ description: Device connection query
605
+ content:
606
+ application/json:
607
+ schema:
608
+ allOf:
609
+ - $ref: '#/components/schemas/DeviceConnectionListRequest'
610
+ - description: Device connection query
611
+ required: true
612
+ responses:
613
+ '200':
614
+ description: List of device connection events, sorted by the occurredAt timestamp, oldest first.
615
+ headers: {}
616
+ content:
617
+ application/json:
618
+ schema:
619
+ type: array
620
+ items:
621
+ $ref: '#/components/schemas/ConnectionHistoryResponse'
622
+ description: ''
623
+ '202':
624
+ description: List of device connection events, sorted by the occurredAt timestamp, oldest first. Additional events remain.
625
+ headers: {}
626
+ content:
627
+ application/json:
628
+ schema:
629
+ type: array
630
+ items:
631
+ $ref: '#/components/schemas/ConnectionHistoryResponse'
632
+ description: ''
633
+ '400':
634
+ description: Error Response
635
+ headers: {}
636
+ content:
637
+ application/json:
638
+ schema:
639
+ $ref: '#/components/schemas/RestErrorResponse'
640
+ deprecated: false
641
+ /devices/costCenter:
642
+ put:
643
+ tags:
644
+ - devices
645
+ summary: changeCostCenterUsingPUT
646
+ description: ''
647
+ operationId: changeCostCenterUsingPUT
648
+ parameters:
649
+ - name: VZ-M2M-Token
650
+ in: header
651
+ description: VZ-M2M session token
652
+ required: true
653
+ style: simple
654
+ schema:
655
+ type: string
656
+ requestBody:
657
+ description: Change cost center request
658
+ content:
659
+ application/json:
660
+ schema:
661
+ allOf:
662
+ - $ref: '#/components/schemas/DeviceCostCenterRequest'
663
+ - description: Change cost center request
664
+ required: true
665
+ responses:
666
+ '200':
667
+ description: Request ID
668
+ headers: {}
669
+ content:
670
+ application/json:
671
+ schema:
672
+ $ref: '#/components/schemas/RequestResponse'
673
+ '400':
674
+ description: Error Response
675
+ headers: {}
676
+ content:
677
+ application/json:
678
+ schema:
679
+ $ref: '#/components/schemas/RestErrorResponse'
680
+ deprecated: false
681
+ /devices/extendeddiagnostics/actions/list:
682
+ post:
683
+ tags:
684
+ - devices
685
+ summary: getExtendedDiagsUsingPOST
686
+ description: ''
687
+ operationId: getExtendedDiagsUsingPOST
688
+ parameters:
689
+ - name: VZ-M2M-Token
690
+ in: header
691
+ description: M2M-MC Session Token
692
+ required: true
693
+ style: simple
694
+ schema:
695
+ type: string
696
+ requestBody:
697
+ description: Device Query
698
+ content:
699
+ application/json:
700
+ schema:
701
+ allOf:
702
+ - $ref: '#/components/schemas/DeviceExtendedDiagnosticsRequest'
703
+ - description: Device Query
704
+ required: true
705
+ responses:
706
+ '200':
707
+ description: Device diagnostic information
708
+ headers: {}
709
+ content:
710
+ application/json:
711
+ schema:
712
+ $ref: '#/components/schemas/DeviceExtendedDiagnosticsResponse'
713
+ '400':
714
+ description: Error Response
715
+ headers: {}
716
+ content:
717
+ application/json:
718
+ schema:
719
+ $ref: '#/components/schemas/RestErrorResponse'
720
+ deprecated: false
721
+ /devices/history/actions/list:
722
+ post:
723
+ tags:
724
+ - devices
725
+ summary: provisioningHistoryListUsingPOST
726
+ description: ''
727
+ operationId: provisioningHistoryListUsingPOST
728
+ parameters:
729
+ - name: VZ-M2M-Token
730
+ in: header
731
+ description: VZ-M2M session token
732
+ required: true
733
+ style: simple
734
+ schema:
735
+ type: string
736
+ requestBody:
737
+ description: Device provisioning history query
738
+ content:
739
+ application/json:
740
+ schema:
741
+ allOf:
742
+ - $ref: '#/components/schemas/DeviceProvisioningHistoryListRequest'
743
+ - description: Device provisioning history query
744
+ required: true
745
+ responses:
746
+ '200':
747
+ description: List of Device Provision History events, sorted by the timestamp, oldest first.
748
+ headers: {}
749
+ content:
750
+ application/json:
751
+ schema:
752
+ type: array
753
+ items:
754
+ $ref: '#/components/schemas/DeviceProvisioningHistoryListResponse'
755
+ description: ''
756
+ '202':
757
+ description: List of Device Provision History events, sorted by the timestamp, oldest first. Additional events remain.
758
+ headers: {}
759
+ content:
760
+ application/json:
761
+ schema:
762
+ type: array
763
+ items:
764
+ $ref: '#/components/schemas/DeviceProvisioningHistoryListResponse'
765
+ description: ''
766
+ '400':
767
+ description: Error Response
768
+ headers: {}
769
+ content:
770
+ application/json:
771
+ schema:
772
+ $ref: '#/components/schemas/RestErrorResponse'
773
+ deprecated: false
774
+ /devices/prl/actions/list:
775
+ post:
776
+ tags:
777
+ - devices
778
+ summary: prlListUsingPOST
779
+ description: 4G and GSM devices do not have a PRL.
780
+ operationId: prlListUsingPOST
781
+ parameters:
782
+ - name: VZ-M2M-Token
783
+ in: header
784
+ description: VZ-M2M session token
785
+ required: true
786
+ style: simple
787
+ schema:
788
+ type: string
789
+ requestBody:
790
+ description: Device PRL query
791
+ content:
792
+ application/json:
793
+ schema:
794
+ allOf:
795
+ - $ref: '#/components/schemas/DevicePrlListRequest'
796
+ - description: Device PRL query
797
+ required: true
798
+ responses:
799
+ '200':
800
+ description: Request ID
801
+ headers: {}
802
+ content:
803
+ application/json:
804
+ schema:
805
+ $ref: '#/components/schemas/RequestResponse'
806
+ '400':
807
+ description: Error Response
808
+ headers: {}
809
+ content:
810
+ application/json:
811
+ schema:
812
+ $ref: '#/components/schemas/RestErrorResponse'
813
+ deprecated: false
814
+ /devices/suspension/status:
815
+ post:
816
+ tags:
817
+ - devices
818
+ summary: getDeviceSuspensionStatusUsingPOST
819
+ description: Returns DeviceSuspensionStatus callback messages containing the current device state and information on how many days a device has been suspended and can continue to be suspended.
820
+ operationId: getDeviceSuspensionStatusUsingPOST
821
+ parameters:
822
+ - name: VZ-M2M-Token
823
+ in: header
824
+ description: VZ-M2M session token
825
+ required: true
826
+ style: simple
827
+ schema:
828
+ type: string
829
+ requestBody:
830
+ description: Device query
831
+ content:
832
+ application/json:
833
+ schema:
834
+ allOf:
835
+ - $ref: '#/components/schemas/DeviceSuspensionStatusRequest'
836
+ - description: Device query
837
+ required: true
838
+ responses:
839
+ '200':
840
+ description: Request ID
841
+ headers: {}
842
+ content:
843
+ application/json:
844
+ schema:
845
+ $ref: '#/components/schemas/RequestResponse'
846
+ '400':
847
+ description: Error Response
848
+ headers: {}
849
+ content:
850
+ application/json:
851
+ schema:
852
+ $ref: '#/components/schemas/RestErrorResponse'
853
+ deprecated: false
854
+ /devices/usage/actions/list:
855
+ post:
856
+ tags:
857
+ - devices
858
+ summary: usageListUsingPOST
859
+ description: Returns the network data usage history of a device during a specified time period.
860
+ operationId: usageListUsingPOST
861
+ parameters:
862
+ - name: VZ-M2M-Token
863
+ in: header
864
+ description: VZ-M2M session token
865
+ required: true
866
+ style: simple
867
+ schema:
868
+ type: string
869
+ requestBody:
870
+ description: Device usage query
871
+ content:
872
+ application/json:
873
+ schema:
874
+ allOf:
875
+ - $ref: '#/components/schemas/DeviceUsageListRequest'
876
+ - description: Device usage query
877
+ required: true
878
+ responses:
879
+ '200':
880
+ description: List of device usage events, sorted by the timestamp, oldest first.
881
+ headers: {}
882
+ content:
883
+ application/json:
884
+ schema:
885
+ type: array
886
+ items:
887
+ $ref: '#/components/schemas/DeviceUsageListResponse'
888
+ description: ''
889
+ '202':
890
+ description: List of device usage events, sorted by the timestamp, oldest first. Additional events remain.
891
+ headers: {}
892
+ content:
893
+ application/json:
894
+ schema:
895
+ type: array
896
+ items:
897
+ $ref: '#/components/schemas/DeviceUsageListResponse'
898
+ description: ''
899
+ '400':
900
+ description: Error Response
901
+ headers: {}
902
+ content:
903
+ application/json:
904
+ schema:
905
+ $ref: '#/components/schemas/RestErrorResponse'
906
+ deprecated: false
907
+ /devices/usage/actions/list/aggregate:
908
+ post:
909
+ tags:
910
+ - devices
911
+ summary: aggregateUsingPOST
912
+ description: The information is returned in a callback response, so you must register a URL for DeviceUsage callback messages using the POST /callbacks API.
913
+ operationId: aggregateUsingPOST
914
+ parameters:
915
+ - name: VZ-M2M-Token
916
+ in: header
917
+ description: VZ-M2M session token
918
+ required: true
919
+ style: simple
920
+ schema:
921
+ type: string
922
+ requestBody:
923
+ description: Aggregated usage request
924
+ content:
925
+ application/json:
926
+ schema:
927
+ allOf:
928
+ - $ref: '#/components/schemas/DeviceAggregateUsageListRequest'
929
+ - description: Aggregated usage request
930
+ required: true
931
+ responses:
932
+ '200':
933
+ description: A unique string that associates the request with the results that are sent via a callback service.
934
+ headers: {}
935
+ content:
936
+ application/json:
937
+ schema:
938
+ $ref: '#/components/schemas/RequestResponse'
939
+ '400':
940
+ description: Error Response
941
+ headers: {}
942
+ content:
943
+ application/json:
944
+ schema:
945
+ $ref: '#/components/schemas/RestErrorResponse'
946
+ deprecated: false
947
+ /devices/{serviceType}/actions/deviceId:
948
+ put:
949
+ tags:
950
+ - devices
951
+ summary: changeDeviceIdUsingPUT
952
+ description: ''
953
+ operationId: changeDeviceIdUsingPUT
954
+ parameters:
955
+ - name: serviceType
956
+ in: path
957
+ description: Identifier type
958
+ required: true
959
+ style: simple
960
+ schema:
961
+ type: string
962
+ - name: VZ-M2M-Token
963
+ in: header
964
+ description: VZ-M2M session token
965
+ required: true
966
+ style: simple
967
+ schema:
968
+ type: string
969
+ requestBody:
970
+ description: Device query
971
+ content:
972
+ application/json:
973
+ schema:
974
+ allOf:
975
+ - $ref: '#/components/schemas/ChangeDeviceIdRequest'
976
+ - description: Device query
977
+ required: true
978
+ responses:
979
+ '200':
980
+ description: A unique string that associates the request with the results that are sent via a callback service.
981
+ headers: {}
982
+ content:
983
+ application/json:
984
+ schema:
985
+ $ref: '#/components/schemas/RequestResponse'
986
+ '400':
987
+ description: Error Response
988
+ headers: {}
989
+ content:
990
+ application/json:
991
+ schema:
992
+ $ref: '#/components/schemas/RestErrorResponse'
993
+ deprecated: false
994
+ /accounts/{aname}:
995
+ get:
996
+ tags:
997
+ - accounts
998
+ summary: getAccountUsingGET
999
+ description: ''
1000
+ operationId: getAccountUsingGET
1001
+ parameters:
1002
+ - name: VZ-M2M-Token
1003
+ in: header
1004
+ description: VZ-M2M session token
1005
+ required: true
1006
+ style: simple
1007
+ schema:
1008
+ type: string
1009
+ - name: aname
1010
+ in: path
1011
+ description: Account name
1012
+ required: true
1013
+ style: simple
1014
+ schema:
1015
+ type: string
1016
+ responses:
1017
+ '200':
1018
+ description: The account information.
1019
+ headers: {}
1020
+ content:
1021
+ application/json:
1022
+ schema:
1023
+ $ref: '#/components/schemas/AccountInformationResponse'
1024
+ '400':
1025
+ description: Error Response
1026
+ headers: {}
1027
+ content:
1028
+ application/json:
1029
+ schema:
1030
+ $ref: '#/components/schemas/RestErrorResponse'
1031
+ deprecated: false
1032
+ /accounts/{aname}/statesandservices:
1033
+ get:
1034
+ tags:
1035
+ - accounts
1036
+ summary: getServicesAndStatesUsingGET
1037
+ description: Returns a list and details of all custom services and states defined for a specified account.
1038
+ operationId: getServicesAndStatesUsingGET
1039
+ parameters:
1040
+ - name: VZ-M2M-Token
1041
+ in: header
1042
+ description: M2M-MC Session Token
1043
+ required: true
1044
+ style: simple
1045
+ schema:
1046
+ type: string
1047
+ - name: aname
1048
+ in: path
1049
+ description: Account name
1050
+ required: true
1051
+ style: simple
1052
+ schema:
1053
+ type: string
1054
+ responses:
1055
+ '200':
1056
+ description: The account's engagements, services, and states.
1057
+ headers: {}
1058
+ content:
1059
+ application/json:
1060
+ schema:
1061
+ $ref: '#/components/schemas/GetStatesAndServicesResponse'
1062
+ '400':
1063
+ description: Error Response
1064
+ headers: {}
1065
+ content:
1066
+ application/json:
1067
+ schema:
1068
+ $ref: '#/components/schemas/RestErrorResponse'
1069
+ deprecated: false
1070
+ /leads/{aname}:
1071
+ get:
1072
+ tags:
1073
+ - accounts
1074
+ summary: getListUsingGET_1
1075
+ description: When HTTP status is 202, a URL will be returned in the Location header of the form /leads/{aname}?next={token}. This URL can be used to request the next set of leads.
1076
+ operationId: getListUsingGET_1
1077
+ parameters:
1078
+ - name: VZ-M2M-Token
1079
+ in: header
1080
+ description: VZ-M2M session token
1081
+ required: true
1082
+ style: simple
1083
+ schema:
1084
+ type: string
1085
+ - name: aname
1086
+ in: path
1087
+ description: Account name
1088
+ required: true
1089
+ style: simple
1090
+ schema:
1091
+ type: string
1092
+ - name: next
1093
+ in: query
1094
+ description: Continue the previous query from the pageUrl in Location Header
1095
+ style: form
1096
+ explode: true
1097
+ schema:
1098
+ type: integer
1099
+ format: int64
1100
+ responses:
1101
+ '200':
1102
+ description: The list of leads associated with the account.
1103
+ headers: {}
1104
+ content:
1105
+ application/json:
1106
+ schema:
1107
+ $ref: '#/components/schemas/LeadInformationResponse'
1108
+ '202':
1109
+ description: The list of leads associated with the account, additional leads remain.
1110
+ headers: {}
1111
+ content:
1112
+ application/json:
1113
+ schema:
1114
+ $ref: '#/components/schemas/LeadInformationResponse'
1115
+ '400':
1116
+ description: Error Response
1117
+ headers: {}
1118
+ content:
1119
+ application/json:
1120
+ schema:
1121
+ $ref: '#/components/schemas/RestErrorResponse'
1122
+ deprecated: false
1123
+ /groups:
1124
+ post:
1125
+ tags:
1126
+ - groups
1127
+ summary: createDeviceGroupUsingPOST
1128
+ description: ''
1129
+ operationId: createDeviceGroupUsingPOST
1130
+ parameters:
1131
+ - name: VZ-M2M-Token
1132
+ in: header
1133
+ description: VZ-M2M session token
1134
+ required: true
1135
+ style: simple
1136
+ schema:
1137
+ type: string
1138
+ requestBody:
1139
+ description: Request
1140
+ content:
1141
+ application/json:
1142
+ schema:
1143
+ allOf:
1144
+ - $ref: '#/components/schemas/CreateDevGroupRequest'
1145
+ - description: Request
1146
+ required: true
1147
+ responses:
1148
+ '200':
1149
+ description: Request Success Message
1150
+ headers: {}
1151
+ content:
1152
+ application/json:
1153
+ schema:
1154
+ $ref: '#/components/schemas/RestSuccessResponse'
1155
+ '400':
1156
+ description: Error Response
1157
+ headers: {}
1158
+ content:
1159
+ application/json:
1160
+ schema:
1161
+ $ref: '#/components/schemas/RestErrorResponse'
1162
+ deprecated: false
1163
+ /groups/{aname}:
1164
+ get:
1165
+ tags:
1166
+ - groups
1167
+ summary: getListUsingGET
1168
+ description: ''
1169
+ operationId: getListUsingGET
1170
+ parameters:
1171
+ - name: VZ-M2M-Token
1172
+ in: header
1173
+ description: VZ-M2M session token
1174
+ required: true
1175
+ style: simple
1176
+ schema:
1177
+ type: string
1178
+ - name: aname
1179
+ in: path
1180
+ description: Account name
1181
+ required: true
1182
+ style: simple
1183
+ schema:
1184
+ type: string
1185
+ responses:
1186
+ '200':
1187
+ description: The list of device groups in the account.
1188
+ headers: {}
1189
+ content:
1190
+ application/json:
1191
+ schema:
1192
+ type: array
1193
+ items:
1194
+ $ref: '#/components/schemas/GroupResponse'
1195
+ description: ''
1196
+ '400':
1197
+ description: Error Response
1198
+ headers: {}
1199
+ content:
1200
+ application/json:
1201
+ schema:
1202
+ $ref: '#/components/schemas/RestErrorResponse'
1203
+ deprecated: false
1204
+ /groups/{aname}/name/{gname}:
1205
+ get:
1206
+ tags:
1207
+ - groups
1208
+ summary: getDeviceGroupInfoUsingGET
1209
+ description: When HTTP status is 202, a URL will be returned in the Location header of the form /groups/{aname}/name/{gname}/?next={token}. This URL can be used to request the next set of groups.
1210
+ operationId: getDeviceGroupInfoUsingGET
1211
+ parameters:
1212
+ - name: aname
1213
+ in: path
1214
+ description: Account name
1215
+ required: true
1216
+ style: simple
1217
+ schema:
1218
+ type: string
1219
+ - name: gname
1220
+ in: path
1221
+ description: Group name
1222
+ required: true
1223
+ style: simple
1224
+ schema:
1225
+ type: string
1226
+ - name: next
1227
+ in: query
1228
+ description: Continue the previous query from the pageUrl pagetoken
1229
+ style: form
1230
+ explode: true
1231
+ schema:
1232
+ type: integer
1233
+ format: int64
1234
+ - name: VZ-M2M-Token
1235
+ in: header
1236
+ description: VZ-M2M session token
1237
+ required: true
1238
+ style: simple
1239
+ schema:
1240
+ type: string
1241
+ responses:
1242
+ '200':
1243
+ description: Successful response
1244
+ headers: {}
1245
+ content:
1246
+ application/json:
1247
+ schema:
1248
+ $ref: '#/components/schemas/GroupListResponse'
1249
+ '202':
1250
+ description: Successful response, additional groups remain
1251
+ headers: {}
1252
+ content:
1253
+ application/json:
1254
+ schema:
1255
+ $ref: '#/components/schemas/GroupListResponse'
1256
+ '400':
1257
+ description: Error Response
1258
+ headers: {}
1259
+ content:
1260
+ application/json:
1261
+ schema:
1262
+ $ref: '#/components/schemas/RestErrorResponse'
1263
+ deprecated: false
1264
+ put:
1265
+ tags:
1266
+ - groups
1267
+ summary: updateDeviceGroupUsingPUT
1268
+ description: ''
1269
+ operationId: updateDeviceGroupUsingPUT
1270
+ parameters:
1271
+ - name: aname
1272
+ in: path
1273
+ description: Account name
1274
+ required: true
1275
+ style: simple
1276
+ schema:
1277
+ type: string
1278
+ - name: gname
1279
+ in: path
1280
+ description: Group name
1281
+ required: true
1282
+ style: simple
1283
+ schema:
1284
+ type: string
1285
+ - name: VZ-M2M-Token
1286
+ in: header
1287
+ description: VZ-M2M session token
1288
+ required: true
1289
+ style: simple
1290
+ schema:
1291
+ type: string
1292
+ requestBody:
1293
+ description: Request
1294
+ content:
1295
+ application/json:
1296
+ schema:
1297
+ allOf:
1298
+ - $ref: '#/components/schemas/GroupUpdateRequest'
1299
+ - description: Request
1300
+ required: true
1301
+ responses:
1302
+ '200':
1303
+ description: Request Success Message
1304
+ headers: {}
1305
+ content:
1306
+ application/json:
1307
+ schema:
1308
+ $ref: '#/components/schemas/RestSuccessResponse'
1309
+ '400':
1310
+ description: Error Response
1311
+ headers: {}
1312
+ content:
1313
+ application/json:
1314
+ schema:
1315
+ $ref: '#/components/schemas/RestErrorResponse'
1316
+ deprecated: false
1317
+ delete:
1318
+ tags:
1319
+ - groups
1320
+ summary: deleteDeviceGroupUsingDELETE
1321
+ description: ''
1322
+ operationId: deleteDeviceGroupUsingDELETE
1323
+ parameters:
1324
+ - name: VZ-M2M-Token
1325
+ in: header
1326
+ description: VZ-M2M session token
1327
+ required: true
1328
+ style: simple
1329
+ schema:
1330
+ type: string
1331
+ - name: aname
1332
+ in: path
1333
+ description: Account name
1334
+ required: true
1335
+ style: simple
1336
+ schema:
1337
+ type: string
1338
+ - name: gname
1339
+ in: path
1340
+ description: Group name
1341
+ required: true
1342
+ style: simple
1343
+ schema:
1344
+ type: string
1345
+ responses:
1346
+ '200':
1347
+ description: Request Success Message
1348
+ headers: {}
1349
+ content:
1350
+ application/json:
1351
+ schema:
1352
+ $ref: '#/components/schemas/RestSuccessResponse'
1353
+ '400':
1354
+ description: Error Response
1355
+ headers: {}
1356
+ content:
1357
+ application/json:
1358
+ schema:
1359
+ $ref: '#/components/schemas/RestErrorResponse'
1360
+ deprecated: false
1361
+ /sms:
1362
+ post:
1363
+ tags:
1364
+ - sms
1365
+ summary: sendSmsMessageUsingPOST
1366
+ description: The messages are queued on the ThingSpace Platform and sent as soon as possible, but they may be delayed due to traffic and routing considerations.
1367
+ operationId: sendSmsMessageUsingPOST
1368
+ parameters:
1369
+ - name: VZ-M2M-Token
1370
+ in: header
1371
+ description: VZ-M2M session token
1372
+ required: true
1373
+ style: simple
1374
+ schema:
1375
+ type: string
1376
+ requestBody:
1377
+ description: SMS Request
1378
+ content:
1379
+ application/json:
1380
+ schema:
1381
+ allOf:
1382
+ - $ref: '#/components/schemas/SMSSendRequest'
1383
+ - description: SMS Request
1384
+ required: true
1385
+ responses:
1386
+ '200':
1387
+ description: Request ID
1388
+ headers: {}
1389
+ content:
1390
+ application/json:
1391
+ schema:
1392
+ $ref: '#/components/schemas/RequestResponse'
1393
+ '400':
1394
+ description: Error Response
1395
+ headers: {}
1396
+ content:
1397
+ application/json:
1398
+ schema:
1399
+ $ref: '#/components/schemas/RestErrorResponse'
1400
+ deprecated: false
1401
+ /sms/{aname}/history:
1402
+ get:
1403
+ tags:
1404
+ - sms
1405
+ summary: getSmsMessagesUsingGET
1406
+ description: When HTTP status is 202, a URL will be returned in the Location header of the form /sms/{aname}/history?next={token}. This URL can be used to request the next set of messages.
1407
+ operationId: getSmsMessagesUsingGET
1408
+ parameters:
1409
+ - name: aname
1410
+ in: path
1411
+ description: Account name
1412
+ required: true
1413
+ style: simple
1414
+ schema:
1415
+ type: string
1416
+ - name: next
1417
+ in: query
1418
+ description: Continue the previous query from the URL in Location Header
1419
+ style: form
1420
+ explode: true
1421
+ schema:
1422
+ type: integer
1423
+ format: int64
1424
+ - name: VZ-M2M-Token
1425
+ in: header
1426
+ description: VZ-M2M session token
1427
+ required: true
1428
+ style: simple
1429
+ schema:
1430
+ type: string
1431
+ responses:
1432
+ '200':
1433
+ description: Successful response
1434
+ headers: {}
1435
+ content:
1436
+ application/json:
1437
+ schema:
1438
+ $ref: '#/components/schemas/SmsMessagesResponse'
1439
+ '202':
1440
+ description: Successful response, additional SMS messages remain
1441
+ headers: {}
1442
+ content:
1443
+ application/json:
1444
+ schema:
1445
+ $ref: '#/components/schemas/SmsMessagesResponse'
1446
+ '400':
1447
+ description: Error Response
1448
+ headers: {}
1449
+ content:
1450
+ application/json:
1451
+ schema:
1452
+ $ref: '#/components/schemas/RestErrorResponse'
1453
+ deprecated: false
1454
+ /sms/{aname}/startCallbacks:
1455
+ put:
1456
+ tags:
1457
+ - sms
1458
+ summary: startSmsCallbackUsingPUT
1459
+ description: ''
1460
+ operationId: startSmsCallbackUsingPUT
1461
+ parameters:
1462
+ - name: aname
1463
+ in: path
1464
+ description: Account name
1465
+ required: true
1466
+ style: simple
1467
+ schema:
1468
+ type: string
1469
+ - name: VZ-M2M-Token
1470
+ in: header
1471
+ description: VZ-M2M session token
1472
+ required: true
1473
+ style: simple
1474
+ schema:
1475
+ type: string
1476
+ responses:
1477
+ '200':
1478
+ description: Request Success Message
1479
+ headers: {}
1480
+ content:
1481
+ application/json:
1482
+ schema:
1483
+ $ref: '#/components/schemas/RestSuccessResponse'
1484
+ '400':
1485
+ description: Error Response
1486
+ headers: {}
1487
+ content:
1488
+ application/json:
1489
+ schema:
1490
+ $ref: '#/components/schemas/RestErrorResponse'
1491
+ deprecated: false
1492
+ /session/login:
1493
+ post:
1494
+ tags:
1495
+ - session
1496
+ summary: loginUsingPOST
1497
+ description: ''
1498
+ operationId: loginUsingPOST
1499
+ parameters: []
1500
+ requestBody:
1501
+ description: request
1502
+ content:
1503
+ application/json:
1504
+ schema:
1505
+ allOf:
1506
+ - $ref: '#/components/schemas/LogInRequest'
1507
+ - description: request
1508
+ required: false
1509
+ responses:
1510
+ '200':
1511
+ description: VZ-M2M session token
1512
+ headers: {}
1513
+ content:
1514
+ application/json:
1515
+ schema:
1516
+ $ref: '#/components/schemas/LogInResponse'
1517
+ '400':
1518
+ description: Error Response
1519
+ headers: {}
1520
+ content:
1521
+ application/json:
1522
+ schema:
1523
+ $ref: '#/components/schemas/RestErrorResponse'
1524
+ deprecated: false
1525
+ /session/logout:
1526
+ post:
1527
+ tags:
1528
+ - session
1529
+ summary: logoutUsingPOST
1530
+ description: ''
1531
+ operationId: logoutUsingPOST
1532
+ parameters:
1533
+ - name: VZ-M2M-Token
1534
+ in: header
1535
+ description: VZ-M2M session token
1536
+ required: true
1537
+ style: simple
1538
+ schema:
1539
+ type: string
1540
+ responses:
1541
+ '200':
1542
+ description: VZ-M2M session token
1543
+ headers: {}
1544
+ content:
1545
+ application/json:
1546
+ schema:
1547
+ $ref: '#/components/schemas/LogOutRequest'
1548
+ '400':
1549
+ description: Error Response
1550
+ headers: {}
1551
+ content:
1552
+ application/json:
1553
+ schema:
1554
+ $ref: '#/components/schemas/RestErrorResponse'
1555
+ deprecated: false
1556
+ /session/password/actions/reset:
1557
+ put:
1558
+ tags:
1559
+ - session
1560
+ summary: resetUsingPUT
1561
+ description: The new password is effective immediately. Passwords do not expire, but Verizon recommends changing your password every 90 days.
1562
+ operationId: resetUsingPUT
1563
+ parameters:
1564
+ - name: VZ-M2M-Token
1565
+ in: header
1566
+ description: VZ-M2M session token
1567
+ required: true
1568
+ style: simple
1569
+ schema:
1570
+ type: string
1571
+ requestBody:
1572
+ description: Current Password
1573
+ content:
1574
+ application/json:
1575
+ schema:
1576
+ allOf:
1577
+ - $ref: '#/components/schemas/SessionResetPasswordRequest'
1578
+ - description: Current Password
1579
+ required: true
1580
+ responses:
1581
+ '200':
1582
+ description: Returns a new, randomly generated password for the current username.
1583
+ headers: {}
1584
+ content:
1585
+ application/json:
1586
+ schema:
1587
+ $ref: '#/components/schemas/SessionResetPasswordResponse'
1588
+ '400':
1589
+ description: Error Response
1590
+ headers: {}
1591
+ content:
1592
+ application/json:
1593
+ schema:
1594
+ $ref: '#/components/schemas/RestErrorResponse'
1595
+ deprecated: false
1596
+ /callbacks/{aname}:
1597
+ get:
1598
+ tags:
1599
+ - callbacks
1600
+ summary: listCallbacksUsingGET
1601
+ description: ''
1602
+ operationId: listCallbacksUsingGET
1603
+ parameters:
1604
+ - name: VZ-M2M-Token
1605
+ in: header
1606
+ description: VZ-M2M session token
1607
+ required: true
1608
+ style: simple
1609
+ schema:
1610
+ type: string
1611
+ - name: aname
1612
+ in: path
1613
+ description: Account name
1614
+ required: true
1615
+ style: simple
1616
+ schema:
1617
+ type: string
1618
+ responses:
1619
+ '200':
1620
+ description: Callback response
1621
+ headers: {}
1622
+ content:
1623
+ application/json:
1624
+ schema:
1625
+ type: array
1626
+ items:
1627
+ $ref: '#/components/schemas/Callback'
1628
+ description: ''
1629
+ '400':
1630
+ description: Error Response
1631
+ headers: {}
1632
+ content:
1633
+ application/json:
1634
+ schema:
1635
+ $ref: '#/components/schemas/RestErrorResponse'
1636
+ deprecated: false
1637
+ post:
1638
+ tags:
1639
+ - callbacks
1640
+ summary: registerCallbackUsingPOST
1641
+ description: You are responsible for creating and running a listening process on your server at that URL.
1642
+ operationId: registerCallbackUsingPOST
1643
+ parameters:
1644
+ - name: VZ-M2M-Token
1645
+ in: header
1646
+ description: VZ-M2M session token
1647
+ required: true
1648
+ style: simple
1649
+ schema:
1650
+ type: string
1651
+ - name: aname
1652
+ in: path
1653
+ description: Account name
1654
+ required: true
1655
+ style: simple
1656
+ schema:
1657
+ type: string
1658
+ requestBody:
1659
+ description: Request
1660
+ content:
1661
+ application/json:
1662
+ schema:
1663
+ allOf:
1664
+ - $ref: '#/components/schemas/RegisterCallbackRequest'
1665
+ - description: Request
1666
+ required: true
1667
+ responses:
1668
+ '200':
1669
+ description: Callback response
1670
+ headers: {}
1671
+ content:
1672
+ application/json:
1673
+ schema:
1674
+ $ref: '#/components/schemas/CallbackActionResponse'
1675
+ '400':
1676
+ description: Error Response
1677
+ headers: {}
1678
+ content:
1679
+ application/json:
1680
+ schema:
1681
+ $ref: '#/components/schemas/RestErrorResponse'
1682
+ deprecated: false
1683
+ /callbacks/{aname}/name/{sname}:
1684
+ delete:
1685
+ tags:
1686
+ - callbacks
1687
+ summary: unregisterCallbackUsingDELETE
1688
+ description: ''
1689
+ operationId: unregisterCallbackUsingDELETE
1690
+ parameters:
1691
+ - name: VZ-M2M-Token
1692
+ in: header
1693
+ description: VZ-M2M session token
1694
+ required: true
1695
+ style: simple
1696
+ schema:
1697
+ type: string
1698
+ - name: aname
1699
+ in: path
1700
+ description: Account name
1701
+ required: true
1702
+ style: simple
1703
+ schema:
1704
+ type: string
1705
+ - name: sname
1706
+ in: path
1707
+ description: Service name
1708
+ required: true
1709
+ style: simple
1710
+ schema:
1711
+ type: string
1712
+ responses:
1713
+ '200':
1714
+ description: Callback response
1715
+ headers: {}
1716
+ content:
1717
+ application/json:
1718
+ schema:
1719
+ $ref: '#/components/schemas/CallbackActionResponse'
1720
+ '400':
1721
+ description: Error Response
1722
+ headers: {}
1723
+ content:
1724
+ application/json:
1725
+ schema:
1726
+ $ref: '#/components/schemas/RestErrorResponse'
1727
+ deprecated: false
1728
+ /accounts/{aname}/requests/{requestId}/status:
1729
+ get:
1730
+ tags:
1731
+ - requests
1732
+ summary: getRequestStatusUsingGET
1733
+ description: Returns the current status of an asynchronous request that was made for a single device.
1734
+ operationId: getRequestStatusUsingGET
1735
+ parameters:
1736
+ - name: VZ-M2M-Token
1737
+ in: header
1738
+ description: VZ-M2M session token
1739
+ required: true
1740
+ style: simple
1741
+ schema:
1742
+ type: string
1743
+ - name: aname
1744
+ in: path
1745
+ description: Account name
1746
+ required: true
1747
+ style: simple
1748
+ schema:
1749
+ type: string
1750
+ - name: requestId
1751
+ in: path
1752
+ description: UUID from synchronous response
1753
+ required: true
1754
+ style: simple
1755
+ schema:
1756
+ type: string
1757
+ responses:
1758
+ '200':
1759
+ description: The request status.
1760
+ headers: {}
1761
+ content:
1762
+ application/json:
1763
+ schema:
1764
+ $ref: '#/components/schemas/RequestStatusResponse'
1765
+ '400':
1766
+ description: Error Response
1767
+ headers: {}
1768
+ content:
1769
+ application/json:
1770
+ schema:
1771
+ $ref: '#/components/schemas/RestErrorResponse'
1772
+ deprecated: false
1773
+ /plans/{aname}:
1774
+ get:
1775
+ tags:
1776
+ - plans
1777
+ summary: getServicePlanListUsingGET
1778
+ description: ''
1779
+ operationId: getServicePlanListUsingGET
1780
+ parameters:
1781
+ - name: VZ-M2M-Token
1782
+ in: header
1783
+ description: VZ-M2M session token
1784
+ required: true
1785
+ style: simple
1786
+ schema:
1787
+ type: string
1788
+ - name: aname
1789
+ in: path
1790
+ description: Account name
1791
+ required: true
1792
+ style: simple
1793
+ schema:
1794
+ type: string
1795
+ responses:
1796
+ '200':
1797
+ description: The list of service plans associated with the account.
1798
+ headers: {}
1799
+ content:
1800
+ application/json:
1801
+ schema:
1802
+ type: array
1803
+ items:
1804
+ $ref: '#/components/schemas/ServicePlanResponse'
1805
+ description: ''
1806
+ '400':
1807
+ description: Error Response
1808
+ headers: {}
1809
+ content:
1810
+ application/json:
1811
+ schema:
1812
+ $ref: '#/components/schemas/RestErrorResponse'
1813
+ deprecated: false
1814
+ components:
1815
+ schemas:
1816
+ AccountInformationResponse:
1817
+ title: AccountInformationResponse
1818
+ type: object
1819
+ properties:
1820
+ accountName:
1821
+ type: string
1822
+ accountNumber:
1823
+ type: string
1824
+ organizationName:
1825
+ type: string
1826
+ isProvisioningAllowed:
1827
+ type: boolean
1828
+ carriers:
1829
+ type: array
1830
+ items:
1831
+ type: string
1832
+ description: ''
1833
+ features:
1834
+ type: array
1835
+ items:
1836
+ type: string
1837
+ description: ''
1838
+ iPPools:
1839
+ type: array
1840
+ items:
1841
+ $ref: '#/components/schemas/IPPool'
1842
+ description: ''
1843
+ servicePlans:
1844
+ type: array
1845
+ items:
1846
+ $ref: '#/components/schemas/ServicePlanResponse'
1847
+ description: ''
1848
+ AddDevicesRequest:
1849
+ title: AddDevicesRequest
1850
+ type: object
1851
+ properties:
1852
+ accountName:
1853
+ type: string
1854
+ customFields:
1855
+ type: array
1856
+ items:
1857
+ $ref: '#/components/schemas/KvPair'
1858
+ description: ''
1859
+ devicesToAdd:
1860
+ type: array
1861
+ items:
1862
+ $ref: '#/components/schemas/DeviceList'
1863
+ description: ''
1864
+ groupName:
1865
+ type: string
1866
+ skuNumber:
1867
+ type: string
1868
+ state:
1869
+ type: string
1870
+ AddDevicesResponseMessage:
1871
+ title: AddDevicesResponseMessage
1872
+ type: object
1873
+ properties:
1874
+ deviceIds:
1875
+ type: array
1876
+ items:
1877
+ $ref: '#/components/schemas/DeviceId'
1878
+ description: ''
1879
+ response:
1880
+ type: string
1881
+ Address:
1882
+ title: Address
1883
+ required:
1884
+ - addressLine1
1885
+ - city
1886
+ - state
1887
+ - zip
1888
+ - country
1889
+ type: object
1890
+ properties:
1891
+ addressLine1:
1892
+ type: string
1893
+ addressLine2:
1894
+ type: string
1895
+ city:
1896
+ type: string
1897
+ state:
1898
+ type: string
1899
+ zip:
1900
+ type: string
1901
+ zip4:
1902
+ type: string
1903
+ country:
1904
+ type: string
1905
+ phone:
1906
+ type: string
1907
+ phoneType:
1908
+ type: string
1909
+ emailAddress:
1910
+ type: string
1911
+ Callback:
1912
+ title: Callback
1913
+ type: object
1914
+ properties:
1915
+ accountName:
1916
+ type: string
1917
+ password:
1918
+ type: string
1919
+ serviceName:
1920
+ type: string
1921
+ url:
1922
+ type: string
1923
+ username:
1924
+ type: string
1925
+ CallbackActionResponse:
1926
+ title: CallbackActionResponse
1927
+ type: object
1928
+ properties:
1929
+ accountName:
1930
+ type: string
1931
+ serviceName:
1932
+ type: string
1933
+ CarrierActionsRequest:
1934
+ title: CarrierActionsRequest
1935
+ type: object
1936
+ properties:
1937
+ accountName:
1938
+ type: string
1939
+ customFields:
1940
+ type: array
1941
+ items:
1942
+ $ref: '#/components/schemas/KvPair'
1943
+ description: ''
1944
+ devices:
1945
+ type: array
1946
+ items:
1947
+ $ref: '#/components/schemas/DeviceList'
1948
+ description: ''
1949
+ groupName:
1950
+ type: string
1951
+ servicePlan:
1952
+ type: string
1953
+ CarrierActivateRequest:
1954
+ title: CarrierActivateRequest
1955
+ type: object
1956
+ properties:
1957
+ accountName:
1958
+ type: string
1959
+ carrierIpPoolName:
1960
+ type: string
1961
+ carrierName:
1962
+ type: string
1963
+ costCenterCode:
1964
+ type: string
1965
+ customFields:
1966
+ type: array
1967
+ items:
1968
+ $ref: '#/components/schemas/KvPair'
1969
+ description: ''
1970
+ devices:
1971
+ type: array
1972
+ items:
1973
+ $ref: '#/components/schemas/DeviceList'
1974
+ description: ''
1975
+ groupName:
1976
+ type: string
1977
+ leadId:
1978
+ type: string
1979
+ mdnZipCode:
1980
+ type: string
1981
+ primaryPlaceOfUse:
1982
+ $ref: '#/components/schemas/PlaceOfUse'
1983
+ publicIpRestriction:
1984
+ type: string
1985
+ servicePlan:
1986
+ type: string
1987
+ skuNumber:
1988
+ type: string
1989
+ CarrierDeactivateRequest:
1990
+ title: CarrierDeactivateRequest
1991
+ type: object
1992
+ properties:
1993
+ accountName:
1994
+ type: string
1995
+ customFields:
1996
+ type: array
1997
+ items:
1998
+ $ref: '#/components/schemas/KvPair'
1999
+ description: ''
2000
+ devices:
2001
+ type: array
2002
+ items:
2003
+ $ref: '#/components/schemas/DeviceList'
2004
+ description: ''
2005
+ etfWaiver:
2006
+ type: boolean
2007
+ groupName:
2008
+ type: string
2009
+ reasonCode:
2010
+ type: string
2011
+ servicePlan:
2012
+ type: string
2013
+ CarrierInformation:
2014
+ title: CarrierInformation
2015
+ type: object
2016
+ properties:
2017
+ carrierName:
2018
+ type: string
2019
+ servicePlan:
2020
+ type: string
2021
+ state:
2022
+ type: string
2023
+ ChangeDeviceIdRequest:
2024
+ title: ChangeDeviceIdRequest
2025
+ type: object
2026
+ properties:
2027
+ assignNonGeoMdn:
2028
+ type: boolean
2029
+ change4gOption:
2030
+ type: string
2031
+ deviceIds:
2032
+ type: array
2033
+ items:
2034
+ $ref: '#/components/schemas/DeviceId'
2035
+ description: ''
2036
+ deviceIdsTo:
2037
+ type: array
2038
+ items:
2039
+ $ref: '#/components/schemas/DeviceId'
2040
+ description: ''
2041
+ npaNxx:
2042
+ type: string
2043
+ servicePlan:
2044
+ type: string
2045
+ zipCode:
2046
+ type: string
2047
+ ConnectionEvent:
2048
+ title: ConnectionEvent
2049
+ type: object
2050
+ properties:
2051
+ connectionEventAttributes:
2052
+ type: array
2053
+ items:
2054
+ $ref: '#/components/schemas/KvPair'
2055
+ description: ''
2056
+ extendedAttributes:
2057
+ type: array
2058
+ items:
2059
+ $ref: '#/components/schemas/KvPair'
2060
+ description: ''
2061
+ occurredAt:
2062
+ type: string
2063
+ ConnectionHistoryResponse:
2064
+ title: ConnectionHistoryResponse
2065
+ type: object
2066
+ properties:
2067
+ connectionHistory:
2068
+ type: array
2069
+ items:
2070
+ $ref: '#/components/schemas/ConnectionEvent'
2071
+ description: ''
2072
+ hasMoreData:
2073
+ type: boolean
2074
+ ContactInfoUpdateRequest:
2075
+ title: ContactInfoUpdateRequest
2076
+ type: object
2077
+ properties:
2078
+ accountName:
2079
+ type: string
2080
+ devices:
2081
+ type: array
2082
+ items:
2083
+ $ref: '#/components/schemas/DeviceList'
2084
+ description: ''
2085
+ primaryPlaceOfUse:
2086
+ type: object
2087
+ CreateDevGroupRequest:
2088
+ title: CreateDevGroupRequest
2089
+ type: object
2090
+ properties:
2091
+ accountName:
2092
+ type: string
2093
+ devicesToAdd:
2094
+ type: array
2095
+ items:
2096
+ $ref: '#/components/schemas/DeviceId'
2097
+ description: ''
2098
+ groupDescription:
2099
+ type: string
2100
+ groupName:
2101
+ type: string
2102
+ CustomerName:
2103
+ title: CustomerName
2104
+ required:
2105
+ - firstName
2106
+ - lastName
2107
+ type: object
2108
+ properties:
2109
+ title:
2110
+ type: string
2111
+ firstName:
2112
+ type: string
2113
+ middleName:
2114
+ type: string
2115
+ lastName:
2116
+ type: string
2117
+ suffix:
2118
+ type: string
2119
+ CustomFieldsUpdateRequest:
2120
+ title: CustomFieldsUpdateRequest
2121
+ type: object
2122
+ properties:
2123
+ accountName:
2124
+ type: string
2125
+ customFields:
2126
+ type: array
2127
+ items:
2128
+ $ref: '#/components/schemas/KvPair'
2129
+ description: ''
2130
+ customFieldsToUpdate:
2131
+ type: array
2132
+ items:
2133
+ $ref: '#/components/schemas/KvPair'
2134
+ description: ''
2135
+ devices:
2136
+ type: array
2137
+ items:
2138
+ $ref: '#/components/schemas/DeviceList'
2139
+ description: ''
2140
+ groupName:
2141
+ type: string
2142
+ servicePlan:
2143
+ type: string
2144
+ DateFilter:
2145
+ title: DateFilter
2146
+ type: object
2147
+ properties:
2148
+ earliest:
2149
+ type: string
2150
+ latest:
2151
+ type: string
2152
+ DeleteDevicesRequest:
2153
+ title: DeleteDevicesRequest
2154
+ type: object
2155
+ properties:
2156
+ accountName:
2157
+ type: string
2158
+ devicesToDelete:
2159
+ type: array
2160
+ items:
2161
+ $ref: '#/components/schemas/DeviceList'
2162
+ description: ''
2163
+ DeleteDevicesResponseMessage:
2164
+ title: DeleteDevicesResponseMessage
2165
+ type: object
2166
+ properties:
2167
+ deviceIds:
2168
+ type: array
2169
+ items:
2170
+ $ref: '#/components/schemas/DeviceId'
2171
+ description: ''
2172
+ status:
2173
+ type: string
2174
+ message:
2175
+ type: string
2176
+ Device:
2177
+ title: Device
2178
+ type: object
2179
+ properties:
2180
+ accountName:
2181
+ type: string
2182
+ billingCycleEndDate:
2183
+ type: string
2184
+ carrierInformations:
2185
+ type: array
2186
+ items:
2187
+ $ref: '#/components/schemas/CarrierInformation'
2188
+ description: ''
2189
+ connected:
2190
+ type: boolean
2191
+ createdAt:
2192
+ type: string
2193
+ customFields:
2194
+ type: array
2195
+ items:
2196
+ $ref: '#/components/schemas/KvPair'
2197
+ description: ''
2198
+ deviceIds:
2199
+ type: array
2200
+ items:
2201
+ $ref: '#/components/schemas/DeviceId'
2202
+ description: ''
2203
+ extendedAttributes:
2204
+ type: array
2205
+ items:
2206
+ $ref: '#/components/schemas/KvPair'
2207
+ description: ''
2208
+ groupNames:
2209
+ type: array
2210
+ items:
2211
+ type: string
2212
+ description: ''
2213
+ ipAddress:
2214
+ type: string
2215
+ lastActivationBy:
2216
+ type: string
2217
+ lastActivationDate:
2218
+ type: string
2219
+ lastConnectionDate:
2220
+ type: string
2221
+ DeviceAggregateUsageListRequest:
2222
+ title: DeviceAggregateUsageListRequest
2223
+ type: object
2224
+ properties:
2225
+ deviceIds:
2226
+ type: array
2227
+ items:
2228
+ $ref: '#/components/schemas/DeviceId'
2229
+ description: ''
2230
+ accountName:
2231
+ type: string
2232
+ groupName:
2233
+ type: string
2234
+ startTime:
2235
+ type: string
2236
+ endTime:
2237
+ type: string
2238
+ DeviceConnectionListRequest:
2239
+ title: DeviceConnectionListRequest
2240
+ type: object
2241
+ properties:
2242
+ deviceId:
2243
+ $ref: '#/components/schemas/DeviceId'
2244
+ earliest:
2245
+ type: string
2246
+ latest:
2247
+ type: string
2248
+ DeviceCostCenterRequest:
2249
+ title: DeviceCostCenterRequest
2250
+ type: object
2251
+ properties:
2252
+ accountName:
2253
+ type: string
2254
+ costCenter:
2255
+ type: string
2256
+ customFields:
2257
+ type: array
2258
+ items:
2259
+ $ref: '#/components/schemas/KvPair'
2260
+ description: ''
2261
+ devices:
2262
+ type: array
2263
+ items:
2264
+ $ref: '#/components/schemas/DeviceList'
2265
+ description: ''
2266
+ groupName:
2267
+ type: string
2268
+ primaryPlaceOfUse:
2269
+ type: object
2270
+ removeCostCenter:
2271
+ type: boolean
2272
+ servicePlan:
2273
+ type: string
2274
+ DeviceExtendedDiagnosticsRequest:
2275
+ title: DeviceExtendedDiagnosticsRequest
2276
+ required:
2277
+ - accountName
2278
+ - deviceList
2279
+ type: object
2280
+ properties:
2281
+ accountName:
2282
+ type: string
2283
+ deviceList:
2284
+ type: array
2285
+ items:
2286
+ $ref: '#/components/schemas/DeviceId'
2287
+ description: ''
2288
+ DeviceExtendedDiagnosticsResponse:
2289
+ title: DeviceExtendedDiagnosticsResponse
2290
+ type: object
2291
+ properties:
2292
+ categories:
2293
+ type: array
2294
+ items:
2295
+ $ref: '#/components/schemas/DiagnosticsCategory'
2296
+ description: ''
2297
+ DeviceFilter:
2298
+ title: DeviceFilter
2299
+ type: object
2300
+ properties:
2301
+ account:
2302
+ type: string
2303
+ groupName:
2304
+ type: string
2305
+ servicePlan:
2306
+ type: string
2307
+ customFields:
2308
+ type: array
2309
+ items:
2310
+ $ref: '#/components/schemas/KvPair'
2311
+ description: ''
2312
+ DeviceFilterWithoutAccount:
2313
+ title: DeviceFilterWithoutAccount
2314
+ type: object
2315
+ properties:
2316
+ groupName:
2317
+ type: string
2318
+ servicePlan:
2319
+ type: string
2320
+ customFields:
2321
+ type: array
2322
+ items:
2323
+ $ref: '#/components/schemas/KvPair'
2324
+ description: ''
2325
+ DeviceId:
2326
+ title: DeviceId
2327
+ type: object
2328
+ properties:
2329
+ id:
2330
+ type: string
2331
+ kind:
2332
+ type: string
2333
+ DeviceIdSearch:
2334
+ title: DeviceIdSearch
2335
+ required:
2336
+ - kind
2337
+ type: object
2338
+ properties:
2339
+ contains:
2340
+ type: string
2341
+ startswith:
2342
+ type: string
2343
+ endswith:
2344
+ type: string
2345
+ kind:
2346
+ type: string
2347
+ DeviceList:
2348
+ title: DeviceList
2349
+ type: object
2350
+ properties:
2351
+ deviceIds:
2352
+ type: array
2353
+ items:
2354
+ $ref: '#/components/schemas/DeviceId'
2355
+ description: ''
2356
+ DeviceListRequest:
2357
+ title: DeviceListRequest
2358
+ type: object
2359
+ properties:
2360
+ accountName:
2361
+ type: string
2362
+ deviceId:
2363
+ $ref: '#/components/schemas/DeviceId'
2364
+ filter:
2365
+ $ref: '#/components/schemas/Filter'
2366
+ currentState:
2367
+ type: string
2368
+ customFields:
2369
+ type: array
2370
+ items:
2371
+ $ref: '#/components/schemas/KvPair'
2372
+ description: ''
2373
+ earliest:
2374
+ type: string
2375
+ groupName:
2376
+ type: string
2377
+ latest:
2378
+ type: string
2379
+ servicePlan:
2380
+ type: string
2381
+ DeviceListResponse:
2382
+ title: DeviceListResponse
2383
+ type: object
2384
+ properties:
2385
+ devices:
2386
+ type: array
2387
+ items:
2388
+ $ref: '#/components/schemas/Device'
2389
+ description: ''
2390
+ hasMoreData:
2391
+ type: boolean
2392
+ DeviceRequest:
2393
+ title: DeviceRequest
2394
+ type: object
2395
+ properties:
2396
+ accountName:
2397
+ type: string
2398
+ devices:
2399
+ type: array
2400
+ items:
2401
+ $ref: '#/components/schemas/DeviceList'
2402
+ description: ''
2403
+ DevicePrlListRequest:
2404
+ title: DevicePrlListRequest
2405
+ type: object
2406
+ properties:
2407
+ deviceIds:
2408
+ type: array
2409
+ items:
2410
+ $ref: '#/components/schemas/DeviceId'
2411
+ description: ''
2412
+ accountName:
2413
+ type: string
2414
+ customFields:
2415
+ type: array
2416
+ items:
2417
+ $ref: '#/components/schemas/KvPair'
2418
+ description: ''
2419
+ groupName:
2420
+ type: string
2421
+ servicePlan:
2422
+ type: string
2423
+ DeviceMismatchListRequest:
2424
+ title: DeviceMismatchListRequest
2425
+ type: object
2426
+ properties:
2427
+ devices:
2428
+ type: array
2429
+ items:
2430
+ $ref: '#/components/schemas/DeviceList'
2431
+ description: ''
2432
+ filter:
2433
+ $ref: '#/components/schemas/DateFilter'
2434
+ accountName:
2435
+ type: string
2436
+ groupName:
2437
+ type: string
2438
+ DeviceMismatchListResponse:
2439
+ title: DeviceMismatchListResponse
2440
+ type: object
2441
+ properties:
2442
+ devices:
2443
+ type: array
2444
+ items:
2445
+ $ref: '#/components/schemas/MismatchedDevice'
2446
+ description: ''
2447
+ DeviceProvisioningHistoryListRequest:
2448
+ title: DeviceProvisioningHistoryListRequest
2449
+ type: object
2450
+ properties:
2451
+ deviceId:
2452
+ $ref: '#/components/schemas/DeviceId'
2453
+ earliest:
2454
+ type: string
2455
+ latest:
2456
+ type: string
2457
+ DeviceProvisioningHistoryListResponse:
2458
+ title: DeviceProvisioningHistoryListResponse
2459
+ type: object
2460
+ properties:
2461
+ hasMoreData:
2462
+ type: boolean
2463
+ provisioningHistory:
2464
+ type: array
2465
+ items:
2466
+ $ref: '#/components/schemas/ProvisioningHistory'
2467
+ description: ''
2468
+ DeviceSuspensionStatusRequest:
2469
+ title: DeviceSuspensionStatusRequest
2470
+ type: object
2471
+ properties:
2472
+ deviceIds:
2473
+ type: array
2474
+ items:
2475
+ $ref: '#/components/schemas/DeviceId'
2476
+ description: ''
2477
+ filter:
2478
+ $ref: '#/components/schemas/DeviceFilterWithoutAccount'
2479
+ accountName:
2480
+ type: string
2481
+ DeviceUsageListRequest:
2482
+ title: DeviceUsageListRequest
2483
+ type: object
2484
+ properties:
2485
+ deviceId:
2486
+ $ref: '#/components/schemas/DeviceId'
2487
+ earliest:
2488
+ type: string
2489
+ latest:
2490
+ type: string
2491
+ DeviceUsageListResponse:
2492
+ title: DeviceUsageListResponse
2493
+ type: object
2494
+ properties:
2495
+ hasMoreData:
2496
+ type: boolean
2497
+ usageHistory:
2498
+ type: array
2499
+ items:
2500
+ $ref: '#/components/schemas/Usage'
2501
+ description: ''
2502
+ DiagnosticsCategory:
2503
+ title: DiagnosticsCategory
2504
+ type: object
2505
+ properties:
2506
+ categoryName:
2507
+ type: string
2508
+ extendedAttributes:
2509
+ type: array
2510
+ items:
2511
+ $ref: '#/components/schemas/KvPair'
2512
+ description: ''
2513
+ GetStatesAndServicesResponse:
2514
+ title: GetStatesAndServicesResponse
2515
+ required:
2516
+ - engagement
2517
+ type: object
2518
+ properties:
2519
+ engagement:
2520
+ type: array
2521
+ items:
2522
+ $ref: '#/components/schemas/Engagement'
2523
+ description: ''
2524
+ GoToStateRequest:
2525
+ title: GoToStateRequest
2526
+ type: object
2527
+ properties:
2528
+ devices:
2529
+ type: array
2530
+ items:
2531
+ $ref: '#/components/schemas/DeviceList'
2532
+ description: ''
2533
+ filter:
2534
+ $ref: '#/components/schemas/DeviceFilter'
2535
+ serviceName:
2536
+ type: string
2537
+ stateName:
2538
+ type: string
2539
+ servicePlan:
2540
+ type: string
2541
+ mdnZipCode:
2542
+ type: string
2543
+ carrierIpPoolName:
2544
+ type: string
2545
+ publicIpRestriction:
2546
+ type: string
2547
+ skuNumber:
2548
+ type: string
2549
+ customFields:
2550
+ type: array
2551
+ items:
2552
+ $ref: '#/components/schemas/KvPair'
2553
+ description: ''
2554
+ groupName:
2555
+ type: string
2556
+ primaryPlaceOfUse:
2557
+ $ref: '#/components/schemas/PlaceOfUse'
2558
+ GroupListResponse:
2559
+ title: GroupListResponse
2560
+ type: object
2561
+ properties:
2562
+ description:
2563
+ type: string
2564
+ devices:
2565
+ type: array
2566
+ items:
2567
+ $ref: '#/components/schemas/DeviceList'
2568
+ description: ''
2569
+ hasMoreData:
2570
+ type: boolean
2571
+ name:
2572
+ type: string
2573
+ GroupResponse:
2574
+ title: GroupResponse
2575
+ type: object
2576
+ properties:
2577
+ description:
2578
+ type: string
2579
+ extendedAttributes:
2580
+ type: array
2581
+ items:
2582
+ $ref: '#/components/schemas/KvPair'
2583
+ description: ''
2584
+ isDefaultGroup:
2585
+ type: boolean
2586
+ name:
2587
+ type: string
2588
+ GroupUpdateRequest:
2589
+ title: GroupUpdateRequest
2590
+ type: object
2591
+ properties:
2592
+ devicesToAdd:
2593
+ type: array
2594
+ items:
2595
+ $ref: '#/components/schemas/DeviceId'
2596
+ description: ''
2597
+ devicesToRemove:
2598
+ type: array
2599
+ items:
2600
+ $ref: '#/components/schemas/DeviceId'
2601
+ description: ''
2602
+ newGroupDescription:
2603
+ type: string
2604
+ newGroupName:
2605
+ type: string
2606
+ IPPool:
2607
+ title: IPPool
2608
+ type: object
2609
+ properties:
2610
+ poolName:
2611
+ type: string
2612
+ example: ACMESALES001
2613
+ poolType:
2614
+ type: string
2615
+ isDefaultPool:
2616
+ type: boolean
2617
+ KvPair:
2618
+ title: KvPair
2619
+ type: object
2620
+ properties:
2621
+ key:
2622
+ type: string
2623
+ value:
2624
+ type: string
2625
+ LeadInformationResponse:
2626
+ title: LeadInformationResponse
2627
+ type: object
2628
+ properties:
2629
+ hasMoreData:
2630
+ type: boolean
2631
+ leads:
2632
+ type: array
2633
+ items:
2634
+ $ref: '#/components/schemas/LeadResponse'
2635
+ description: ''
2636
+ LeadResponse:
2637
+ title: LeadResponse
2638
+ type: object
2639
+ properties:
2640
+ address:
2641
+ $ref: '#/components/schemas/Address'
2642
+ leadId:
2643
+ type: string
2644
+ leadState:
2645
+ type: string
2646
+ LogInRequest:
2647
+ title: LogInRequest
2648
+ type: object
2649
+ properties:
2650
+ username:
2651
+ type: string
2652
+ password:
2653
+ type: string
2654
+ LogInResponse:
2655
+ title: LogInResponse
2656
+ type: object
2657
+ properties:
2658
+ sessionToken:
2659
+ type: string
2660
+ LogOutRequest:
2661
+ title: LogOutRequest
2662
+ type: object
2663
+ properties:
2664
+ sessionToken:
2665
+ type: string
2666
+ MismatchedDevice:
2667
+ title: MismatchedDevice
2668
+ type: object
2669
+ properties:
2670
+ accountName:
2671
+ type: string
2672
+ mdn:
2673
+ type: string
2674
+ activationDate:
2675
+ type: string
2676
+ iccid:
2677
+ type: string
2678
+ preImei:
2679
+ type: string
2680
+ postImei:
2681
+ type: string
2682
+ simOtaDate:
2683
+ type: string
2684
+ MoveDeviceRequest:
2685
+ title: MoveDeviceRequest
2686
+ type: object
2687
+ properties:
2688
+ accountName:
2689
+ type: string
2690
+ filter:
2691
+ $ref: '#/components/schemas/DeviceFilter'
2692
+ customFields:
2693
+ type: array
2694
+ items:
2695
+ $ref: '#/components/schemas/KvPair'
2696
+ description: ''
2697
+ devices:
2698
+ type: array
2699
+ items:
2700
+ $ref: '#/components/schemas/DeviceList'
2701
+ description: ''
2702
+ groupName:
2703
+ type: string
2704
+ carrierIpPoolName:
2705
+ type: string
2706
+ servicePlan:
2707
+ type: string
2708
+ PlaceOfUse:
2709
+ title: PlaceOfUse
2710
+ type: object
2711
+ properties:
2712
+ address:
2713
+ $ref: '#/components/schemas/Address'
2714
+ customerName:
2715
+ $ref: '#/components/schemas/CustomerName'
2716
+ ProvisioningHistory:
2717
+ title: ProvisioningHistory
2718
+ type: object
2719
+ properties:
2720
+ occurredAt:
2721
+ type: string
2722
+ status:
2723
+ type: string
2724
+ eventBy:
2725
+ type: string
2726
+ eventType:
2727
+ type: string
2728
+ mdn:
2729
+ type: string
2730
+ msisdn:
2731
+ type: string
2732
+ servicePlan:
2733
+ type: string
2734
+ extendedAttributes:
2735
+ type: array
2736
+ items:
2737
+ $ref: '#/components/schemas/KvPair'
2738
+ description: ''
2739
+ RegisterCallbackRequest:
2740
+ title: RegisterCallbackRequest
2741
+ type: object
2742
+ properties:
2743
+ name:
2744
+ type: string
2745
+ url:
2746
+ type: string
2747
+ username:
2748
+ type: string
2749
+ password:
2750
+ type: string
2751
+ RequestResponse:
2752
+ title: RequestResponse
2753
+ type: object
2754
+ properties:
2755
+ requestId:
2756
+ type: string
2757
+ RequestStatusResponse:
2758
+ title: RequestStatusResponse
2759
+ type: object
2760
+ properties:
2761
+ requestId:
2762
+ type: string
2763
+ status:
2764
+ $ref: '#/components/schemas/Status'
2765
+ RestErrorResponse:
2766
+ title: RestErrorResponse
2767
+ type: object
2768
+ properties:
2769
+ errorCode:
2770
+ type: string
2771
+ errorMessage:
2772
+ type: string
2773
+ RestSuccessResponse:
2774
+ title: RestSuccessResponse
2775
+ type: object
2776
+ properties:
2777
+ success:
2778
+ type: boolean
2779
+ ServicePlanResponse:
2780
+ title: ServicePlanResponse
2781
+ type: object
2782
+ properties:
2783
+ carrierServicePlanCode:
2784
+ type: string
2785
+ code:
2786
+ type: string
2787
+ extendedAttributes:
2788
+ type: array
2789
+ items:
2790
+ $ref: '#/components/schemas/KvPair'
2791
+ description: ''
2792
+ name:
2793
+ type: string
2794
+ sizeKb:
2795
+ type: integer
2796
+ format: int64
2797
+ ServicePlanUpdateRequest:
2798
+ title: ServicePlanUpdateRequest
2799
+ type: object
2800
+ properties:
2801
+ accountName:
2802
+ type: string
2803
+ currentServicePlan:
2804
+ type: string
2805
+ customFields:
2806
+ type: array
2807
+ items:
2808
+ $ref: '#/components/schemas/KvPair'
2809
+ description: ''
2810
+ devices:
2811
+ type: array
2812
+ items:
2813
+ $ref: '#/components/schemas/DeviceList'
2814
+ description: ''
2815
+ groupName:
2816
+ type: string
2817
+ servicePlan:
2818
+ type: string
2819
+ SessionResetPasswordRequest:
2820
+ title: SessionResetPasswordRequest
2821
+ type: object
2822
+ properties:
2823
+ oldPassword:
2824
+ type: string
2825
+ SessionResetPasswordResponse:
2826
+ title: SessionResetPasswordResponse
2827
+ type: object
2828
+ properties:
2829
+ newPassword:
2830
+ type: string
2831
+ SmsMessage:
2832
+ title: SmsMessage
2833
+ type: object
2834
+ properties:
2835
+ deviceIds:
2836
+ type: array
2837
+ items:
2838
+ $ref: '#/components/schemas/DeviceId'
2839
+ description: ''
2840
+ message:
2841
+ type: string
2842
+ timestamp:
2843
+ type: string
2844
+ SmsMessagesResponse:
2845
+ title: SmsMessagesResponse
2846
+ type: object
2847
+ properties:
2848
+ hasMoreData:
2849
+ type: boolean
2850
+ messages:
2851
+ type: array
2852
+ items:
2853
+ $ref: '#/components/schemas/SmsMessage'
2854
+ description: ''
2855
+ SMSSendRequest:
2856
+ title: SMSSendRequest
2857
+ type: object
2858
+ properties:
2859
+ accountName:
2860
+ type: string
2861
+ customFields:
2862
+ type: array
2863
+ items:
2864
+ $ref: '#/components/schemas/KvPair'
2865
+ description: ''
2866
+ dataEncoding:
2867
+ type: string
2868
+ deviceIds:
2869
+ type: array
2870
+ items:
2871
+ $ref: '#/components/schemas/DeviceId'
2872
+ description: ''
2873
+ groupName:
2874
+ type: string
2875
+ servicePlan:
2876
+ type: string
2877
+ smsMessage:
2878
+ type: string
2879
+ Usage:
2880
+ title: Usage
2881
+ type: object
2882
+ properties:
2883
+ bytesUsed:
2884
+ type: integer
2885
+ format: int64
2886
+ extendedAttributes:
2887
+ type: array
2888
+ items:
2889
+ $ref: '#/components/schemas/KvPair'
2890
+ description: ''
2891
+ servicePlan:
2892
+ type: string
2893
+ smsUsed:
2894
+ type: integer
2895
+ format: int32
2896
+ source:
2897
+ type: string
2898
+ timestamp:
2899
+ type: string
2900
+ Engagement:
2901
+ title: Engagement
2902
+ type: object
2903
+ properties:
2904
+ engagementId:
2905
+ type: string
2906
+ example: '1234'
2907
+ chargingGroup:
2908
+ type: string
2909
+ example: Engagement1234
2910
+ services:
2911
+ type: array
2912
+ items:
2913
+ $ref: '#/components/schemas/Service'
2914
+ description: ''
2915
+ Filter:
2916
+ title: Filter
2917
+ type: object
2918
+ properties:
2919
+ deviceIdentifierFilters:
2920
+ type: array
2921
+ items:
2922
+ $ref: '#/components/schemas/DeviceIdSearch'
2923
+ description: ''
2924
+ Service:
2925
+ title: Service
2926
+ type: object
2927
+ properties:
2928
+ name:
2929
+ type: string
2930
+ example: Svc1
2931
+ description:
2932
+ type: string
2933
+ example: Usage Segmentation - Main Line
2934
+ states:
2935
+ type: array
2936
+ items:
2937
+ $ref: '#/components/schemas/State'
2938
+ description: ''
2939
+ State:
2940
+ title: State
2941
+ type: object
2942
+ properties:
2943
+ name:
2944
+ type: string
2945
+ example: Svc1 Activate
2946
+ workflowSequenceNumber:
2947
+ type: number
2948
+ example: 1
2949
+ servicePlans:
2950
+ type: array
2951
+ items:
2952
+ type: string
2953
+ description: ''
2954
+ example:
2955
+ - 4523aef7250f67205fd5
2956
+ - 4d4090c0f2d48814c94d
2957
+ Status:
2958
+ title: Status
2959
+ enum:
2960
+ - Pending
2961
+ - Success
2962
+ - Failed
2963
+ type: string
2964
+ securitySchemes:
2965
+ thingspace_oauth:
2966
+ type: oauth2
2967
+ flows:
2968
+ clientCredentials:
2969
+ tokenUrl: https://thingspace.verizon.com/api/ts/v1/oauth2/token
2970
+ scopes: {}
2971
+ bearer_authorization:
2972
+ type: apiKey
2973
+ name: Authorization
2974
+ in: header
2975
+ security:
2976
+ - thingspace_oauth: []
2977
+ bearer_authorization: []
2978
+ tags:
2979
+ - name: devices
2980
+ description: Manage device connectivity and get device history.
2981
+ - name: accounts
2982
+ description: Get information about an account or account leads.
2983
+ - name: groups
2984
+ description: Manage device groups.
2985
+ - name: sms
2986
+ description: Exchange Short Message Service (SMS) messages with devices.
2987
+ - name: session
2988
+ description: Start and end Connectivity Management sessions.
2989
+ - name: callbacks
2990
+ description: Manage subscriptions to asynchronous webhook messages.
2991
+ - name: requests
2992
+ description: Get the status of asynchronous reqeusts.
2993
+ - name: plans
2994
+ description: Get a list of service plans in an account.