losant_rest 1.0.8 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (84) hide show
  1. checksums.yaml +4 -4
  2. data/.ruby-version +1 -0
  3. data/.travis.yml +3 -2
  4. data/README.md +19 -8
  5. data/docs/_schemas.md +210 -184
  6. data/docs/application.md +20 -0
  7. data/docs/applicationApiToken.md +130 -0
  8. data/docs/applicationApiTokens.md +83 -0
  9. data/docs/applicationKey.md +15 -0
  10. data/docs/applicationKeys.md +10 -0
  11. data/docs/applications.md +10 -0
  12. data/docs/auditLog.md +5 -0
  13. data/docs/auditLogs.md +5 -0
  14. data/docs/auth.md +20 -8
  15. data/docs/dashboard.md +13 -0
  16. data/docs/dashboards.md +10 -0
  17. data/docs/data.md +10 -0
  18. data/docs/device.md +55 -0
  19. data/docs/deviceRecipe.md +20 -0
  20. data/docs/deviceRecipes.md +10 -0
  21. data/docs/devices.md +20 -0
  22. data/docs/event.md +15 -0
  23. data/docs/events.md +20 -0
  24. data/docs/flow.md +35 -0
  25. data/docs/flows.md +10 -0
  26. data/docs/me.md +61 -0
  27. data/docs/org.md +51 -0
  28. data/docs/orgInvites.md +6 -0
  29. data/docs/orgs.md +11 -0
  30. data/docs/solution.md +15 -0
  31. data/docs/solutionUser.md +15 -0
  32. data/docs/solutionUsers.md +10 -0
  33. data/docs/solutions.md +10 -0
  34. data/docs/webhook.md +15 -0
  35. data/docs/webhooks.md +10 -0
  36. data/lib/losant_rest.rb +2 -2
  37. data/lib/losant_rest/application.rb +24 -0
  38. data/lib/losant_rest/{access_token.rb → application_api_token.rb} +47 -23
  39. data/lib/losant_rest/{access_tokens.rb → application_api_tokens.rb} +27 -11
  40. data/lib/losant_rest/application_key.rb +18 -0
  41. data/lib/losant_rest/application_keys.rb +12 -0
  42. data/lib/losant_rest/applications.rb +12 -0
  43. data/lib/losant_rest/audit_log.rb +6 -0
  44. data/lib/losant_rest/audit_logs.rb +6 -0
  45. data/lib/losant_rest/auth.rb +20 -8
  46. data/lib/losant_rest/client.rb +8 -8
  47. data/lib/losant_rest/dashboard.rb +15 -0
  48. data/lib/losant_rest/dashboards.rb +12 -0
  49. data/lib/losant_rest/data.rb +12 -0
  50. data/lib/losant_rest/device.rb +66 -0
  51. data/lib/losant_rest/device_recipe.rb +24 -0
  52. data/lib/losant_rest/device_recipes.rb +12 -0
  53. data/lib/losant_rest/devices.rb +24 -0
  54. data/lib/losant_rest/event.rb +18 -0
  55. data/lib/losant_rest/events.rb +24 -0
  56. data/lib/losant_rest/flow.rb +42 -0
  57. data/lib/losant_rest/flows.rb +12 -0
  58. data/lib/losant_rest/me.rb +74 -0
  59. data/lib/losant_rest/org.rb +62 -0
  60. data/lib/losant_rest/org_invites.rb +6 -0
  61. data/lib/losant_rest/orgs.rb +14 -0
  62. data/lib/losant_rest/solution.rb +18 -0
  63. data/lib/losant_rest/solution_user.rb +18 -0
  64. data/lib/losant_rest/solution_users.rb +12 -0
  65. data/lib/losant_rest/solutions.rb +12 -0
  66. data/lib/losant_rest/version.rb +1 -1
  67. data/lib/losant_rest/webhook.rb +18 -0
  68. data/lib/losant_rest/webhooks.rb +12 -0
  69. data/losant_rest.gemspec +3 -3
  70. data/schemas/{accessToken.json → apiToken.json} +31 -3
  71. data/schemas/{accessTokenPatch.json → apiTokenPatch.json} +4 -0
  72. data/schemas/applicationApiTokenPost.json +116 -0
  73. data/schemas/auditLog.json +3 -1
  74. data/schemas/auditLogFilter.json +3 -1
  75. data/schemas/auditLogs.json +3 -1
  76. data/schemas/event.json +4 -2
  77. data/schemas/events.json +4 -2
  78. metadata +17 -19
  79. data/.rbenv-version +0 -1
  80. data/docs/accessToken.md +0 -107
  81. data/docs/accessTokens.md +0 -68
  82. data/schemas/accessTokenPost.json +0 -32
  83. data/schemas/accessTokens.json +0 -65
  84. data/schemas/deviceState.json +0 -31
