losant_rest 1.12.0 → 1.13.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (124) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/README.md +1 -1
  4. data/docs/_schemas.md +4164 -701
  5. data/docs/events.md +3 -3
  6. data/docs/flow.md +41 -0
  7. data/docs/instance.md +128 -0
  8. data/docs/instanceMember.md +133 -0
  9. data/docs/instanceMembers.md +91 -0
  10. data/docs/instanceOrg.md +133 -0
  11. data/docs/instanceOrgMember.md +139 -0
  12. data/docs/instanceOrgMembers.md +96 -0
  13. data/docs/instanceOrgs.md +91 -0
  14. data/docs/instances.md +50 -0
  15. data/lib/losant_rest.rb +9 -1
  16. data/lib/losant_rest/application.rb +2 -2
  17. data/lib/losant_rest/application_api_token.rb +1 -1
  18. data/lib/losant_rest/application_api_tokens.rb +1 -1
  19. data/lib/losant_rest/application_certificate.rb +1 -1
  20. data/lib/losant_rest/application_certificate_authorities.rb +1 -1
  21. data/lib/losant_rest/application_certificate_authority.rb +1 -1
  22. data/lib/losant_rest/application_certificates.rb +1 -1
  23. data/lib/losant_rest/application_dashboard.rb +1 -1
  24. data/lib/losant_rest/application_dashboards.rb +1 -1
  25. data/lib/losant_rest/application_key.rb +1 -1
  26. data/lib/losant_rest/application_keys.rb +1 -1
  27. data/lib/losant_rest/application_template.rb +1 -1
  28. data/lib/losant_rest/application_templates.rb +1 -1
  29. data/lib/losant_rest/applications.rb +1 -1
  30. data/lib/losant_rest/audit_log.rb +1 -1
  31. data/lib/losant_rest/audit_logs.rb +1 -1
  32. data/lib/losant_rest/auth.rb +1 -1
  33. data/lib/losant_rest/client.rb +35 -3
  34. data/lib/losant_rest/dashboard.rb +1 -1
  35. data/lib/losant_rest/dashboards.rb +1 -1
  36. data/lib/losant_rest/data.rb +1 -1
  37. data/lib/losant_rest/data_table.rb +1 -1
  38. data/lib/losant_rest/data_table_row.rb +1 -1
  39. data/lib/losant_rest/data_table_rows.rb +1 -1
  40. data/lib/losant_rest/data_tables.rb +1 -1
  41. data/lib/losant_rest/device.rb +1 -1
  42. data/lib/losant_rest/device_recipe.rb +1 -1
  43. data/lib/losant_rest/device_recipes.rb +1 -1
  44. data/lib/losant_rest/devices.rb +1 -1
  45. data/lib/losant_rest/edge_deployments.rb +1 -1
  46. data/lib/losant_rest/error.rb +1 -1
  47. data/lib/losant_rest/event.rb +1 -1
  48. data/lib/losant_rest/events.rb +4 -4
  49. data/lib/losant_rest/experience.rb +1 -1
  50. data/lib/losant_rest/experience_domain.rb +1 -1
  51. data/lib/losant_rest/experience_domains.rb +1 -1
  52. data/lib/losant_rest/experience_endpoint.rb +1 -1
  53. data/lib/losant_rest/experience_endpoints.rb +1 -1
  54. data/lib/losant_rest/experience_group.rb +1 -1
  55. data/lib/losant_rest/experience_groups.rb +1 -1
  56. data/lib/losant_rest/experience_slug.rb +1 -1
  57. data/lib/losant_rest/experience_slugs.rb +1 -1
  58. data/lib/losant_rest/experience_user.rb +1 -1
  59. data/lib/losant_rest/experience_users.rb +1 -1
  60. data/lib/losant_rest/experience_version.rb +1 -1
  61. data/lib/losant_rest/experience_versions.rb +1 -1
  62. data/lib/losant_rest/experience_view.rb +1 -1
  63. data/lib/losant_rest/experience_views.rb +1 -1
  64. data/lib/losant_rest/file.rb +1 -1
  65. data/lib/losant_rest/files.rb +1 -1
  66. data/lib/losant_rest/flow.rb +47 -1
  67. data/lib/losant_rest/flow_version.rb +1 -1
  68. data/lib/losant_rest/flow_versions.rb +1 -1
  69. data/lib/losant_rest/flows.rb +1 -1
  70. data/lib/losant_rest/instance.rb +181 -0
  71. data/lib/losant_rest/instance_member.rb +176 -0
  72. data/lib/losant_rest/instance_members.rb +134 -0
  73. data/lib/losant_rest/instance_org.rb +176 -0
  74. data/lib/losant_rest/instance_org_member.rb +182 -0
  75. data/lib/losant_rest/instance_org_members.rb +138 -0
  76. data/lib/losant_rest/instance_orgs.rb +139 -0
  77. data/lib/losant_rest/instances.rb +88 -0
  78. data/lib/losant_rest/integration.rb +1 -1
  79. data/lib/losant_rest/integrations.rb +1 -1
  80. data/lib/losant_rest/me.rb +2 -2
  81. data/lib/losant_rest/notebook.rb +1 -1
  82. data/lib/losant_rest/notebooks.rb +1 -1
  83. data/lib/losant_rest/org.rb +2 -2
  84. data/lib/losant_rest/org_invites.rb +1 -1
  85. data/lib/losant_rest/orgs.rb +1 -1
  86. data/lib/losant_rest/utils.rb +1 -1
  87. data/lib/losant_rest/version.rb +2 -2
  88. data/lib/losant_rest/webhook.rb +1 -1
  89. data/lib/losant_rest/webhooks.rb +1 -1
  90. data/schemas/advancedDeviceQuery.json +309 -0
  91. data/schemas/applicationApiTokenPost.json +1 -0
  92. data/schemas/applicationDashboardPost.json +19 -1
  93. data/schemas/dashboard.json +19 -1
  94. data/schemas/dashboardPatch.json +19 -1
  95. data/schemas/dashboardPost.json +19 -1
  96. data/schemas/dashboards.json +19 -1
  97. data/schemas/devicesDeletePost.json +309 -0
  98. data/schemas/devicesExportPost.json +309 -0
  99. data/schemas/devicesPatch.json +309 -0
  100. data/schemas/devicesRemoveDataPost.json +309 -0
  101. data/schemas/filePost.json +8 -2
  102. data/schemas/flowStorageMetadata.json +13 -0
  103. data/schemas/githubLogin.json +35 -11
  104. data/schemas/historicalSummaries.json +43 -0
  105. data/schemas/historicalSummary.json +455 -0
  106. data/schemas/instanceMember.json +37 -0
  107. data/schemas/instanceMemberPatch.json +17 -0
  108. data/schemas/instanceMemberPost.json +22 -0
  109. data/schemas/instanceMembers.json +69 -0
  110. data/schemas/instanceOrg.json +14 -0
  111. data/schemas/instanceOrgMember.json +37 -0
  112. data/schemas/instanceOrgMemberPatch.json +69 -0
  113. data/schemas/instanceOrgMemberPost.json +161 -0
  114. data/schemas/instanceOrgMembers.json +34 -0
  115. data/schemas/instanceOrgPatch.json +19 -0
  116. data/schemas/instanceOrgPost.json +11 -0
  117. data/schemas/instanceOrgs.json +14 -0
  118. data/schemas/instanceReportOptionsPost.json +40 -0
  119. data/schemas/multiDeviceCommand.json +309 -0
  120. data/schemas/orgPatch.json +0 -9
  121. data/schemas/payloadStats.json +110 -0
  122. data/schemas/userCredentials.json +35 -11
  123. data/schemas/userPost.json +35 -11
  124. metadata +31 -2
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 CHANGED
@@ -110,6 +110,20 @@
110
110
  },
