losant_rest 1.10.2 → 1.12.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (143) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/docs/_schemas.md +21561 -8561
  4. data/docs/application.md +83 -0
  5. data/docs/applicationApiTokens.md +2 -2
  6. data/docs/applicationCertificateAuthorities.md +1 -1
  7. data/docs/applicationCertificates.md +1 -1
  8. data/docs/applicationDashboard.md +133 -0
  9. data/docs/applicationDashboards.md +93 -0
  10. data/docs/applicationKeys.md +4 -3
  11. data/docs/applicationTemplate.md +46 -0
  12. data/docs/applicationTemplates.md +77 -2
  13. data/docs/applications.md +1 -1
  14. data/docs/auditLogs.md +1 -1
  15. data/docs/dashboards.md +1 -1
  16. data/docs/dataTables.md +1 -1
  17. data/docs/device.md +6 -3
  18. data/docs/deviceRecipes.md +1 -1
  19. data/docs/devices.md +130 -4
  20. data/docs/edgeDeployments.md +1 -1
  21. data/docs/events.md +1 -1
  22. data/docs/experienceEndpoint.md +1 -0
  23. data/docs/experienceEndpoints.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/file.md +4 -4
  29. data/docs/files.md +1 -1
  30. data/docs/flow.md +94 -1
  31. data/docs/flowVersion.md +96 -1
  32. data/docs/flowVersions.md +2 -1
  33. data/docs/flows.md +5 -2
  34. data/docs/integration.md +1 -0
  35. data/docs/integrations.md +1 -1
  36. data/docs/me.md +0 -36
  37. data/docs/notebooks.md +1 -1
  38. data/docs/orgs.md +1 -1
  39. data/docs/webhook.md +1 -0
  40. data/docs/webhooks.md +1 -1
  41. data/lib/losant_rest.rb +3 -0
  42. data/lib/losant_rest/application.rb +95 -0
  43. data/lib/losant_rest/application_api_tokens.rb +1 -1
  44. data/lib/losant_rest/application_dashboard.rb +176 -0
  45. data/lib/losant_rest/application_dashboards.rb +138 -0
  46. data/lib/losant_rest/application_keys.rb +3 -0
  47. data/lib/losant_rest/application_template.rb +79 -0
  48. data/lib/losant_rest/application_templates.rb +89 -1
  49. data/lib/losant_rest/client.rb +14 -2
  50. data/lib/losant_rest/device.rb +9 -3
  51. data/lib/losant_rest/devices.rb +154 -1
  52. data/lib/losant_rest/experience_endpoint.rb +2 -0
  53. data/lib/losant_rest/experience_endpoints.rb +2 -0
  54. data/lib/losant_rest/file.rb +3 -3
  55. data/lib/losant_rest/flow.rb +115 -1
  56. data/lib/losant_rest/flow_version.rb +115 -1
  57. data/lib/losant_rest/flow_versions.rb +3 -0
  58. data/lib/losant_rest/flows.rb +8 -0
  59. data/lib/losant_rest/integration.rb +2 -0
  60. data/lib/losant_rest/me.rb +0 -41
  61. data/lib/losant_rest/version.rb +1 -1
  62. data/lib/losant_rest/webhook.rb +2 -0
  63. data/schemas/advancedApplicationKeyQuery.json +1082 -0
  64. data/schemas/advancedFlowByVersionQuery.json +665 -0
  65. data/schemas/advancedFlowQuery.json +883 -0
  66. data/schemas/advancedFlowVersionQuery.json +925 -0
  67. data/schemas/application.json +8 -0
  68. data/schemas/applicationApiTokenPost.json +16 -1
  69. data/schemas/applicationApplyTemplatePatch.json +19 -0
  70. data/schemas/applicationCreationByTemplateResult.json +8 -0
  71. data/schemas/applicationDashboardPost.json +5665 -0
  72. data/schemas/applicationGlobalPatch.json +33 -0
  73. data/schemas/applicationPost.json +8 -0
  74. data/schemas/applicationTemplate.json +20 -0
  75. data/schemas/applicationTemplateCategories.json +43 -0
  76. data/schemas/applicationTemplateCategory.json +23 -0
  77. data/schemas/applicationTemplates.json +32 -0
  78. data/schemas/applications.json +8 -0
  79. data/schemas/attributeNamesResponse.json +14 -0
  80. data/schemas/authedUser.json +3 -0
  81. data/schemas/changePassword.json +2 -2
  82. data/schemas/dashboard.json +195 -26
  83. data/schemas/dashboardPatch.json +195 -26
  84. data/schemas/dashboardPost.json +195 -26
  85. data/schemas/dashboards.json +195 -26
  86. data/schemas/dataExport.json +132 -1
  87. data/schemas/deviceAttributeDataTypeFilter.json +29 -0
  88. data/schemas/deviceClassFilter.json +1 -2
  89. data/schemas/eventPost.json +22 -0
  90. data/schemas/experienceDomain.json +1 -1
  91. data/schemas/experienceDomainPatch.json +1 -1
  92. data/schemas/experienceDomainPost.json +1 -1
  93. data/schemas/experienceDomains.json +1 -1
  94. data/schemas/experienceLinkedResources.json +96 -0
  95. data/schemas/experienceVersion.json +10 -1
  96. data/schemas/experienceVersionPatch.json +9 -0
  97. data/schemas/experienceVersions.json +10 -1
  98. data/schemas/files.json +3 -0
  99. data/schemas/flow.json +32 -0
  100. data/schemas/flowErrors.json +87 -0
  101. data/schemas/flowPatch.json +32 -0
  102. data/schemas/flowPost.json +32 -0
  103. data/schemas/flowStats.json +54 -0
  104. data/schemas/flowVersion.json +64 -0
  105. data/schemas/flowVersionPost.json +32 -0
  106. data/schemas/flowVersions.json +64 -0
  107. data/schemas/flows.json +32 -0
  108. data/schemas/flowsImportPost.json +64 -0
  109. data/schemas/flowsImportResult.json +96 -0
  110. data/schemas/githubLogin.json +33 -4
  111. data/schemas/instance.json +132 -0
  112. data/schemas/instanceOrg.json +119 -0
  113. data/schemas/instanceOrgPatch.json +103 -0
  114. data/schemas/instanceOrgPost.json +114 -0
  115. data/schemas/instanceOrgs.json +160 -0
  116. data/schemas/instances.json +43 -0
  117. data/schemas/integration.json +3 -0
  118. data/schemas/integrationPatch.json +3 -0
  119. data/schemas/integrationPost.json +3 -0
  120. data/schemas/integrations.json +3 -0
  121. data/schemas/me.json +3 -3
  122. data/schemas/mePatch.json +2 -2
  123. data/schemas/notebook.json +96 -0
  124. data/schemas/notebookExecutionLogs.json +7 -0
  125. data/schemas/notebookPatch.json +96 -0
  126. data/schemas/notebookPost.json +96 -0
  127. data/schemas/notebooks.json +96 -0
  128. data/schemas/org.json +1 -1
  129. data/schemas/orgInviteInfo.json +3 -0
  130. data/schemas/orgInvitePost.json +3 -0
  131. data/schemas/orgInvites.json +3 -0
  132. data/schemas/orgPatch.json +1 -1
  133. data/schemas/orgs.json +1 -1
  134. data/schemas/passwordResetFinish.json +2 -2
  135. data/schemas/samlResponse.json +1 -1
  136. data/schemas/tagKeysResponse.json +14 -0
  137. data/schemas/tagValuesResponse.json +19 -0
  138. data/schemas/templateKeywords.json +14 -0
  139. data/schemas/timeSeriesData.json +12 -2
  140. data/schemas/timeSeriesQuery.json +94 -14
  141. data/schemas/userCredentials.json +31 -3
  142. data/schemas/userPost.json +39 -7
  143. metadata +34 -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/instanceOrg.json ADDED