@@ -22,6 +22,11 @@ result = client.dashboard.delete(dashboardId: my_dashboard_id)
22
22
  puts result
23
23
  ```
24
24
 
25
+ #### Authentication
26
+ The client must be configured with a valid api access token to call this
27
+ action. The token must include at least one of the following scopes:
28
+ all.Organization, all.User, dashboard.*, or dashboard.delete.
29
+
25
30
  #### Available Parameters
26
31
 
27
32
  | Name | Type | Required | Description | Default | Example |
@@ -53,6 +58,9 @@ result = client.dashboard.get(dashboardId: my_dashboard_id)
53
58
  puts result
54
59
  ```
55
60
 
61
+ #### Authentication
62
+ No api access token is required to call this action.
63
+
56
64
  #### Available Parameters
57
65
 
58
66
  | Name | Type | Required | Description | Default | Example |
@@ -87,6 +95,11 @@ result = client.dashboard.patch(
87
95
  puts result
88
96
  ```
89
97
 
98
+ #### Authentication
99
+ The client must be configured with a valid api access token to call this
100
+ action. The token must include at least one of the following scopes:
101
+ all.Organization, all.User, dashboard.*, or dashboard.patch.
102
+
90
103
  #### Available Parameters
91
104
 
92
105
  | Name | Type | Required | Description | Default | Example |
@@ -21,6 +21,11 @@ result = client.dashboards.get(optional_params)
21
21
  puts result
22
22
  ```
23
23
 
24
+ #### Authentication
25
+ The client must be configured with a valid api access token to call this
26
+ action. The token must include at least one of the following scopes:
27
+ all.Organization, all.SolutionUser, all.SolutionUser.read, all.User, dashboards.*, or dashboards.get.
28
+
24
29
  #### Available Parameters
25
30
 
26
31
  | Name | Type | Required | Description | Default | Example |
@@ -57,6 +62,11 @@ result = client.dashboards.post(dashboard: my_dashboard)
57
62
  puts result
58
63
  ```
59
64
 
65
+ #### Authentication
66
+ The client must be configured with a valid api access token to call this
67
+ action. The token must include at least one of the following scopes:
68
+ all.Organization, all.User, dashboards.*, or dashboards.post.
69
+
60
70
  #### Available Parameters
61
71
 
62
72
  | Name | Type | Required | Description | Default | Example |
@@ -23,6 +23,11 @@ result = client.data.last_value_query(
23
23
  puts result
24
24
  ```
25
25
 
26
+ #### Authentication
27
+ The client must be configured with a valid api access token to call this
28
+ action. The token must include at least one of the following scopes:
29
+ all.Application, all.Application.read, all.Device, all.Device.read, all.Organization, all.Organization.read, all.User, all.User.read, data.*, or data.lastValueQuery.
30
+
26
31
  #### Available Parameters
27
32
 
28
33
  | Name | Type | Required | Description | Default | Example |
@@ -57,6 +62,11 @@ result = client.data.time_series_query(
57
62
  puts result
58
63
  ```
59
64
 
65
+ #### Authentication
66
+ The client must be configured with a valid api access token to call this
67
+ action. The token must include at least one of the following scopes:
68
+ all.Application, all.Application.read, all.Device, all.Device.read, all.Organization, all.Organization.read, all.User, all.User.read, data.*, or data.timeSeriesQuery.
69
+
60
70
  #### Available Parameters
61
71
 
62
72
  | Name | Type | Required | Description | Default | Example |
@@ -32,6 +32,11 @@ result = client.device.delete(
32
32
  puts result
33
33
  ```
34
34
 
35
+ #### Authentication
36
+ The client must be configured with a valid api access token to call this
37
+ action. The token must include at least one of the following scopes:
38
+ all.Application, all.Organization, all.User, device.*, or device.delete.
39
+
35
40
  #### Available Parameters
36
41
 
37
42
  | Name | Type | Required | Description | Default | Example |
@@ -66,6 +71,11 @@ result = client.device.export(
66
71
  puts result
67
72
  ```
68
73
 
74
+ #### Authentication
75
+ The client must be configured with a valid api access token to call this
76
+ action. The token must include at least one of the following scopes:
77
+ all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, device.*, or device.export.
78
+
69
79
  #### Available Parameters
70
80
 
71
81
  | Name | Type | Required | Description | Default | Example |
@@ -104,6 +114,11 @@ result = client.device.get(
104
114
  puts result
105
115
  ```
106
116
 
117
+ #### Authentication
118
+ The client must be configured with a valid api access token to call this
119
+ action. The token must include at least one of the following scopes:
120
+ all.Application, all.Application.read, all.Device, all.Device.read, all.Organization, all.Organization.read, all.User, all.User.read, device.*, or device.get.
121
+
107
122
  #### Available Parameters
108
123
 
109
124
  | Name | Type | Required | Description | Default | Example |
@@ -138,6 +153,11 @@ result = client.device.get_command(
138
153
  puts result
139
154
  ```
140
155
 
156
+ #### Authentication
157
+ The client must be configured with a valid api access token to call this
158
+ action. The token must include at least one of the following scopes:
159
+ all.Application, all.Application.read, all.Device, all.Device.read, all.Organization, all.Organization.read, all.User, all.User.read, device.*, or device.getCommand.
160
+
141
161
  #### Available Parameters
142
162
 
143
163
  | Name | Type | Required | Description | Default | Example |
@@ -174,6 +194,11 @@ result = client.device.get_composite_state(
174
194
  puts result
175
195
  ```
176
196
 
197
+ #### Authentication
198
+ The client must be configured with a valid api access token to call this
199
+ action. The token must include at least one of the following scopes:
200
+ all.Application, all.Application.read, all.Device, all.Device.read, all.Organization, all.Organization.read, all.User, all.User.read, device.*, or device.getCompositeState.
201
+
177
202
  #### Available Parameters
178
203
 
179
204
  | Name | Type | Required | Description | Default | Example |
@@ -210,6 +235,11 @@ result = client.device.get_log_entries(
210
235
  puts result
211
236
  ```
212
237
 
238
+ #### Authentication
239
+ The client must be configured with a valid api access token to call this
240
+ action. The token must include at least one of the following scopes:
241
+ all.Application, all.Application.read, all.Device, all.Device.read, all.Organization, all.Organization.read, all.User, all.User.read, device.*, or device.getLogEntries.
242
+
213
243
  #### Available Parameters
214
244
 
215
245
  | Name | Type | Required | Description | Default | Example |
@@ -246,6 +276,11 @@ result = client.device.get_state(
246
276
  puts result
247
277
  ```
248
278
 
279
+ #### Authentication
280
+ The client must be configured with a valid api access token to call this
281
+ action. The token must include at least one of the following scopes:
282
+ all.Application, all.Application.read, all.Device, all.Device.read, all.Organization, all.Organization.read, all.User, all.User.read, device.*, or device.getState.
283
+
249
284
  #### Available Parameters
250
285
 
251
286
  | Name | Type | Required | Description | Default | Example |
@@ -283,6 +318,11 @@ result = client.device.patch(
283
318
  puts result
284
319
  ```
285
320
 
321
+ #### Authentication
322
+ The client must be configured with a valid api access token to call this
323
+ action. The token must include at least one of the following scopes:
324
+ all.Application, all.Organization, all.User, device.*, or device.patch.
325
+
286
326
  #### Available Parameters
287
327
 
288
328
  | Name | Type | Required | Description | Default | Example |
@@ -318,6 +358,11 @@ result = client.device.remove_data(
318
358
  puts result
319
359
  ```
320
360
 
361
+ #### Authentication
362
+ The client must be configured with a valid api access token to call this
363
+ action. The token must include at least one of the following scopes:
364
+ all.Application, all.Organization, all.User, device.*, or device.removeData.
365
+
321
366
  #### Available Parameters
322
367
 
323
368
  | Name | Type | Required | Description | Default | Example |
@@ -355,6 +400,11 @@ result = client.device.send_command(
355
400
  puts result
356
401
  ```
357
402
 
403
+ #### Authentication
404
+ The client must be configured with a valid api access token to call this
405
+ action. The token must include at least one of the following scopes:
406
+ all.Application, all.Device, all.Organization, all.User, device.*, or device.sendCommand.
407
+
358
408
  #### Available Parameters
359
409
 
360
410
  | Name | Type | Required | Description | Default | Example |
@@ -391,6 +441,11 @@ result = client.device.send_state(
391
441
  puts result
392
442
  ```
393
443
 
444
+ #### Authentication
445
+ The client must be configured with a valid api access token to call this
446
+ action. The token must include at least one of the following scopes:
447
+ all.Application, all.Device, all.Organization, all.User, device.*, or device.sendState.
448
+
394
449
  #### Available Parameters
395
450
 
396
451
  | Name | Type | Required | Description | Default | Example |
@@ -26,6 +26,11 @@ result = client.device_recipe.bulk_create(
26
26
  puts result
27
27
  ```
28
28
 
29
+ #### Authentication
30
+ The client must be configured with a valid api access token to call this
31
+ action. The token must include at least one of the following scopes:
32
+ all.Application, all.Organization, all.User, deviceRecipe.*, or deviceRecipe.bulkCreate.
33
+
29
34
  #### Available Parameters
30
35
 
31
36
  | Name | Type | Required | Description | Default | Example |
@@ -61,6 +66,11 @@ result = client.device_recipe.delete(
61
66
  puts result
62
67
  ```
63
68
 
69
+ #### Authentication
70
+ The client must be configured with a valid api access token to call this
71
+ action. The token must include at least one of the following scopes:
72
+ all.Application, all.Organization, all.User, deviceRecipe.*, or deviceRecipe.delete.
73
+
64
74
  #### Available Parameters
65
75
 
66
76
  | Name | Type | Required | Description | Default | Example |
@@ -95,6 +105,11 @@ result = client.device_recipe.get(
95
105
  puts result
96
106
  ```
97
107
 
108
+ #### Authentication
109
+ The client must be configured with a valid api access token to call this
110
+ action. The token must include at least one of the following scopes:
111
+ all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, deviceRecipe.*, or deviceRecipe.get.
112
+
98
113
  #### Available Parameters
99
114
 
100
115
  | Name | Type | Required | Description | Default | Example |
@@ -130,6 +145,11 @@ result = client.device_recipe.patch(
130
145
  puts result
131
146
  ```
132
147
 
148
+ #### Authentication
149
+ The client must be configured with a valid api access token to call this
150
+ action. The token must include at least one of the following scopes:
151
+ all.Application, all.Organization, all.User, deviceRecipe.*, or deviceRecipe.patch.
152
+
133
153
  #### Available Parameters
134
154
 
135
155
  | Name | Type | Required | Description | Default | Example |
@@ -21,6 +21,11 @@ result = client.device_recipes.get(applicationId: my_application_id)
21
21
  puts result
22
22
  ```
23
23
 
24
+ #### Authentication
25
+ The client must be configured with a valid api access token to call this
26
+ action. The token must include at least one of the following scopes:
27
+ all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, deviceRecipes.*, or deviceRecipes.get.
28
+
24
29
  #### Available Parameters
25
30
 
26
31
  | Name | Type | Required | Description | Default | Example |
@@ -60,6 +65,11 @@ result = client.device_recipes.post(
60
65
  puts result
61
66
  ```
62
67
 
68
+ #### Authentication
69
+ The client must be configured with a valid api access token to call this
70
+ action. The token must include at least one of the following scopes:
71
+ all.Application, all.Organization, all.User, deviceRecipes.*, or deviceRecipes.post.
72
+
63
73
  #### Available Parameters
64
74
 
65
75
  | Name | Type | Required | Description | Default | Example |
@@ -23,6 +23,11 @@ result = client.devices.export(applicationId: my_application_id)
23
23
  puts result
24
24
  ```
25
25
 
26
+ #### Authentication
27
+ The client must be configured with a valid api access token to call this
28
+ action. The token must include at least one of the following scopes:
29
+ all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, devices.*, or devices.export.
30
+
26
31
  #### Available Parameters
27
32
 
28
33
  | Name | Type | Required | Description | Default | Example |
@@ -56,6 +61,11 @@ result = client.devices.get(applicationId: my_application_id)
56
61
  puts result
57
62
  ```
58
63
 
64
+ #### Authentication
65
+ The client must be configured with a valid api access token to call this
66
+ action. The token must include at least one of the following scopes:
67
+ all.Application, all.Application.read, all.Device, all.Device.read, all.Organization, all.Organization.read, all.User, all.User.read, devices.*, or devices.get.
68
+
59
69
  #### Available Parameters
60
70
 
61
71
  | Name | Type | Required | Description | Default | Example |
@@ -96,6 +106,11 @@ result = client.devices.post(
96
106
  puts result
97
107
  ```
98
108
 
109
+ #### Authentication
110
+ The client must be configured with a valid api access token to call this
111
+ action. The token must include at least one of the following scopes:
112
+ all.Application, all.Organization, all.User, devices.*, or devices.post.
113
+
99
114
  #### Available Parameters
100
115
 
101
116
  | Name | Type | Required | Description | Default | Example |
@@ -130,6 +145,11 @@ result = client.devices.send_command(
130
145
  puts result
131
146
  ```
132
147
 
148
+ #### Authentication
149
+ The client must be configured with a valid api access token to call this
150
+ action. The token must include at least one of the following scopes:
151
+ all.Application, all.Device, all.Organization, all.User, devices.*, or devices.sendCommand.
152
+
133
153
  #### Available Parameters
134
154
 
135
155
  | Name | Type | Required | Description | Default | Example |
@@ -24,6 +24,11 @@ result = client.event.delete(
24
24
  puts result
25
25
  ```
26
26
 
27
+ #### Authentication
28
+ The client must be configured with a valid api access token to call this
29
+ action. The token must include at least one of the following scopes:
30
+ all.Application, all.Organization, all.User, event.*, or event.delete.
31
+
27
32
  #### Available Parameters
28
33
 
29
34
  | Name | Type | Required | Description | Default | Example |
@@ -58,6 +63,11 @@ result = client.event.get(
58
63
  puts result
59
64
  ```
60
65
 
66
+ #### Authentication
67
+ The client must be configured with a valid api access token to call this
68
+ action. The token must include at least one of the following scopes:
69
+ all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, event.*, or event.get.
70
+
61
71
  #### Available Parameters
62
72
 
63
73
  | Name | Type | Required | Description | Default | Example |
@@ -93,6 +103,11 @@ result = client.event.patch(
93
103
  puts result
94
104
  ```
95
105
 
106
+ #### Authentication
107
+ The client must be configured with a valid api access token to call this
108
+ action. The token must include at least one of the following scopes:
109
+ all.Application, all.Organization, all.User, event.*, or event.patch.
110
+
96
111
  #### Available Parameters
97
112
 
98
113
  | Name | Type | Required | Description | Default | Example |
@@ -23,6 +23,11 @@ result = client.events.get(applicationId: my_application_id)
23
23
  puts result
24
24
  ```
25
25
 
26
+ #### Authentication
27
+ The client must be configured with a valid api access token to call this
28
+ action. The token must include at least one of the following scopes:
29
+ all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, events.*, or events.get.
30
+
26
31
  #### Available Parameters
27
32
 
28
33
  | Name | Type | Required | Description | Default | Example |
@@ -61,6 +66,11 @@ result = client.events.most_recent_by_severity(applicationId: my_application_id)
61
66
  puts result
62
67
  ```
63
68
 
69
+ #### Authentication
70
+ The client must be configured with a valid api access token to call this
71
+ action. The token must include at least one of the following scopes:
72
+ all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, events.*, or events.mostRecentBySeverity.
73
+
64
74
  #### Available Parameters
65
75
 
66
76
  | Name | Type | Required | Description | Default | Example |
@@ -94,6 +104,11 @@ result = client.events.patch(
94
104
  puts result
95
105
  ```
96
106
 
107
+ #### Authentication
108
+ The client must be configured with a valid api access token to call this
109
+ action. The token must include at least one of the following scopes:
110
+ all.Application, all.Organization, all.User, events.*, or events.patch.
111
+
97
112
  #### Available Parameters
98
113
 
99
114
  | Name | Type | Required | Description | Default | Example |
@@ -131,6 +146,11 @@ result = client.events.post(
131
146
  puts result
132
147
  ```
133
148
 
149
+ #### Authentication
150
+ The client must be configured with a valid api access token to call this
151
+ action. The token must include at least one of the following scopes:
152
+ all.Application, all.Organization, all.User, events.*, or events.post.
153
+
134
154
  #### Available Parameters
135
155
 
136
156
  | Name | Type | Required | Description | Default | Example |
@@ -28,6 +28,11 @@ result = client.flow.delete(
28
28
  puts result
29
29
  ```
30
30
 
31
+ #### Authentication
32
+ The client must be configured with a valid api access token to call this
33
+ action. The token must include at least one of the following scopes:
34
+ all.Application, all.Organization, all.User, flow.*, or flow.delete.
35
+
31
36
  #### Available Parameters
32
37
 
33
38
  | Name | Type | Required | Description | Default | Example |
@@ -62,6 +67,11 @@ result = client.flow.get(
62
67
  puts result
63
68
  ```
64
69
 
70
+ #### Authentication
71
+ The client must be configured with a valid api access token to call this
72
+ action. The token must include at least one of the following scopes:
73
+ all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, flow.*, or flow.get.
74
+
65
75
  #### Available Parameters
66
76
 
67
77
  | Name | Type | Required | Description | Default | Example |
@@ -96,6 +106,11 @@ result = client.flow.get_log_entries(
96
106
  puts result
97
107
  ```
98
108
 
109
+ #### Authentication
110
+ The client must be configured with a valid api access token to call this
111
+ action. The token must include at least one of the following scopes:
112
+ all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, flow.*, or flow.log.
113
+
99
114
  #### Available Parameters
100
115
 
101
116
  | Name | Type | Required | Description | Default | Example |
@@ -132,6 +147,11 @@ result = client.flow.get_storage_entries(
132
147
  puts result
133
148
  ```
134
149
 
150
+ #### Authentication
151
+ The client must be configured with a valid api access token to call this
152
+ action. The token must include at least one of the following scopes:
153
+ all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, flow.*, or flow.getStorageEntries.
154
+
135
155
  #### Available Parameters
136
156
 
137
157
  | Name | Type | Required | Description | Default | Example |
@@ -167,6 +187,11 @@ result = client.flow.patch(
167
187
  puts result
168
188
  ```
169
189
 
190
+ #### Authentication
191
+ The client must be configured with a valid api access token to call this
192
+ action. The token must include at least one of the following scopes:
193
+ all.Application, all.Organization, all.User, flow.*, or flow.patch.
194
+
170
195
  #### Available Parameters
171
196
 
172
197
  | Name | Type | Required | Description | Default | Example |
@@ -203,6 +228,11 @@ result = client.flow.press_virtual_button(
203
228
  puts result
204
229
  ```
205
230
 
231
+ #### Authentication
232
+ The client must be configured with a valid api access token to call this
233
+ action. The token must include at least one of the following scopes:
234
+ all.Application, all.Organization, all.User, flow.*, or flow.pressVirtualButton.
235
+
206
236
  #### Available Parameters
207
237
 
208
238
  | Name | Type | Required | Description | Default | Example |
@@ -239,6 +269,11 @@ result = client.flow.set_storage_entry(
239
269
  puts result
240
270
  ```
241
271
 
272
+ #### Authentication
273
+ The client must be configured with a valid api access token to call this
274
+ action. The token must include at least one of the following scopes:
275
+ all.Application, all.Organization, all.User, flow.*, or flow.setStorageEntry.
276
+
242
277
  #### Available Parameters
243
278
 
244
279
  | Name | Type | Required | Description | Default | Example |