losant_rest 1.13.1 → 1.15.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (116) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +10817 -3660
  3. data/docs/application.md +1 -1
  4. data/docs/device.md +43 -0
  5. data/docs/devices.md +39 -0
  6. data/docs/edgeDeployment.md +49 -0
  7. data/docs/embeddedDeployment.md +49 -0
  8. data/docs/embeddedDeployments.md +215 -0
  9. data/docs/flow.md +3 -3
  10. data/docs/flows.md +2 -2
  11. data/docs/instance.md +4 -2
  12. data/docs/instanceOrg.md +2 -0
  13. data/docs/instanceOrgInvite.md +139 -0
  14. data/docs/instanceOrgInvites.md +96 -0
  15. data/docs/instanceOrgMembers.md +2 -2
  16. data/docs/instanceOrgs.md +1 -1
  17. data/docs/me.md +1 -1
  18. data/docs/org.md +1 -1
  19. data/lib/losant_rest/client.rb +22 -2
  20. data/lib/losant_rest/device.rb +50 -0
  21. data/lib/losant_rest/devices.rb +46 -0
  22. data/lib/losant_rest/edge_deployment.rb +81 -0
  23. data/lib/losant_rest/embedded_deployment.rb +81 -0
  24. data/lib/losant_rest/embedded_deployments.rb +280 -0
  25. data/lib/losant_rest/flow.rb +3 -3
  26. data/lib/losant_rest/flows.rb +2 -2
  27. data/lib/losant_rest/instance.rb +1 -0
  28. data/lib/losant_rest/instance_org.rb +4 -0
  29. data/lib/losant_rest/instance_org_invite.rb +182 -0
  30. data/lib/losant_rest/instance_org_invites.rb +138 -0
  31. data/lib/losant_rest/instance_org_members.rb +2 -2
  32. data/lib/losant_rest/instance_orgs.rb +2 -2
  33. data/lib/losant_rest/version.rb +1 -1
  34. data/lib/losant_rest.rb +5 -0
  35. data/schemas/apiTokenPost.json +19 -0
  36. data/schemas/application.json +32 -32
  37. data/schemas/applicationCreationByTemplateResult.json +32 -32
  38. data/schemas/applicationDashboardPost.json +8 -5
  39. data/schemas/applicationPatch.json +13 -13
  40. data/schemas/applicationPost.json +13 -13
  41. data/schemas/applicationTemplate.json +16 -16
  42. data/schemas/applicationTemplates.json +16 -16
  43. data/schemas/applications.json +32 -32
  44. data/schemas/authedDevice.json +2 -1
  45. data/schemas/dashboard.json +8 -5
  46. data/schemas/dashboardPatch.json +8 -5
  47. data/schemas/dashboardPost.json +8 -5
  48. data/schemas/dashboardSendReport.json +6 -6
  49. data/schemas/dashboards.json +8 -5
  50. data/schemas/dataTableRowsDelete.json +1 -1
  51. data/schemas/device.json +2 -1
  52. data/schemas/deviceClassFilter.json +4 -2
  53. data/schemas/devicePatch.json +2 -1
  54. data/schemas/devicePayloadCounts.json +24 -0
  55. data/schemas/devicePost.json +2 -1
  56. data/schemas/deviceRecipe.json +2 -1
  57. data/schemas/deviceRecipePatch.json +2 -1
  58. data/schemas/deviceRecipePost.json +2 -1
  59. data/schemas/deviceRecipes.json +2 -1
  60. data/schemas/devices.json +4 -2
  61. data/schemas/devicesExportPayloadCountPost.json +1350 -0
  62. data/schemas/devicesPatch.json +4 -2
  63. data/schemas/edgeDeployment.json +20 -0
  64. data/schemas/edgeDeployments.json +20 -0
  65. data/schemas/embeddedDeployment.json +179 -0
  66. data/schemas/embeddedDeploymentExport.json +44 -0
  67. data/schemas/embeddedDeploymentRelease.json +58 -0
  68. data/schemas/embeddedDeploymentRemove.json +25 -0
  69. data/schemas/embeddedDeploymentReplace.json +29 -0
  70. data/schemas/embeddedDeployments.json +212 -0
  71. data/schemas/eventsDeleted.json +1 -1
  72. data/schemas/eventsExport.json +4 -0
  73. data/schemas/experienceEndpoint.json +6 -8
  74. data/schemas/experienceEndpointPatch.json +6 -8
  75. data/schemas/experienceEndpointPost.json +6 -8
  76. data/schemas/experienceEndpoints.json +6 -8
  77. data/schemas/experienceLinkedResources.json +790 -85
  78. data/schemas/flow.json +252 -16
  79. data/schemas/flowPatch.json +251 -16
  80. data/schemas/flowPost.json +252 -16
  81. data/schemas/flowVersion.json +503 -33
  82. data/schemas/flowVersionPost.json +251 -16
  83. data/schemas/flowVersions.json +503 -33
  84. data/schemas/flows.json +253 -16
  85. data/schemas/flowsImportPost.json +503 -32
  86. data/schemas/flowsImportResult.json +785 -79
  87. data/schemas/githubLogin.json +19 -0
  88. data/schemas/historicalSummary.json +147 -102
  89. data/schemas/instance.json +92 -79
  90. data/schemas/instanceMember.json +10 -0
  91. data/schemas/instanceMemberPost.json +18 -3
  92. data/schemas/instanceMembers.json +14 -0
  93. data/schemas/instanceOrg.json +87 -74
  94. data/schemas/instanceOrgMember.json +14 -0
  95. data/schemas/instanceOrgMembers.json +8 -0
  96. data/schemas/instanceOrgPatch.json +64 -26
  97. data/schemas/instanceOrgPost.json +65 -27
  98. data/schemas/instanceOrgs.json +91 -74
  99. data/schemas/instancePatch.json +2 -2
  100. data/schemas/me.json +134 -105
  101. data/schemas/notebook.json +32 -1
  102. data/schemas/notebookExecutionLogs.json +2 -1
  103. data/schemas/notebookPatch.json +32 -1
  104. data/schemas/notebookPost.json +32 -1
  105. data/schemas/notebooks.json +32 -1
  106. data/schemas/org.json +145 -110
  107. data/schemas/orgInvite.json +90 -0
  108. data/schemas/orgInviteCollection.json +130 -0
  109. data/schemas/orgInvites.json +82 -77
  110. data/schemas/orgRoleInfo.json +69 -0
  111. data/schemas/orgs.json +145 -110
  112. data/schemas/payloadStats.json +28 -12
  113. data/schemas/userCredentials.json +19 -0
  114. data/schemas/userPost.json +19 -0
  115. data/schemas/virtualButtonPress.json +4 -0
  116. metadata +27 -6
