losant_rest 1.7.2 → 1.8.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (119) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +7347 -4603
  3. data/docs/application.md +47 -0
  4. data/docs/applicationApiToken.md +3 -0
  5. data/docs/applicationApiTokens.md +2 -0
  6. data/docs/applicationKey.md +3 -0
  7. data/docs/applicationKeys.md +2 -0
  8. data/docs/applications.md +2 -0
  9. data/docs/auditLog.md +1 -0
  10. data/docs/auditLogs.md +1 -0
  11. data/docs/auth.md +4 -0
  12. data/docs/dashboard.md +4 -0
  13. data/docs/dashboards.md +2 -0
  14. data/docs/data.md +2 -0
  15. data/docs/dataTable.md +5 -0
  16. data/docs/dataTableRow.md +3 -0
  17. data/docs/dataTableRows.md +9 -3
  18. data/docs/dataTables.md +2 -0
  19. data/docs/device.md +12 -0
  20. data/docs/deviceRecipe.md +4 -0
  21. data/docs/deviceRecipes.md +2 -0
  22. data/docs/devices.md +4 -0
  23. data/docs/edgeDeployments.md +4 -0
  24. data/docs/event.md +3 -0
  25. data/docs/events.md +4 -0
  26. data/docs/experience.md +52 -8
  27. data/docs/experienceDomain.md +3 -0
  28. data/docs/experienceDomains.md +2 -0
  29. data/docs/experienceEndpoint.md +4 -0
  30. data/docs/experienceEndpoints.md +9 -1
  31. data/docs/experienceGroup.md +3 -0
  32. data/docs/experienceGroups.md +2 -0
  33. data/docs/experienceSlug.md +133 -0
  34. data/docs/experienceSlugs.md +87 -0
  35. data/docs/experienceUser.md +3 -0
  36. data/docs/experienceUsers.md +2 -0
  37. data/docs/experienceVersion.md +133 -0
  38. data/docs/experienceVersions.md +93 -0
  39. data/docs/experienceView.md +4 -0
  40. data/docs/experienceViews.md +3 -0
  41. data/docs/file.md +4 -0
  42. data/docs/files.md +2 -0
  43. data/docs/flow.md +8 -0
  44. data/docs/flowVersion.md +4 -0
  45. data/docs/flowVersions.md +2 -0
  46. data/docs/flows.md +54 -1
  47. data/docs/integration.md +3 -0
  48. data/docs/integrations.md +2 -0
  49. data/docs/me.md +19 -3
  50. data/docs/org.md +10 -0
  51. data/docs/orgInvites.md +2 -0
  52. data/docs/orgs.md +2 -0
  53. data/docs/solution.md +3 -0
  54. data/docs/solutionUser.md +3 -0
  55. data/docs/solutionUsers.md +2 -0
  56. data/docs/solutions.md +2 -0
  57. data/docs/webhook.md +3 -0
  58. data/docs/webhooks.md +2 -0
  59. data/lib/losant_rest/application.rb +47 -0
  60. data/lib/losant_rest/client.rb +18 -2
  61. data/lib/losant_rest/data_table_rows.rb +3 -3
  62. data/lib/losant_rest/experience.rb +62 -11
  63. data/lib/losant_rest/experience_endpoint.rb +2 -0
  64. data/lib/losant_rest/experience_endpoints.rb +11 -1
  65. data/lib/losant_rest/experience_slug.rb +174 -0
  66. data/lib/losant_rest/experience_slugs.rb +124 -0
  67. data/lib/losant_rest/experience_version.rb +174 -0
  68. data/lib/losant_rest/experience_versions.rb +136 -0
  69. data/lib/losant_rest/experience_view.rb +2 -0
  70. data/lib/losant_rest/experience_views.rb +2 -0
  71. data/lib/losant_rest/flows.rb +66 -1
  72. data/lib/losant_rest/version.rb +1 -1
  73. data/lib/losant_rest.rb +4 -0
  74. data/schemas/apiTokens.json +128 -0
  75. data/schemas/application.json +6 -0
  76. data/schemas/applicationApiTokenPost.json +18 -0
  77. data/schemas/applications.json +6 -0
  78. data/schemas/dataTableRowInMultiple.json +20 -0
  79. data/schemas/dataTableRowInsert.json +42 -0
  80. data/schemas/dataTableRowInsertResult.json +54 -0
  81. data/schemas/edgeDeployment.json +119 -0
  82. data/schemas/emailVerificationVerify.json +20 -0
  83. data/schemas/experienceBootstrapOptions.json +25 -0
  84. data/schemas/experienceBootstrapResult.json +16 -0
  85. data/schemas/experienceDomain.json +5 -0
  86. data/schemas/experienceDomainPatch.json +12 -0
  87. data/schemas/experienceDomainPost.json +12 -0
  88. data/schemas/experienceDomains.json +5 -0
  89. data/schemas/experienceSlug.json +37 -0
  90. data/schemas/experienceSlugPatch.json +25 -0
  91. data/schemas/experienceSlugPost.json +28 -0
  92. data/schemas/experienceSlugs.json +57 -0
  93. data/schemas/experienceVersion.json +82 -0
  94. data/schemas/experienceVersionPatch.json +19 -0
  95. data/schemas/experienceVersionPost.json +35 -0
  96. data/schemas/experienceVersions.json +102 -0
  97. data/schemas/file.json +3 -0
  98. data/schemas/files.json +3 -0
  99. data/schemas/flow.json +5 -0
  100. data/schemas/flowPatch.json +1 -0
  101. data/schemas/flowPost.json +2 -0
  102. data/schemas/flowVersion.json +622 -433
  103. data/schemas/flowVersionPost.json +1 -0
  104. data/schemas/flowVersions.json +622 -433
  105. data/schemas/flows.json +6 -0
  106. data/schemas/flowsImportPost.json +3 -0
  107. data/schemas/flowsImportResult.json +628 -434
  108. data/schemas/githubLogin.json +18 -0
  109. data/schemas/me.json +12 -0
  110. data/schemas/mqttPublishBody.json +20 -0
  111. data/schemas/org.json +12 -0
  112. data/schemas/orgs.json +12 -0
  113. data/schemas/passwordResetFinish.json +31 -0
  114. data/schemas/passwordResetInput.json +19 -0
  115. data/schemas/passwordResetResponse.json +18 -0
  116. data/schemas/solutionMe.json +150 -0
  117. data/schemas/userCredentials.json +18 -0
  118. data/schemas/userPost.json +388 -0
  119. metadata +32 -2
