losant_rest 1.17.3 → 1.17.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (54) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +19420 -12740
  3. data/docs/application.md +80 -0
  4. data/docs/applicationDashboard.md +1 -1
  5. data/docs/dashboard.md +1 -0
  6. data/docs/flow.md +1 -1
  7. data/docs/instance.md +80 -0
  8. data/docs/instanceOrg.md +86 -0
  9. data/docs/me.md +76 -0
  10. data/docs/notebook.md +43 -0
  11. data/docs/org.md +80 -0
  12. data/lib/losant_rest/application.rb +96 -0
  13. data/lib/losant_rest/application_dashboard.rb +1 -1
  14. data/lib/losant_rest/client.rb +2 -2
  15. data/lib/losant_rest/dashboard.rb +2 -0
  16. data/lib/losant_rest/flow.rb +1 -1
  17. data/lib/losant_rest/instance.rb +96 -0
  18. data/lib/losant_rest/instance_org.rb +100 -0
  19. data/lib/losant_rest/me.rb +90 -0
  20. data/lib/losant_rest/notebook.rb +50 -0
  21. data/lib/losant_rest/org.rb +96 -0
  22. data/lib/losant_rest/version.rb +1 -1
  23. data/schemas/apiTokenPost.json +11 -0
  24. data/schemas/applicationDashboardPost.json +41 -7
  25. data/schemas/dashboard.json +65 -7
  26. data/schemas/dashboardPatch.json +41 -7
  27. data/schemas/dashboardPost.json +41 -7
  28. data/schemas/dashboards.json +65 -7
  29. data/schemas/dataExport.json +1467 -9
  30. data/schemas/deviceCounts.json +35 -0
  31. data/schemas/edgeDeployment.json +25 -0
  32. data/schemas/edgeDeployments.json +25 -0
  33. data/schemas/experienceLinkedResources.json +279 -0
  34. data/schemas/flow.json +93 -0
  35. data/schemas/flowPatch.json +93 -0
  36. data/schemas/flowPost.json +93 -0
  37. data/schemas/flowVersion.json +186 -0
  38. data/schemas/flowVersionPost.json +93 -0
  39. data/schemas/flowVersions.json +186 -0
  40. data/schemas/flows.json +93 -0
  41. data/schemas/flowsImportPost.json +186 -0
  42. data/schemas/flowsImportResult.json +279 -0
  43. data/schemas/githubLogin.json +11 -0
  44. data/schemas/integration.json +10 -10
  45. data/schemas/integrationPatch.json +10 -10
  46. data/schemas/integrationPost.json +10 -10
  47. data/schemas/integrations.json +10 -10
  48. data/schemas/lastValueQuery.json +1598 -6
  49. data/schemas/notebookMinuteCounts.json +41 -0
  50. data/schemas/samlResponse.json +11 -0
  51. data/schemas/timeSeriesQuery.json +1599 -7
  52. data/schemas/userCredentials.json +11 -0
  53. data/schemas/userPost.json +11 -0
  54. metadata +4 -2