111
111
  "auditLogEnabled": {
112
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
+ ]
113
127
  }
114
128
  },
115
129
  "additionalProperties": false,
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
+ }
data/schemas/instanceOrgMemberPatch.json ADDED
@@ -0,0 +1,69 @@
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
+ "edit",
10
+ "collaborate",
11
+ "view",
12
+ "none"
13
+ ]
14
+ },
15
+ "applicationRoles": {
16
+ "type": "array",
17
+ "items": {
18
+ "type": "object",
19
+ "properties": {
20
+ "resourceId": {
21
+ "type": "string",
22
+ "pattern": "^[A-Fa-f\\d]{24}$"
23
+ },
24
+ "role": {
25
+ "type": "string",
26
+ "enum": [
27
+ "collaborate",
28
+ "view",
29
+ "none"
30
+ ]
31
+ }
32
+ },
33
+ "required": [
34
+ "resourceId",
35
+ "role"
36
+ ],
37
+ "additionalProperties": false
38
+ },
39
+ "maxItems": 1000
40
+ },
41
+ "dashboardRoles": {
42
+ "type": "array",
43
+ "items": {
44
+ "type": "object",
45
+ "properties": {
46
+ "resourceId": {
47
+ "type": "string",
48
+ "pattern": "^[A-Fa-f\\d]{24}$"
49
+ },
50
+ "role": {
51
+ "type": "string",
52
+ "enum": [
53
+ "collaborate",
54
+ "view",
55
+ "none"
56
+ ]
57
+ }
58
+ },
59
+ "required": [
60
+ "resourceId",
61
+ "role"
62
+ ],
63
+ "additionalProperties": false
64
+ },
65
+ "maxItems": 1000
66
+ }
67
+ },
68
+ "additionalProperties": false
69
+ }
data/schemas/instanceOrgMemberPost.json ADDED
@@ -0,0 +1,161 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "oneOf": [
4
+ {
5
+ "type": "object",
6
+ "properties": {
7
+ "userId": {
8
+ "type": "string",
9
+ "pattern": "^[A-Fa-f\\d]{24}$"
10
+ },
11
+ "role": {
12
+ "type": "string",
13
+ "enum": [
14
+ "admin",
15
+ "edit",
16
+ "collaborate",
17
+ "view",
18
+ "none"
19
+ ]
20
+ },
21
+ "applicationRoles": {
22
+ "type": "array",
23
+ "items": {
24
+ "type": "object",
25
+ "properties": {
26
+ "resourceId": {
27
+ "type": "string",
28
+ "pattern": "^[A-Fa-f\\d]{24}$"
29
+ },
30
+ "role": {
31
+ "type": "string",
32
+ "enum": [
33
+ "collaborate",
34
+ "view",
35
+ "none"
36
+ ]
37
+ }
38
+ },
39
+ "required": [
40
+ "resourceId",
41
+ "role"
42
+ ],
43
+ "additionalProperties": false
44
+ },
45
+ "maxItems": 1000
46
+ },
47
+ "dashboardRoles": {
48
+ "type": "array",
49
+ "items": {
50
+ "type": "object",
51
+ "properties": {
52
+ "resourceId": {
53
+ "type": "string",
54
+ "pattern": "^[A-Fa-f\\d]{24}$"
55
+ },
56
+ "role": {
57
+ "type": "string",
58
+ "enum": [
59
+ "collaborate",
60
+ "view",
61
+ "none"
62
+ ]
63
+ }
64
+ },
65
+ "required": [
66
+ "resourceId",
67
+ "role"
68
+ ],
69
+ "additionalProperties": false
70
+ },
71
+ "maxItems": 1000
72
+ }
73
+ },
74
+ "additionalProperties": false,
75
+ "required": [
76
+ "userId",
77
+ "role"
78
+ ]
79
+ },
80
+ {
81
+ "type": "object",
82
+ "properties": {
83
+ "email": {
84
+ "type": "string",
85
+ "format": "email",
86
+ "maxLength": 1024
87
+ },
88
+ "role": {
89
+ "type": "string",
90
+ "enum": [
91
+ "admin",
92
+ "edit",
93
+ "collaborate",
94
+ "view",
95
+ "none"
96
+ ]
97
+ },
98
+ "applicationRoles": {
99
+ "type": "array",
100
+ "items": {
101
+ "type": "object",
102
+ "properties": {
103
+ "resourceId": {
104
+ "type": "string",
105
+ "pattern": "^[A-Fa-f\\d]{24}$"
106
+ },
107
+ "role": {
108
+ "type": "string",
109
+ "enum": [
110
+ "collaborate",
111
+ "view",
112
+ "none"
113
+ ]
114
+ }
115
+ },
116
+ "required": [
117
+ "resourceId",
118
+ "role"
119
+ ],
120
+ "additionalProperties": false
121
+ },
122
+ "maxItems": 1000
123
+ },
124
+ "dashboardRoles": {
125
+ "type": "array",
126
+ "items": {
127
+ "type": "object",
128
+ "properties": {
129
+ "resourceId": {
130
+ "type": "string",
131
+ "pattern": "^[A-Fa-f\\d]{24}$"
132
+ },
133
+ "role": {
134
+ "type": "string",
135
+ "enum": [
136
+ "collaborate",
137
+ "view",
138
+ "none"
139
+ ]
140
+ }
141
+ },
142
+ "required": [
143
+ "resourceId",
144
+ "role"
145
+ ],
146
+ "additionalProperties": false
147
+ },
148
+ "maxItems": 1000
149
+ },
150
+ "disallowTransfer": {
151
+ "type": "boolean"
152
+ }
153
+ },
154
+ "additionalProperties": false,
155
+ "required": [
156
+ "email",
157
+ "role"
158
+ ]
159
+ }
160
+ ]
161
+ }
data/schemas/instanceOrgMembers.json ADDED
@@ -0,0 +1,34 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "items": {
6
+ "type": "array",
7
+ "items": {
8
+ "$ref": "#/definitions/instanceOrgMembers"
9
+ }
10
+ },
11
+ "count": {
12
+ "type": "integer"
13
+ },
14
+ "filter": {
15
+ "type": "string"
16
+ },
17
+ "filterField": {
18
+ "type": "string"
19
+ },
20
+ "sortField": {
21
+ "type": "string"
22
+ },
23
+ "sortDirection": {
24
+ "type": "string",
25
+ "enum": [
26
+ "asc",
27
+ "desc",
28
+ "ASC",
29
+ "DESC",
30
+ ""
31
+ ]
32
+ }
33
+ }
34
+ }