data/schemas/experienceDomains.json CHANGED
@@ -43,6 +43,11 @@
43
43
  "type": "string",
44
44
  "maxLength": 1024,
45
45
  "minLength": 3
46
+ },
47
+ "version": {
48
+ "type": "string",
49
+ "minLength": 1,
50
+ "maxLength": 255
46
51
  }
47
52
  }
48
53
  }
data/schemas/experienceSlug.json ADDED
@@ -0,0 +1,37 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "id": {
6
+ "type": "string",
7
+ "pattern": "^[A-Fa-f\\d]{24}$"
8
+ },
9
+ "experienceSlugId": {
10
+ "type": "string",
11
+ "pattern": "^[A-Fa-f\\d]{24}$"
12
+ },
13
+ "applicationId": {
14
+ "type": "string",
15
+ "pattern": "^[A-Fa-f\\d]{24}$"
16
+ },
17
+ "creationDate": {
18
+ "type": "string",
19
+ "format": "date-time"
20
+ },
21
+ "lastUpdated": {
22
+ "type": "string",
23
+ "format": "date-time"
24
+ },
25
+ "slug": {
26
+ "type": "string",
27
+ "minLength": 4,
28
+ "maxLength": 63,
29
+ "pattern": "^[0-9a-z-]*$"
30
+ },
31
+ "version": {
32
+ "type": "string",
33
+ "minLength": 1,
34
+ "maxLength": 255
35
+ }
36
+ }
37
+ }
data/schemas/experienceSlugPatch.json ADDED
@@ -0,0 +1,25 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "version": {
6
+ "$oneOf": [
7
+ {
8
+ "type": "string",
9
+ "minLength": 1,
10
+ "maxLength": 255
11
+ },
12
+ {
13
+ "type": null
14
+ }
15
+ ]
16
+ },
17
+ "slug": {
18
+ "type": "string",
19
+ "minLength": 4,
20
+ "maxLength": 63,
21
+ "pattern": "^[0-9a-z-]*$"
22
+ }
23
+ },
24
+ "additionalProperties": false
25
+ }
data/schemas/experienceSlugPost.json ADDED
@@ -0,0 +1,28 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "version": {
6
+ "$oneOf": [
7
+ {
8
+ "type": "string",
9
+ "minLength": 1,
10
+ "maxLength": 255
11
+ },
12
+ {
13
+ "type": null
14
+ }
15
+ ]
16
+ },
17
+ "slug": {
18
+ "type": "string",
19
+ "minLength": 4,
20
+ "maxLength": 63,
21
+ "pattern": "^[0-9a-z-]*$"
22
+ }
23
+ },
24
+ "additionalProperties": false,
25
+ "required": [
26
+ "slug"
27
+ ]
28
+ }
data/schemas/experienceSlugs.json ADDED
@@ -0,0 +1,57 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "items": {
6
+ "type": "array",
7
+ "items": {
8
+ "title": "Experience Slug",
9
+ "description": "Schema for a single Experience Slug",
10
+ "type": "object",
11
+ "properties": {
12
+ "id": {
13
+ "type": "string",
14
+ "pattern": "^[A-Fa-f\\d]{24}$"
15
+ },
16
+ "experienceSlugId": {
17
+ "type": "string",
18
+ "pattern": "^[A-Fa-f\\d]{24}$"
19
+ },
20
+ "applicationId": {
21
+ "type": "string",
22
+ "pattern": "^[A-Fa-f\\d]{24}$"
23
+ },
24
+ "creationDate": {
25
+ "type": "string",
26
+ "format": "date-time"
27
+ },
28
+ "lastUpdated": {
29
+ "type": "string",
30
+ "format": "date-time"
31
+ },
32
+ "slug": {
33
+ "type": "string",
34
+ "minLength": 4,
35
+ "maxLength": 63,
36
+ "pattern": "^[0-9a-z-]*$"
37
+ },
38
+ "version": {
39
+ "type": "string",
40
+ "minLength": 1,
41
+ "maxLength": 255
42
+ }
43
+ }
44
+ }
45
+ },
46
+ "count": {
47
+ "type": "integer"
48
+ },
49
+ "totalCount": {
50
+ "type": "integer"
51
+ },
52
+ "applicationId": {
53
+ "type": "string",
54
+ "pattern": "^[A-Fa-f\\d]{24}$"
55
+ }
56
+ }
57
+ }
data/schemas/experienceVersion.json ADDED
@@ -0,0 +1,82 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "id": {
6
+ "type": "string",
7
+ "pattern": "^[A-Fa-f\\d]{24}$"
8
+ },
9
+ "experienceVersionId": {
10
+ "type": "string",
11
+ "pattern": "^[A-Fa-f\\d]{24}$"
12
+ },
13
+ "applicationId": {
14
+ "type": "string",
15
+ "pattern": "^[A-Fa-f\\d]{24}$"
16
+ },
17
+ "creationDate": {
18
+ "type": "string",
19
+ "format": "date-time"
20
+ },
21
+ "createdById": {
22
+ "type": "string",
23
+ "pattern": "^[A-Fa-f\\d]{24}$"
24
+ },
25
+ "createdByType": {
26
+ "type": "string",
27
+ "enum": [
28
+ "flow",
29
+ "user",
30
+ "apiToken"
31
+ ]
32
+ },
33
+ "lastUpdated": {
34
+ "type": "string",
35
+ "format": "date-time"
36
+ },
37
+ "endpointDefaultCors": {
38
+ "type": "boolean"
39
+ },
40
+ "version": {
41
+ "type": "string",
42
+ "minLength": 1,
43
+ "maxLength": 255
44
+ },
45
+ "description": {
46
+ "type": "string",
47
+ "maxLength": 32767
48
+ },
49
+ "attachedDomains": {
50
+ "type": "array",
51
+ "items": {
52
+ "type": "object",
53
+ "properties": {
54
+ "domainName": {
55
+ "type": "string",
56
+ "maxLength": 1024,
57
+ "minLength": 3
58
+ },
59
+ "id": {
60
+ "type": "string",
61
+ "pattern": "^[A-Fa-f\\d]{24}$"
62
+ }
63
+ }
64
+ }
65
+ },
66
+ "attachedSlugs": {
67
+ "type": "array",
68
+ "items": {
69
+ "type": "object",
70
+ "properties": {
71
+ "slug": {
72
+ "type": "string"
73
+ },
74
+ "id": {
75
+ "type": "string",
76
+ "pattern": "^[A-Fa-f\\d]{24}$"
77
+ }
78
+ }
79
+ }
80
+ }
81
+ }
82
+ }
data/schemas/experienceVersionPatch.json ADDED
@@ -0,0 +1,19 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "endpointDefaultCors": {
6
+ "type": "boolean"
7
+ },
8
+ "description": {
9
+ "type": "string",
10
+ "maxLength": 32767
11
+ },
12
+ "sourceVersionIdOrName": {
13
+ "type": "string",
14
+ "minLength": 1,
15
+ "maxLength": 255
16
+ }
17
+ },
18
+ "additionalProperties": false
19
+ }
data/schemas/experienceVersionPost.json ADDED
@@ -0,0 +1,35 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "version": {
6
+ "type": "string",
7
+ "minLength": 1,
8
+ "maxLength": 255
9
+ },
10
+ "description": {
11
+ "type": "string",
12
+ "maxLength": 32767
13
+ },
14
+ "domainIds": {
15
+ "type": "array",
16
+ "items": {
17
+ "type": "string",
18
+ "pattern": "^[A-Fa-f\\d]{24}$"
19
+ },
20
+ "maxItems": 1000
21
+ },
22
+ "slugIds": {
23
+ "type": "array",
24
+ "items": {
25
+ "type": "string",
26
+ "pattern": "^[A-Fa-f\\d]{24}$"
27
+ },
28
+ "maxItems": 1000
29
+ }
30
+ },
31
+ "additionalProperties": false,
32
+ "required": [
33
+ "version"
34
+ ]
35
+ }
data/schemas/experienceVersions.json ADDED
@@ -0,0 +1,102 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "items": {
6
+ "type": "array",
7
+ "items": {
8
+ "title": "Experience Version",
9
+ "description": "Schema for a single Experience Version",
10
+ "type": "object",
11
+ "properties": {
12
+ "id": {
13
+ "type": "string",
14
+ "pattern": "^[A-Fa-f\\d]{24}$"
15
+ },
16
+ "experienceVersionId": {
17
+ "type": "string",
18
+ "pattern": "^[A-Fa-f\\d]{24}$"
19
+ },
20
+ "applicationId": {
21
+ "type": "string",
22
+ "pattern": "^[A-Fa-f\\d]{24}$"
23
+ },
24
+ "creationDate": {
25
+ "type": "string",
26
+ "format": "date-time"
27
+ },
28
+ "createdById": {
29
+ "type": "string",
30
+ "pattern": "^[A-Fa-f\\d]{24}$"
31
+ },
32
+ "createdByType": {
33
+ "type": "string",
34
+ "enum": [
35
+ "flow",
36
+ "user",
37
+ "apiToken"
38
+ ]
39
+ },
40
+ "lastUpdated": {
41
+ "type": "string",
42
+ "format": "date-time"
43
+ },
44
+ "endpointDefaultCors": {
45
+ "type": "boolean"
46
+ },
47
+ "version": {
48
+ "type": "string",
49
+ "minLength": 1,
50
+ "maxLength": 255
51
+ },
52
+ "description": {
53
+ "type": "string",
54
+ "maxLength": 32767
55
+ },
56
+ "attachedDomains": {
57
+ "type": "array",
58
+ "items": {
59
+ "type": "object",
60
+ "properties": {
61
+ "domainName": {
62
+ "type": "string",
63
+ "maxLength": 1024,
64
+ "minLength": 3
65
+ },
66
+ "id": {
67
+ "type": "string",
68
+ "pattern": "^[A-Fa-f\\d]{24}$"
69
+ }
70
+ }
71
+ }
72
+ },
73
+ "attachedSlugs": {
74
+ "type": "array",
75
+ "items": {
76
+ "type": "object",
77
+ "properties": {
78
+ "slug": {
79
+ "type": "string"
80
+ },
81
+ "id": {
82
+ "type": "string",
83
+ "pattern": "^[A-Fa-f\\d]{24}$"
84
+ }
85
+ }
86
+ }
87
+ }
88
+ }
89
+ }
90
+ },
91
+ "count": {
92
+ "type": "integer"
93
+ },
94
+ "totalCount": {
95
+ "type": "integer"
96
+ },
97
+ "applicationId": {
98
+ "type": "string",
99
+ "pattern": "^[A-Fa-f\\d]{24}$"
100
+ }
101
+ }
102
+ }
data/schemas/file.json CHANGED
@@ -59,6 +59,9 @@
59
59
  "fileSize": {
60
60
  "type": "number"
61
61
  },