@@ -0,0 +1,130 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "items": {
6
+ "type": "array",
7
+ "items": {
8
+ "title": "Organization Invitation",
9
+ "description": "Schema for a pending invitation to an Organization",
10
+ "type": "object",
11
+ "properties": {
12
+ "id": {
13
+ "type": "string",
14
+ "pattern": "^[A-Fa-f\\d]{24}$"
15
+ },
16
+ "email": {
17
+ "type": "string",
18
+ "format": "email",
19
+ "maxLength": 1024
20
+ },
21
+ "role": {
22
+ "type": "string",
23
+ "enum": [
24
+ "admin",
25
+ "edit",
26
+ "collaborate",
27
+ "view",
28
+ "none"
29
+ ]
30
+ },
31
+ "applicationRoles": {
32
+ "type": "array",
33
+ "items": {
34
+ "type": "object",
35
+ "properties": {
36
+ "resourceId": {
37
+ "type": "string",
38
+ "pattern": "^[A-Fa-f\\d]{24}$"
39
+ },
40
+ "role": {
41
+ "type": "string",
42
+ "enum": [
43
+ "collaborate",
44
+ "view",
45
+ "none"
46
+ ]
47
+ }
48
+ },
49
+ "required": [
50
+ "resourceId",
51
+ "role"
52
+ ],
53
+ "additionalProperties": false
54
+ },
55
+ "maxItems": 1000
56
+ },
57
+ "dashboardRoles": {
58
+ "type": "array",
59
+ "items": {
60
+ "type": "object",
61
+ "properties": {
62
+ "resourceId": {
63
+ "type": "string",
64
+ "pattern": "^[A-Fa-f\\d]{24}$"
65
+ },
66
+ "role": {
67
+ "type": "string",
68
+ "enum": [
69
+ "collaborate",
70
+ "view",
71
+ "none"
72
+ ]
73
+ }
74
+ },
75
+ "required": [
76
+ "resourceId",
77
+ "role"
78
+ ],
79
+ "additionalProperties": false
80
+ },
81
+ "maxItems": 1000
82
+ },
83
+ "inviteDate": {
84
+ "type": "string",
85
+ "format": "date-time"
86
+ },
87
+ "ttl": {
88
+ "type": "number"
89
+ },
90
+ "hasExpired": {
91
+ "type": "boolean"
92
+ },
93
+ "disallowTransfer": {
94
+ "type": "boolean"
95
+ }
96
+ }
97
+ }
98
+ },
99
+ "instanceId": {
100
+ "type": "string",
101
+ "pattern": "^[A-Fa-f\\d]{24}$"
102
+ },
103
+ "orgId": {
104
+ "type": "string",
105
+ "pattern": "^[A-Fa-f\\d]{24}$"
106
+ },
107
+ "count": {
108
+ "type": "integer"
109
+ },
110
+ "filter": {
111
+ "type": "string"
112
+ },
113
+ "filterField": {
114
+ "type": "string"
115
+ },
116
+ "sortField": {
117
+ "type": "string"
118
+ },
119
+ "sortDirection": {
120
+ "type": "string",
121
+ "enum": [
122
+ "asc",
123
+ "desc",
124
+ "ASC",
125
+ "DESC",
126
+ ""
127
+ ]
128
+ }
129
+ }
130
+ }
@@ -4,89 +4,94 @@
4
4
  "items": {
5
5
  "type": "object",
6
6
  "properties": {
7
- "id": {
8
- "type": "string",
9
- "pattern": "^[A-Fa-f\\d]{24}$"
10
- },
11
- "email": {
12
- "type": "string",
13
- "format": "email",
14
- "maxLength": 1024
15
- },
16
- "role": {
17
- "type": "string",
18
- "enum": [
19
- "admin",
20
- "edit",
21
- "collaborate",
22
- "view",
23
- "none"
24
- ]
25
- },
26
- "applicationRoles": {
27
- "type": "array",
28
- "items": {
29
- "type": "object",
30
- "properties": {
31
- "resourceId": {
32
- "type": "string",
33
- "pattern": "^[A-Fa-f\\d]{24}$"
7
+ "title": "Organization Invitation",
8
+ "description": "Schema for a pending invitation to an Organization",
9
+ "type": "object",
10
+ "properties": {
11
+ "id": {
12
+ "type": "string",
13
+ "pattern": "^[A-Fa-f\\d]{24}$"
14
+ },
15
+ "email": {
16
+ "type": "string",
17
+ "format": "email",
18
+ "maxLength": 1024
19
+ },
20
+ "role": {
21
+ "type": "string",
22
+ "enum": [
23
+ "admin",
24
+ "edit",
25
+ "collaborate",
26
+ "view",
27
+ "none"
28
+ ]
29
+ },
30
+ "applicationRoles": {
31
+ "type": "array",
32
+ "items": {
33
+ "type": "object",
34
+ "properties": {
35
+ "resourceId": {
36
+ "type": "string",
37
+ "pattern": "^[A-Fa-f\\d]{24}$"
38
+ },
39
+ "role": {
40
+ "type": "string",
41
+ "enum": [
42
+ "collaborate",
43
+ "view",
44
+ "none"
45
+ ]
46
+ }
34
47
  },
35
- "role": {
36
- "type": "string",
37
- "enum": [
38
- "collaborate",
39
- "view",
40
- "none"
41
- ]
42
- }
48
+ "required": [
49
+ "resourceId",
50
+ "role"
51
+ ],
52
+ "additionalProperties": false
43
53
  },
44
- "required": [
45
- "resourceId",
46
- "role"
47
- ],
48
- "additionalProperties": false
54
+ "maxItems": 1000
49
55
  },
50
- "maxItems": 1000
51
- },
52
- "dashboardRoles": {
53
- "type": "array",
54
- "items": {
55
- "type": "object",
56
- "properties": {
57
- "resourceId": {
58
- "type": "string",
59
- "pattern": "^[A-Fa-f\\d]{24}$"
56
+ "dashboardRoles": {
57
+ "type": "array",
58
+ "items": {
59
+ "type": "object",
60
+ "properties": {
61
+ "resourceId": {
62
+ "type": "string",
63
+ "pattern": "^[A-Fa-f\\d]{24}$"
64
+ },
65
+ "role": {
66
+ "type": "string",
67
+ "enum": [
68
+ "collaborate",
69
+ "view",
70
+ "none"
71
+ ]
72
+ }
60
73
  },
61
- "role": {
62
- "type": "string",
63
- "enum": [
64
- "collaborate",
65
- "view",
66
- "none"
67
- ]
68
- }
74
+ "required": [
75
+ "resourceId",
76
+ "role"
77
+ ],
78
+ "additionalProperties": false
69
79
  },
70
- "required": [
71
- "resourceId",
72
- "role"
73
- ],
74
- "additionalProperties": false
80
+ "maxItems": 1000
81
+ },
82
+ "inviteDate": {
83
+ "type": "string",
84
+ "format": "date-time"
85
+ },
86
+ "ttl": {
87
+ "type": "number"
88
+ },
89
+ "hasExpired": {
90
+ "type": "boolean"
75
91
  },
76
- "maxItems": 1000
77
- },
78
- "inviteDate": {
79
- "type": "string",
80
- "format": "date-time"
81
- },
82
- "ttl": {
83
- "type": "number"
84
- },
85
- "hasExpired": {
86
- "type": "boolean"
87
- },
88
- "disallowTransfer": {
89
- "type": "boolean"
92
+ "disallowTransfer": {
93
+ "type": "boolean"
94
+ }
90
95
  }
91
96
  }
92
97
  }
@@ -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
+ }