@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.json ADDED
@@ -0,0 +1,4020 @@
1
+ {
2
+ "openapi": "3.0.1",
3
+ "info": {
4
+ "title": "ThingSpace Connectivity Management API",
5
+ "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>.",
6
+ "license": {
7
+ "name": "Verizon Terms of Service",
8
+ "url": "https://thingspace.verizon.com/legal/terms-of-services/"
9
+ },
10
+ "version": "v5.12"
11
+ },
12
+ "servers": [
13
+ {
14
+ "url": "https://{host}/api/m2m/v1"
15
+ }
16
+ ],
17
+ "security": [
18
+ {
19
+ "thingspace_oauth": [],
20
+ "bearer_authorization": []
21
+ }
22
+ ],
23
+ "tags": [
24
+ {
25
+ "name": "devices",
26
+ "description": "Manage device connectivity and get device history."
27
+ },
28
+ {
29
+ "name": "accounts",
30
+ "description": "Get information about an account or account leads."
31
+ },
32
+ {
33
+ "name": "groups",
34
+ "description": "Manage device groups."
35
+ },
36
+ {
37
+ "name": "sms",
38
+ "description": "Exchange Short Message Service (SMS) messages with devices."
39
+ },
40
+ {
41
+ "name": "session",
42
+ "description": "Start and end Connectivity Management sessions."
43
+ },
44
+ {
45
+ "name": "callbacks",
46
+ "description": "Manage subscriptions to asynchronous webhook messages."
47
+ },
48
+ {
49
+ "name": "requests",
50
+ "description": "Get the status of asynchronous reqeusts."
51
+ },
52
+ {
53
+ "name": "plans",
54
+ "description": "Get a list of service plans in an account."
55
+ }
56
+ ],
57
+ "paths": {
58
+ "/accounts/{aname}": {
59
+ "get": {
60
+ "tags": [
61
+ "accounts"
62
+ ],
63
+ "summary": "Returns information about a specified account",
64
+ "operationId": "getAccountUsingGET",
65
+ "parameters": [
66
+ {
67
+ "name": "VZ-M2M-Token",
68
+ "in": "header",
69
+ "description": "VZ-M2M session token",
70
+ "required": true,
71
+ "schema": {
72
+ "type": "string"
73
+ }
74
+ },
75
+ {
76
+ "name": "aname",
77
+ "in": "path",
78
+ "description": "Account name",
79
+ "required": true,
80
+ "schema": {
81
+ "type": "string"
82
+ }
83
+ }
84
+ ],
85
+ "responses": {
86
+ "200": {
87
+ "description": "The account information.",
88
+ "content": {
89
+ "application/json": {
90
+ "schema": {
91
+ "$ref": "#/components/schemas/AccountInformationResponse"
92
+ }
93
+ }
94
+ }
95
+ },
96
+ "400": {
97
+ "description": "Error Response",
98
+ "content": {
99
+ "application/json": {
100
+ "schema": {
101
+ "$ref": "#/components/schemas/RestErrorResponse"
102
+ }
103
+ }
104
+ }
105
+ }
106
+ }
107
+ }
108
+ },
109
+ "/accounts/{aname}/requests/{requestId}/status": {
110
+ "get": {
111
+ "tags": [
112
+ "requests"
113
+ ],
114
+ "summary": "Returns the status of an asynchronous request",
115
+ "description": "Returns the current status of an asynchronous request that was made for a single device.",
116
+ "operationId": "getRequestStatusUsingGET",
117
+ "parameters": [
118
+ {
119
+ "name": "VZ-M2M-Token",
120
+ "in": "header",
121
+ "description": "VZ-M2M session token",
122
+ "required": true,
123
+ "schema": {
124
+ "type": "string"
125
+ }
126
+ },
127
+ {
128
+ "name": "aname",
129
+ "in": "path",
130
+ "description": "Account name",
131
+ "required": true,
132
+ "schema": {
133
+ "type": "string"
134
+ }
135
+ },
136
+ {
137
+ "name": "requestId",
138
+ "in": "path",
139
+ "description": "UUID from synchronous response",
140
+ "required": true,
141
+ "schema": {
142
+ "type": "string"
143
+ }
144
+ }
145
+ ],
146
+ "responses": {
147
+ "200": {
148
+ "description": "The request status.",
149
+ "content": {
150
+ "application/json": {
151
+ "schema": {
152
+ "$ref": "#/components/schemas/RequestStatusResponse"
153
+ }
154
+ }
155
+ }
156
+ },
157
+ "400": {
158
+ "description": "Error Response",
159
+ "content": {
160
+ "application/json": {
161
+ "schema": {
162
+ "$ref": "#/components/schemas/RestErrorResponse"
163
+ }
164
+ }
165
+ }
166
+ }
167
+ }
168
+ }
169
+ },
170
+ "/accounts/{aname}/statesandservices": {
171
+ "get": {
172
+ "tags": [
173
+ "accounts"
174
+ ],
175
+ "summary": "Returns an account's custom services and states",
176
+ "description": "Returns a list and details of all custom services and states defined for a specified account.",
177
+ "operationId": "getServicesAndStatesUsingGET",
178
+ "parameters": [
179
+ {
180
+ "name": "VZ-M2M-Token",
181
+ "in": "header",
182
+ "description": "M2M-MC Session Token",
183
+ "required": true,
184
+ "schema": {
185
+ "type": "string"
186
+ }
187
+ },
188
+ {
189
+ "name": "aname",
190
+ "in": "path",
191
+ "description": "Account name",
192
+ "required": true,
193
+ "schema": {
194
+ "type": "string"
195
+ }
196
+ }
197
+ ],
198
+ "responses": {
199
+ "200": {
200
+ "description": "The account's engagements, services, and states.",
201
+ "content": {
202
+ "application/json": {
203
+ "schema": {
204
+ "$ref": "#/components/schemas/GetStatesAndServicesResponse"
205
+ }
206
+ }
207
+ }
208
+ },
209
+ "400": {
210
+ "description": "Error Response",
211
+ "content": {
212
+ "application/json": {
213
+ "schema": {
214
+ "$ref": "#/components/schemas/RestErrorResponse"
215
+ }
216
+ }
217
+ }
218
+ }
219
+ }
220
+ }
221
+ },
222
+ "/callbacks/{aname}": {
223
+ "get": {
224
+ "tags": [
225
+ "callbacks"
226
+ ],
227
+ "summary": "Returns the name and endpoint URL of all callback listening services registered for a given account.",
228
+ "operationId": "listCallbacksUsingGET",
229
+ "parameters": [
230
+ {
231
+ "name": "VZ-M2M-Token",
232
+ "in": "header",
233
+ "description": "VZ-M2M session token",
234
+ "required": true,
235
+ "schema": {
236
+ "type": "string"
237
+ }
238
+ },
239
+ {
240
+ "name": "aname",
241
+ "in": "path",
242
+ "description": "Account name",
243
+ "required": true,
244
+ "schema": {
245
+ "type": "string"
246
+ }
247
+ }
248
+ ],
249
+ "responses": {
250
+ "200": {
251
+ "description": "Callback response",
252
+ "content": {
253
+ "application/json": {
254
+ "schema": {
255
+ "type": "array",
256
+ "items": {
257
+ "$ref": "#/components/schemas/Callback"
258
+ }
259
+ }
260
+ }
261
+ }
262
+ },
263
+ "400": {
264
+ "description": "Error Response",
265
+ "content": {
266
+ "application/json": {
267
+ "schema": {
268
+ "$ref": "#/components/schemas/RestErrorResponse"
269
+ }
270
+ }
271
+ }
272
+ }
273
+ }
274
+ },
275
+ "post": {
276
+ "tags": [
277
+ "callbacks"
278
+ ],
279
+ "summary": "Registers a URL where an account will receive RESTFul messages from a platform callback service.",
280
+ "description": "You are responsible for creating and running a listening process on your server at that URL.",
281
+ "operationId": "registerCallbackUsingPOST",
282
+ "parameters": [
283
+ {
284
+ "name": "VZ-M2M-Token",
285
+ "in": "header",
286
+ "description": "VZ-M2M session token",
287
+ "required": true,
288
+ "schema": {
289
+ "type": "string"
290
+ }
291
+ },
292
+ {
293
+ "name": "aname",
294
+ "in": "path",
295
+ "description": "Account name",
296
+ "required": true,
297
+ "schema": {
298
+ "type": "string"
299
+ }
300
+ }
301
+ ],
302
+ "requestBody": {
303
+ "description": "Request",
304
+ "content": {
305
+ "application/json": {
306
+ "schema": {
307
+ "$ref": "#/components/schemas/RegisterCallbackRequest"
308
+ }
309
+ }
310
+ },
311
+ "required": true
312
+ },
313
+ "responses": {
314
+ "200": {
315
+ "description": "Callback response",
316
+ "content": {
317
+ "application/json": {
318
+ "schema": {
319
+ "$ref": "#/components/schemas/CallbackActionResponse"
320
+ }
321
+ }
322
+ }
323
+ },
324
+ "400": {
325
+ "description": "Error Response",
326
+ "content": {
327
+ "application/json": {
328
+ "schema": {
329
+ "$ref": "#/components/schemas/RestErrorResponse"
330
+ }
331
+ }
332
+ }
333
+ }
334
+ },
335
+ "x-codegen-request-body-name": "request"
336
+ }
337
+ },
338
+ "/callbacks/{aname}/name/{sname}": {
339
+ "delete": {
340
+ "tags": [
341
+ "callbacks"
342
+ ],
343
+ "summary": "Stops the platform from sending callback messages for the specified account and service.",
344
+ "operationId": "unregisterCallbackUsingDELETE",
345
+ "parameters": [
346
+ {
347
+ "name": "VZ-M2M-Token",
348
+ "in": "header",
349
+ "description": "VZ-M2M session token",
350
+ "required": true,
351
+ "schema": {
352
+ "type": "string"
353
+ }
354
+ },
355
+ {
356
+ "name": "aname",
357
+ "in": "path",
358
+ "description": "Account name",
359
+ "required": true,
360
+ "schema": {
361
+ "type": "string"
362
+ }
363
+ },
364
+ {
365
+ "name": "sname",
366
+ "in": "path",
367
+ "description": "Service name",
368
+ "required": true,
369
+ "schema": {
370
+ "type": "string"
371
+ }
372
+ }
373
+ ],
374
+ "responses": {
375
+ "200": {
376
+ "description": "Callback response",
377
+ "content": {
378
+ "application/json": {
379
+ "schema": {
380
+ "$ref": "#/components/schemas/CallbackActionResponse"
381
+ }
382
+ }
383
+ }
384
+ },
385
+ "400": {
386
+ "description": "Error Response",
387
+ "content": {
388
+ "application/json": {
389
+ "schema": {
390
+ "$ref": "#/components/schemas/RestErrorResponse"
391
+ }
392
+ }
393
+ }
394
+ }
395
+ }
396
+ }
397
+ },
398
+ "/devices/actions/activate": {
399
+ "post": {
400
+ "tags": [
401
+ "devices"
402
+ ],
403
+ "summary": "Activates service for one or more devices.",
404
+ "description": "If the devices do not already exist in the account, this API resource adds them before activation.",
405
+ "operationId": "activeUsingPOST",
406
+ "parameters": [
407
+ {
408
+ "name": "VZ-M2M-Token",
409
+ "in": "header",
410
+ "description": "VZ-M2M session token",
411
+ "required": true,
412
+ "schema": {
413
+ "type": "string"
414
+ }
415
+ }
416
+ ],
417
+ "requestBody": {
418
+ "description": "Activate request",
419
+ "content": {
420
+ "application/json": {
421
+ "schema": {
422
+ "$ref": "#/components/schemas/CarrierActivateRequest"
423
+ }
424
+ }
425
+ },
426
+ "required": true
427
+ },
428
+ "responses": {
429
+ "200": {
430
+ "description": "Request ID",
431
+ "content": {
432
+ "application/json": {
433
+ "schema": {
434
+ "$ref": "#/components/schemas/RequestResponse"
435
+ }
436
+ }
437
+ }
438
+ },
439
+ "400": {
440
+ "description": "Error Response",
441
+ "content": {
442
+ "application/json": {
443
+ "schema": {
444
+ "$ref": "#/components/schemas/RestErrorResponse"
445
+ }
446
+ }
447
+ }
448
+ }
449
+ },
450
+ "x-codegen-request-body-name": "request"
451
+ }
452
+ },
453
+ "/devices/actions/add": {
454
+ "post": {
455
+ "tags": [
456
+ "devices"
457
+ ],
458
+ "summary": "Adds up to 200 new devices, without provisioning lines of service for them.",
459
+ "description": "Use this API if you want to manage some device settings before you are ready to activate service for the devices.",
460
+ "operationId": "addUsingPOST",
461
+ "parameters": [
462
+ {
463
+ "name": "VZ-M2M-Token",
464
+ "in": "header",
465
+ "description": "VZ-M2M session token",
466
+ "required": true,
467
+ "schema": {
468
+ "type": "string"
469
+ }
470
+ }
471
+ ],
472
+ "requestBody": {
473
+ "description": "Devices to Add",
474
+ "content": {
475
+ "application/json": {
476
+ "schema": {
477
+ "$ref": "#/components/schemas/AddDevicesRequest"
478
+ }
479
+ }
480
+ },
481
+ "required": true
482
+ },
483
+ "responses": {
484
+ "200": {
485
+ "description": "For each device in the request, contains device identifiers and a success or failure response.",
486
+ "content": {
487
+ "application/json": {
488
+ "schema": {
489
+ "type": "array",
490
+ "items": {
491
+ "$ref": "#/components/schemas/AddDevicesResponseMessage"
492
+ }
493
+ }
494
+ }
495
+ }
496
+ },
497
+ "400": {
498
+ "description": "Error Response",
499
+ "content": {
500
+ "application/json": {
501
+ "schema": {
502
+ "$ref": "#/components/schemas/RestErrorResponse"
503
+ }
504
+ }
505
+ }
506
+ }
507
+ },
508
+ "x-codegen-request-body-name": "request"
509
+ }
510
+ },
511
+ "/devices/actions/contactinfo": {
512
+ "put": {
513
+ "tags": [
514
+ "devices"
515
+ ],
516
+ "summary": "Changes the name and address associated with a device.",
517
+ "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.",
518
+ "operationId": "updateContactInfoUsingPUT",
519
+ "parameters": [
520
+ {
521
+ "name": "VZ-M2M-Token",
522
+ "in": "header",
523
+ "description": "VZ-M2M session token",
524
+ "required": true,
525
+ "schema": {
526
+ "type": "string"
527
+ }
528
+ }
529
+ ],
530
+ "requestBody": {
531
+ "description": "Change contact info request",
532
+ "content": {
533
+ "application/json": {
534
+ "schema": {
535
+ "$ref": "#/components/schemas/ContactInfoUpdateRequest"
536
+ }
537
+ }
538
+ },
539
+ "required": true
540
+ },
541
+ "responses": {
542
+ "200": {
543
+ "description": "Request ID",
544
+ "content": {
545
+ "application/json": {
546
+ "schema": {
547
+ "$ref": "#/components/schemas/RequestResponse"
548
+ }
549
+ }
550
+ }
551
+ },
552
+ "400": {
553
+ "description": "Error Response",
554
+ "content": {
555
+ "application/json": {
556
+ "schema": {
557
+ "$ref": "#/components/schemas/RestErrorResponse"
558
+ }
559
+ }
560
+ }
561
+ }
562
+ },
563
+ "x-codegen-request-body-name": "request"
564
+ }
565
+ },
566
+ "/devices/actions/customFields": {
567
+ "put": {
568
+ "tags": [
569
+ "devices"
570
+ ],
571
+ "summary": "Updates one or more custom field values for devices.",
572
+ "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.",
573
+ "operationId": "updateCustomFieldsUsingPUT",
574
+ "parameters": [
575
+ {
576
+ "name": "VZ-M2M-Token",
577
+ "in": "header",
578
+ "description": "VZ-M2M session token",
579
+ "required": true,
580
+ "schema": {
581
+ "type": "string"
582
+ }
583
+ }
584
+ ],
585
+ "requestBody": {
586
+ "description": "Change custom fields request",
587
+ "content": {
588
+ "application/json": {
589
+ "schema": {
590
+ "$ref": "#/components/schemas/CustomFieldsUpdateRequest"
591
+ }
592
+ }
593
+ },
594
+ "required": true
595
+ },
596
+ "responses": {
597
+ "200": {
598
+ "description": "Request ID",
599
+ "content": {
600
+ "application/json": {
601
+ "schema": {
602
+ "$ref": "#/components/schemas/RequestResponse"
603
+ }
604
+ }
605
+ }
606
+ },
607
+ "400": {
608
+ "description": "Error Response",
609
+ "content": {
610
+ "application/json": {
611
+ "schema": {
612
+ "$ref": "#/components/schemas/RestErrorResponse"
613
+ }
614
+ }
615
+ }
616
+ }
617
+ },
618
+ "x-codegen-request-body-name": "request"
619
+ }
620
+ },
621
+ "/devices/actions/deactivate": {
622
+ "post": {
623
+ "tags": [
624
+ "devices"
625
+ ],
626
+ "summary": "Deactivates service for one or more devices.",
627
+ "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.",
628
+ "operationId": "deactiveUsingPOST",
629
+ "parameters": [
630
+ {
631
+ "name": "VZ-M2M-Token",
632
+ "in": "header",
633
+ "description": "VZ-M2M session token",
634
+ "required": true,
635
+ "schema": {
636
+ "type": "string"
637
+ }
638
+ }
639
+ ],
640
+ "requestBody": {
641
+ "description": "Deactivate request",
642
+ "content": {
643
+ "application/json": {
644
+ "schema": {
645
+ "$ref": "#/components/schemas/CarrierDeactivateRequest"
646
+ }
647
+ }
648
+ },
649
+ "required": true
650
+ },
651
+ "responses": {
652
+ "200": {
653
+ "description": "Request ID",
654
+ "content": {
655
+ "application/json": {
656
+ "schema": {
657
+ "$ref": "#/components/schemas/RequestResponse"
658
+ }
659
+ }
660
+ }
661
+ },
662
+ "400": {
663
+ "description": "Error Response",
664
+ "content": {
665
+ "application/json": {
666
+ "schema": {
667
+ "$ref": "#/components/schemas/RestErrorResponse"
668
+ }
669
+ }
670
+ }
671
+ }
672
+ },
673
+ "x-codegen-request-body-name": "request"
674
+ }
675
+ },
676
+ "/devices/actions/delete": {
677
+ "post": {
678
+ "tags": [
679
+ "devices"
680
+ ],
681
+ "summary": "Deletes up to 200 deactive devices.",
682
+ "description": "Use this API to remove unneeded devices from an account",
683
+ "operationId": "deleteUsingPOST",
684
+ "parameters": [
685
+ {
686
+ "name": "VZ-M2M-Token",
687
+ "in": "header",
688
+ "description": "VZ-M2M session token",
689
+ "required": true,
690
+ "schema": {
691
+ "type": "string"
692
+ }
693
+ }
694
+ ],
695
+ "requestBody": {
696
+ "description": "Devices to delete",
697
+ "content": {
698
+ "application/json": {
699
+ "schema": {
700
+ "$ref": "#/components/schemas/DeleteDevicesRequest"
701
+ }
702
+ }
703
+ },
704
+ "required": true
705
+ },
706
+ "responses": {
707
+ "200": {
708
+ "description": "For each device in the request, contains device identifiers and a success or failure response.",
709
+ "content": {
710
+ "application/json": {
711
+ "schema": {
712
+ "type": "array",
713
+ "items": {
714
+ "$ref": "#/components/schemas/DeleteDevicesResponseMessage"
715
+ }
716
+ }
717
+ }
718
+ }
719
+ },
720
+ "400": {
721
+ "description": "Error Response",
722
+ "content": {
723
+ "application/json": {
724
+ "schema": {
725
+ "$ref": "#/components/schemas/RestErrorResponse"
726
+ }
727
+ }
728
+ }
729
+ }
730
+ },
731
+ "x-codegen-request-body-name": "request"
732
+ }
733
+ },
734
+ "/devices/actions/list": {
735
+ "post": {
736
+ "tags": [
737
+ "devices"
738
+ ],
739
+ "summary": "Returns information about a specified device or a list of devices in an account.",
740
+ "operationId": "listUsingPOST",
741
+ "parameters": [
742
+ {
743
+ "name": "VZ-M2M-Token",
744
+ "in": "header",
745
+ "description": "VZ-M2M session token",
746
+ "required": true,
747
+ "schema": {
748
+ "type": "string"
749
+ }
750
+ }
751
+ ],
752
+ "requestBody": {
753
+ "description": "Device Query",
754
+ "content": {
755
+ "application/json": {
756
+ "schema": {
757
+ "$ref": "#/components/schemas/DeviceListRequest"
758
+ }
759
+ }
760
+ },
761
+ "required": true
762
+ },
763
+ "responses": {
764
+ "200": {
765
+ "description": "List of devices that match the request parameters, ordered by device creation date, oldest first.",
766
+ "content": {
767
+ "application/json": {
768
+ "schema": {
769
+ "$ref": "#/components/schemas/DeviceListResponse"
770
+ }
771
+ }
772
+ }
773
+ },
774
+ "202": {
775
+ "description": "List of devices that match the request parameters, ordered by device creation date, oldest first. Additional devices remain.",
776
+ "content": {
777
+ "application/json": {
778
+ "schema": {
779
+ "$ref": "#/components/schemas/DeviceListResponse"
780
+ }
781
+ }
782
+ }
783
+ },
784
+ "400": {
785
+ "description": "Error Response",
786
+ "content": {
787
+ "application/json": {
788
+ "schema": {
789
+ "$ref": "#/components/schemas/RestErrorResponse"
790
+ }
791
+ }
792
+ }
793
+ }
794
+ },
795
+ "x-codegen-request-body-name": "request"
796
+ }
797
+ },
798
+ "/devices/actions/list/imeiiccidmismatch": {
799
+ "post": {
800
+ "tags": [
801
+ "devices"
802
+ ],
803
+ "summary": "Returns a list of all 4G devices with an ICCID that was not activated with the expected IMEI.",
804
+ "operationId": "imeiIccidMismatchListUsingPOST",
805
+ "parameters": [
806
+ {
807
+ "name": "VZ-M2M-Token",
808
+ "in": "header",
809
+ "description": "VZ-M2M session token",
810
+ "required": true,
811
+ "schema": {
812
+ "type": "string"
813
+ }
814
+ }
815
+ ],
816
+ "requestBody": {
817
+ "description": "Device Query",
818
+ "content": {
819
+ "application/json": {
820
+ "schema": {
821
+ "$ref": "#/components/schemas/DeviceMismatchListRequest"
822
+ }
823
+ }
824
+ },
825
+ "required": true
826
+ },
827
+ "responses": {
828
+ "200": {
829
+ "description": "List of devices that have mismatched IMEIs and ICCIDs.",
830
+ "content": {
831
+ "application/json": {
832
+ "schema": {
833
+ "$ref": "#/components/schemas/DeviceMismatchListResponse"
834
+ }
835
+ }
836
+ }
837
+ },
838
+ "400": {
839
+ "description": "Error Response",
840
+ "content": {
841
+ "application/json": {
842
+ "schema": {
843
+ "$ref": "#/components/schemas/RestErrorResponse"
844
+ }
845
+ }
846
+ }
847
+ }
848
+ },
849
+ "x-codegen-request-body-name": "request"
850
+ }
851
+ },
852
+ "/devices/actions/move": {
853
+ "put": {
854
+ "tags": [
855
+ "devices"
856
+ ],
857
+ "summary": "Move devices between accounts.",
858
+ "description": "Move active devices from one billing account to another within a customer profile.",
859
+ "operationId": "moveUsingPut",
860
+ "parameters": [
861
+ {
862
+ "name": "VZ-M2M-Token",
863
+ "in": "header",
864
+ "description": "VZ-M2M session token",
865
+ "required": true,
866
+ "schema": {
867
+ "type": "string"
868
+ }
869
+ }
870
+ ],
871
+ "requestBody": {
872
+ "description": "Move request",
873
+ "content": {
874
+ "application/json": {
875
+ "schema": {
876
+ "$ref": "#/components/schemas/MoveDeviceRequest"
877
+ }
878
+ }
879
+ },
880
+ "required": true
881
+ },
882
+ "responses": {
883
+ "200": {
884
+ "description": "Request ID",
885
+ "content": {
886
+ "application/json": {
887
+ "schema": {
888
+ "$ref": "#/components/schemas/RequestResponse"
889
+ }
890
+ }
891
+ }
892
+ },
893
+ "400": {
894
+ "description": "Error Response",
895
+ "content": {
896
+ "application/json": {
897
+ "schema": {
898
+ "$ref": "#/components/schemas/RestErrorResponse"
899
+ }
900
+ }
901
+ }
902
+ }
903
+ },
904
+ "x-codegen-request-body-name": "request"
905
+ }
906
+ },
907
+ "/devices/actions/gotostate": {
908
+ "put": {
909
+ "tags": [
910
+ "devices"
911
+ ],
912
+ "summary": "Move devices to a new customer-defined state",
913
+ "description": "Changes the provisioning state of one or more devices to a specified customer-defined service and state.",
914
+ "operationId": "gotostateUsingPut",
915
+ "parameters": [
916
+ {
917
+ "name": "VZ-M2M-Token",
918
+ "in": "header",
919
+ "description": "VZ-M2M session token",
920
+ "required": true,
921
+ "schema": {
922
+ "type": "string"
923
+ }
924
+ }
925
+ ],
926
+ "requestBody": {
927
+ "description": "Move state request",
928
+ "content": {
929
+ "application/json": {
930
+ "schema": {
931
+ "$ref": "#/components/schemas/GoToStateRequest"
932
+ }
933
+ }
934
+ },
935
+ "required": true
936
+ },
937
+ "responses": {
938
+ "200": {
939
+ "description": "Request ID",
940
+ "content": {
941
+ "application/json": {
942
+ "schema": {
943
+ "$ref": "#/components/schemas/RequestResponse"
944
+ }
945
+ }
946
+ }
947
+ },
948
+ "400": {
949
+ "description": "Error Response",
950
+ "content": {
951
+ "application/json": {
952
+ "schema": {
953
+ "$ref": "#/components/schemas/RestErrorResponse"
954
+ }
955
+ }
956
+ }
957
+ }
958
+ },
959
+ "x-codegen-request-body-name": "request"
960
+ }
961
+ },
962
+ "/devices/actions/plan": {
963
+ "put": {
964
+ "tags": [
965
+ "devices"
966
+ ],
967
+ "summary": "Sets a new service plan for one or more devices.",
968
+ "operationId": "updateServicePlanUsingPUT",
969
+ "parameters": [
970
+ {
971
+ "name": "VZ-M2M-Token",
972
+ "in": "header",
973
+ "description": "VZ-M2M session token",
974
+ "required": true,
975
+ "schema": {
976
+ "type": "string"
977
+ }
978
+ }
979
+ ],
980
+ "requestBody": {
981
+ "description": "Change service plan request",
982
+ "content": {
983
+ "application/json": {
984
+ "schema": {
985
+ "$ref": "#/components/schemas/ServicePlanUpdateRequest"
986
+ }
987
+ }
988
+ },
989
+ "required": true
990
+ },
991
+ "responses": {
992
+ "200": {
993
+ "description": "Request ID",
994
+ "content": {
995
+ "application/json": {
996
+ "schema": {
997
+ "$ref": "#/components/schemas/RequestResponse"
998
+ }
999
+ }
1000
+ }
1001
+ },
1002
+ "400": {
1003
+ "description": "Error Response",
1004
+ "content": {
1005
+ "application/json": {
1006
+ "schema": {
1007
+ "$ref": "#/components/schemas/RestErrorResponse"
1008
+ }
1009
+ }
1010
+ }
1011
+ }
1012
+ },
1013
+ "x-codegen-request-body-name": "request"
1014
+ }
1015
+ },
1016
+ "/devices/actions/suspend": {
1017
+ "post": {
1018
+ "tags": [
1019
+ "devices"
1020
+ ],
1021
+ "summary": "Suspends service for one or more devices. ",
1022
+ "operationId": "suspendUsingPOST",
1023
+ "parameters": [
1024
+ {
1025
+ "name": "VZ-M2M-Token",
1026
+ "in": "header",
1027
+ "description": "VZ-M2M session token",
1028
+ "required": true,
1029
+ "schema": {
1030
+ "type": "string"
1031
+ }
1032
+ }
1033
+ ],
1034
+ "requestBody": {
1035
+ "description": "Suspend request",
1036
+ "content": {
1037
+ "application/json": {
1038
+ "schema": {
1039
+ "$ref": "#/components/schemas/CarrierActionsRequest"
1040
+ }
1041
+ }
1042
+ },
1043
+ "required": true
1044
+ },
1045
+ "responses": {
1046
+ "200": {
1047
+ "description": "Request ID",
1048
+ "content": {
1049
+ "application/json": {
1050
+ "schema": {
1051
+ "$ref": "#/components/schemas/RequestResponse"
1052
+ }
1053
+ }
1054
+ }
1055
+ },
1056
+ "400": {
1057
+ "description": "Error Response",
1058
+ "content": {
1059
+ "application/json": {
1060
+ "schema": {
1061
+ "$ref": "#/components/schemas/RestErrorResponse"
1062
+ }
1063
+ }
1064
+ }
1065
+ }
1066
+ },
1067
+ "x-codegen-request-body-name": "request"
1068
+ }
1069
+ },
1070
+ "/devices/actions/restore": {
1071
+ "post": {
1072
+ "tags": [
1073
+ "devices"
1074
+ ],
1075
+ "summary": "Restore service to one or more suspended devices. ",
1076
+ "operationId": "restoreUsingPOST",
1077
+ "parameters": [
1078
+ {
1079
+ "name": "VZ-M2M-Token",
1080
+ "in": "header",
1081
+ "description": "VZ-M2M session token",
1082
+ "required": true,
1083
+ "schema": {
1084
+ "type": "string"
1085
+ }
1086
+ }
1087
+ ],
1088
+ "requestBody": {
1089
+ "description": "Restore request",
1090
+ "content": {
1091
+ "application/json": {
1092
+ "schema": {
1093
+ "$ref": "#/components/schemas/CarrierActionsRequest"
1094
+ }
1095
+ }
1096
+ },
1097
+ "required": true
1098
+ },
1099
+ "responses": {
1100
+ "200": {
1101
+ "description": "Request ID",
1102
+ "content": {
1103
+ "application/json": {
1104
+ "schema": {
1105
+ "$ref": "#/components/schemas/RequestResponse"
1106
+ }
1107
+ }
1108
+ }
1109
+ },
1110
+ "400": {
1111
+ "description": "Error Response",
1112
+ "content": {
1113
+ "application/json": {
1114
+ "schema": {
1115
+ "$ref": "#/components/schemas/RestErrorResponse"
1116
+ }
1117
+ }
1118
+ }
1119
+ }
1120
+ },
1121
+ "x-codegen-request-body-name": "request"
1122
+ }
1123
+ },
1124
+ "/devices/availability/actions/list": {
1125
+ "post": {
1126
+ "tags": [
1127
+ "devices"
1128
+ ],
1129
+ "summary": "Checks whether devices are available to be activated.",
1130
+ "description": "Checks whether specified devices are registered by the manufacturer with the Verizon network and are available to be activated.",
1131
+ "operationId": "deviceAvailabilityListUsingPOST",
1132
+ "parameters": [
1133
+ {
1134
+ "name": "VZ-M2M-Token",
1135
+ "in": "header",
1136
+ "description": "VZ-M2M session token",
1137
+ "required": true,
1138
+ "schema": {
1139
+ "type": "string"
1140
+ }
1141
+ }
1142
+ ],
1143
+ "requestBody": {
1144
+ "description": "Device Query",
1145
+ "content": {
1146
+ "application/json": {
1147
+ "schema": {
1148
+ "$ref": "#/components/schemas/DeviceRequest"
1149
+ }
1150
+ }
1151
+ },
1152
+ "required": true
1153
+ },
1154
+ "responses": {
1155
+ "200": {
1156
+ "description": "Request ID",
1157
+ "content": {
1158
+ "application/json": {
1159
+ "schema": {
1160
+ "$ref": "#/components/schemas/RequestResponse"
1161
+ }
1162
+ }
1163
+ }
1164
+ },
1165
+ "400": {
1166
+ "description": "Error Response",
1167
+ "content": {
1168
+ "application/json": {
1169
+ "schema": {
1170
+ "$ref": "#/components/schemas/RestErrorResponse"
1171
+ }
1172
+ }
1173
+ }
1174
+ }
1175
+ },
1176
+ "x-codegen-request-body-name": "request"
1177
+ }
1178
+ },
1179
+ "/devices/connections/actions/listHistory": {
1180
+ "post": {
1181
+ "tags": [
1182
+ "devices"
1183
+ ],
1184
+ "summary": "Returns a list of network connection events for a device during a specified time period.",
1185
+ "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.",
1186
+ "operationId": "connectionListHistoryUsingPOST",
1187
+ "parameters": [
1188
+ {
1189
+ "name": "VZ-M2M-Token",
1190
+ "in": "header",
1191
+ "description": "VZ-M2M session token",
1192
+ "required": true,
1193
+ "schema": {
1194
+ "type": "string"
1195
+ }
1196
+ }
1197
+ ],
1198
+ "requestBody": {
1199
+ "description": "Device connection query",
1200
+ "content": {
1201
+ "application/json": {
1202
+ "schema": {
1203
+ "$ref": "#/components/schemas/DeviceConnectionListRequest"
1204
+ }
1205
+ }
1206
+ },
1207
+ "required": true
1208
+ },
1209
+ "responses": {
1210
+ "200": {
1211
+ "description": "List of device connection events, sorted by the occurredAt timestamp, oldest first.",
1212
+ "content": {
1213
+ "application/json": {
1214
+ "schema": {
1215
+ "type": "array",
1216
+ "items": {
1217
+ "$ref": "#/components/schemas/ConnectionHistoryResponse"
1218
+ }
1219
+ }
1220
+ }
1221
+ }
1222
+ },
1223
+ "202": {
1224
+ "description": "List of device connection events, sorted by the occurredAt timestamp, oldest first. Additional events remain.",
1225
+ "content": {
1226
+ "application/json": {
1227
+ "schema": {
1228
+ "type": "array",
1229
+ "items": {
1230
+ "$ref": "#/components/schemas/ConnectionHistoryResponse"
1231
+ }
1232
+ }
1233
+ }
1234
+ }
1235
+ },
1236
+ "400": {
1237
+ "description": "Error Response",
1238
+ "content": {
1239
+ "application/json": {
1240
+ "schema": {
1241
+ "$ref": "#/components/schemas/RestErrorResponse"
1242
+ }
1243
+ }
1244
+ }
1245
+ }
1246
+ },
1247
+ "x-codegen-request-body-name": "request"
1248
+ }
1249
+ },
1250
+ "/devices/costCenter": {
1251
+ "put": {
1252
+ "tags": [
1253
+ "devices"
1254
+ ],
1255
+ "summary": "Changes or removes the costCenterCode value for one or more devices.",
1256
+ "operationId": "changeCostCenterUsingPUT",
1257
+ "parameters": [
1258
+ {
1259
+ "name": "VZ-M2M-Token",
1260
+ "in": "header",
1261
+ "description": "VZ-M2M session token",
1262
+ "required": true,
1263
+ "schema": {
1264
+ "type": "string"
1265
+ }
1266
+ }
1267
+ ],
1268
+ "requestBody": {
1269
+ "description": "Change cost center request",
1270
+ "content": {
1271
+ "application/json": {
1272
+ "schema": {
1273
+ "$ref": "#/components/schemas/DeviceCostCenterRequest"
1274
+ }
1275
+ }
1276
+ },
1277
+ "required": true
1278
+ },
1279
+ "responses": {
1280
+ "200": {
1281
+ "description": "Request ID",
1282
+ "content": {
1283
+ "application/json": {
1284
+ "schema": {
1285
+ "$ref": "#/components/schemas/RequestResponse"
1286
+ }
1287
+ }
1288
+ }
1289
+ },
1290
+ "400": {
1291
+ "description": "Error Response",
1292
+ "content": {
1293
+ "application/json": {
1294
+ "schema": {
1295
+ "$ref": "#/components/schemas/RestErrorResponse"
1296
+ }
1297
+ }
1298
+ }
1299
+ }
1300
+ },
1301
+ "x-codegen-request-body-name": "request"
1302
+ }
1303
+ },
1304
+ "/devices/extendeddiagnostics/actions/list": {
1305
+ "post": {
1306
+ "tags": [
1307
+ "devices"
1308
+ ],
1309
+ "summary": "Returns basic diagnostic information about a specified device, including connectivity, provisioning, and billing status.",
1310
+ "operationId": "getExtendedDiagsUsingPOST",
1311
+ "parameters": [
1312
+ {
1313
+ "name": "VZ-M2M-Token",
1314
+ "in": "header",
1315
+ "description": "M2M-MC Session Token",
1316
+ "required": true,
1317
+ "schema": {
1318
+ "type": "string"
1319
+ }
1320
+ }
1321
+ ],
1322
+ "requestBody": {
1323
+ "description": "Device Query",
1324
+ "content": {
1325
+ "application/json": {
1326
+ "schema": {
1327
+ "$ref": "#/components/schemas/DeviceExtendedDiagnosticsRequest"
1328
+ }
1329
+ }
1330
+ },
1331
+ "required": true
1332
+ },
1333
+ "responses": {
1334
+ "200": {
1335
+ "description": "Device diagnostic information",
1336
+ "content": {
1337
+ "application/json": {
1338
+ "schema": {
1339
+ "$ref": "#/components/schemas/DeviceExtendedDiagnosticsResponse"
1340
+ }
1341
+ }
1342
+ }
1343
+ },
1344
+ "400": {
1345
+ "description": "Error Response",
1346
+ "content": {
1347
+ "application/json": {
1348
+ "schema": {
1349
+ "$ref": "#/components/schemas/RestErrorResponse"
1350
+ }
1351
+ }
1352
+ }
1353
+ }
1354
+ },
1355
+ "x-codegen-request-body-name": "request"
1356
+ }
1357
+ },
1358
+ "/devices/history/actions/list": {
1359
+ "post": {
1360
+ "tags": [
1361
+ "devices"
1362
+ ],
1363
+ "summary": "Returns the provisioning history of a device during a specified time period.",
1364
+ "operationId": "provisioningHistoryListUsingPOST",
1365
+ "parameters": [
1366
+ {
1367
+ "name": "VZ-M2M-Token",
1368
+ "in": "header",
1369
+ "description": "VZ-M2M session token",
1370
+ "required": true,
1371
+ "schema": {
1372
+ "type": "string"
1373
+ }
1374
+ }
1375
+ ],
1376
+ "requestBody": {
1377
+ "description": "Device provisioning history query",
1378
+ "content": {
1379
+ "application/json": {
1380
+ "schema": {
1381
+ "$ref": "#/components/schemas/DeviceProvisioningHistoryListRequest"
1382
+ }
1383
+ }
1384
+ },
1385
+ "required": true
1386
+ },
1387
+ "responses": {
1388
+ "200": {
1389
+ "description": "List of Device Provision History events, sorted by the timestamp, oldest first.",
1390
+ "content": {
1391
+ "application/json": {
1392
+ "schema": {
1393
+ "type": "array",
1394
+ "items": {
1395
+ "$ref": "#/components/schemas/DeviceProvisioningHistoryListResponse"
1396
+ }
1397
+ }
1398
+ }
1399
+ }
1400
+ },
1401
+ "202": {
1402
+ "description": "List of Device Provision History events, sorted by the timestamp, oldest first. Additional events remain.",
1403
+ "content": {
1404
+ "application/json": {
1405
+ "schema": {
1406
+ "type": "array",
1407
+ "items": {
1408
+ "$ref": "#/components/schemas/DeviceProvisioningHistoryListResponse"
1409
+ }
1410
+ }
1411
+ }
1412
+ }
1413
+ },
1414
+ "400": {
1415
+ "description": "Error Response",
1416
+ "content": {
1417
+ "application/json": {
1418
+ "schema": {
1419
+ "$ref": "#/components/schemas/RestErrorResponse"
1420
+ }
1421
+ }
1422
+ }
1423
+ }
1424
+ },
1425
+ "x-codegen-request-body-name": "request"
1426
+ }
1427
+ },
1428
+ "/devices/prl/actions/list": {
1429
+ "post": {
1430
+ "tags": [
1431
+ "devices"
1432
+ ],
1433
+ "summary": "Requests the current PRL version for devices, which can help determine which devices need a PRL update.",
1434
+ "description": "4G and GSM devices do not have a PRL.",
1435
+ "operationId": "prlListUsingPOST",
1436
+ "parameters": [
1437
+ {
1438
+ "name": "VZ-M2M-Token",
1439
+ "in": "header",
1440
+ "description": "VZ-M2M session token",
1441
+ "required": true,
1442
+ "schema": {
1443
+ "type": "string"
1444
+ }
1445
+ }
1446
+ ],
1447
+ "requestBody": {
1448
+ "description": "Device PRL query",
1449
+ "content": {
1450
+ "application/json": {
1451
+ "schema": {
1452
+ "$ref": "#/components/schemas/DevicePrlListRequest"
1453
+ }
1454
+ }
1455
+ },
1456
+ "required": true
1457
+ },
1458
+ "responses": {
1459
+ "200": {
1460
+ "description": "Request ID",
1461
+ "content": {
1462
+ "application/json": {
1463
+ "schema": {
1464
+ "$ref": "#/components/schemas/RequestResponse"
1465
+ }
1466
+ }
1467
+ }
1468
+ },
1469
+ "400": {
1470
+ "description": "Error Response",
1471
+ "content": {
1472
+ "application/json": {
1473
+ "schema": {
1474
+ "$ref": "#/components/schemas/RestErrorResponse"
1475
+ }
1476
+ }
1477
+ }
1478
+ }
1479
+ },
1480
+ "x-codegen-request-body-name": "request"
1481
+ }
1482
+ },
1483
+ "/devices/suspension/status": {
1484
+ "post": {
1485
+ "tags": [
1486
+ "devices"
1487
+ ],
1488
+ "summary": "Request service suspension information about devices.",
1489
+ "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.",
1490
+ "operationId": "getDeviceSuspensionStatusUsingPOST",
1491
+ "parameters": [
1492
+ {
1493
+ "name": "VZ-M2M-Token",
1494
+ "in": "header",
1495
+ "description": "VZ-M2M session token",
1496
+ "required": true,
1497
+ "schema": {
1498
+ "type": "string"
1499
+ }
1500
+ }
1501
+ ],
1502
+ "requestBody": {
1503
+ "description": "Device query",
1504
+ "content": {
1505
+ "application/json": {
1506
+ "schema": {
1507
+ "$ref": "#/components/schemas/DeviceSuspensionStatusRequest"
1508
+ }
1509
+ }
1510
+ },
1511
+ "required": true
1512
+ },
1513
+ "responses": {
1514
+ "200": {
1515
+ "description": "Request ID",
1516
+ "content": {
1517
+ "application/json": {
1518
+ "schema": {
1519
+ "$ref": "#/components/schemas/RequestResponse"
1520
+ }
1521
+ }
1522
+ }
1523
+ },
1524
+ "400": {
1525
+ "description": "Error Response",
1526
+ "content": {
1527
+ "application/json": {
1528
+ "schema": {
1529
+ "$ref": "#/components/schemas/RestErrorResponse"
1530
+ }
1531
+ }
1532
+ }
1533
+ }
1534
+ },
1535
+ "x-codegen-request-body-name": "request"
1536
+ }
1537
+ },
1538
+ "/devices/usage/actions/list": {
1539
+ "post": {
1540
+ "tags": [
1541
+ "devices"
1542
+ ],
1543
+ "summary": "Obtain the usage history of a specific device.",
1544
+ "description": "Returns the network data usage history of a device during a specified time period.",
1545
+ "operationId": "usageListUsingPOST",
1546
+ "parameters": [
1547
+ {
1548
+ "name": "VZ-M2M-Token",
1549
+ "in": "header",
1550
+ "description": "VZ-M2M session token",
1551
+ "required": true,
1552
+ "schema": {
1553
+ "type": "string"
1554
+ }
1555
+ }
1556
+ ],
1557
+ "requestBody": {
1558
+ "description": "Device usage query",
1559
+ "content": {
1560
+ "application/json": {
1561
+ "schema": {
1562
+ "$ref": "#/components/schemas/DeviceUsageListRequest"
1563
+ }
1564
+ }
1565
+ },
1566
+ "required": true
1567
+ },
1568
+ "responses": {
1569
+ "200": {
1570
+ "description": "List of device usage events, sorted by the timestamp, oldest first.",
1571
+ "content": {
1572
+ "application/json": {
1573
+ "schema": {
1574
+ "type": "array",
1575
+ "items": {
1576
+ "$ref": "#/components/schemas/DeviceUsageListResponse"
1577
+ }
1578
+ }
1579
+ }
1580
+ }
1581
+ },
1582
+ "202": {
1583
+ "description": "List of device usage events, sorted by the timestamp, oldest first. Additional events remain.",
1584
+ "content": {
1585
+ "application/json": {
1586
+ "schema": {
1587
+ "type": "array",
1588
+ "items": {
1589
+ "$ref": "#/components/schemas/DeviceUsageListResponse"
1590
+ }
1591
+ }
1592
+ }
1593
+ }
1594
+ },
1595
+ "400": {
1596
+ "description": "Error Response",
1597
+ "content": {
1598
+ "application/json": {
1599
+ "schema": {
1600
+ "$ref": "#/components/schemas/RestErrorResponse"
1601
+ }
1602
+ }
1603
+ }
1604
+ }
1605
+ },
1606
+ "x-codegen-request-body-name": "request"
1607
+ }
1608
+ },
1609
+ "/devices/usage/actions/list/aggregate": {
1610
+ "post": {
1611
+ "tags": [
1612
+ "devices"
1613
+ ],
1614
+ "summary": "Returns the total amount of data sent and the total number of SMS messages sent or received by a set of devices in a specified timeframe.",
1615
+ "description": "The information is returned in a callback response, so you must register a URL for DeviceUsage callback messages using the POST /callbacks API.",
1616
+ "operationId": "aggregateUsingPOST",
1617
+ "parameters": [
1618
+ {
1619
+ "name": "VZ-M2M-Token",
1620
+ "in": "header",
1621
+ "description": "VZ-M2M session token",
1622
+ "required": true,
1623
+ "schema": {
1624
+ "type": "string"
1625
+ }
1626
+ }
1627
+ ],
1628
+ "requestBody": {
1629
+ "description": "Aggregated usage request",
1630
+ "content": {
1631
+ "application/json": {
1632
+ "schema": {
1633
+ "$ref": "#/components/schemas/DeviceAggregateUsageListRequest"
1634
+ }
1635
+ }
1636
+ },
1637
+ "required": true
1638
+ },
1639
+ "responses": {
1640
+ "200": {
1641
+ "description": "A unique string that associates the request with the results that are sent via a callback service.",
1642
+ "content": {
1643
+ "application/json": {
1644
+ "schema": {
1645
+ "$ref": "#/components/schemas/RequestResponse"
1646
+ }
1647
+ }
1648
+ }
1649
+ },
1650
+ "400": {
1651
+ "description": "Error Response",
1652
+ "content": {
1653
+ "application/json": {
1654
+ "schema": {
1655
+ "$ref": "#/components/schemas/RestErrorResponse"
1656
+ }
1657
+ }
1658
+ }
1659
+ }
1660
+ },
1661
+ "x-codegen-request-body-name": "request"
1662
+ }
1663
+ },
1664
+ "/devices/{serviceType}/actions/deviceId": {
1665
+ "put": {
1666
+ "tags": [
1667
+ "devices"
1668
+ ],
1669
+ "summary": "Changes the identifier of a 3G or 4G device to match hardware changes made for a line of service.",
1670
+ "operationId": "changeDeviceIdUsingPUT",
1671
+ "parameters": [
1672
+ {
1673
+ "name": "serviceType",
1674
+ "in": "path",
1675
+ "description": "Identifier type",
1676
+ "required": true,
1677
+ "schema": {
1678
+ "type": "string"
1679
+ }
1680
+ },
1681
+ {
1682
+ "name": "VZ-M2M-Token",
1683
+ "in": "header",
1684
+ "description": "VZ-M2M session token",
1685
+ "required": true,
1686
+ "schema": {
1687
+ "type": "string"
1688
+ }
1689
+ }
1690
+ ],
1691
+ "requestBody": {
1692
+ "description": "Device query",
1693
+ "content": {
1694
+ "application/json": {
1695
+ "schema": {
1696
+ "$ref": "#/components/schemas/ChangeDeviceIdRequest"
1697
+ }
1698
+ }
1699
+ },
1700
+ "required": true
1701
+ },
1702
+ "responses": {
1703
+ "200": {
1704
+ "description": "A unique string that associates the request with the results that are sent via a callback service.",
1705
+ "content": {
1706
+ "application/json": {
1707
+ "schema": {
1708
+ "$ref": "#/components/schemas/RequestResponse"
1709
+ }
1710
+ }
1711
+ }
1712
+ },
1713
+ "400": {
1714
+ "description": "Error Response",
1715
+ "content": {
1716
+ "application/json": {
1717
+ "schema": {
1718
+ "$ref": "#/components/schemas/RestErrorResponse"
1719
+ }
1720
+ }
1721
+ }
1722
+ }
1723
+ },
1724
+ "x-codegen-request-body-name": "request"
1725
+ }
1726
+ },
1727
+ "/groups": {
1728
+ "post": {
1729
+ "tags": [
1730
+ "groups"
1731
+ ],
1732
+ "summary": "Creates a new device group and optionally adds a set of devices to that group.",
1733
+ "operationId": "createDeviceGroupUsingPOST",
1734
+ "parameters": [
1735
+ {
1736
+ "name": "VZ-M2M-Token",
1737
+ "in": "header",
1738
+ "description": "VZ-M2M session token",
1739
+ "required": true,
1740
+ "schema": {
1741
+ "type": "string"
1742
+ }
1743
+ }
1744
+ ],
1745
+ "requestBody": {
1746
+ "description": "Request",
1747
+ "content": {
1748
+ "application/json": {
1749
+ "schema": {
1750
+ "$ref": "#/components/schemas/CreateDevGroupRequest"
1751
+ }
1752
+ }
1753
+ },
1754
+ "required": true
1755
+ },
1756
+ "responses": {
1757
+ "200": {
1758
+ "description": "Request Success Message",
1759
+ "content": {
1760
+ "application/json": {
1761
+ "schema": {
1762
+ "$ref": "#/components/schemas/RestSuccessResponse"
1763
+ }
1764
+ }
1765
+ }
1766
+ },
1767
+ "400": {
1768
+ "description": "Error Response",
1769
+ "content": {
1770
+ "application/json": {
1771
+ "schema": {
1772
+ "$ref": "#/components/schemas/RestErrorResponse"
1773
+ }
1774
+ }
1775
+ }
1776
+ }
1777
+ },
1778
+ "x-codegen-request-body-name": "request"
1779
+ }
1780
+ },
1781
+ "/groups/{aname}": {
1782
+ "get": {
1783
+ "tags": [
1784
+ "groups"
1785
+ ],
1786
+ "summary": "Returns a list of device groups in an account",
1787
+ "operationId": "getListUsingGET",
1788
+ "parameters": [
1789
+ {
1790
+ "name": "VZ-M2M-Token",
1791
+ "in": "header",
1792
+ "description": "VZ-M2M session token",
1793
+ "required": true,
1794
+ "schema": {
1795
+ "type": "string"
1796
+ }
1797
+ },
1798
+ {
1799
+ "name": "aname",
1800
+ "in": "path",
1801
+ "description": "Account name",
1802
+ "required": true,
1803
+ "schema": {
1804
+ "type": "string"
1805
+ }
1806
+ }
1807
+ ],
1808
+ "responses": {
1809
+ "200": {
1810
+ "description": "The list of device groups in the account.",
1811
+ "content": {
1812
+ "application/json": {
1813
+ "schema": {
1814
+ "type": "array",
1815
+ "items": {
1816
+ "$ref": "#/components/schemas/GroupResponse"
1817
+ }
1818
+ }
1819
+ }
1820
+ }
1821
+ },
1822
+ "400": {
1823
+ "description": "Error Response",
1824
+ "content": {
1825
+ "application/json": {
1826
+ "schema": {
1827
+ "$ref": "#/components/schemas/RestErrorResponse"
1828
+ }
1829
+ }
1830
+ }
1831
+ }
1832
+ }
1833
+ }
1834
+ },
1835
+ "/groups/{aname}/name/{gname}": {
1836
+ "get": {
1837
+ "tags": [
1838
+ "groups"
1839
+ ],
1840
+ "summary": "Returns the name, description, and list of devices in a device group.",
1841
+ "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.",
1842
+ "operationId": "getDeviceGroupInfoUsingGET",
1843
+ "parameters": [
1844
+ {
1845
+ "name": "aname",
1846
+ "in": "path",
1847
+ "description": "Account name",
1848
+ "required": true,
1849
+ "schema": {
1850
+ "type": "string"
1851
+ }
1852
+ },
1853
+ {
1854
+ "name": "gname",
1855
+ "in": "path",
1856
+ "description": "Group name",
1857
+ "required": true,
1858
+ "schema": {
1859
+ "type": "string"
1860
+ }
1861
+ },
1862
+ {
1863
+ "name": "next",
1864
+ "in": "query",
1865
+ "description": "Continue the previous query from the pageUrl pagetoken",
1866
+ "schema": {
1867
+ "type": "integer",
1868
+ "format": "int64"
1869
+ }
1870
+ },
1871
+ {
1872
+ "name": "VZ-M2M-Token",
1873
+ "in": "header",
1874
+ "description": "VZ-M2M session token",
1875
+ "required": true,
1876
+ "schema": {
1877
+ "type": "string"
1878
+ }
1879
+ }
1880
+ ],
1881
+ "responses": {
1882
+ "200": {
1883
+ "description": "Successful response",
1884
+ "content": {
1885
+ "application/json": {
1886
+ "schema": {
1887
+ "$ref": "#/components/schemas/GroupListResponse"
1888
+ }
1889
+ }
1890
+ }
1891
+ },
1892
+ "202": {
1893
+ "description": "Successful response, additional groups remain",
1894
+ "content": {
1895
+ "application/json": {
1896
+ "schema": {
1897
+ "$ref": "#/components/schemas/GroupListResponse"
1898
+ }
1899
+ }
1900
+ }
1901
+ },
1902
+ "400": {
1903
+ "description": "Error Response",
1904
+ "content": {
1905
+ "application/json": {
1906
+ "schema": {
1907
+ "$ref": "#/components/schemas/RestErrorResponse"
1908
+ }
1909
+ }
1910
+ }
1911
+ }
1912
+ }
1913
+ },
1914
+ "put": {
1915
+ "tags": [
1916
+ "groups"
1917
+ ],
1918
+ "summary": "Make changes to a device group, including changing the name and description, and adding or removing devices.",
1919
+ "operationId": "updateDeviceGroupUsingPUT",
1920
+ "parameters": [
1921
+ {
1922
+ "name": "aname",
1923
+ "in": "path",
1924
+ "description": "Account name",
1925
+ "required": true,
1926
+ "schema": {
1927
+ "type": "string"
1928
+ }
1929
+ },
1930
+ {
1931
+ "name": "gname",
1932
+ "in": "path",
1933
+ "description": "Group name",
1934
+ "required": true,
1935
+ "schema": {
1936
+ "type": "string"
1937
+ }
1938
+ },
1939
+ {
1940
+ "name": "VZ-M2M-Token",
1941
+ "in": "header",
1942
+ "description": "VZ-M2M session token",
1943
+ "required": true,
1944
+ "schema": {
1945
+ "type": "string"
1946
+ }
1947
+ }
1948
+ ],
1949
+ "requestBody": {
1950
+ "description": "Request",
1951
+ "content": {
1952
+ "application/json": {
1953
+ "schema": {
1954
+ "$ref": "#/components/schemas/GroupUpdateRequest"
1955
+ }
1956
+ }
1957
+ },
1958
+ "required": true
1959
+ },
1960
+ "responses": {
1961
+ "200": {
1962
+ "description": "Request Success Message",
1963
+ "content": {
1964
+ "application/json": {
1965
+ "schema": {
1966
+ "$ref": "#/components/schemas/RestSuccessResponse"
1967
+ }
1968
+ }
1969
+ }
1970
+ },
1971
+ "400": {
1972
+ "description": "Error Response",
1973
+ "content": {
1974
+ "application/json": {
1975
+ "schema": {
1976
+ "$ref": "#/components/schemas/RestErrorResponse"
1977
+ }
1978
+ }
1979
+ }
1980
+ }
1981
+ },
1982
+ "x-codegen-request-body-name": "request"
1983
+ },
1984
+ "delete": {
1985
+ "tags": [
1986
+ "groups"
1987
+ ],
1988
+ "summary": "Deletes a device group. Devices in the group are moved to the default device group and are not deleted from the account.",
1989
+ "operationId": "deleteDeviceGroupUsingDELETE",
1990
+ "parameters": [
1991
+ {
1992
+ "name": "VZ-M2M-Token",
1993
+ "in": "header",
1994
+ "description": "VZ-M2M session token",
1995
+ "required": true,
1996
+ "schema": {
1997
+ "type": "string"
1998
+ }
1999
+ },
2000
+ {
2001
+ "name": "aname",
2002
+ "in": "path",
2003
+ "description": "Account name",
2004
+ "required": true,
2005
+ "schema": {
2006
+ "type": "string"
2007
+ }
2008
+ },
2009
+ {
2010
+ "name": "gname",
2011
+ "in": "path",
2012
+ "description": "Group name",
2013
+ "required": true,
2014
+ "schema": {
2015
+ "type": "string"
2016
+ }
2017
+ }
2018
+ ],
2019
+ "responses": {
2020
+ "200": {
2021
+ "description": "Request Success Message",
2022
+ "content": {
2023
+ "application/json": {
2024
+ "schema": {
2025
+ "$ref": "#/components/schemas/RestSuccessResponse"
2026
+ }
2027
+ }
2028
+ }
2029
+ },
2030
+ "400": {
2031
+ "description": "Error Response",
2032
+ "content": {
2033
+ "application/json": {
2034
+ "schema": {
2035
+ "$ref": "#/components/schemas/RestErrorResponse"
2036
+ }
2037
+ }
2038
+ }
2039
+ }
2040
+ }
2041
+ }
2042
+ },
2043
+ "/leads/{aname}": {
2044
+ "get": {
2045
+ "tags": [
2046
+ "accounts"
2047
+ ],
2048
+ "summary": "Returns information for all leads associated with the account",
2049
+ "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.",
2050
+ "operationId": "getListUsingGET_1",
2051
+ "parameters": [
2052
+ {
2053
+ "name": "VZ-M2M-Token",
2054
+ "in": "header",
2055
+ "description": "VZ-M2M session token",
2056
+ "required": true,
2057
+ "schema": {
2058
+ "type": "string"
2059
+ }
2060
+ },
2061
+ {
2062
+ "name": "aname",
2063
+ "in": "path",
2064
+ "description": "Account name",
2065
+ "required": true,
2066
+ "schema": {
2067
+ "type": "string"
2068
+ }
2069
+ },
2070
+ {
2071
+ "name": "next",
2072
+ "in": "query",
2073
+ "description": "Continue the previous query from the pageUrl in Location Header",
2074
+ "schema": {
2075
+ "type": "integer",
2076
+ "format": "int64"
2077
+ }
2078
+ }
2079
+ ],
2080
+ "responses": {
2081
+ "200": {
2082
+ "description": "The list of leads associated with the account.",
2083
+ "content": {
2084
+ "application/json": {
2085
+ "schema": {
2086
+ "$ref": "#/components/schemas/LeadInformationResponse"
2087
+ }
2088
+ }
2089
+ }
2090
+ },
2091
+ "202": {
2092
+ "description": "The list of leads associated with the account, additional leads remain.",
2093
+ "content": {
2094
+ "application/json": {
2095
+ "schema": {
2096
+ "$ref": "#/components/schemas/LeadInformationResponse"
2097
+ }
2098
+ }
2099
+ }
2100
+ },
2101
+ "400": {
2102
+ "description": "Error Response",
2103
+ "content": {
2104
+ "application/json": {
2105
+ "schema": {
2106
+ "$ref": "#/components/schemas/RestErrorResponse"
2107
+ }
2108
+ }
2109
+ }
2110
+ }
2111
+ }
2112
+ }
2113
+ },
2114
+ "/plans/{aname}": {
2115
+ "get": {
2116
+ "tags": [
2117
+ "plans"
2118
+ ],
2119
+ "summary": "Returns a list of all data service plans that are associated with a specified account.",
2120
+ "operationId": "getServicePlanListUsingGET",
2121
+ "parameters": [
2122
+ {
2123
+ "name": "VZ-M2M-Token",
2124
+ "in": "header",
2125
+ "description": "VZ-M2M session token",
2126
+ "required": true,
2127
+ "schema": {
2128
+ "type": "string"
2129
+ }
2130
+ },
2131
+ {
2132
+ "name": "aname",
2133
+ "in": "path",
2134
+ "description": "Account name",
2135
+ "required": true,
2136
+ "schema": {
2137
+ "type": "string"
2138
+ }
2139
+ }
2140
+ ],
2141
+ "responses": {
2142
+ "200": {
2143
+ "description": "The list of service plans associated with the account.",
2144
+ "content": {
2145
+ "application/json": {
2146
+ "schema": {
2147
+ "type": "array",
2148
+ "items": {
2149
+ "$ref": "#/components/schemas/ServicePlanResponse"
2150
+ }
2151
+ }
2152
+ }
2153
+ }
2154
+ },
2155
+ "400": {
2156
+ "description": "Error Response",
2157
+ "content": {
2158
+ "application/json": {
2159
+ "schema": {
2160
+ "$ref": "#/components/schemas/RestErrorResponse"
2161
+ }
2162
+ }
2163
+ }
2164
+ }
2165
+ }
2166
+ }
2167
+ },
2168
+ "/session/login": {
2169
+ "post": {
2170
+ "tags": [
2171
+ "session"
2172
+ ],
2173
+ "summary": "Initiates a Connectivity Management session and returns a session token required in subsequent API requests.",
2174
+ "operationId": "loginUsingPOST",
2175
+ "requestBody": {
2176
+ "description": "request",
2177
+ "content": {
2178
+ "application/json": {
2179
+ "schema": {
2180
+ "$ref": "#/components/schemas/LogInRequest"
2181
+ }
2182
+ }
2183
+ },
2184
+ "required": false
2185
+ },
2186
+ "responses": {
2187
+ "200": {
2188
+ "description": "VZ-M2M session token",
2189
+ "content": {
2190
+ "application/json": {
2191
+ "schema": {
2192
+ "$ref": "#/components/schemas/LogInResponse"
2193
+ }
2194
+ }
2195
+ }
2196
+ },
2197
+ "400": {
2198
+ "description": "Error Response",
2199
+ "content": {
2200
+ "application/json": {
2201
+ "schema": {
2202
+ "$ref": "#/components/schemas/RestErrorResponse"
2203
+ }
2204
+ }
2205
+ }
2206
+ }
2207
+ },
2208
+ "x-codegen-request-body-name": "request"
2209
+ }
2210
+ },
2211
+ "/session/logout": {
2212
+ "post": {
2213
+ "tags": [
2214
+ "session"
2215
+ ],
2216
+ "summary": "Ends a Connectivity Management session.",
2217
+ "operationId": "logoutUsingPOST",
2218
+ "parameters": [
2219
+ {
2220
+ "name": "VZ-M2M-Token",
2221
+ "in": "header",
2222
+ "description": "VZ-M2M session token",
2223
+ "required": true,
2224
+ "schema": {
2225
+ "type": "string"
2226
+ }
2227
+ }
2228
+ ],
2229
+ "responses": {
2230
+ "200": {
2231
+ "description": "VZ-M2M session token",
2232
+ "content": {
2233
+ "application/json": {
2234
+ "schema": {
2235
+ "$ref": "#/components/schemas/LogOutRequest"
2236
+ }
2237
+ }
2238
+ }
2239
+ },
2240
+ "400": {
2241
+ "description": "Error Response",
2242
+ "content": {
2243
+ "application/json": {
2244
+ "schema": {
2245
+ "$ref": "#/components/schemas/RestErrorResponse"
2246
+ }
2247
+ }
2248
+ }
2249
+ }
2250
+ }
2251
+ }
2252
+ },
2253
+ "/session/password/actions/reset": {
2254
+ "put": {
2255
+ "tags": [
2256
+ "session"
2257
+ ],
2258
+ "summary": "Returns a new, randomly generated password for the current username",
2259
+ "description": "The new password is effective immediately. Passwords do not expire, but Verizon recommends changing your password every 90 days.",
2260
+ "operationId": "resetUsingPUT",
2261
+ "parameters": [
2262
+ {
2263
+ "name": "VZ-M2M-Token",
2264
+ "in": "header",
2265
+ "description": "VZ-M2M session token",
2266
+ "required": true,
2267
+ "schema": {
2268
+ "type": "string"
2269
+ }
2270
+ }
2271
+ ],
2272
+ "requestBody": {
2273
+ "description": "Current Password",
2274
+ "content": {
2275
+ "application/json": {
2276
+ "schema": {
2277
+ "$ref": "#/components/schemas/SessionResetPasswordRequest"
2278
+ }
2279
+ }
2280
+ },
2281
+ "required": true
2282
+ },
2283
+ "responses": {
2284
+ "200": {
2285
+ "description": "Returns a new, randomly generated password for the current username.",
2286
+ "content": {
2287
+ "application/json": {
2288
+ "schema": {
2289
+ "$ref": "#/components/schemas/SessionResetPasswordResponse"
2290
+ }
2291
+ }
2292
+ }
2293
+ },
2294
+ "400": {
2295
+ "description": "Error Response",
2296
+ "content": {
2297
+ "application/json": {
2298
+ "schema": {
2299
+ "$ref": "#/components/schemas/RestErrorResponse"
2300
+ }
2301
+ }
2302
+ }
2303
+ }
2304
+ },
2305
+ "x-codegen-request-body-name": "request"
2306
+ }
2307
+ },
2308
+ "/sms": {
2309
+ "post": {
2310
+ "tags": [
2311
+ "sms"
2312
+ ],
2313
+ "summary": "Sends an SMS message to one or more devices.",
2314
+ "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.",
2315
+ "operationId": "sendSmsMessageUsingPOST",
2316
+ "parameters": [
2317
+ {
2318
+ "name": "VZ-M2M-Token",
2319
+ "in": "header",
2320
+ "description": "VZ-M2M session token",
2321
+ "required": true,
2322
+ "schema": {
2323
+ "type": "string"
2324
+ }
2325
+ }
2326
+ ],
2327
+ "requestBody": {
2328
+ "description": "SMS Request",
2329
+ "content": {
2330
+ "application/json": {
2331
+ "schema": {
2332
+ "$ref": "#/components/schemas/SMSSendRequest"
2333
+ }
2334
+ }
2335
+ },
2336
+ "required": true
2337
+ },
2338
+ "responses": {
2339
+ "200": {
2340
+ "description": "Request ID",
2341
+ "content": {
2342
+ "application/json": {
2343
+ "schema": {
2344
+ "$ref": "#/components/schemas/RequestResponse"
2345
+ }
2346
+ }
2347
+ }
2348
+ },
2349
+ "400": {
2350
+ "description": "Error Response",
2351
+ "content": {
2352
+ "application/json": {
2353
+ "schema": {
2354
+ "$ref": "#/components/schemas/RestErrorResponse"
2355
+ }
2356
+ }
2357
+ }
2358
+ }
2359
+ },
2360
+ "x-codegen-request-body-name": "request"
2361
+ }
2362
+ },
2363
+ "/sms/{aname}/history": {
2364
+ "get": {
2365
+ "tags": [
2366
+ "sms"
2367
+ ],
2368
+ "summary": "Retrieves queued SMS messages sent by all M2M MC devices associated with an account.",
2369
+ "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.",
2370
+ "operationId": "getSmsMessagesUsingGET",
2371
+ "parameters": [
2372
+ {
2373
+ "name": "aname",
2374
+ "in": "path",
2375
+ "description": "Account name",
2376
+ "required": true,
2377
+ "schema": {
2378
+ "type": "string"
2379
+ }
2380
+ },
2381
+ {
2382
+ "name": "next",
2383
+ "in": "query",
2384
+ "description": "Continue the previous query from the URL in Location Header",
2385
+ "schema": {
2386
+ "type": "integer",
2387
+ "format": "int64"
2388
+ }
2389
+ },
2390
+ {
2391
+ "name": "VZ-M2M-Token",
2392
+ "in": "header",
2393
+ "description": "VZ-M2M session token",
2394
+ "required": true,
2395
+ "schema": {
2396
+ "type": "string"
2397
+ }
2398
+ }
2399
+ ],
2400
+ "responses": {
2401
+ "200": {
2402
+ "description": "Successful response",
2403
+ "content": {
2404
+ "application/json": {
2405
+ "schema": {
2406
+ "$ref": "#/components/schemas/SmsMessagesResponse"
2407
+ }
2408
+ }
2409
+ }
2410
+ },
2411
+ "202": {
2412
+ "description": "Successful response, additional SMS messages remain",
2413
+ "content": {
2414
+ "application/json": {
2415
+ "schema": {
2416
+ "$ref": "#/components/schemas/SmsMessagesResponse"
2417
+ }
2418
+ }
2419
+ }
2420
+ },
2421
+ "400": {
2422
+ "description": "Error Response",
2423
+ "content": {
2424
+ "application/json": {
2425
+ "schema": {
2426
+ "$ref": "#/components/schemas/RestErrorResponse"
2427
+ }
2428
+ }
2429
+ }
2430
+ }
2431
+ }
2432
+ }
2433
+ },
2434
+ "/sms/{aname}/startCallbacks": {
2435
+ "put": {
2436
+ "tags": [
2437
+ "sms"
2438
+ ],
2439
+ "summary": "Starts delivery of queued SMS messages for the specific account.",
2440
+ "operationId": "startSmsCallbackUsingPUT",
2441
+ "parameters": [
2442
+ {
2443
+ "name": "aname",
2444
+ "in": "path",
2445
+ "description": "Account name",
2446
+ "required": true,
2447
+ "schema": {
2448
+ "type": "string"
2449
+ }
2450
+ },
2451
+ {
2452
+ "name": "VZ-M2M-Token",
2453
+ "in": "header",
2454
+ "description": "VZ-M2M session token",
2455
+ "required": true,
2456
+ "schema": {
2457
+ "type": "string"
2458
+ }
2459
+ }
2460
+ ],
2461
+ "responses": {
2462
+ "200": {
2463
+ "description": "Request Success Message",
2464
+ "content": {
2465
+ "application/json": {
2466
+ "schema": {
2467
+ "$ref": "#/components/schemas/RestSuccessResponse"
2468
+ }
2469
+ }
2470
+ }
2471
+ },
2472
+ "400": {
2473
+ "description": "Error Response",
2474
+ "content": {
2475
+ "application/json": {
2476
+ "schema": {
2477
+ "$ref": "#/components/schemas/RestErrorResponse"
2478
+ }
2479
+ }
2480
+ }
2481
+ }
2482
+ }
2483
+ }
2484
+ }
2485
+ },
2486
+ "components": {
2487
+ "schemas": {
2488
+ "AccountInformationResponse": {
2489
+ "type": "object",
2490
+ "properties": {
2491
+ "accountName": {
2492
+ "type": "string"
2493
+ },
2494
+ "accountNumber": {
2495
+ "type": "string"
2496
+ },
2497
+ "organizationName": {
2498
+ "type": "string"
2499
+ },
2500
+ "isProvisioningAllowed": {
2501
+ "type": "boolean"
2502
+ },
2503
+ "carriers": {
2504
+ "type": "array",
2505
+ "items": {
2506
+ "type": "string"
2507
+ }
2508
+ },
2509
+ "features": {
2510
+ "type": "array",
2511
+ "items": {
2512
+ "type": "string"
2513
+ }
2514
+ },
2515
+ "iPPools": {
2516
+ "type": "array",
2517
+ "items": {
2518
+ "$ref": "#/components/schemas/IPPool"
2519
+ }
2520
+ },
2521
+ "servicePlans": {
2522
+ "type": "array",
2523
+ "items": {
2524
+ "$ref": "#/components/schemas/ServicePlanResponse"
2525
+ }
2526
+ }
2527
+ }
2528
+ },
2529
+ "AddDevicesRequest": {
2530
+ "type": "object",
2531
+ "properties": {
2532
+ "accountName": {
2533
+ "type": "string"
2534
+ },
2535
+ "customFields": {
2536
+ "type": "array",
2537
+ "items": {
2538
+ "$ref": "#/components/schemas/KvPair"
2539
+ }
2540
+ },
2541
+ "devicesToAdd": {
2542
+ "type": "array",
2543
+ "items": {
2544
+ "$ref": "#/components/schemas/DeviceList"
2545
+ }
2546
+ },
2547
+ "groupName": {
2548
+ "type": "string"
2549
+ },
2550
+ "skuNumber": {
2551
+ "type": "string"
2552
+ },
2553
+ "state": {
2554
+ "type": "string"
2555
+ }
2556
+ }
2557
+ },
2558
+ "AddDevicesResponseMessage": {
2559
+ "type": "object",
2560
+ "properties": {
2561
+ "deviceIds": {
2562
+ "type": "array",
2563
+ "items": {
2564
+ "$ref": "#/components/schemas/DeviceId"
2565
+ }
2566
+ },
2567
+ "response": {
2568
+ "type": "string"
2569
+ }
2570
+ }
2571
+ },
2572
+ "Address": {
2573
+ "required": [
2574
+ "addressLine1",
2575
+ "city",
2576
+ "country",
2577
+ "state",
2578
+ "zip"
2579
+ ],
2580
+ "type": "object",
2581
+ "properties": {
2582
+ "addressLine1": {
2583
+ "type": "string"
2584
+ },
2585
+ "addressLine2": {
2586
+ "type": "string"
2587
+ },
2588
+ "city": {
2589
+ "type": "string"
2590
+ },
2591
+ "state": {
2592
+ "type": "string"
2593
+ },
2594
+ "zip": {
2595
+ "type": "string"
2596
+ },
2597
+ "zip4": {
2598
+ "type": "string"
2599
+ },
2600
+ "country": {
2601
+ "type": "string"
2602
+ },
2603
+ "phone": {
2604
+ "type": "string"
2605
+ },
2606
+ "phoneType": {
2607
+ "type": "string"
2608
+ },
2609
+ "emailAddress": {
2610
+ "type": "string"
2611
+ }
2612
+ }
2613
+ },
2614
+ "Callback": {
2615
+ "type": "object",
2616
+ "properties": {
2617
+ "accountName": {
2618
+ "type": "string"
2619
+ },
2620
+ "password": {
2621
+ "type": "string"
2622
+ },
2623
+ "serviceName": {
2624
+ "type": "string"
2625
+ },
2626
+ "url": {
2627
+ "type": "string"
2628
+ },
2629
+ "username": {
2630
+ "type": "string"
2631
+ }
2632
+ }
2633
+ },
2634
+ "CallbackActionResponse": {
2635
+ "type": "object",
2636
+ "properties": {
2637
+ "accountName": {
2638
+ "type": "string"
2639
+ },
2640
+ "serviceName": {
2641
+ "type": "string"
2642
+ }
2643
+ }
2644
+ },
2645
+ "CarrierActionsRequest": {
2646
+ "type": "object",
2647
+ "properties": {
2648
+ "accountName": {
2649
+ "type": "string"
2650
+ },
2651
+ "customFields": {
2652
+ "type": "array",
2653
+ "items": {
2654
+ "$ref": "#/components/schemas/KvPair"
2655
+ }
2656
+ },
2657
+ "devices": {
2658
+ "type": "array",
2659
+ "items": {
2660
+ "$ref": "#/components/schemas/DeviceList"
2661
+ }
2662
+ },
2663
+ "groupName": {
2664
+ "type": "string"
2665
+ },
2666
+ "servicePlan": {
2667
+ "type": "string"
2668
+ }
2669
+ }
2670
+ },
2671
+ "CarrierActivateRequest": {
2672
+ "type": "object",
2673
+ "properties": {
2674
+ "accountName": {
2675
+ "type": "string"
2676
+ },
2677
+ "carrierIpPoolName": {
2678
+ "type": "string"
2679
+ },
2680
+ "carrierName": {
2681
+ "type": "string"
2682
+ },
2683
+ "costCenterCode": {
2684
+ "type": "string"
2685
+ },
2686
+ "customFields": {
2687
+ "type": "array",
2688
+ "items": {
2689
+ "$ref": "#/components/schemas/KvPair"
2690
+ }
2691
+ },
2692
+ "devices": {
2693
+ "type": "array",
2694
+ "items": {
2695
+ "$ref": "#/components/schemas/DeviceList"
2696
+ }
2697
+ },
2698
+ "groupName": {
2699
+ "type": "string"
2700
+ },
2701
+ "leadId": {
2702
+ "type": "string"
2703
+ },
2704
+ "mdnZipCode": {
2705
+ "type": "string"
2706
+ },
2707
+ "primaryPlaceOfUse": {
2708
+ "$ref": "#/components/schemas/PlaceOfUse"
2709
+ },
2710
+ "publicIpRestriction": {
2711
+ "type": "string"
2712
+ },
2713
+ "servicePlan": {
2714
+ "type": "string"
2715
+ },
2716
+ "skuNumber": {
2717
+ "type": "string"
2718
+ }
2719
+ }
2720
+ },
2721
+ "CarrierDeactivateRequest": {
2722
+ "type": "object",
2723
+ "properties": {
2724
+ "accountName": {
2725
+ "type": "string"
2726
+ },
2727
+ "customFields": {
2728
+ "type": "array",
2729
+ "items": {
2730
+ "$ref": "#/components/schemas/KvPair"
2731
+ }
2732
+ },
2733
+ "devices": {
2734
+ "type": "array",
2735
+ "items": {
2736
+ "$ref": "#/components/schemas/DeviceList"
2737
+ }
2738
+ },
2739
+ "etfWaiver": {
2740
+ "type": "boolean"
2741
+ },
2742
+ "groupName": {
2743
+ "type": "string"
2744
+ },
2745
+ "reasonCode": {
2746
+ "type": "string"
2747
+ },
2748
+ "servicePlan": {
2749
+ "type": "string"
2750
+ }
2751
+ }
2752
+ },
2753
+ "CarrierInformation": {
2754
+ "type": "object",
2755
+ "properties": {
2756
+ "carrierName": {
2757
+ "type": "string"
2758
+ },
2759
+ "servicePlan": {
2760
+ "type": "string"
2761
+ },
2762
+ "state": {
2763
+ "type": "string"
2764
+ }
2765
+ }
2766
+ },
2767
+ "ChangeDeviceIdRequest": {
2768
+ "type": "object",
2769
+ "properties": {
2770
+ "assignNonGeoMdn": {
2771
+ "type": "boolean"
2772
+ },
2773
+ "change4gOption": {
2774
+ "type": "string"
2775
+ },
2776
+ "deviceIds": {
2777
+ "type": "array",
2778
+ "items": {
2779
+ "$ref": "#/components/schemas/DeviceId"
2780
+ }
2781
+ },
2782
+ "deviceIdsTo": {
2783
+ "type": "array",
2784
+ "items": {
2785
+ "$ref": "#/components/schemas/DeviceId"
2786
+ }
2787
+ },
2788
+ "npaNxx": {
2789
+ "type": "string"
2790
+ },
2791
+ "servicePlan": {
2792
+ "type": "string"
2793
+ },
2794
+ "zipCode": {
2795
+ "type": "string"
2796
+ }
2797
+ }
2798
+ },
2799
+ "ConnectionEvent": {
2800
+ "type": "object",
2801
+ "properties": {
2802
+ "connectionEventAttributes": {
2803
+ "type": "array",
2804
+ "items": {
2805
+ "$ref": "#/components/schemas/KvPair"
2806
+ }
2807
+ },
2808
+ "extendedAttributes": {
2809
+ "type": "array",
2810
+ "items": {
2811
+ "$ref": "#/components/schemas/KvPair"
2812
+ }
2813
+ },
2814
+ "occurredAt": {
2815
+ "type": "string"
2816
+ }
2817
+ }
2818
+ },
2819
+ "ConnectionHistoryResponse": {
2820
+ "type": "object",
2821
+ "properties": {
2822
+ "connectionHistory": {
2823
+ "type": "array",
2824
+ "items": {
2825
+ "$ref": "#/components/schemas/ConnectionEvent"
2826
+ }
2827
+ },
2828
+ "hasMoreData": {
2829
+ "type": "boolean"
2830
+ }
2831
+ }
2832
+ },
2833
+ "ContactInfoUpdateRequest": {
2834
+ "type": "object",
2835
+ "properties": {
2836
+ "accountName": {
2837
+ "type": "string"
2838
+ },
2839
+ "devices": {
2840
+ "type": "array",
2841
+ "items": {
2842
+ "$ref": "#/components/schemas/DeviceList"
2843
+ }
2844
+ },
2845
+ "primaryPlaceOfUse": {
2846
+ "type": "object",
2847
+ "properties": {}
2848
+ }
2849
+ }
2850
+ },
2851
+ "CreateDevGroupRequest": {
2852
+ "type": "object",
2853
+ "properties": {
2854
+ "accountName": {
2855
+ "type": "string"
2856
+ },
2857
+ "devicesToAdd": {
2858
+ "type": "array",
2859
+ "items": {
2860
+ "$ref": "#/components/schemas/DeviceId"
2861
+ }
2862
+ },
2863
+ "groupDescription": {
2864
+ "type": "string"
2865
+ },
2866
+ "groupName": {
2867
+ "type": "string"
2868
+ }
2869
+ }
2870
+ },
2871
+ "CustomerName": {
2872
+ "required": [
2873
+ "firstName",
2874
+ "lastName"
2875
+ ],
2876
+ "type": "object",
2877
+ "properties": {
2878
+ "title": {
2879
+ "type": "string"
2880
+ },
2881
+ "firstName": {
2882
+ "type": "string"
2883
+ },
2884
+ "middleName": {
2885
+ "type": "string"
2886
+ },
2887
+ "lastName": {
2888
+ "type": "string"
2889
+ },
2890
+ "suffix": {
2891
+ "type": "string"
2892
+ }
2893
+ }
2894
+ },
2895
+ "CustomFieldsUpdateRequest": {
2896
+ "type": "object",
2897
+ "properties": {
2898
+ "accountName": {
2899
+ "type": "string"
2900
+ },
2901
+ "customFields": {
2902
+ "type": "array",
2903
+ "items": {
2904
+ "$ref": "#/components/schemas/KvPair"
2905
+ }
2906
+ },
2907
+ "customFieldsToUpdate": {
2908
+ "type": "array",
2909
+ "items": {
2910
+ "$ref": "#/components/schemas/KvPair"
2911
+ }
2912
+ },
2913
+ "devices": {
2914
+ "type": "array",
2915
+ "items": {
2916
+ "$ref": "#/components/schemas/DeviceList"
2917
+ }
2918
+ },
2919
+ "groupName": {
2920
+ "type": "string"
2921
+ },
2922
+ "servicePlan": {
2923
+ "type": "string"
2924
+ }
2925
+ }
2926
+ },
2927
+ "DateFilter": {
2928
+ "type": "object",
2929
+ "properties": {
2930
+ "earliest": {
2931
+ "type": "string"
2932
+ },
2933
+ "latest": {
2934
+ "type": "string"
2935
+ }
2936
+ }
2937
+ },
2938
+ "DeleteDevicesRequest": {
2939
+ "type": "object",
2940
+ "properties": {
2941
+ "accountName": {
2942
+ "type": "string"
2943
+ },
2944
+ "devicesToDelete": {
2945
+ "type": "array",
2946
+ "items": {
2947
+ "$ref": "#/components/schemas/DeviceList"
2948
+ }
2949
+ }
2950
+ }
2951
+ },
2952
+ "DeleteDevicesResponseMessage": {
2953
+ "type": "object",
2954
+ "properties": {
2955
+ "deviceIds": {
2956
+ "type": "array",
2957
+ "items": {
2958
+ "$ref": "#/components/schemas/DeviceId"
2959
+ }
2960
+ },
2961
+ "status": {
2962
+ "type": "string"
2963
+ },
2964
+ "message": {
2965
+ "type": "string"
2966
+ }
2967
+ }
2968
+ },
2969
+ "Device": {
2970
+ "type": "object",
2971
+ "properties": {
2972
+ "accountName": {
2973
+ "type": "string"
2974
+ },
2975
+ "billingCycleEndDate": {
2976
+ "type": "string"
2977
+ },
2978
+ "carrierInformations": {
2979
+ "type": "array",
2980
+ "items": {
2981
+ "$ref": "#/components/schemas/CarrierInformation"
2982
+ }
2983
+ },
2984
+ "connected": {
2985
+ "type": "boolean"
2986
+ },
2987
+ "createdAt": {
2988
+ "type": "string"
2989
+ },
2990
+ "customFields": {
2991
+ "type": "array",
2992
+ "items": {
2993
+ "$ref": "#/components/schemas/KvPair"
2994
+ }
2995
+ },
2996
+ "deviceIds": {
2997
+ "type": "array",
2998
+ "items": {
2999
+ "$ref": "#/components/schemas/DeviceId"
3000
+ }
3001
+ },
3002
+ "extendedAttributes": {
3003
+ "type": "array",
3004
+ "items": {
3005
+ "$ref": "#/components/schemas/KvPair"
3006
+ }
3007
+ },
3008
+ "groupNames": {
3009
+ "type": "array",
3010
+ "items": {
3011
+ "type": "string"
3012
+ }
3013
+ },
3014
+ "ipAddress": {
3015
+ "type": "string"
3016
+ },
3017
+ "lastActivationBy": {
3018
+ "type": "string"
3019
+ },
3020
+ "lastActivationDate": {
3021
+ "type": "string"
3022
+ },
3023
+ "lastConnectionDate": {
3024
+ "type": "string"
3025
+ }
3026
+ }
3027
+ },
3028
+ "DeviceAggregateUsageListRequest": {
3029
+ "type": "object",
3030
+ "properties": {
3031
+ "deviceIds": {
3032
+ "type": "array",
3033
+ "items": {
3034
+ "$ref": "#/components/schemas/DeviceId"
3035
+ }
3036
+ },
3037
+ "accountName": {
3038
+ "type": "string"
3039
+ },
3040
+ "groupName": {
3041
+ "type": "string"
3042
+ },
3043
+ "startTime": {
3044
+ "type": "string"
3045
+ },
3046
+ "endTime": {
3047
+ "type": "string"
3048
+ }
3049
+ }
3050
+ },
3051
+ "DeviceConnectionListRequest": {
3052
+ "type": "object",
3053
+ "properties": {
3054
+ "deviceId": {
3055
+ "$ref": "#/components/schemas/DeviceId"
3056
+ },
3057
+ "earliest": {
3058
+ "type": "string"
3059
+ },
3060
+ "latest": {
3061
+ "type": "string"
3062
+ }
3063
+ }
3064
+ },
3065
+ "DeviceCostCenterRequest": {
3066
+ "type": "object",
3067
+ "properties": {
3068
+ "accountName": {
3069
+ "type": "string"
3070
+ },
3071
+ "costCenter": {
3072
+ "type": "string"
3073
+ },
3074
+ "customFields": {
3075
+ "type": "array",
3076
+ "items": {
3077
+ "$ref": "#/components/schemas/KvPair"
3078
+ }
3079
+ },
3080
+ "devices": {
3081
+ "type": "array",
3082
+ "items": {
3083
+ "$ref": "#/components/schemas/DeviceList"
3084
+ }
3085
+ },
3086
+ "groupName": {
3087
+ "type": "string"
3088
+ },
3089
+ "primaryPlaceOfUse": {
3090
+ "type": "object",
3091
+ "properties": {}
3092
+ },
3093
+ "removeCostCenter": {
3094
+ "type": "boolean"
3095
+ },
3096
+ "servicePlan": {
3097
+ "type": "string"
3098
+ }
3099
+ }
3100
+ },
3101
+ "DeviceExtendedDiagnosticsRequest": {
3102
+ "required": [
3103
+ "accountName",
3104
+ "deviceList"
3105
+ ],
3106
+ "type": "object",
3107
+ "properties": {
3108
+ "accountName": {
3109
+ "type": "string"
3110
+ },
3111
+ "deviceList": {
3112
+ "type": "array",
3113
+ "items": {
3114
+ "$ref": "#/components/schemas/DeviceId"
3115
+ }
3116
+ }
3117
+ }
3118
+ },
3119
+ "DeviceExtendedDiagnosticsResponse": {
3120
+ "type": "object",
3121
+ "properties": {
3122
+ "categories": {
3123
+ "type": "array",
3124
+ "items": {
3125
+ "$ref": "#/components/schemas/DiagnosticsCategory"
3126
+ }
3127
+ }
3128
+ }
3129
+ },
3130
+ "DeviceFilter": {
3131
+ "type": "object",
3132
+ "properties": {
3133
+ "account": {
3134
+ "type": "string"
3135
+ },
3136
+ "groupName": {
3137
+ "type": "string"
3138
+ },
3139
+ "servicePlan": {
3140
+ "type": "string"
3141
+ },
3142
+ "customFields": {
3143
+ "type": "array",
3144
+ "items": {
3145
+ "$ref": "#/components/schemas/KvPair"
3146
+ }
3147
+ }
3148
+ }
3149
+ },
3150
+ "DeviceFilterWithoutAccount": {
3151
+ "type": "object",
3152
+ "properties": {
3153
+ "groupName": {
3154
+ "type": "string"
3155
+ },
3156
+ "servicePlan": {
3157
+ "type": "string"
3158
+ },
3159
+ "customFields": {
3160
+ "type": "array",
3161
+ "items": {
3162
+ "$ref": "#/components/schemas/KvPair"
3163
+ }
3164
+ }
3165
+ }
3166
+ },
3167
+ "DeviceId": {
3168
+ "type": "object",
3169
+ "properties": {
3170
+ "id": {
3171
+ "type": "string"
3172
+ },
3173
+ "kind": {
3174
+ "type": "string"
3175
+ }
3176
+ }
3177
+ },
3178
+ "DeviceIdSearch": {
3179
+ "required": [
3180
+ "kind"
3181
+ ],
3182
+ "type": "object",
3183
+ "properties": {
3184
+ "contains": {
3185
+ "type": "string"
3186
+ },
3187
+ "startswith": {
3188
+ "type": "string"
3189
+ },
3190
+ "endswith": {
3191
+ "type": "string"
3192
+ },
3193
+ "kind": {
3194
+ "type": "string"
3195
+ }
3196
+ }
3197
+ },
3198
+ "DeviceList": {
3199
+ "type": "object",
3200
+ "properties": {
3201
+ "deviceIds": {
3202
+ "type": "array",
3203
+ "items": {
3204
+ "$ref": "#/components/schemas/DeviceId"
3205
+ }
3206
+ }
3207
+ }
3208
+ },
3209
+ "DeviceListRequest": {
3210
+ "type": "object",
3211
+ "properties": {
3212
+ "accountName": {
3213
+ "type": "string"
3214
+ },
3215
+ "deviceId": {
3216
+ "$ref": "#/components/schemas/DeviceId"
3217
+ },
3218
+ "filter": {
3219
+ "type": "object",
3220
+ "properties": {
3221
+ "deviceIdentifierFilters": {
3222
+ "type": "array",
3223
+ "items": {
3224
+ "$ref": "#/components/schemas/DeviceIdSearch"
3225
+ }
3226
+ }
3227
+ }
3228
+ },
3229
+ "currentState": {
3230
+ "type": "string"
3231
+ },
3232
+ "customFields": {
3233
+ "type": "array",
3234
+ "items": {
3235
+ "$ref": "#/components/schemas/KvPair"
3236
+ }
3237
+ },
3238
+ "earliest": {
3239
+ "type": "string"
3240
+ },
3241
+ "groupName": {
3242
+ "type": "string"
3243
+ },
3244
+ "latest": {
3245
+ "type": "string"
3246
+ },
3247
+ "servicePlan": {
3248
+ "type": "string"
3249
+ }
3250
+ }
3251
+ },
3252
+ "DeviceListResponse": {
3253
+ "type": "object",
3254
+ "properties": {
3255
+ "devices": {
3256
+ "type": "array",
3257
+ "items": {
3258
+ "$ref": "#/components/schemas/Device"
3259
+ }
3260
+ },
3261
+ "hasMoreData": {
3262
+ "type": "boolean"
3263
+ }
3264
+ }
3265
+ },
3266
+ "DeviceRequest": {
3267
+ "type": "object",
3268
+ "properties": {
3269
+ "accountName": {
3270
+ "type": "string"
3271
+ },
3272
+ "devices": {
3273
+ "type": "array",
3274
+ "items": {
3275
+ "$ref": "#/components/schemas/DeviceList"
3276
+ }
3277
+ }
3278
+ }
3279
+ },
3280
+ "DevicePrlListRequest": {
3281
+ "type": "object",
3282
+ "properties": {
3283
+ "deviceIds": {
3284
+ "type": "array",
3285
+ "items": {
3286
+ "$ref": "#/components/schemas/DeviceId"
3287
+ }
3288
+ },
3289
+ "accountName": {
3290
+ "type": "string"
3291
+ },
3292
+ "customFields": {
3293
+ "type": "array",
3294
+ "items": {
3295
+ "$ref": "#/components/schemas/KvPair"
3296
+ }
3297
+ },
3298
+ "groupName": {
3299
+ "type": "string"
3300
+ },
3301
+ "servicePlan": {
3302
+ "type": "string"
3303
+ }
3304
+ }
3305
+ },
3306
+ "DeviceMismatchListRequest": {
3307
+ "type": "object",
3308
+ "properties": {
3309
+ "devices": {
3310
+ "type": "array",
3311
+ "items": {
3312
+ "$ref": "#/components/schemas/DeviceList"
3313
+ }
3314
+ },
3315
+ "filter": {
3316
+ "$ref": "#/components/schemas/DateFilter"
3317
+ },
3318
+ "accountName": {
3319
+ "type": "string"
3320
+ },
3321
+ "groupName": {
3322
+ "type": "string"
3323
+ }
3324
+ }
3325
+ },
3326
+ "DeviceMismatchListResponse": {
3327
+ "type": "object",
3328
+ "properties": {
3329
+ "devices": {
3330
+ "type": "array",
3331
+ "items": {
3332
+ "$ref": "#/components/schemas/MismatchedDevice"
3333
+ }
3334
+ }
3335
+ }
3336
+ },
3337
+ "DeviceProvisioningHistoryListRequest": {
3338
+ "type": "object",
3339
+ "properties": {
3340
+ "deviceId": {
3341
+ "$ref": "#/components/schemas/DeviceId"
3342
+ },
3343
+ "earliest": {
3344
+ "type": "string"
3345
+ },
3346
+ "latest": {
3347
+ "type": "string"
3348
+ }
3349
+ }
3350
+ },
3351
+ "DeviceProvisioningHistoryListResponse": {
3352
+ "type": "object",
3353
+ "properties": {
3354
+ "hasMoreData": {
3355
+ "type": "boolean"
3356
+ },
3357
+ "provisioningHistory": {
3358
+ "type": "array",
3359
+ "items": {
3360
+ "$ref": "#/components/schemas/ProvisioningHistory"
3361
+ }
3362
+ }
3363
+ }
3364
+ },
3365
+ "DeviceSuspensionStatusRequest": {
3366
+ "type": "object",
3367
+ "properties": {
3368
+ "deviceIds": {
3369
+ "type": "array",
3370
+ "items": {
3371
+ "$ref": "#/components/schemas/DeviceId"
3372
+ }
3373
+ },
3374
+ "filter": {
3375
+ "$ref": "#/components/schemas/DeviceFilterWithoutAccount"
3376
+ },
3377
+ "accountName": {
3378
+ "type": "string"
3379
+ }
3380
+ }
3381
+ },
3382
+ "DeviceUsageListRequest": {
3383
+ "type": "object",
3384
+ "properties": {
3385
+ "deviceId": {
3386
+ "$ref": "#/components/schemas/DeviceId"
3387
+ },
3388
+ "earliest": {
3389
+ "type": "string"
3390
+ },
3391
+ "latest": {
3392
+ "type": "string"
3393
+ }
3394
+ }
3395
+ },
3396
+ "DeviceUsageListResponse": {
3397
+ "type": "object",
3398
+ "properties": {
3399
+ "hasMoreData": {
3400
+ "type": "boolean"
3401
+ },
3402
+ "usageHistory": {
3403
+ "type": "array",
3404
+ "items": {
3405
+ "$ref": "#/components/schemas/Usage"
3406
+ }
3407
+ }
3408
+ }
3409
+ },
3410
+ "DiagnosticsCategory": {
3411
+ "type": "object",
3412
+ "properties": {
3413
+ "categoryName": {
3414
+ "type": "string"
3415
+ },
3416
+ "extendedAttributes": {
3417
+ "type": "array",
3418
+ "items": {
3419
+ "$ref": "#/components/schemas/KvPair"
3420
+ }
3421
+ }
3422
+ }
3423
+ },
3424
+ "GetStatesAndServicesResponse": {
3425
+ "required": [
3426
+ "engagement"
3427
+ ],
3428
+ "type": "object",
3429
+ "properties": {
3430
+ "engagement": {
3431
+ "type": "array",
3432
+ "items": {
3433
+ "type": "object",
3434
+ "properties": {
3435
+ "engagementId": {
3436
+ "type": "string",
3437
+ "example": "1234"
3438
+ },
3439
+ "chargingGroup": {
3440
+ "type": "string",
3441
+ "example": "Engagement1234"
3442
+ },
3443
+ "services": {
3444
+ "type": "array",
3445
+ "items": {
3446
+ "type": "object",
3447
+ "properties": {
3448
+ "name": {
3449
+ "type": "string",
3450
+ "example": "Svc1"
3451
+ },
3452
+ "description": {
3453
+ "type": "string",
3454
+ "example": "Usage Segmentation - Main Line"
3455
+ },
3456
+ "states": {
3457
+ "type": "array",
3458
+ "items": {
3459
+ "type": "object",
3460
+ "properties": {
3461
+ "name": {
3462
+ "type": "string",
3463
+ "example": "Svc1 Activate"
3464
+ },
3465
+ "workflowSequenceNumber": {
3466
+ "type": "number",
3467
+ "example": 1
3468
+ },
3469
+ "servicePlans": {
3470
+ "type": "array",
3471
+ "example": [
3472
+ "4523aef7250f67205fd5",
3473
+ "4d4090c0f2d48814c94d"
3474
+ ],
3475
+ "items": {
3476
+ "type": "string"
3477
+ }
3478
+ }
3479
+ }
3480
+ }
3481
+ }
3482
+ }
3483
+ }
3484
+ }
3485
+ }
3486
+ }
3487
+ }
3488
+ }
3489
+ },
3490
+ "GoToStateRequest": {
3491
+ "type": "object",
3492
+ "properties": {
3493
+ "devices": {
3494
+ "type": "array",
3495
+ "items": {
3496
+ "$ref": "#/components/schemas/DeviceList"
3497
+ }
3498
+ },
3499
+ "filter": {
3500
+ "$ref": "#/components/schemas/DeviceFilter"
3501
+ },
3502
+ "serviceName": {
3503
+ "type": "string"
3504
+ },
3505
+ "stateName": {
3506
+ "type": "string"
3507
+ },
3508
+ "servicePlan": {
3509
+ "type": "string"
3510
+ },
3511
+ "mdnZipCode": {
3512
+ "type": "string"
3513
+ },
3514
+ "carrierIpPoolName": {
3515
+ "type": "string"
3516
+ },
3517
+ "publicIpRestriction": {
3518
+ "type": "string"
3519
+ },
3520
+ "skuNumber": {
3521
+ "type": "string"
3522
+ },
3523
+ "customFields": {
3524
+ "type": "array",
3525
+ "items": {
3526
+ "$ref": "#/components/schemas/KvPair"
3527
+ }
3528
+ },
3529
+ "groupName": {
3530
+ "type": "string"
3531
+ },
3532
+ "primaryPlaceOfUse": {
3533
+ "$ref": "#/components/schemas/PlaceOfUse"
3534
+ }
3535
+ }
3536
+ },
3537
+ "GroupListResponse": {
3538
+ "type": "object",
3539
+ "properties": {
3540
+ "description": {
3541
+ "type": "string"
3542
+ },
3543
+ "devices": {
3544
+ "type": "array",
3545
+ "items": {
3546
+ "$ref": "#/components/schemas/DeviceList"
3547
+ }
3548
+ },
3549
+ "hasMoreData": {
3550
+ "type": "boolean"
3551
+ },
3552
+ "name": {
3553
+ "type": "string"
3554
+ }
3555
+ }
3556
+ },
3557
+ "GroupResponse": {
3558
+ "type": "object",
3559
+ "properties": {
3560
+ "description": {
3561
+ "type": "string"
3562
+ },
3563
+ "extendedAttributes": {
3564
+ "type": "array",
3565
+ "items": {
3566
+ "$ref": "#/components/schemas/KvPair"
3567
+ }
3568
+ },
3569
+ "isDefaultGroup": {
3570
+ "type": "boolean"
3571
+ },
3572
+ "name": {
3573
+ "type": "string"
3574
+ }
3575
+ }
3576
+ },
3577
+ "GroupUpdateRequest": {
3578
+ "type": "object",
3579
+ "properties": {
3580
+ "devicesToAdd": {
3581
+ "type": "array",
3582
+ "items": {
3583
+ "$ref": "#/components/schemas/DeviceId"
3584
+ }
3585
+ },
3586
+ "devicesToRemove": {
3587
+ "type": "array",
3588
+ "items": {
3589
+ "$ref": "#/components/schemas/DeviceId"
3590
+ }
3591
+ },
3592
+ "newGroupDescription": {
3593
+ "type": "string"
3594
+ },
3595
+ "newGroupName": {
3596
+ "type": "string"
3597
+ }
3598
+ }
3599
+ },
3600
+ "IPPool": {
3601
+ "type": "object",
3602
+ "properties": {
3603
+ "poolName": {
3604
+ "type": "string",
3605
+ "example": "ACMESALES001"
3606
+ },
3607
+ "poolType": {
3608
+ "type": "string"
3609
+ },
3610
+ "isDefaultPool": {
3611
+ "type": "boolean"
3612
+ }
3613
+ }
3614
+ },
3615
+ "KvPair": {
3616
+ "type": "object",
3617
+ "properties": {
3618
+ "key": {
3619
+ "type": "string"
3620
+ },
3621
+ "value": {
3622
+ "type": "string"
3623
+ }
3624
+ }
3625
+ },
3626
+ "LeadInformationResponse": {
3627
+ "type": "object",
3628
+ "properties": {
3629
+ "hasMoreData": {
3630
+ "type": "boolean"
3631
+ },
3632
+ "leads": {
3633
+ "type": "array",
3634
+ "items": {
3635
+ "$ref": "#/components/schemas/LeadResponse"
3636
+ }
3637
+ }
3638
+ }
3639
+ },
3640
+ "LeadResponse": {
3641
+ "type": "object",
3642
+ "properties": {
3643
+ "address": {
3644
+ "$ref": "#/components/schemas/Address"
3645
+ },
3646
+ "leadId": {
3647
+ "type": "string"
3648
+ },
3649
+ "leadState": {
3650
+ "type": "string"
3651
+ }
3652
+ }
3653
+ },
3654
+ "LogInRequest": {
3655
+ "type": "object",
3656
+ "properties": {
3657
+ "username": {
3658
+ "type": "string"
3659
+ },
3660
+ "password": {
3661
+ "type": "string"
3662
+ }
3663
+ }
3664
+ },
3665
+ "LogInResponse": {
3666
+ "type": "object",
3667
+ "properties": {
3668
+ "sessionToken": {
3669
+ "type": "string"
3670
+ }
3671
+ }
3672
+ },
3673
+ "LogOutRequest": {
3674
+ "type": "object",
3675
+ "properties": {
3676
+ "sessionToken": {
3677
+ "type": "string"
3678
+ }
3679
+ }
3680
+ },
3681
+ "MismatchedDevice": {
3682
+ "type": "object",
3683
+ "properties": {
3684
+ "accountName": {
3685
+ "type": "string"
3686
+ },
3687
+ "mdn": {
3688
+ "type": "string"
3689
+ },
3690
+ "activationDate": {
3691
+ "type": "string"
3692
+ },
3693
+ "iccid": {
3694
+ "type": "string"
3695
+ },
3696
+ "preImei": {
3697
+ "type": "string"
3698
+ },
3699
+ "postImei": {
3700
+ "type": "string"
3701
+ },
3702
+ "simOtaDate": {
3703
+ "type": "string"
3704
+ }
3705
+ }
3706
+ },
3707
+ "MoveDeviceRequest": {
3708
+ "type": "object",
3709
+ "properties": {
3710
+ "accountName": {
3711
+ "type": "string"
3712
+ },
3713
+ "filter": {
3714
+ "$ref": "#/components/schemas/DeviceFilter"
3715
+ },
3716
+ "customFields": {
3717
+ "type": "array",
3718
+ "items": {
3719
+ "$ref": "#/components/schemas/KvPair"
3720
+ }
3721
+ },
3722
+ "devices": {
3723
+ "type": "array",
3724
+ "items": {
3725
+ "$ref": "#/components/schemas/DeviceList"
3726
+ }
3727
+ },
3728
+ "groupName": {
3729
+ "type": "string"
3730
+ },
3731
+ "carrierIpPoolName": {
3732
+ "type": "string"
3733
+ },
3734
+ "servicePlan": {
3735
+ "type": "string"
3736
+ }
3737
+ }
3738
+ },
3739
+ "PlaceOfUse": {
3740
+ "type": "object",
3741
+ "properties": {
3742
+ "address": {
3743
+ "$ref": "#/components/schemas/Address"
3744
+ },
3745
+ "customerName": {
3746
+ "$ref": "#/components/schemas/CustomerName"
3747
+ }
3748
+ }
3749
+ },
3750
+ "ProvisioningHistory": {
3751
+ "type": "object",
3752
+ "properties": {
3753
+ "occurredAt": {
3754
+ "type": "string"
3755
+ },
3756
+ "status": {
3757
+ "type": "string"
3758
+ },
3759
+ "eventBy": {
3760
+ "type": "string"
3761
+ },
3762
+ "eventType": {
3763
+ "type": "string"
3764
+ },
3765
+ "mdn": {
3766
+ "type": "string"
3767
+ },
3768
+ "msisdn": {
3769
+ "type": "string"
3770
+ },
3771
+ "servicePlan": {
3772
+ "type": "string"
3773
+ },
3774
+ "extendedAttributes": {
3775
+ "type": "array",
3776
+ "items": {
3777
+ "$ref": "#/components/schemas/KvPair"
3778
+ }
3779
+ }
3780
+ }
3781
+ },
3782
+ "RegisterCallbackRequest": {
3783
+ "type": "object",
3784
+ "properties": {
3785
+ "name": {
3786
+ "type": "string"
3787
+ },
3788
+ "url": {
3789
+ "type": "string"
3790
+ },
3791
+ "username": {
3792
+ "type": "string"
3793
+ },
3794
+ "password": {
3795
+ "type": "string"
3796
+ }
3797
+ }
3798
+ },
3799
+ "RequestResponse": {
3800
+ "type": "object",
3801
+ "properties": {
3802
+ "requestId": {
3803
+ "type": "string"
3804
+ }
3805
+ }
3806
+ },
3807
+ "RequestStatusResponse": {
3808
+ "type": "object",
3809
+ "properties": {
3810
+ "requestId": {
3811
+ "type": "string"
3812
+ },
3813
+ "status": {
3814
+ "type": "string",
3815
+ "enum": [
3816
+ "Pending",
3817
+ "Success",
3818
+ "Failed"
3819
+ ]
3820
+ }
3821
+ }
3822
+ },
3823
+ "RestErrorResponse": {
3824
+ "type": "object",
3825
+ "properties": {
3826
+ "errorCode": {
3827
+ "type": "string"
3828
+ },
3829
+ "errorMessage": {
3830
+ "type": "string"
3831
+ }
3832
+ }
3833
+ },
3834
+ "RestSuccessResponse": {
3835
+ "type": "object",
3836
+ "properties": {
3837
+ "success": {
3838
+ "type": "boolean"
3839
+ }
3840
+ }
3841
+ },
3842
+ "ServicePlanResponse": {
3843
+ "type": "object",
3844
+ "properties": {
3845
+ "carrierServicePlanCode": {
3846
+ "type": "string"
3847
+ },
3848
+ "code": {
3849
+ "type": "string"
3850
+ },
3851
+ "extendedAttributes": {
3852
+ "type": "array",
3853
+ "items": {
3854
+ "$ref": "#/components/schemas/KvPair"
3855
+ }
3856
+ },
3857
+ "name": {
3858
+ "type": "string"
3859
+ },
3860
+ "sizeKb": {
3861
+ "type": "integer",
3862
+ "format": "int64"
3863
+ }
3864
+ }
3865
+ },
3866
+ "ServicePlanUpdateRequest": {
3867
+ "type": "object",
3868
+ "properties": {
3869
+ "accountName": {
3870
+ "type": "string"
3871
+ },
3872
+ "currentServicePlan": {
3873
+ "type": "string"
3874
+ },
3875
+ "customFields": {
3876
+ "type": "array",
3877
+ "items": {
3878
+ "$ref": "#/components/schemas/KvPair"
3879
+ }
3880
+ },
3881
+ "devices": {
3882
+ "type": "array",
3883
+ "items": {
3884
+ "$ref": "#/components/schemas/DeviceList"
3885
+ }
3886
+ },
3887
+ "groupName": {
3888
+ "type": "string"
3889
+ },
3890
+ "servicePlan": {
3891
+ "type": "string"
3892
+ }
3893
+ }
3894
+ },
3895
+ "SessionResetPasswordRequest": {
3896
+ "type": "object",
3897
+ "properties": {
3898
+ "oldPassword": {
3899
+ "type": "string"
3900
+ }
3901
+ }
3902
+ },
3903
+ "SessionResetPasswordResponse": {
3904
+ "type": "object",
3905
+ "properties": {
3906
+ "newPassword": {
3907
+ "type": "string"
3908
+ }
3909
+ }
3910
+ },
3911
+ "SmsMessage": {
3912
+ "type": "object",
3913
+ "properties": {
3914
+ "deviceIds": {
3915
+ "type": "array",
3916
+ "items": {
3917
+ "$ref": "#/components/schemas/DeviceId"
3918
+ }
3919
+ },
3920
+ "message": {
3921
+ "type": "string"
3922
+ },
3923
+ "timestamp": {
3924
+ "type": "string"
3925
+ }
3926
+ }
3927
+ },
3928
+ "SmsMessagesResponse": {
3929
+ "type": "object",
3930
+ "properties": {
3931
+ "hasMoreData": {
3932
+ "type": "boolean"
3933
+ },
3934
+ "messages": {
3935
+ "type": "array",
3936
+ "items": {
3937
+ "$ref": "#/components/schemas/SmsMessage"
3938
+ }
3939
+ }
3940
+ }
3941
+ },
3942
+ "SMSSendRequest": {
3943
+ "type": "object",
3944
+ "properties": {
3945
+ "accountName": {
3946
+ "type": "string"
3947
+ },
3948
+ "customFields": {
3949
+ "type": "array",
3950
+ "items": {
3951
+ "$ref": "#/components/schemas/KvPair"
3952
+ }
3953
+ },
3954
+ "dataEncoding": {
3955
+ "type": "string"
3956
+ },
3957
+ "deviceIds": {
3958
+ "type": "array",
3959
+ "items": {
3960
+ "$ref": "#/components/schemas/DeviceId"
3961
+ }
3962
+ },
3963
+ "groupName": {
3964
+ "type": "string"
3965
+ },
3966
+ "servicePlan": {
3967
+ "type": "string"
3968
+ },
3969
+ "smsMessage": {
3970
+ "type": "string"
3971
+ }
3972
+ }
3973
+ },
3974
+ "Usage": {
3975
+ "type": "object",
3976
+ "properties": {
3977
+ "bytesUsed": {
3978
+ "type": "integer",
3979
+ "format": "int64"
3980
+ },
3981
+ "extendedAttributes": {
3982
+ "type": "array",
3983
+ "items": {
3984
+ "$ref": "#/components/schemas/KvPair"
3985
+ }
3986
+ },
3987
+ "servicePlan": {
3988
+ "type": "string"
3989
+ },
3990
+ "smsUsed": {
3991
+ "type": "integer",
3992
+ "format": "int32"
3993
+ },
3994
+ "source": {
3995
+ "type": "string"
3996
+ },
3997
+ "timestamp": {
3998
+ "type": "string"
3999
+ }
4000
+ }
4001
+ }
4002
+ },
4003
+ "securitySchemes": {
4004
+ "thingspace_oauth": {
4005
+ "type": "oauth2",
4006
+ "flows": {
4007
+ "clientCredentials": {
4008
+ "tokenUrl": "https://thingspace.verizon.com/api/ts/v1/oauth2/token",
4009
+ "scopes": {}
4010
+ }
4011
+ }
4012
+ },
4013
+ "bearer_authorization": {
4014
+ "type": "apiKey",
4015
+ "name": "Authorization",
4016
+ "in": "header"
4017
+ }
4018
+ }
4019
+ }
4020
+ }