data/docs/application.md CHANGED
@@ -11,6 +11,7 @@ parameters and the potential responses.
11
11
  * [Backfill Archive Data](#backfill-archive-data)
12
12
  * [Clone](#clone)
13
13
  * [Delete](#delete)
14
+ * [Device Counts](#device-counts)
14
15
  * [Export](#export)
15
16
  * [Full Data Tables Archive](#full-data-tables-archive)
16
17
  * [Full Events Archive](#full-events-archive)
@@ -18,6 +19,7 @@ parameters and the potential responses.
18
19
  * [Globals](#globals)
19
20
  * [Import](#import)
20
21
  * [Mqtt Publish Message](#mqtt-publish-message)
22
+ * [Notebook Minute Counts](#notebook-minute-counts)
21
23
  * [Patch](#patch)
22
24
  * [Payload Counts](#payload-counts)
23
25
  * [Readme](#readme)
@@ -222,6 +224,45 @@ all.Application, all.Organization, all.User, application.*, or application.delet
222
224
 
223
225
  <br/>
224
226
 
227
+ ## Device Counts
228
+
229
+ Returns device counts by day for the time range specified for this application
230
+
231
+ ```ruby
232
+ result = client.application.device_counts(applicationId: my_application_id)
233
+
234
+ puts result
235
+ ```
236
+
237
+ #### Authentication
238
+ The client must be configured with a valid api access token to call this
239
+ action. The token must include at least one of the following scopes:
240
+ all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, application.*, or application.deviceCounts.
241
+
242
+ #### Available Parameters
243
+
244
+ | Name | Type | Required | Description | Default | Example |
245
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
246
+ | applicationId | string | Y | ID of the associated application | | 575ec8687ae143cd83dc4a97 |
247
+ | start | string | N | Start of range for device count query (ms since epoch) | | 0 |
248
+ | end | string | N | End of range for device count query (ms since epoch) | | 1465790400000 |
249
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
250
+
251
+ #### Successful Responses
252
+
253
+ | Code | Type | Description |
254
+ | ---- | ---- | ----------- |
255
+ | 200 | [Device Counts](_schemas.md#device-counts) | Device counts by day |
256
+
257
+ #### Error Responses
258
+
259
+ | Code | Type | Description |
260
+ | ---- | ---- | ----------- |
261
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
262
+ | 404 | [Error](_schemas.md#error) | Error if application was not found |
263
+
264
+ <br/>
265
+
225
266
  ## Export
226
267
 
227
268
  Export an application and all of its resources
@@ -497,6 +538,45 @@ all.Application, all.Organization, all.User, application.*, or application.mqttP
497
538
 
498
539
  <br/>
499
540
 
541
+ ## Notebook Minute Counts
542
+
543
+ Returns notebook execution usage by day for the time range specified for this application
544
+
545
+ ```ruby
546
+ result = client.application.notebook_minute_counts(applicationId: my_application_id)
547
+
548
+ puts result
549
+ ```
550
+
551
+ #### Authentication
552
+ The client must be configured with a valid api access token to call this
553
+ action. The token must include at least one of the following scopes:
554
+ all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, application.*, or application.notebookMinuteCounts.
555
+
556
+ #### Available Parameters
557
+
558
+ | Name | Type | Required | Description | Default | Example |
559
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
560
+ | applicationId | string | Y | ID of the associated application | | 575ec8687ae143cd83dc4a97 |
561
+ | start | string | N | Start of range for notebook execution query (ms since epoch) | | 0 |
562
+ | end | string | N | End of range for notebook execution query (ms since epoch) | | 1465790400000 |
563
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
564
+
565
+ #### Successful Responses
566
+
567
+ | Code | Type | Description |
568
+ | ---- | ---- | ----------- |
569
+ | 200 | [Notebook Minute Counts](_schemas.md#notebook-minute-counts) | Notebook usage information |
570
+
571
+ #### Error Responses
572
+
573
+ | Code | Type | Description |
574
+ | ---- | ---- | ----------- |
575
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
576
+ | 404 | [Error](_schemas.md#error) | Error if application was not found |
577
+
578
+ <br/>
579
+
500
580
  ## Patch
501
581
 
502
582
  Updates information about an application
@@ -166,7 +166,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
166
166
 
167
167
  | Code | Type | Description |
168
168
  | ---- | ---- | ----------- |
169
- | 200 | [Success](_schemas.md#success) | Send dashboard report |
169
+ | 202 | [Job Enqueued API Result](_schemas.md#job-enqueued-api-result) | If dashboard report was enqueued to be sent |
170
170
 
171
171
  #### Error Responses
172
172
 
data/docs/dashboard.md CHANGED
@@ -191,6 +191,7 @@ No api access token is required to call this action.
191
191
  | password | string | N | Password for password-protected dashboards | | myPassword |
192
192
  | duration | string | N | Duration of data to fetch in milliseconds | | 3600000 |
193
193
  | resolution | string | N | Resolution in milliseconds | | 60000 |
194
+ | end | string | N | End timestamp of the data, in ms since epoch | | 1465790400000 |
194
195
  | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
195
196
 
196
197
  #### Successful Responses
data/docs/flow.md CHANGED
@@ -128,7 +128,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
128
128
  | limit | string | N | Maximum number of errors to return | 25 | 25 |
129
129
  | sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | desc | desc |
130
130
  | flowVersion | string | N | Flow version name or ID. When not included, will be errors for all versions. Pass develop for just the develop version. | | develop |
131
- | deviceId | string | N | For edge or embedded workflows, the Device ID to return workflow errors for. When not included, will be errors for all device IDs. | | 575ed18f7ae143cd83dc4bb6 |
131
+ | deviceId | string | N | For edge or embedded workflows, the Device ID for which to return workflow errors. When not included, will be errors for all device IDs. | | 575ed18f7ae143cd83dc4bb6 |
132
132
  | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
133
133
 
134
134
  #### Successful Responses
data/docs/instance.md CHANGED
@@ -6,13 +6,54 @@ parameters and the potential responses.
6
6
 
7
7
  ##### Contents
8
8
 
9
+ * [Device Counts](#device-counts)
9
10
  * [Generate Report](#generate-report)
10
11
  * [Get](#get)
11
12
  * [Historical Summaries](#historical-summaries)
13
+ * [Notebook Minute Counts](#notebook-minute-counts)
12
14
  * [Patch](#patch)
13
15
 
14
16
  <br/>
15
17
 
18
+ ## Device Counts
19
+
20
+ Returns device counts by day for the time range specified for this instance
21
+
22
+ ```ruby
23
+ result = client.instance.device_counts(instanceId: my_instance_id)
24
+
25
+ puts result
26
+ ```
27
+
28
+ #### Authentication
29
+ The client must be configured with a valid api access token to call this
30
+ action. The token must include at least one of the following scopes:
31
+ all.Instance, all.Instance.read, all.User, all.User.read, instance.*, or instance.deviceCounts.
32
+
33
+ #### Available Parameters
34
+
35
+ | Name | Type | Required | Description | Default | Example |
36
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
37
+ | instanceId | string | Y | ID associated with the instance | | 575ec8687ae143cd83dc4a97 |
38
+ | start | string | N | Start of range for device count query (ms since epoch) | | 0 |
39
+ | end | string | N | End of range for device count query (ms since epoch) | | 1465790400000 |
40
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
41
+
42
+ #### Successful Responses
43
+
44
+ | Code | Type | Description |
45
+ | ---- | ---- | ----------- |
46
+ | 200 | [Device Counts](_schemas.md#device-counts) | Device counts by day |
47
+
48
+ #### Error Responses
49
+
50
+ | Code | Type | Description |
51
+ | ---- | ---- | ----------- |
52
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
53
+ | 404 | [Error](_schemas.md#error) | Error if instance was not found |
54
+
55
+ <br/>
56
+
16
57
  ## Generate Report
17
58
 
18
59
  Generates a CSV report on instance stats
@@ -130,6 +171,45 @@ all.Instance, all.Instance.read, all.User, all.User.read, instance.*, or instanc
130
171
 
131
172
  <br/>
132
173
 
174
+ ## Notebook Minute Counts
175
+
176
+ Returns notebook execution usage by day for the time range specified for this instance
177
+
178
+ ```ruby
179
+ result = client.instance.notebook_minute_counts(instanceId: my_instance_id)
180
+
181
+ puts result
182
+ ```
183
+
184
+ #### Authentication
185
+ The client must be configured with a valid api access token to call this
186
+ action. The token must include at least one of the following scopes:
187
+ all.Instance, all.Instance.read, all.User, all.User.read, instance.*, or instance.notebookMinuteCounts.
188
+
189
+ #### Available Parameters
190
+
191
+ | Name | Type | Required | Description | Default | Example |
192
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
193
+ | instanceId | string | Y | ID associated with the instance | | 575ec8687ae143cd83dc4a97 |
194
+ | start | string | N | Start of range for notebook execution query (ms since epoch) | | 0 |
195
+ | end | string | N | End of range for notebook execution query (ms since epoch) | | 1465790400000 |
196
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
197
+
198
+ #### Successful Responses
199
+
200
+ | Code | Type | Description |
201
+ | ---- | ---- | ----------- |
202
+ | 200 | [Notebook Minute Counts](_schemas.md#notebook-minute-counts) | Notebook usage information |
203
+
204
+ #### Error Responses
205
+
206
+ | Code | Type | Description |
207
+ | ---- | ---- | ----------- |
208
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
209
+ | 404 | [Error](_schemas.md#error) | Error if instance was not found |
210
+
211
+ <br/>
212
+
133
213
  ## Patch
134
214
 
135
215
  Updates information about an instance
data/docs/instanceOrg.md CHANGED
@@ -7,7 +7,9 @@ parameters and the potential responses.
7
7
  ##### Contents
8
8
 
9
9
  * [Delete](#delete)
10
+ * [Device Counts](#device-counts)
10
11
  * [Get](#get)
12
+ * [Notebook Minute Counts](#notebook-minute-counts)
11
13
  * [Patch](#patch)
12
14
 
13
15
  <br/>
@@ -52,6 +54,48 @@ all.Instance, all.User, instanceOrg.*, or instanceOrg.delete.
52
54
 
53
55
  <br/>
54
56
 
57
+ ## Device Counts
58
+
59
+ Returns device counts by day for the time range specified for this organization
60
+
61
+ ```ruby
62
+ result = client.instance_org.device_counts(
63
+ instanceId: my_instance_id,
64
+ orgId: my_org_id)
65
+
66
+ puts result
67
+ ```
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.Instance, all.Instance.read, all.User, all.User.read, instanceOrg.*, or instanceOrg.deviceCounts.
73
+
74
+ #### Available Parameters
75
+
76
+ | Name | Type | Required | Description | Default | Example |
77
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
78
+ | instanceId | string | Y | ID associated with the instance | | 575ec8687ae143cd83dc4a97 |
79
+ | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
80
+ | start | string | N | Start of range for device count query (ms since epoch) | | 0 |
81
+ | end | string | N | End of range for device count query (ms since epoch) | 0 | 1465790400000 |
82
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
83
+
84
+ #### Successful Responses
85
+
86
+ | Code | Type | Description |
87
+ | ---- | ---- | ----------- |
88
+ | 200 | [Device Counts](_schemas.md#device-counts) | Device counts by day |
89
+
90
+ #### Error Responses
91
+
92
+ | Code | Type | Description |
93
+ | ---- | ---- | ----------- |
94
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
95
+ | 404 | [Error](_schemas.md#error) | Error if instance or organization was not found |
96
+
97
+ <br/>
98
+
55
99
  ## Get
56
100
 
57
101
  Retrieves information on an organization
@@ -93,6 +137,48 @@ all.Instance, all.Instance.read, all.User, all.User.read, instanceOrg.*, or inst
93
137
 
94
138
  <br/>
95
139
 
140
+ ## Notebook Minute Counts
141
+
142
+ Returns notebook execution usage by day for the time range specified for this organization
143
+
144
+ ```ruby
145
+ result = client.instance_org.notebook_minute_counts(
146
+ instanceId: my_instance_id,
147
+ orgId: my_org_id)
148
+
149
+ puts result
150
+ ```
151
+
152
+ #### Authentication
153
+ The client must be configured with a valid api access token to call this
154
+ action. The token must include at least one of the following scopes:
155
+ all.Instance, all.Instance.read, all.User, all.User.read, instanceOrg.*, or instanceOrg.notebookMinuteCounts.
156
+
157
+ #### Available Parameters
158
+
159
+ | Name | Type | Required | Description | Default | Example |
160
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
161
+ | instanceId | string | Y | ID associated with the instance | | 575ec8687ae143cd83dc4a97 |
162
+ | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
163
+ | start | string | N | Start of range for notebook execution query (ms since epoch) | | 0 |
164
+ | end | string | N | End of range for notebook execution query (ms since epoch) | | 1465790400000 |
165
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
166
+
167
+ #### Successful Responses
168
+
169
+ | Code | Type | Description |
170
+ | ---- | ---- | ----------- |
171
+ | 200 | [Notebook Minute Counts](_schemas.md#notebook-minute-counts) | Notebook usage information |
172
+
173
+ #### Error Responses
174
+
175
+ | Code | Type | Description |
176
+ | ---- | ---- | ----------- |
177
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
178
+ | 404 | [Error](_schemas.md#error) | Error if organization was not found |
179
+
180
+ <br/>
181
+
96
182
  ## Patch
97
183
 
98
184
  Updates information about an organization
data/docs/me.md CHANGED
@@ -9,12 +9,14 @@ parameters and the potential responses.
9
9
  * [Add Recent Item](#add-recent-item)
10
10
  * [Change Password](#change-password)
11
11
  * [Delete](#delete)
12
+ * [Device Counts](#device-counts)
12
13
  * [Disable Two Factor Auth](#disable-two-factor-auth)
13
14
  * [Disconnect Github](#disconnect-github)
14
15
  * [Enable Two Factor Auth](#enable-two-factor-auth)
15
16
  * [Fetch Recent Items](#fetch-recent-items)
16
17
  * [Generate Two Factor Auth](#generate-two-factor-auth)
17
18
  * [Get](#get)
19
+ * [Notebook Minute Counts](#notebook-minute-counts)
18
20
  * [Patch](#patch)
19
21
  * [Payload Counts](#payload-counts)
20
22
  * [Refresh Token](#refresh-token)
@@ -131,6 +133,43 @@ all.User, me.*, or me.delete.
131
133
 
132
134
  <br/>
133
135
 
136
+ ## Device Counts
137
+
138
+ Returns device counts by day for the time range specified for all applications the current user owns
139
+
140
+ ```ruby
141
+ result = client.me.device_counts(optional_params)
142
+
143
+ puts result
144
+ ```
145
+
146
+ #### Authentication
147
+ The client must be configured with a valid api access token to call this
148
+ action. The token must include at least one of the following scopes:
149
+ all.User, all.User.read, me.*, or me.deviceCounts.
150
+
151
+ #### Available Parameters
152
+
153
+ | Name | Type | Required | Description | Default | Example |
154
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
155
+ | start | string | N | Start of range for device count query (ms since epoch) | | 0 |
156
+ | end | string | N | End of range for device count query (ms since epoch) | | 1465790400000 |
157
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
158
+
159
+ #### Successful Responses
160
+
161
+ | Code | Type | Description |
162
+ | ---- | ---- | ----------- |
163
+ | 200 | [Device Counts](_schemas.md#device-counts) | Device counts by day |
164
+
165
+ #### Error Responses
166
+
167
+ | Code | Type | Description |
168
+ | ---- | ---- | ----------- |
169
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
170
+
171
+ <br/>
172
+
134
173
  ## Disable Two Factor Auth
135
174
 
136
175
  Disables two factor auth for the current user
@@ -347,6 +386,43 @@ all.User, all.User.read, me.*, or me.get.
347
386
 
348
387
  <br/>
349
388
 
389
+ ## Notebook Minute Counts
390
+
391
+ Returns notebook execution usage by day for the time range specified for all applications the current user owns
392
+
393
+ ```ruby
394
+ result = client.me.notebook_minute_counts(optional_params)
395
+
396
+ puts result
397
+ ```
398
+
399
+ #### Authentication
400
+ The client must be configured with a valid api access token to call this
401
+ action. The token must include at least one of the following scopes:
402
+ all.User, all.User.read, me.*, or me.notebookMinuteCounts.
403
+
404
+ #### Available Parameters
405
+
406
+ | Name | Type | Required | Description | Default | Example |
407
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
408
+ | start | string | N | Start of range for notebook execution query (ms since epoch) | | 0 |
409
+ | end | string | N | End of range for notebook execution query (ms since epoch) | | 1465790400000 |
410
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
411
+
412
+ #### Successful Responses
413
+
414
+ | Code | Type | Description |
415
+ | ---- | ---- | ----------- |
416
+ | 200 | [Notebook Minute Counts](_schemas.md#notebook-minute-counts) | Notebook usage information |
417
+
418
+ #### Error Responses
419
+
420
+ | Code | Type | Description |
421
+ | ---- | ---- | ----------- |
422
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
423
+
424
+ <br/>
425
+
350
426
  ## Patch
351
427
 
352
428
  Updates information about the current user
data/docs/notebook.md CHANGED
@@ -11,6 +11,7 @@ parameters and the potential responses.
11
11
  * [Execute](#execute)
12
12
  * [Get](#get)
13
13
  * [Logs](#logs)
14
+ * [Notebook Minute Counts](#notebook-minute-counts)
14
15
  * [Patch](#patch)
15
16
  * [Request Input Data Export](#request-input-data-export)
16
17
  * [Upload](#upload)
@@ -223,6 +224,48 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
223
224
 
224
225
  <br/>
225
226
 
227
+ ## Notebook Minute Counts
228
+
229
+ Returns notebook execution usage by day for the time range specified for this notebook
230
+
231
+ ```ruby
232
+ result = client.notebook.notebook_minute_counts(
233
+ applicationId: my_application_id,
234
+ notebookId: my_notebook_id)
235
+
236
+ puts result
237
+ ```
238
+
239
+ #### Authentication
240
+ The client must be configured with a valid api access token to call this
241
+ action. The token must include at least one of the following scopes:
242
+ all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, notebook.*, or notebook.notebookMinuteCounts.
243
+
244
+ #### Available Parameters
245
+
246
+ | Name | Type | Required | Description | Default | Example |
247
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
248
+ | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
249
+ | notebookId | string | Y | ID associated with the notebook | | 575ed78e7ae143cd83dc4aab |
250
+ | start | string | N | Start of range for notebook execution query (ms since epoch) | | 0 |
251
+ | end | string | N | End of range for notebook execution query (ms since epoch) | | 1465790400000 |
252
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
253
+
254
+ #### Successful Responses
255
+
256
+ | Code | Type | Description |
257
+ | ---- | ---- | ----------- |
258
+ | 200 | [Notebook Minute Counts](_schemas.md#notebook-minute-counts) | Notebook usage information |
259
+
260
+ #### Error Responses
261
+
262
+ | Code | Type | Description |
263
+ | ---- | ---- | ----------- |
264
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
265
+ | 404 | [Error](_schemas.md#error) | Error if notebook was not found |
266
+
267
+ <br/>
268
+
226
269
  ## Patch
227
270
 
228
271
  Updates information about a notebook
data/docs/org.md CHANGED
@@ -7,9 +7,11 @@ parameters and the potential responses.
7
7
  ##### Contents
8
8
 
9
9
  * [Delete](#delete)
10
+ * [Device Counts](#device-counts)
10
11
  * [Get](#get)
11
12
  * [Invite Member](#invite-member)
12
13
  * [Modify Member](#modify-member)
14
+ * [Notebook Minute Counts](#notebook-minute-counts)
13
15
  * [Patch](#patch)
14
16
  * [Payload Counts](#payload-counts)
15
17
  * [Pending Invites](#pending-invites)
@@ -56,6 +58,45 @@ all.Organization, all.User, org.*, or org.delete.
56
58
 
57
59
  <br/>
58
60
 
61
+ ## Device Counts
62
+
63
+ Returns device counts by day for the time range specified for this organization
64
+
65
+ ```ruby
66
+ result = client.org.device_counts(orgId: my_org_id)
67
+
68
+ puts result
69
+ ```
70
+
71
+ #### Authentication
72
+ The client must be configured with a valid api access token to call this
73
+ action. The token must include at least one of the following scopes:
74
+ all.Organization, all.Organization.read, all.User, all.User.read, org.*, or org.deviceCounts.
75
+
76
+ #### Available Parameters
77
+
78
+ | Name | Type | Required | Description | Default | Example |
79
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
80
+ | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
81
+ | start | string | N | Start of range for device count query (ms since epoch) | | 0 |
82
+ | end | string | N | End of range for device count query (ms since epoch) | | 1465790400000 |
83
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
84
+
85
+ #### Successful Responses
86
+
87
+ | Code | Type | Description |
88
+ | ---- | ---- | ----------- |
89
+ | 200 | [Device Counts](_schemas.md#device-counts) | Device counts by day |
90
+
91
+ #### Error Responses
92
+
93
+ | Code | Type | Description |
94
+ | ---- | ---- | ----------- |
95
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
96
+ | 404 | [Error](_schemas.md#error) | Error if organization was not found |
97
+
98
+ <br/>
99
+
59
100
  ## Get
60
101
 
61
102
  Retrieves information on an organization
@@ -177,6 +218,45 @@ all.Organization, all.User, org.*, or org.modifyMember.
177
218
 
178
219
  <br/>
179
220
 
221
+ ## Notebook Minute Counts
222
+
223
+ Returns notebook execution usage by day for the time range specified for this organization
224
+
225
+ ```ruby
226
+ result = client.org.notebook_minute_counts(orgId: my_org_id)
227
+
228
+ puts result
229
+ ```
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.Organization, all.Organization.read, all.User, all.User.read, org.*, or org.notebookMinuteCounts.
235
+
236
+ #### Available Parameters
237
+
238
+ | Name | Type | Required | Description | Default | Example |
239
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
240
+ | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
241
+ | start | string | N | Start of range for notebook execution query (ms since epoch) | | 0 |
242
+ | end | string | N | End of range for notebook execution query (ms since epoch) | | 1465790400000 |
243
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
244
+
245
+ #### Successful Responses
246
+
247
+ | Code | Type | Description |
248
+ | ---- | ---- | ----------- |
249
+ | 200 | [Notebook Minute Counts](_schemas.md#notebook-minute-counts) | Notebook usage information |
250
+
251
+ #### Error Responses
252
+
253
+ | Code | Type | Description |
254
+ | ---- | ---- | ----------- |
255
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
256
+ | 404 | [Error](_schemas.md#error) | Error if organization was not found |
257
+
258
+ <br/>
259
+
180
260
  ## Patch
181
261
 
182
262
  Updates information about an organization