losant_rest 1.19.0 → 1.19.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (120) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +872 -38
  3. data/docs/applications.md +49 -0
  4. data/docs/device.md +12 -3
  5. data/docs/me.md +116 -0
  6. data/lib/losant_rest/version.rb +1 -1
  7. data/lib/platform_rest/application.rb +932 -0
  8. data/lib/platform_rest/application_api_token.rb +176 -0
  9. data/lib/platform_rest/application_api_tokens.rb +136 -0
  10. data/lib/platform_rest/application_certificate.rb +176 -0
  11. data/lib/platform_rest/application_certificate_authorities.rb +138 -0
  12. data/lib/platform_rest/application_certificate_authority.rb +176 -0
  13. data/lib/platform_rest/application_certificates.rb +138 -0
  14. data/lib/platform_rest/application_dashboard.rb +225 -0
  15. data/lib/platform_rest/application_dashboards.rb +138 -0
  16. data/lib/platform_rest/application_key.rb +176 -0
  17. data/lib/platform_rest/application_keys.rb +141 -0
  18. data/lib/platform_rest/application_template.rb +79 -0
  19. data/lib/platform_rest/application_templates.rb +176 -0
  20. data/lib/platform_rest/applications.rb +209 -0
  21. data/lib/platform_rest/audit_log.rb +81 -0
  22. data/lib/platform_rest/audit_logs.rb +93 -0
  23. data/lib/platform_rest/auth.rb +245 -0
  24. data/lib/platform_rest/client.rb +410 -0
  25. data/lib/platform_rest/credential.rb +224 -0
  26. data/lib/platform_rest/credentials.rb +138 -0
  27. data/lib/platform_rest/dashboard.rb +268 -0
  28. data/lib/platform_rest/dashboards.rb +136 -0
  29. data/lib/platform_rest/data.rb +176 -0
  30. data/lib/platform_rest/data_table.rb +274 -0
  31. data/lib/platform_rest/data_table_row.rb +182 -0
  32. data/lib/platform_rest/data_table_rows.rb +343 -0
  33. data/lib/platform_rest/data_tables.rb +138 -0
  34. data/lib/platform_rest/device.rb +767 -0
  35. data/lib/platform_rest/device_recipe.rb +234 -0
  36. data/lib/platform_rest/device_recipes.rb +146 -0
  37. data/lib/platform_rest/devices.rb +707 -0
  38. data/lib/platform_rest/edge_deployment.rb +81 -0
  39. data/lib/platform_rest/edge_deployments.rb +236 -0
  40. data/lib/platform_rest/embedded_deployment.rb +81 -0
  41. data/lib/platform_rest/embedded_deployments.rb +280 -0
  42. data/lib/platform_rest/error.rb +34 -0
  43. data/lib/platform_rest/event.rb +176 -0
  44. data/lib/platform_rest/events.rb +341 -0
  45. data/lib/platform_rest/experience.rb +142 -0
  46. data/lib/platform_rest/experience_domain.rb +176 -0
  47. data/lib/platform_rest/experience_domains.rb +126 -0
  48. data/lib/platform_rest/experience_endpoint.rb +230 -0
  49. data/lib/platform_rest/experience_endpoints.rb +200 -0
  50. data/lib/platform_rest/experience_group.rb +180 -0
  51. data/lib/platform_rest/experience_groups.rb +141 -0
  52. data/lib/platform_rest/experience_slug.rb +176 -0
  53. data/lib/platform_rest/experience_slugs.rb +126 -0
  54. data/lib/platform_rest/experience_user.rb +176 -0
  55. data/lib/platform_rest/experience_users.rb +142 -0
  56. data/lib/platform_rest/experience_version.rb +176 -0
  57. data/lib/platform_rest/experience_versions.rb +138 -0
  58. data/lib/platform_rest/experience_view.rb +228 -0
  59. data/lib/platform_rest/experience_views.rb +142 -0
  60. data/lib/platform_rest/file.rb +226 -0
  61. data/lib/platform_rest/files.rb +144 -0
  62. data/lib/platform_rest/flow.rb +580 -0
  63. data/lib/platform_rest/flow_version.rb +352 -0
  64. data/lib/platform_rest/flow_versions.rb +201 -0
  65. data/lib/platform_rest/flows.rb +310 -0
  66. data/lib/platform_rest/instance.rb +377 -0
  67. data/lib/platform_rest/instance_api_token.rb +176 -0
  68. data/lib/platform_rest/instance_api_tokens.rb +136 -0
  69. data/lib/platform_rest/instance_custom_node.rb +282 -0
  70. data/lib/platform_rest/instance_custom_nodes.rb +136 -0
  71. data/lib/platform_rest/instance_member.rb +176 -0
  72. data/lib/platform_rest/instance_members.rb +134 -0
  73. data/lib/platform_rest/instance_org.rb +336 -0
  74. data/lib/platform_rest/instance_org_invite.rb +182 -0
  75. data/lib/platform_rest/instance_org_invites.rb +138 -0
  76. data/lib/platform_rest/instance_org_member.rb +182 -0
  77. data/lib/platform_rest/instance_org_members.rb +138 -0
  78. data/lib/platform_rest/instance_orgs.rb +139 -0
  79. data/lib/platform_rest/instance_sandbox.rb +181 -0
  80. data/lib/platform_rest/instance_sandboxes.rb +98 -0
  81. data/lib/platform_rest/instances.rb +88 -0
  82. data/lib/platform_rest/integration.rb +178 -0
  83. data/lib/platform_rest/integrations.rb +138 -0
  84. data/lib/platform_rest/me.rb +923 -0
  85. data/lib/platform_rest/notebook.rb +423 -0
  86. data/lib/platform_rest/notebooks.rb +138 -0
  87. data/lib/platform_rest/org.rb +663 -0
  88. data/lib/platform_rest/org_invites.rb +124 -0
  89. data/lib/platform_rest/orgs.rb +140 -0
  90. data/lib/platform_rest/resource_job.rb +326 -0
  91. data/lib/platform_rest/resource_jobs.rb +138 -0
  92. data/lib/platform_rest/user_api_token.rb +170 -0
  93. data/lib/platform_rest/user_api_tokens.rb +132 -0
  94. data/lib/platform_rest/utils.rb +44 -0
  95. data/lib/platform_rest/webhook.rb +178 -0
  96. data/lib/platform_rest/webhooks.rb +138 -0
  97. data/lib/platform_rest.rb +129 -0
  98. data/schemas/apiTokenPost.json +4 -0
  99. data/schemas/applicationDashboardPost.json +66 -0
  100. data/schemas/dashboard.json +66 -0
  101. data/schemas/dashboardPatch.json +66 -0
  102. data/schemas/dashboardPost.json +66 -0
  103. data/schemas/dashboards.json +66 -0
  104. data/schemas/deviceConnectionStatus.json +10 -0
  105. data/schemas/deviceLog.json +3 -0
  106. data/schemas/event.json +8 -0
  107. data/schemas/eventPlusNewCount.json +8 -0
  108. data/schemas/events.json +8 -0
  109. data/schemas/githubLogin.json +4 -0
  110. data/schemas/integrationPatch.json +0 -10
  111. data/schemas/orgInviteActionUser.json +18 -0
  112. data/schemas/orgInviteResultUser.json +18 -0
  113. data/schemas/orgInviteUser.json +51 -0
  114. data/schemas/orgInvitesUser.json +59 -0
  115. data/schemas/payloadCountsBreakdown.json +1 -25
  116. data/schemas/periodSummaries.json +172 -0
  117. data/schemas/samlResponse.json +4 -0
  118. data/schemas/userCredentials.json +4 -0
  119. data/schemas/userPost.json +4 -0
  120. metadata +98 -2
