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