losant_rest 1.10.3 → 1.13.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (212) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/README.md +2 -2
  4. data/docs/_schemas.md +27526 -11724
  5. data/docs/application.md +83 -0
  6. data/docs/applicationApiTokens.md +2 -2
  7. data/docs/applicationCertificateAuthorities.md +1 -1
  8. data/docs/applicationCertificates.md +1 -1
  9. data/docs/applicationDashboard.md +133 -0
  10. data/docs/applicationDashboards.md +93 -0
  11. data/docs/applicationKeys.md +4 -3
  12. data/docs/applicationTemplate.md +46 -0
  13. data/docs/applicationTemplates.md +77 -2
  14. data/docs/applications.md +1 -1
  15. data/docs/auditLogs.md +1 -1
  16. data/docs/dashboards.md +1 -1
  17. data/docs/dataTables.md +1 -1
  18. data/docs/device.md +6 -3
  19. data/docs/deviceRecipes.md +1 -1
  20. data/docs/devices.md +125 -1
  21. data/docs/edgeDeployments.md +1 -1
  22. data/docs/events.md +4 -4
  23. data/docs/experienceEndpoint.md +1 -0
  24. data/docs/experienceGroups.md +1 -1
  25. data/docs/experienceUsers.md +1 -1
  26. data/docs/experienceVersions.md +1 -1
  27. data/docs/experienceViews.md +1 -1
  28. data/docs/files.md +1 -1
  29. data/docs/flow.md +41 -0
  30. data/docs/flowVersions.md +2 -1
  31. data/docs/flows.md +5 -2
  32. data/docs/instance.md +128 -0
  33. data/docs/instanceMember.md +133 -0
  34. data/docs/instanceMembers.md +91 -0
  35. data/docs/instanceOrg.md +133 -0
  36. data/docs/instanceOrgMember.md +139 -0
  37. data/docs/instanceOrgMembers.md +96 -0
  38. data/docs/instanceOrgs.md +91 -0
  39. data/docs/instances.md +50 -0
  40. data/docs/integration.md +1 -0
  41. data/docs/integrations.md +1 -1
  42. data/docs/me.md +0 -36
  43. data/docs/notebooks.md +1 -1
  44. data/docs/orgs.md +1 -1
  45. data/docs/webhook.md +1 -0
  46. data/docs/webhooks.md +1 -1
  47. data/lib/losant_rest.rb +12 -1
  48. data/lib/losant_rest/application.rb +97 -2
  49. data/lib/losant_rest/application_api_token.rb +1 -1
  50. data/lib/losant_rest/application_api_tokens.rb +2 -2
  51. data/lib/losant_rest/application_certificate.rb +1 -1
  52. data/lib/losant_rest/application_certificate_authorities.rb +1 -1
  53. data/lib/losant_rest/application_certificate_authority.rb +1 -1
  54. data/lib/losant_rest/application_certificates.rb +1 -1
  55. data/lib/losant_rest/application_dashboard.rb +176 -0
  56. data/lib/losant_rest/application_dashboards.rb +138 -0
  57. data/lib/losant_rest/application_key.rb +1 -1
  58. data/lib/losant_rest/application_keys.rb +4 -1
  59. data/lib/losant_rest/application_template.rb +79 -0
  60. data/lib/losant_rest/application_templates.rb +90 -2
  61. data/lib/losant_rest/applications.rb +1 -1
  62. data/lib/losant_rest/audit_log.rb +1 -1
  63. data/lib/losant_rest/audit_logs.rb +1 -1
  64. data/lib/losant_rest/auth.rb +1 -1
  65. data/lib/losant_rest/client.rb +47 -3
  66. data/lib/losant_rest/dashboard.rb +1 -1
  67. data/lib/losant_rest/dashboards.rb +1 -1
  68. data/lib/losant_rest/data.rb +1 -1
  69. data/lib/losant_rest/data_table.rb +1 -1
  70. data/lib/losant_rest/data_table_row.rb +1 -1
  71. data/lib/losant_rest/data_table_rows.rb +1 -1
  72. data/lib/losant_rest/data_tables.rb +1 -1
  73. data/lib/losant_rest/device.rb +10 -4
  74. data/lib/losant_rest/device_recipe.rb +1 -1
  75. data/lib/losant_rest/device_recipes.rb +1 -1
  76. data/lib/losant_rest/devices.rb +153 -1
  77. data/lib/losant_rest/edge_deployments.rb +1 -1
  78. data/lib/losant_rest/error.rb +1 -1
  79. data/lib/losant_rest/event.rb +1 -1
  80. data/lib/losant_rest/events.rb +4 -4
  81. data/lib/losant_rest/experience.rb +1 -1
  82. data/lib/losant_rest/experience_domain.rb +1 -1
  83. data/lib/losant_rest/experience_domains.rb +1 -1
  84. data/lib/losant_rest/experience_endpoint.rb +3 -1
  85. data/lib/losant_rest/experience_endpoints.rb +1 -1
  86. data/lib/losant_rest/experience_group.rb +1 -1
  87. data/lib/losant_rest/experience_groups.rb +1 -1
  88. data/lib/losant_rest/experience_slug.rb +1 -1
  89. data/lib/losant_rest/experience_slugs.rb +1 -1
  90. data/lib/losant_rest/experience_user.rb +1 -1
  91. data/lib/losant_rest/experience_users.rb +1 -1
  92. data/lib/losant_rest/experience_version.rb +1 -1
  93. data/lib/losant_rest/experience_versions.rb +1 -1
  94. data/lib/losant_rest/experience_view.rb +1 -1
  95. data/lib/losant_rest/experience_views.rb +1 -1
  96. data/lib/losant_rest/file.rb +1 -1
  97. data/lib/losant_rest/files.rb +1 -1
  98. data/lib/losant_rest/flow.rb +47 -1
  99. data/lib/losant_rest/flow_version.rb +1 -1
  100. data/lib/losant_rest/flow_versions.rb +4 -1
  101. data/lib/losant_rest/flows.rb +9 -1
  102. data/lib/losant_rest/instance.rb +181 -0
  103. data/lib/losant_rest/instance_member.rb +176 -0
  104. data/lib/losant_rest/instance_members.rb +134 -0
  105. data/lib/losant_rest/instance_org.rb +176 -0
  106. data/lib/losant_rest/instance_org_member.rb +182 -0
  107. data/lib/losant_rest/instance_org_members.rb +138 -0
  108. data/lib/losant_rest/instance_orgs.rb +139 -0
  109. data/lib/losant_rest/instances.rb +88 -0
  110. data/lib/losant_rest/integration.rb +3 -1
  111. data/lib/losant_rest/integrations.rb +1 -1
  112. data/lib/losant_rest/me.rb +2 -43
  113. data/lib/losant_rest/notebook.rb +1 -1
  114. data/lib/losant_rest/notebooks.rb +1 -1
  115. data/lib/losant_rest/org.rb +2 -2
  116. data/lib/losant_rest/org_invites.rb +1 -1
  117. data/lib/losant_rest/orgs.rb +1 -1
  118. data/lib/losant_rest/utils.rb +1 -1
  119. data/lib/losant_rest/version.rb +2 -2
  120. data/lib/losant_rest/webhook.rb +3 -1
  121. data/lib/losant_rest/webhooks.rb +1 -1
  122. data/schemas/advancedApplicationKeyQuery.json +1082 -0
  123. data/schemas/advancedDeviceQuery.json +309 -0
  124. data/schemas/advancedFlowByVersionQuery.json +665 -0
  125. data/schemas/advancedFlowQuery.json +883 -0
  126. data/schemas/advancedFlowVersionQuery.json +925 -0
  127. data/schemas/application.json +8 -0
  128. data/schemas/applicationApiTokenPost.json +12 -0
  129. data/schemas/applicationApplyTemplatePatch.json +19 -0
  130. data/schemas/applicationCreationByTemplateResult.json +8 -0
  131. data/schemas/applicationDashboardPost.json +5683 -0
  132. data/schemas/applicationGlobalPatch.json +33 -0
  133. data/schemas/applicationPost.json +8 -0
  134. data/schemas/applicationTemplate.json +20 -0
  135. data/schemas/applicationTemplateCategories.json +43 -0
  136. data/schemas/applicationTemplateCategory.json +23 -0
  137. data/schemas/applicationTemplates.json +32 -0
  138. data/schemas/applications.json +8 -0
  139. data/schemas/attributeNamesResponse.json +14 -0
  140. data/schemas/authedUser.json +3 -0
  141. data/schemas/changePassword.json +2 -2
  142. data/schemas/dashboard.json +197 -26
  143. data/schemas/dashboardPatch.json +197 -26
  144. data/schemas/dashboardPost.json +197 -26
  145. data/schemas/dashboards.json +197 -26
  146. data/schemas/dataExport.json +132 -1
  147. data/schemas/deviceAttributeDataTypeFilter.json +29 -0
  148. data/schemas/deviceClassFilter.json +1 -2
  149. data/schemas/devicesDeletePost.json +309 -0
  150. data/schemas/devicesExportPost.json +309 -0
  151. data/schemas/devicesPatch.json +309 -0
  152. data/schemas/devicesRemoveDataPost.json +309 -0
  153. data/schemas/experienceLinkedResources.json +96 -0
  154. data/schemas/experienceVersion.json +9 -0
  155. data/schemas/experienceVersionPatch.json +9 -0
  156. data/schemas/experienceVersions.json +9 -0
  157. data/schemas/filePost.json +8 -2
  158. data/schemas/files.json +3 -0
  159. data/schemas/flow.json +32 -0
  160. data/schemas/flowPatch.json +32 -0
  161. data/schemas/flowPost.json +32 -0
  162. data/schemas/flowStorageMetadata.json +13 -0
  163. data/schemas/flowVersion.json +64 -0
  164. data/schemas/flowVersionPost.json +32 -0
  165. data/schemas/flowVersions.json +64 -0
  166. data/schemas/flows.json +32 -0
  167. data/schemas/flowsImportPost.json +64 -0
  168. data/schemas/flowsImportResult.json +96 -0
  169. data/schemas/githubLogin.json +53 -4
  170. data/schemas/historicalSummaries.json +43 -0
  171. data/schemas/historicalSummary.json +455 -0
  172. data/schemas/instance.json +132 -0
  173. data/schemas/instanceMember.json +37 -0
  174. data/schemas/instanceMemberPatch.json +17 -0
  175. data/schemas/instanceMemberPost.json +22 -0
  176. data/schemas/instanceMembers.json +69 -0
  177. data/schemas/instanceOrg.json +133 -0
  178. data/schemas/instanceOrgMember.json +37 -0
  179. data/schemas/instanceOrgMemberPatch.json +69 -0
  180. data/schemas/instanceOrgMemberPost.json +161 -0
  181. data/schemas/instanceOrgMembers.json +34 -0
  182. data/schemas/instanceOrgPatch.json +122 -0
  183. data/schemas/instanceOrgPost.json +125 -0
  184. data/schemas/instanceOrgs.json +174 -0
  185. data/schemas/instanceReportOptionsPost.json +40 -0
  186. data/schemas/instances.json +43 -0
  187. data/schemas/integration.json +3 -0
  188. data/schemas/integrationPatch.json +3 -0
  189. data/schemas/integrationPost.json +3 -0
  190. data/schemas/integrations.json +3 -0
  191. data/schemas/me.json +3 -3
  192. data/schemas/mePatch.json +2 -2
  193. data/schemas/multiDeviceCommand.json +309 -0
  194. data/schemas/notebook.json +7 -0
  195. data/schemas/notebookExecutionLogs.json +7 -0
  196. data/schemas/notebookPatch.json +7 -0
  197. data/schemas/notebookPost.json +7 -0
  198. data/schemas/notebooks.json +7 -0
  199. data/schemas/orgInviteInfo.json +3 -0
  200. data/schemas/orgInvitePost.json +3 -0
  201. data/schemas/orgInvites.json +3 -0
  202. data/schemas/orgPatch.json +0 -9
  203. data/schemas/passwordResetFinish.json +2 -2
  204. data/schemas/payloadStats.json +110 -0
  205. data/schemas/tagKeysResponse.json +14 -0
  206. data/schemas/tagValuesResponse.json +19 -0
  207. data/schemas/templateKeywords.json +14 -0
  208. data/schemas/timeSeriesData.json +12 -2
  209. data/schemas/timeSeriesQuery.json +94 -14
  210. data/schemas/userCredentials.json +51 -3
  211. data/schemas/userPost.json +59 -7
  212. metadata +61 -6