data/docs/applications.md CHANGED
@@ -8,6 +8,7 @@ parameters and the potential responses.
8
8
 
9
9
  * [Get](#get)
10
10
  * [Import](#import)
11
+ * [Period Summaries](#period-summaries)
11
12
  * [Post](#post)
12
13
 
13
14
  <br/>
@@ -102,6 +103,54 @@ all.Organization, all.User, applications.*, or applications.import.
102
103
 
103
104
  <br/>
104
105
 
106
+ ## Period Summaries
107
+
108
+ Returns application usage summaries over a selected date range
109
+
110
+ ```ruby
111
+ result = client.applications.period_summaries(optional_params)
112
+
113
+ puts result
114
+ ```
115
+
116
+ #### Authentication
117
+ The client must be configured with a valid api access token to call this
118
+ action. The token must include at least one of the following scopes:
119
+ all.Organization, all.User, applications.*, or applications.periodSummaries.
120
+
121
+ #### Available Parameters
122
+
123
+ | Name | Type | Required | Description | Default | Example |
124
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
125
+ | start | string | N | Start of range for resource count queries (ms since epoch) | | 0 |
126
+ | end | string | N | End of range for resource count queries (ms since epoch) | | 1465790400000 |
127
+ | asBytes | string | N | If the resulting payload counts should be returned as bytes | false | true |
128
+ | includeNonBillable | string | N | If non-billable payloads should be included in the result | false | true |
129
+ | sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate, ownerId, lastUpdated | name | name |
130
+ | sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
131
+ | page | string | N | Which page of results to return | 0 | 0 |
132
+ | perPage | string | N | How many items to return per page | 100 | 10 |
133
+ | filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name | | name |
134
+ | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my * app |
135
+ | orgId | string | N | If not provided, return all applications. If provided but blank, only return applications belonging to the current user. If provided and an id, only return applications belonging to the given organization id. | | 575ecdf07ae143cd83dc4a9a |
136
+ | exclude | string | N | Comma-separated list of resources to exclude from summary | | payloadCounts, deviceCounts, notebookMinuteCounts |
137
+ | include | string | N | Comma-separated list of summary fields to include in application summary | | deviceCounts |
138
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
139
+
140
+ #### Successful Responses
141
+
142
+ | Code | Type | Description |
143
+ | ---- | ---- | ----------- |
144
+ | 200 | [Application Period Summaries](_schemas.md#application-period-summaries) | Collection of application period summaries |
145
+
146
+ #### Error Responses
147
+
148
+ | Code | Type | Description |
149
+ | ---- | ---- | ----------- |
150
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
151
+
152
+ <br/>
153
+
105
154
  ## Post
106
155
 
107
156
  Create a new application
data/docs/device.md CHANGED
@@ -175,8 +175,11 @@ all.Application, all.Application.read, all.Device, all.Device.read, all.Organiza
175
175
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
176
176
  | deviceId | string | Y | ID associated with the device | | 575ecf887ae143cd83dc4aa2 |
177
177
  | limit | string | N | Maximum number of command entries to return | 1 | 10 |
178
- | since | string | N | Look for command entries since this time (ms since epoch) | | 1465790400000 |
178
+ | since | string | N | (deprecated) Look for command entries since this time (ms since epoch) | | 1465790400000 |
179
179
  | sortDirection | string | N | Direction to sort the command entries (by time). Accepted values are: asc, desc | desc | desc |
180
+ | duration | string | N | Duration of time range to query in milliseconds | | 86400000 |
181
+ | start | string | N | Start of time range to query in milliseconds since epoch | | 1465790400000 |
182
+ | end | string | N | End of time range to query in milliseconds since epoch | | 0 |
180
183
  | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
181
184
 
182
185
  #### Successful Responses
@@ -261,8 +264,11 @@ all.Application, all.Application.read, all.Device, all.Device.read, all.Organiza
261
264
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
262
265
  | deviceId | string | Y | ID associated with the device | | 575ecf887ae143cd83dc4aa2 |
263
266
  | limit | string | N | Maximum number of log entries to return | 1 | 10 |
264
- | since | string | N | Look for log entries since this time (ms since epoch) | | 1465790400000 |
267
+ | since | string | N | (deprecated) Look for log entries since this time (ms since epoch) | | 1465790400000 |
265
268
  | sortDirection | string | N | Direction to sort the log entries (by time). Accepted values are: asc, desc | desc | desc |
269
+ | duration | string | N | Duration of time range to query in milliseconds | | 86400000 |
270
+ | start | string | N | Start of time range to query in milliseconds since epoch | | 1465790400000 |
271
+ | end | string | N | End of time range to query in milliseconds since epoch | | 0 |
266
272
  | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
267
273
 
268
274
  #### Successful Responses
@@ -304,8 +310,11 @@ all.Application, all.Application.read, all.Device, all.Device.read, all.Organiza
304
310
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
305
311
  | deviceId | string | Y | ID associated with the device | | 575ecf887ae143cd83dc4aa2 |
306
312
  | limit | string | N | Maximum number of state entries to return | 1 | 10 |
307
- | since | string | N | Look for state entries since this time (ms since epoch) | | 1465790400000 |
313
+ | since | string | N | (deprecated) Look for state entries since this time (ms since epoch) | | 1465790400000 |
308
314
  | sortDirection | string | N | Direction to sort the state entries (by time). Accepted values are: asc, desc | desc | desc |
315
+ | duration | string | N | Duration of time range to query in milliseconds | | 86400000 |
316
+ | start | string | N | Start of time range to query in milliseconds since epoch | | 1465790400000 |
317
+ | end | string | N | End of time range to query in milliseconds since epoch | | 0 |
309
318
  | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
310
319
 
311
320
  #### Successful Responses
data/docs/me.md CHANGED
@@ -16,11 +16,14 @@ parameters and the potential responses.
16
16
  * [Fetch Recent Items](#fetch-recent-items)
17
17
  * [Generate Two Factor Auth](#generate-two-factor-auth)
18
18
  * [Get](#get)
19
+ * [Invite](#invite)
20
+ * [Invites](#invites)
19
21
  * [Notebook Minute Counts](#notebook-minute-counts)
20
22
  * [Patch](#patch)
21
23
  * [Payload Counts](#payload-counts)
22
24
  * [Payload Counts Breakdown](#payload-counts-breakdown)
23
25
  * [Refresh Token](#refresh-token)
26
+ * [Respond to Invite](#respond-to-invite)
24
27
  * [Transfer Resources](#transfer-resources)
25
28
  * [Verify Email](#verify-email)
26
29
 
@@ -387,6 +390,78 @@ all.User, all.User.read, me.*, or me.get.
387
390
 
388
391
  <br/>
389
392
 
393
+ ## Invite
394
+
395
+ Retrieves information for an invitation to an organization
396
+
397
+ ```ruby
398
+ result = client.me.invite(inviteId: my_invite_id)
399
+
400
+ puts result
401
+ ```
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.User, me.*, or me.invite.
407
+
408
+ #### Available Parameters
409
+
410
+ | Name | Type | Required | Description | Default | Example |
411
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
412
+ | inviteId | string | Y | ID associated with the invitation | | 575ec8687ae143cd83dc4a97 |
413
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
414
+
415
+ #### Successful Responses
416
+
417
+ | Code | Type | Description |
418
+ | ---- | ---- | ----------- |
419
+ | 200 | [Organization Invitation Information For User](_schemas.md#organization-invitation-information-for-user) | Information about invitation |
420
+
421
+ #### Error Responses
422
+
423
+ | Code | Type | Description |
424
+ | ---- | ---- | ----------- |
425
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
426
+ | 404 | [Error](_schemas.md#error) | Error if invite not found |
427
+
428
+ <br/>
429
+
430
+ ## Invites
431
+
432
+ Retrieves pending organization invitations for a user
433
+
434
+ ```ruby
435
+ result = client.me.invites(optional_params)
436
+
437
+ puts result
438
+ ```
439
+
440
+ #### Authentication
441
+ The client must be configured with a valid api access token to call this
442
+ action. The token must include at least one of the following scopes:
443
+ all.User, me.*, or me.invites.
444
+
445
+ #### Available Parameters
446
+
447
+ | Name | Type | Required | Description | Default | Example |
448
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
449
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
450
+
451
+ #### Successful Responses
452
+
453
+ | Code | Type | Description |
454
+ | ---- | ---- | ----------- |
455
+ | 200 | [User Organization Invitations](_schemas.md#user-organization-invitations) | Information about invitations |
456
+
457
+ #### Error Responses
458
+
459
+ | Code | Type | Description |
460
+ | ---- | ---- | ----------- |
461
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
462
+
463
+ <br/>
464
+
390
465
  ## Notebook Minute Counts
391
466
 
392
467
  Returns notebook execution usage by day for the time range specified for all applications the current user owns
@@ -575,6 +650,47 @@ all.User, or me.*.
575
650
 
576
651
  <br/>
577
652
 
653
+ ## Respond to Invite
654
+
655
+ Accepts or rejects an invitation to an organization
656
+
657
+ ```ruby
658
+ result = client.me.respond_to_invite(
659
+ inviteId: my_invite_id,
660
+ response: my_response)
661
+
662
+ puts result
663
+ ```
664
+
665
+ #### Authentication
666
+ The client must be configured with a valid api access token to call this
667
+ action. The token must include at least one of the following scopes:
668
+ all.User, me.*, or me.respondToInvite.
669
+
670
+ #### Available Parameters
671
+
672
+ | Name | Type | Required | Description | Default | Example |
673
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
674
+ | inviteId | string | Y | ID associated with the invitation | | 575ec8687ae143cd83dc4a97 |
675
+ | response | [Organization Invitation Action For User](_schemas.md#organization-invitation-action-for-user) | Y | Response to invitation | | [Organization Invitation Action For User Example](_schemas.md#organization-invitation-action-for-user-example) |
676
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
677
+
678
+ #### Successful Responses
679
+
680
+ | Code | Type | Description |
681
+ | ---- | ---- | ----------- |
682
+ | 200 | [Organization Invitation Result For User](_schemas.md#organization-invitation-result-for-user) | Acceptance or rejection of invitation |
683
+
684
+ #### Error Responses
685
+
686
+ | Code | Type | Description |
687
+ | ---- | ---- | ----------- |
688
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
689
+ | 404 | [Error](_schemas.md#error) | Error if invitation not found |
690
+ | 410 | [Error](_schemas.md#error) | Error if invitation has expired |
691
+
692
+ <br/>
693
+
578
694
  ## Transfer Resources
579
695
 
580
696
  Moves resources to a new owner
@@ -21,5 +21,5 @@
21
21
  # SOFTWARE.
22
22
 
23
23
  module LosantRest
24
- VERSION = "1.19.0"
24
+ VERSION = "1.19.1"
25
25
  end