62
+ "s3etag": {
63
+ "type": "string"
64
+ },
62
65
  "contentType": {
63
66
  "type": "string",
64
67
  "maxLength": 1024
data/schemas/files.json CHANGED
@@ -66,6 +66,9 @@
66
66
  "fileSize": {
67
67
  "type": "number"
68
68
  },
69
+ "s3etag": {
70
+ "type": "string"
71
+ },
69
72
  "contentType": {
70
73
  "type": "string",
71
74
  "maxLength": 1024
data/schemas/flow.json CHANGED
@@ -52,6 +52,7 @@
52
52
  "enum": [
53
53
  "cloud",
54
54
  "edge",
55
+ "experience",
55
56
  "customNode"
56
57
  ]
57
58
  },
@@ -79,6 +80,7 @@
79
80
  "deviceTagInactivity",
80
81
  "endpoint",
81
82
  "event",
83
+ "fileWatch",
82
84
  "integration",
83
85
  "mqttTopic",
84
86
  "request",
@@ -502,6 +504,9 @@
502
504
  ]
503
505
  }
504
506
  },
507
+ "deletedInDevelop": {
508
+ "type": "boolean"
509
+ },
505
510
  "stats": {
506
511
  "type": "object",
507
512
  "properties": {
data/schemas/flowPatch.json CHANGED
@@ -61,6 +61,7 @@
61
61
  "deviceTagInactivity",
62
62
  "endpoint",
63
63
  "event",
64
+ "fileWatch",
64
65
  "integration",
65
66
  "mqttTopic",
66
67
  "request",
data/schemas/flowPost.json CHANGED
@@ -50,6 +50,7 @@
50
50
  "deviceTagInactivity",
51
51
  "endpoint",
52
52
  "event",
53
+ "fileWatch",
53
54
  "integration",
54
55
  "mqttTopic",
55
56
  "request",
@@ -152,6 +153,7 @@
152
153
  "enum": [
153
154
  "cloud",
154
155
  "edge",
156
+ "experience",
155
157
  "customNode"
156
158
  ]
157
159
  },