data/schemas/instance.json ADDED
@@ -0,0 +1,132 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "name": {
6
+ "type": "string",
7
+ "minLength": 1,
8
+ "maxLength": 255
9
+ },
10
+ "id": {
11
+ "type": "string",
12
+ "pattern": "^[A-Fa-f\\d]{24}$"
13
+ },
14
+ "instanceId": {
15
+ "type": "string",
16
+ "pattern": "^[A-Fa-f\\d]{24}$"
17
+ },
18
+ "creationDate": {
19
+ "type": "string",
20
+ "format": "date-time"
21
+ },
22
+ "lastUpdated": {
23
+ "type": "string",
24
+ "format": "date-time"
25
+ },
26
+ "allowAuditLogging": {
27
+ "type": "boolean"
28
+ },
29
+ "limits": {
30
+ "organization": {
31
+ "type": "number"
32
+ },
33
+ "apitoken": {
34
+ "type": "number"
35
+ },
36
+ "application": {
37
+ "type": "number"
38
+ },
39
+ "applicationkey": {
40
+ "type": "number"
41
+ },
42
+ "dashboard": {
43
+ "type": "number"
44
+ },
45
+ "datatable": {
46
+ "type": "number"
47
+ },
48
+ "device": {
49
+ "type": "number"
50
+ },
51
+ "devicerecipe": {
52
+ "type": "number"
53
+ },
54
+ "experiencedomain": {
55
+ "type": "number"
56
+ },
57
+ "experienceendpoint": {
58
+ "type": "number"
59
+ },
60
+ "experiencegroup": {
61
+ "type": "number"
62
+ },
63
+ "experienceslug": {
64
+ "type": "number"
65
+ },
66
+ "experienceuser": {
67
+ "type": "number"
68
+ },
69
+ "experienceversion": {
70
+ "type": "number"
71
+ },
72
+ "experienceview": {
73
+ "type": "number"
74
+ },
75
+ "file": {
76
+ "type": "number"
77
+ },
78
+ "flow": {
79
+ "type": "number"
80
+ },
81
+ "integration": {
82
+ "type": "number"
83
+ },
84
+ "notebook": {
85
+ "type": "number"
86
+ },
87
+ "webhook": {
88
+ "type": "number"
89
+ },
90
+ "dataTTL": {
91
+ "type": "number"
92
+ },
93
+ "member": {
94
+ "type": "number"
95
+ },
96
+ "payload": {
97
+ "type": "number"
98
+ },
99
+ "notebookMinutesPerRun": {
100
+ "type": "number"
101
+ },
102
+ "notebookMinutesPerMonth": {
103
+ "type": "number"
104
+ },
105
+ "notebookInParallel": {
106
+ "type": "number"
107
+ }
108
+ },
109
+ "members": {
110
+ "type": "array",
111
+ "items": {
112
+ "type": "object",
113
+ "properties": {
114
+ "userId": {
115
+ "type": "string",
116
+ "pattern": "^[A-Fa-f\\d]{24}$"
117
+ },
118
+ "role": {
119
+ "type": "string",
120
+ "enum": [
121
+ "admin",
122
+ "edit",
123
+ "collaborate",
124
+ "view",
125
+ "none"
126
+ ]
127
+ }
128
+ }
129
+ }
130
+ }
131
+ }
132
+ }
data/schemas/instanceMember.json ADDED
@@ -0,0 +1,37 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "userId": {
6
+ "type": "string",
7
+ "pattern": "^[A-Fa-f\\d]{24}$"
8
+ },
9
+ "email": {
10
+ "type": "string",
11
+ "format": "email",
12
+ "maxLength": 1024
13
+ },
14
+ "firstName": {
15
+ "type": "string",
16
+ "minLength": 1,
17
+ "maxLength": 1024
18
+ },
19
+ "lastName": {
20
+ "type": "string",
21
+ "minLength": 1,
22
+ "maxLength": 1024
23
+ },
24
+ "role": {
25
+ "type": "string",
26
+ "enum": [
27
+ "admin",
28
+ "view"
29
+ ]
30
+ },
31
+ "avatarUrl": {
32
+ "type": "string",
33
+ "format": "url"
34
+ }
35
+ },
36
+ "additionalProperties": false
37
+ }
data/schemas/instanceMemberPatch.json ADDED
@@ -0,0 +1,17 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "role": {
6
+ "type": "string",
7
+ "enum": [
8
+ "admin",
9
+ "view"
10
+ ]
11
+ }
12
+ },
13
+ "additionalProperties": false,
14
+ "required": [
15
+ "role"
16
+ ]
17
+ }
data/schemas/instanceMemberPost.json ADDED
@@ -0,0 +1,22 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "userId": {
6
+ "type": "string",
7
+ "pattern": "^[A-Fa-f\\d]{24}$"
8
+ },
9
+ "role": {
10
+ "type": "string",
11
+ "enum": [
12
+ "admin",
13
+ "view"
14
+ ]
15
+ }
16
+ },
17
+ "additionalProperties": false,
18
+ "required": [
19
+ "userId",
20
+ "role"
21
+ ]
22
+ }
data/schemas/instanceMembers.json ADDED
@@ -0,0 +1,69 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "items": {
6
+ "type": "array",
7
+ "items": {
8
+ "title": "Instance Member",
9
+ "description": "Schema for an Instance member",
10
+ "type": "object",
11
+ "properties": {
12
+ "userId": {
13
+ "type": "string",
14
+ "pattern": "^[A-Fa-f\\d]{24}$"
15
+ },
16
+ "email": {
17
+ "type": "string",
18
+ "format": "email",
19
+ "maxLength": 1024
20
+ },
21
+ "firstName": {
22
+ "type": "string",
23
+ "minLength": 1,
24
+ "maxLength": 1024
25
+ },
26
+ "lastName": {
27
+ "type": "string",
28
+ "minLength": 1,
29
+ "maxLength": 1024
30
+ },
31
+ "role": {
32
+ "type": "string",
33
+ "enum": [
34
+ "admin",
35
+ "view"
36
+ ]
37
+ },
38
+ "avatarUrl": {
39
+ "type": "string",
40
+ "format": "url"
41
+ }
42
+ },
43
+ "additionalProperties": false
44
+ }
45
+ },
46
+ "count": {
47
+ "type": "integer"
48
+ },
49
+ "filter": {
50
+ "type": "string"
51
+ },
52
+ "filterField": {
53
+ "type": "string"
54
+ },
55
+ "sortField": {
56
+ "type": "string"
57
+ },
58
+ "sortDirection": {
59
+ "type": "string",
60
+ "enum": [
61
+ "asc",
62
+ "desc",
63
+ "ASC",
64
+ "DESC",
65
+ ""
66
+ ]
67
+ }
68
+ }
69
+ }
data/schemas/instanceOrg.json ADDED
@@ -0,0 +1,133 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "name": {
6
+ "type": "string",
7
+ "minLength": 1,
8
+ "maxLength": 255
9
+ },
10
+ "id": {
11
+ "type": "string",
12
+ "pattern": "^[A-Fa-f\\d]{24}$"
13
+ },
14
+ "instanceId": {
15
+ "type": "string",
16
+ "pattern": "^[A-Fa-f\\d]{24}$"
17
+ },
18
+ "description": {
19
+ "type": "string",
20
+ "maxLength": 32767
21
+ },
22
+ "iconColor": {
23
+ "type": "string",
24
+ "maxLength": 64
25
+ },
26
+ "limits": {
27
+ "apitoken": {
28
+ "type": "number"
29
+ },
30
+ "application": {
31
+ "type": "number"
32
+ },
33
+ "applicationkey": {
34
+ "type": "number"
35
+ },
36
+ "dashboard": {
37
+ "type": "number"
38
+ },
39
+ "datatable": {
40
+ "type": "number"
41
+ },
42
+ "device": {
43
+ "type": "number"
44
+ },
45
+ "devicerecipe": {
46
+ "type": "number"
47
+ },
48
+ "experiencedomain": {
49
+ "type": "number"
50
+ },
51
+ "experienceendpoint": {
52
+ "type": "number"
53
+ },
54
+ "experiencegroup": {
55
+ "type": "number"
56
+ },
57
+ "experienceslug": {
58
+ "type": "number"
59
+ },
60
+ "experienceuser": {
61
+ "type": "number"
62
+ },
63
+ "experienceversion": {
64
+ "type": "number"
65
+ },
66
+ "experienceview": {
67
+ "type": "number"
68
+ },
69
+ "file": {
70
+ "type": "number"
71
+ },
72
+ "flow": {
73
+ "type": "number"
74
+ },
75
+ "integration": {
76
+ "type": "number"
77
+ },
78
+ "notebook": {
79
+ "type": "number"
80
+ },
81
+ "webhook": {
82
+ "type": "number"
83
+ },
84
+ "dataTTL": {
85
+ "type": "number"
86
+ },
87
+ "member": {
88
+ "type": "number"
89
+ },
90
+ "payload": {
91
+ "type": "number"
92
+ },
93
+ "notebookMinutesPerRun": {
94
+ "type": "number"
95
+ },
96
+ "notebookMinutesPerMonth": {
97
+ "type": "number"
98
+ },
99
+ "notebookInParallel": {
100
+ "type": "number"
101
+ }
102
+ },
103
+ "whitelistedEmailDomains": {
104
+ "type": "array",
105
+ "items": {
106
+ "type": "string",
107
+ "maxLength": 45,
108
+ "minLength": 3
109
+ }
110
+ },
111
+ "auditLogEnabled": {
112
+ "type": "boolean"
113
+ },
114
+ "disabledAt": {
115
+ "oneOf": [
116
+ {
117
+ "type": "boolean",
118
+ "enum": [
119
+ false
120
+ ]
121
+ },
122
+ {
123
+ "type": "string",
124
+ "format": "date-time"
125
+ }
126
+ ]
127
+ }
128
+ },
129
+ "additionalProperties": false,
130
+ "required": [
131
+ "name"
132
+ ]
133
+ }
data/schemas/instanceOrgMember.json ADDED
@@ -0,0 +1,37 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "userId": {
6
+ "type": "string",
7
+ "pattern": "^[A-Fa-f\\d]{24}$"
8
+ },
9
+ "email": {
10
+ "type": "string",
11
+ "format": "email",
12
+ "maxLength": 1024
13
+ },
14
+ "firstName": {
15
+ "type": "string",
16
+ "minLength": 1,
17
+ "maxLength": 1024
18
+ },
19
+ "lastName": {
20
+ "type": "string",
21
+ "minLength": 1,
22
+ "maxLength": 1024
23
+ },
24
+ "role": {
25
+ "type": "string",
26
+ "enum": [
27
+ "admin",
28
+ "view"
29
+ ]
30
+ },
31
+ "avatarUrl": {
32
+ "type": "string",
33
+ "format": "url"
34
+ }
35
+ },
36
+ "additionalProperties": false
37
+ }