@@ -0,0 +1,119 @@
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
+ },
115
+ "additionalProperties": false,
116
+ "required": [
117
+ "name"
118
+ ]
119
+ }
data/schemas/instanceOrgPatch.json ADDED
@@ -0,0 +1,103 @@
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
+ "description": {
11
+ "type": "string",
12
+ "maxLength": 32767
13
+ },
14
+ "iconColor": {
15
+ "type": "string",
16
+ "maxLength": 64
17
+ },
18
+ "limits": {
19
+ "type": "object",
20
+ "properties": {
21
+ "apitoken": {
22
+ "type": "number"
23
+ },
24
+ "application": {
25
+ "type": "number"
26
+ },
27
+ "applicationkey": {
28
+ "type": "number"
29
+ },
30
+ "dashboard": {
31
+ "type": "number"
32
+ },
33
+ "datatable": {
34
+ "type": "number"
35
+ },
36
+ "device": {
37
+ "type": "number"
38
+ },
39
+ "devicerecipe": {
40
+ "type": "number"
41
+ },
42
+ "experiencedomain": {
43
+ "type": "number"
44
+ },
45
+ "experienceendpoint": {
46
+ "type": "number"
47
+ },
48
+ "experiencegroup": {
49
+ "type": "number"
50
+ },
51
+ "experienceslug": {
52
+ "type": "number"
53
+ },
54
+ "experienceuser": {
55
+ "type": "number"
56
+ },
57
+ "experienceversion": {
58
+ "type": "number"
59
+ },
60
+ "experienceview": {
61
+ "type": "number"
62
+ },
63
+ "file": {
64
+ "type": "number"
65
+ },
66
+ "flow": {
67
+ "type": "number"
68
+ },
69
+ "integration": {
70
+ "type": "number"
71
+ },
72
+ "notebook": {
73
+ "type": "number"
74
+ },
75
+ "webhook": {
76
+ "type": "number"
77
+ },
78
+ "dataTTL": {
79
+ "type": "number"
80
+ },
81
+ "member": {
82
+ "type": "number"
83
+ },
84
+ "payload": {
85
+ "type": "number"
86
+ },
87
+ "notebookMinutesPerRun": {
88
+ "type": "number"
89
+ },
90
+ "notebookMinutesPerMonth": {
91
+ "type": "number"
92
+ },
93
+ "notebookInParallel": {
94
+ "type": "number"
95
+ }
96
+ }
97
+ },
98
+ "auditLogEnabled": {
99
+ "type": "boolean"
100
+ }
101
+ },
102
+ "additionalProperties": false
103
+ }
data/schemas/instanceOrgPost.json ADDED
@@ -0,0 +1,114 @@
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
+ "description": {
11
+ "type": "string",
12
+ "maxLength": 32767
13
+ },
14
+ "iconColor": {
15
+ "type": "string",
16
+ "maxLength": 64
17
+ },
18
+ "limits": {
19
+ "type": "object",
20
+ "properties": {
21
+ "apitoken": {
22
+ "type": "number"
23
+ },
24
+ "application": {
25
+ "type": "number"
26
+ },
27
+ "applicationkey": {
28
+ "type": "number"
29
+ },
30
+ "dashboard": {
31
+ "type": "number"
32
+ },
33
+ "datatable": {
34
+ "type": "number"
35
+ },
36
+ "device": {
37
+ "type": "number"
38
+ },
39
+ "devicerecipe": {
40
+ "type": "number"
41
+ },
42
+ "experiencedomain": {
43
+ "type": "number"
44
+ },
45
+ "experienceendpoint": {
46
+ "type": "number"
47
+ },
48
+ "experiencegroup": {
49
+ "type": "number"
50
+ },
51
+ "experienceslug": {
52
+ "type": "number"
53
+ },
54
+ "experienceuser": {
55
+ "type": "number"
56
+ },
57
+ "experienceversion": {
58
+ "type": "number"
59
+ },
60
+ "experienceview": {
61
+ "type": "number"
62
+ },
63
+ "file": {
64
+ "type": "number"
65
+ },
66
+ "flow": {
67
+ "type": "number"
68
+ },
69
+ "integration": {
70
+ "type": "number"
71
+ },
72
+ "notebook": {
73
+ "type": "number"
74
+ },
75
+ "webhook": {
76
+ "type": "number"
77
+ },
78
+ "dataTTL": {
79
+ "type": "number"
80
+ },
81
+ "member": {
82
+ "type": "number"
83
+ },
84
+ "payload": {
85
+ "type": "number"
86
+ },
87
+ "notebookMinutesPerRun": {
88
+ "type": "number"
89
+ },
90
+ "notebookMinutesPerMonth": {
91
+ "type": "number"
92
+ },
93
+ "notebookInParallel": {
94
+ "type": "number"
95
+ }
96
+ }
97
+ },
98
+ "whitelistedEmailDomains": {
99
+ "type": "array",
100
+ "items": {
101
+ "type": "string",
102
+ "maxLength": 45,
103
+ "minLength": 3
104
+ }
105
+ },
106
+ "auditLogEnabled": {
107
+ "type": "boolean"
108
+ }
109
+ },
110
+ "additionalProperties": false,
111
+ "required": [
112
+ "name"
113
+ ]
114
+ }