losant_rest 1.19.0 → 1.19.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (120) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +872 -38
  3. data/docs/applications.md +49 -0
  4. data/docs/device.md +12 -3
  5. data/docs/me.md +116 -0
  6. data/lib/losant_rest/version.rb +1 -1
  7. data/lib/platform_rest/application.rb +932 -0
  8. data/lib/platform_rest/application_api_token.rb +176 -0
  9. data/lib/platform_rest/application_api_tokens.rb +136 -0
  10. data/lib/platform_rest/application_certificate.rb +176 -0
  11. data/lib/platform_rest/application_certificate_authorities.rb +138 -0
  12. data/lib/platform_rest/application_certificate_authority.rb +176 -0
  13. data/lib/platform_rest/application_certificates.rb +138 -0
  14. data/lib/platform_rest/application_dashboard.rb +225 -0
  15. data/lib/platform_rest/application_dashboards.rb +138 -0
  16. data/lib/platform_rest/application_key.rb +176 -0
  17. data/lib/platform_rest/application_keys.rb +141 -0
  18. data/lib/platform_rest/application_template.rb +79 -0
  19. data/lib/platform_rest/application_templates.rb +176 -0
  20. data/lib/platform_rest/applications.rb +209 -0
  21. data/lib/platform_rest/audit_log.rb +81 -0
  22. data/lib/platform_rest/audit_logs.rb +93 -0
  23. data/lib/platform_rest/auth.rb +245 -0
  24. data/lib/platform_rest/client.rb +410 -0
  25. data/lib/platform_rest/credential.rb +224 -0
  26. data/lib/platform_rest/credentials.rb +138 -0
  27. data/lib/platform_rest/dashboard.rb +268 -0
  28. data/lib/platform_rest/dashboards.rb +136 -0
  29. data/lib/platform_rest/data.rb +176 -0
  30. data/lib/platform_rest/data_table.rb +274 -0
  31. data/lib/platform_rest/data_table_row.rb +182 -0
  32. data/lib/platform_rest/data_table_rows.rb +343 -0
  33. data/lib/platform_rest/data_tables.rb +138 -0
  34. data/lib/platform_rest/device.rb +767 -0
  35. data/lib/platform_rest/device_recipe.rb +234 -0
  36. data/lib/platform_rest/device_recipes.rb +146 -0
  37. data/lib/platform_rest/devices.rb +707 -0
  38. data/lib/platform_rest/edge_deployment.rb +81 -0
  39. data/lib/platform_rest/edge_deployments.rb +236 -0
  40. data/lib/platform_rest/embedded_deployment.rb +81 -0
  41. data/lib/platform_rest/embedded_deployments.rb +280 -0
  42. data/lib/platform_rest/error.rb +34 -0
  43. data/lib/platform_rest/event.rb +176 -0
  44. data/lib/platform_rest/events.rb +341 -0
  45. data/lib/platform_rest/experience.rb +142 -0
  46. data/lib/platform_rest/experience_domain.rb +176 -0
  47. data/lib/platform_rest/experience_domains.rb +126 -0
  48. data/lib/platform_rest/experience_endpoint.rb +230 -0
  49. data/lib/platform_rest/experience_endpoints.rb +200 -0
  50. data/lib/platform_rest/experience_group.rb +180 -0
  51. data/lib/platform_rest/experience_groups.rb +141 -0
  52. data/lib/platform_rest/experience_slug.rb +176 -0
  53. data/lib/platform_rest/experience_slugs.rb +126 -0
  54. data/lib/platform_rest/experience_user.rb +176 -0
  55. data/lib/platform_rest/experience_users.rb +142 -0
  56. data/lib/platform_rest/experience_version.rb +176 -0
  57. data/lib/platform_rest/experience_versions.rb +138 -0
  58. data/lib/platform_rest/experience_view.rb +228 -0
  59. data/lib/platform_rest/experience_views.rb +142 -0
  60. data/lib/platform_rest/file.rb +226 -0
  61. data/lib/platform_rest/files.rb +144 -0
  62. data/lib/platform_rest/flow.rb +580 -0
  63. data/lib/platform_rest/flow_version.rb +352 -0
  64. data/lib/platform_rest/flow_versions.rb +201 -0
  65. data/lib/platform_rest/flows.rb +310 -0
  66. data/lib/platform_rest/instance.rb +377 -0
  67. data/lib/platform_rest/instance_api_token.rb +176 -0
  68. data/lib/platform_rest/instance_api_tokens.rb +136 -0
  69. data/lib/platform_rest/instance_custom_node.rb +282 -0
  70. data/lib/platform_rest/instance_custom_nodes.rb +136 -0
  71. data/lib/platform_rest/instance_member.rb +176 -0
  72. data/lib/platform_rest/instance_members.rb +134 -0
  73. data/lib/platform_rest/instance_org.rb +336 -0
  74. data/lib/platform_rest/instance_org_invite.rb +182 -0
  75. data/lib/platform_rest/instance_org_invites.rb +138 -0
  76. data/lib/platform_rest/instance_org_member.rb +182 -0
  77. data/lib/platform_rest/instance_org_members.rb +138 -0
  78. data/lib/platform_rest/instance_orgs.rb +139 -0
  79. data/lib/platform_rest/instance_sandbox.rb +181 -0
  80. data/lib/platform_rest/instance_sandboxes.rb +98 -0
  81. data/lib/platform_rest/instances.rb +88 -0
  82. data/lib/platform_rest/integration.rb +178 -0
  83. data/lib/platform_rest/integrations.rb +138 -0
  84. data/lib/platform_rest/me.rb +923 -0
  85. data/lib/platform_rest/notebook.rb +423 -0
  86. data/lib/platform_rest/notebooks.rb +138 -0
  87. data/lib/platform_rest/org.rb +663 -0
  88. data/lib/platform_rest/org_invites.rb +124 -0
  89. data/lib/platform_rest/orgs.rb +140 -0
  90. data/lib/platform_rest/resource_job.rb +326 -0
  91. data/lib/platform_rest/resource_jobs.rb +138 -0
  92. data/lib/platform_rest/user_api_token.rb +170 -0
  93. data/lib/platform_rest/user_api_tokens.rb +132 -0
  94. data/lib/platform_rest/utils.rb +44 -0
  95. data/lib/platform_rest/webhook.rb +178 -0
  96. data/lib/platform_rest/webhooks.rb +138 -0
  97. data/lib/platform_rest.rb +129 -0
  98. data/schemas/apiTokenPost.json +4 -0
  99. data/schemas/applicationDashboardPost.json +66 -0
  100. data/schemas/dashboard.json +66 -0
  101. data/schemas/dashboardPatch.json +66 -0
  102. data/schemas/dashboardPost.json +66 -0
  103. data/schemas/dashboards.json +66 -0
  104. data/schemas/deviceConnectionStatus.json +10 -0
  105. data/schemas/deviceLog.json +3 -0
  106. data/schemas/event.json +8 -0
  107. data/schemas/eventPlusNewCount.json +8 -0
  108. data/schemas/events.json +8 -0
  109. data/schemas/githubLogin.json +4 -0
  110. data/schemas/integrationPatch.json +0 -10
  111. data/schemas/orgInviteActionUser.json +18 -0
  112. data/schemas/orgInviteResultUser.json +18 -0
  113. data/schemas/orgInviteUser.json +51 -0
  114. data/schemas/orgInvitesUser.json +59 -0
  115. data/schemas/payloadCountsBreakdown.json +1 -25
  116. data/schemas/periodSummaries.json +172 -0
  117. data/schemas/samlResponse.json +4 -0
  118. data/schemas/userCredentials.json +4 -0
  119. data/schemas/userPost.json +4 -0
  120. metadata +98 -2
@@ -2601,6 +2601,10 @@
2601
2601
  }
2602
2602
  ]
2603
2603
  },
2604
+ "yAxisId": {
2605
+ "type": "string",
2606
+ "maxLength": 48
2607
+ },
2604
2608
  "lineType": {
2605
2609
  "type": "string",
2606
2610
  "enum": [
@@ -2654,6 +2658,62 @@
2654
2658
  },
2655
2659
  "additionalProperties": false
2656
2660
  }
2661
+ },
2662
+ "yAxes": {
2663
+ "type": "array",
2664
+ "maxItems": 10,
2665
+ "items": {
2666
+ "type": "object",
2667
+ "properties": {
2668
+ "id": {
2669
+ "type": "string",
2670
+ "maxLength": 48
2671
+ },
2672
+ "label": {
2673
+ "type": "string",
2674
+ "maxLength": 255
2675
+ },
2676
+ "position": {
2677
+ "type": "string",
2678
+ "enum": [
2679
+ "left",
2680
+ "right",
2681
+ "hidden"
2682
+ ],
2683
+ "default": "left"
2684
+ },
2685
+ "min": {
2686
+ "oneOf": [
2687
+ {
2688
+ "type": "number"
2689
+ },
2690
+ {
2691
+ "type": "string",
2692
+ "maxLength": 128
2693
+ }
2694
+ ]
2695
+ },
2696
+ "max": {
2697
+ "oneOf": [
2698
+ {
2699
+ "type": "number"
2700
+ },
2701
+ {
2702
+ "type": "string",
2703
+ "maxLength": 128
2704
+ }
2705
+ ]
2706
+ },
2707
+ "format": {
2708
+ "type": "string",
2709
+ "maxLength": 255
2710
+ }
2711
+ },
2712
+ "additionalProperties": false,
2713
+ "required": [
2714
+ "id"
2715
+ ]
2716
+ }
2657
2717
  }
2658
2718
  },
2659
2719
  "additionalProperties": false
@@ -3024,6 +3084,9 @@
3024
3084
  "defaultZoom": {
3025
3085
  "type": "number"
3026
3086
  },
3087
+ "disableZoom": {
3088
+ "type": "boolean"
3089
+ },
3027
3090
  "segments": {
3028
3091
  "type": "array",
3029
3092
  "maxItems": 300,
@@ -5591,6 +5654,9 @@
5591
5654
  }
5592
5655
  ]
5593
5656
  },
5657
+ "disableZoom": {
5658
+ "type": "boolean"
5659
+ },
5594
5660
  "deviceIds": {
5595
5661
  "type": "array",
5596
5662
  "maxItems": 100,
@@ -33,6 +33,11 @@
33
33
  ]
34
34
  }
35
35
  ]
36
+ },
37
+ "ipAddress": {
38
+ "type": "string",
39
+ "minLength": 2,
40
+ "maxLength": 39
36
41
  }
37
42
  },
38
43
  "required": [
@@ -104,6 +109,11 @@
104
109
  },
105
110
  "messagesToClient": {
106
111
  "type": "number"
112
+ },
113
+ "ipAddress": {
114
+ "type": "string",
115
+ "minLength": 2,
116
+ "maxLength": 39
107
117
  }
108
118
  },
109
119
  "required": [
@@ -22,6 +22,9 @@
22
22
  },
23
23
  "messagesToClient": {
24
24
  "type": "number"
25
+ },
26
+ "ipAddress": {
27
+ "type": "string"
25
28
  }
26
29
  }
27
30
  }
data/schemas/event.json CHANGED
@@ -123,6 +123,14 @@
123
123
  "maxLength": 32767
124
124
  },
125
125
  "data": {},
126
+ "state": {
127
+ "type": "string",
128
+ "enum": [
129
+ "new",
130
+ "acknowledged",
131
+ "resolved"
132
+ ]
133
+ },
126
134
  "stateChange": {
127
135
  "type": "object",
128
136
  "properties": {
@@ -128,6 +128,14 @@
128
128
  "maxLength": 32767
129
129
  },
130
130
  "data": {},
131
+ "state": {
132
+ "type": "string",
133
+ "enum": [
134
+ "new",
135
+ "acknowledged",
136
+ "resolved"
137
+ ]
138
+ },
131
139
  "stateChange": {
132
140
  "type": "object",
133
141
  "properties": {
data/schemas/events.json CHANGED
@@ -130,6 +130,14 @@
130
130
  "maxLength": 32767
131
131
  },
132
132
  "data": {},
133
+ "state": {
134
+ "type": "string",
135
+ "enum": [
136
+ "new",
137
+ "acknowledged",
138
+ "resolved"
139
+ ]
140
+ },
133
141
  "stateChange": {
134
142
  "type": "object",
135
143
  "properties": {
@@ -329,6 +329,7 @@
329
329
  "applications.post",
330
330
  "applications.import",
331
331
  "applications.detailedSummary",
332
+ "applications.periodSummaries",
332
333
  "auditLog.get",
333
334
  "auditLogs.get",
334
335
  "dashboard.patch",
@@ -463,6 +464,9 @@
463
464
  "me.deviceCounts",
464
465
  "me.notebookMinuteCounts",
465
466
  "me.transferResources",
467
+ "me.invite",
468
+ "me.invites",
469
+ "me.respondToInvite",
466
470
  "orgs.*",
467
471
  "orgs.get",
468
472
  "orgs.post"
@@ -7,16 +7,6 @@
7
7
  "minLength": 1,
8
8
  "maxLength": 255
9
9
  },
10
- "integrationType": {
11
- "type": "string",
12
- "enum": [
13
- "azureEventHub",
14
- "googlePubSub",
15
- "mqtt",
16
- "particle",
17
- "sqs"
18
- ]
19
- },
20
10
  "enabled": {
21
11
  "type": "boolean"
22
12
  },
@@ -0,0 +1,18 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "action": {
6
+ "type": "string",
7
+ "enum": [
8
+ "accept",
9
+ "dismiss",
10
+ "reject"
11
+ ]
12
+ }
13
+ },
14
+ "additionalProperties": false,
15
+ "required": [
16
+ "action"
17
+ ]
18
+ }
@@ -0,0 +1,18 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "result": {
6
+ "type": "string",
7
+ "enum": [
8
+ "accepted",
9
+ "rejected",
10
+ "dismissed"
11
+ ]
12
+ },
13
+ "orgId": {
14
+ "type": "string",
15
+ "pattern": "^[A-Fa-f\\d]{24}$"
16
+ }
17
+ }
18
+ }
@@ -0,0 +1,51 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "orgName": {
6
+ "type": "string",
7
+ "minLength": 1,
8
+ "maxLength": 255
9
+ },
10
+ "role": {
11
+ "type": "string",
12
+ "enum": [
13
+ "admin",
14
+ "edit",
15
+ "collaborate",
16
+ "view",
17
+ "none"
18
+ ]
19
+ },
20
+ "requiresMFA": {
21
+ "type": "boolean"
22
+ },
23
+ "inviteDate": {
24
+ "type": "string",
25
+ "format": "date-time"
26
+ },
27
+ "ttl": {
28
+ "type": "number"
29
+ },
30
+ "expired": {
31
+ "type": "boolean"
32
+ },
33
+ "id": {
34
+ "type": "string",
35
+ "pattern": "^[A-Fa-f\\d]{24}$"
36
+ },
37
+ "invitedBy": {
38
+ "type": "object",
39
+ "properties": {
40
+ "fullName": {
41
+ "type": "string"
42
+ },
43
+ "email": {
44
+ "type": "string",
45
+ "format": "email",
46
+ "maxLength": 1024
47
+ }
48
+ }
49
+ }
50
+ }
51
+ }
@@ -0,0 +1,59 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "type": "array",
4
+ "items": {
5
+ "type": "object",
6
+ "properties": {
7
+ "title": "Organization Invitation Information For User",
8
+ "description": "Schema for information about an invitation",
9
+ "type": "object",
10
+ "properties": {
11
+ "orgName": {
12
+ "type": "string",
13
+ "minLength": 1,
14
+ "maxLength": 255
15
+ },
16
+ "role": {
17
+ "type": "string",
18
+ "enum": [
19
+ "admin",
20
+ "edit",
21
+ "collaborate",
22
+ "view",
23
+ "none"
24
+ ]
25
+ },
26
+ "requiresMFA": {
27
+ "type": "boolean"
28
+ },
29
+ "inviteDate": {
30
+ "type": "string",
31
+ "format": "date-time"
32
+ },
33
+ "ttl": {
34
+ "type": "number"
35
+ },
36
+ "expired": {
37
+ "type": "boolean"
38
+ },
39
+ "id": {
40
+ "type": "string",
41
+ "pattern": "^[A-Fa-f\\d]{24}$"
42
+ },
43
+ "invitedBy": {
44
+ "type": "object",
45
+ "properties": {
46
+ "fullName": {
47
+ "type": "string"
48
+ },
49
+ "email": {
50
+ "type": "string",
51
+ "format": "email",
52
+ "maxLength": 1024
53
+ }
54
+ }
55
+ }
56
+ }
57
+ }
58
+ }
59
+ }
@@ -10,27 +10,6 @@
10
10
  "type": "string",
11
11
  "format": "date-time"
12
12
  },
13
- "resolution": {
14
- "type": "number",
15
- "enum": [
16
- 86400000,
17
- 3600000
18
- ]
19
- },
20
- "asBytes": {
21
- "type": "boolean",
22
- "enum": [
23
- true,
24
- false
25
- ]
26
- },
27
- "includeNonBillable": {
28
- "type": "boolean",
29
- "enum": [
30
- true,
31
- false
32
- ]
33
- },
34
13
  "counts": {
35
14
  "type": "array",
36
15
  "items": {
@@ -40,11 +19,8 @@
40
19
  "type": "string",
41
20
  "format": "date-time"
42
21
  },
43
- "payloads": {
22
+ "value": {
44
23
  "type": "integer"
45
- },
46
- "bytes": {
47
- "type": "number"
48
24
  }
49
25
  }
50
26
  }
@@ -0,0 +1,172 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "items": {
6
+ "type": "array",
7
+ "items": {
8
+ "type": "object",
9
+ "properties": {
10
+ "name": {
11
+ "type": "string",
12
+ "minLength": 1,
13
+ "maxLength": 255
14
+ },
15
+ "id": {
16
+ "type": "string",
17
+ "pattern": "^[A-Fa-f\\d]{24}$"
18
+ },
19
+ "applicationId": {
20
+ "type": "string",
21
+ "pattern": "^[A-Fa-f\\d]{24}$"
22
+ },
23
+ "summary": {
24
+ "type": "object",
25
+ "properties": {
26
+ "deviceCounts": {
27
+ "title": "Device Counts",
28
+ "description": "Schema for the result of a device counts request",
29
+ "type": "object",
30
+ "properties": {
31
+ "start": {
32
+ "type": "string",
33
+ "format": "date-time"
34
+ },
35
+ "end": {
36
+ "type": "string",
37
+ "format": "date-time"
38
+ },
39
+ "counts": {
40
+ "type": "array",
41
+ "items": {
42
+ "type": "object",
43
+ "properties": {
44
+ "date": {
45
+ "type": "string",
46
+ "format": "date-time"
47
+ },
48
+ "created": {
49
+ "type": "integer"
50
+ },
51
+ "deleted": {
52
+ "type": "integer"
53
+ },
54
+ "total": {
55
+ "type": "integer"
56
+ }
57
+ }
58
+ }
59
+ }
60
+ }
61
+ },
62
+ "notebookMinuteCounts": {
63
+ "title": "Notebook Minute Counts",
64
+ "description": "Schema for the result of a notebook minute counts request",
65
+ "type": "object",
66
+ "properties": {
67
+ "start": {
68
+ "type": "string",
69
+ "format": "date-time"
70
+ },
71
+ "end": {
72
+ "type": "string",
73
+ "format": "date-time"
74
+ },
75
+ "counts": {
76
+ "type": "array",
77
+ "items": {
78
+ "type": "object",
79
+ "properties": {
80
+ "date": {
81
+ "type": "string",
82
+ "format": "date-time"
83
+ },
84
+ "minutes": {
85
+ "type": "integer"
86
+ },
87
+ "completed": {
88
+ "type": "integer"
89
+ },
90
+ "canceled": {
91
+ "type": "integer"
92
+ },
93
+ "errored": {
94
+ "type": "integer"
95
+ },
96
+ "timeout": {
97
+ "type": "integer"
98
+ }
99
+ }
100
+ }
101
+ }
102
+ }
103
+ },
104
+ "payloadCounts": {
105
+ "title": "Payload Counts Breakdown",
106
+ "description": "Schema for the result of a payload counts breakdown request",
107
+ "type": "object",
108
+ "properties": {
109
+ "start": {
110
+ "type": "string",
111
+ "format": "date-time"
112
+ },
113
+ "end": {
114
+ "type": "string",
115
+ "format": "date-time"
116
+ },
117
+ "counts": {
118
+ "type": "array",
119
+ "items": {
120
+ "type": "object",
121
+ "properties": {
122
+ "date": {
123
+ "type": "string",
124
+ "format": "date-time"
125
+ },
126
+ "value": {
127
+ "type": "integer"
128
+ }
129
+ }
130
+ }
131
+ }
132
+ }
133
+ }
134
+ }
135
+ }
136
+ },
137
+ "additionalProperties": false
138
+ }
139
+ },
140
+ "count": {
141
+ "type": "integer"
142
+ },
143
+ "totalCount": {
144
+ "type": "integer"
145
+ },
146
+ "perPage": {
147
+ "type": "integer"
148
+ },
149
+ "page": {
150
+ "type": "integer"
151
+ },
152
+ "filter": {
153
+ "type": "string"
154
+ },
155
+ "filterField": {
156
+ "type": "string"
157
+ },
158
+ "sortField": {
159
+ "type": "string"
160
+ },
161
+ "sortDirection": {
162
+ "type": "string",
163
+ "enum": [
164
+ "asc",
165
+ "desc",
166
+ "ASC",
167
+ "DESC",
168
+ ""
169
+ ]
170
+ }
171
+ }
172
+ }
@@ -334,6 +334,7 @@
334
334
  "applications.post",
335
335
  "applications.import",
336
336
  "applications.detailedSummary",
337
+ "applications.periodSummaries",
337
338
  "auditLog.get",
338
339
  "auditLogs.get",
339
340
  "dashboard.patch",
@@ -468,6 +469,9 @@
468
469
  "me.deviceCounts",
469
470
  "me.notebookMinuteCounts",
470
471
  "me.transferResources",
472
+ "me.invite",
473
+ "me.invites",
474
+ "me.respondToInvite",
471
475
  "orgs.*",
472
476
  "orgs.get",
473
477
  "orgs.post"
@@ -338,6 +338,7 @@
338
338
  "applications.post",
339
339
  "applications.import",
340
340
  "applications.detailedSummary",
341
+ "applications.periodSummaries",
341
342
  "auditLog.get",
342
343
  "auditLogs.get",
343
344
  "dashboard.patch",
@@ -472,6 +473,9 @@
472
473
  "me.deviceCounts",
473
474
  "me.notebookMinuteCounts",
474
475
  "me.transferResources",
476
+ "me.invite",
477
+ "me.invites",
478
+ "me.respondToInvite",
475
479
  "orgs.*",
476
480
  "orgs.get",
477
481
  "orgs.post"
@@ -396,6 +396,7 @@
396
396
  "applications.post",
397
397
  "applications.import",
398
398
  "applications.detailedSummary",
399
+ "applications.periodSummaries",
399
400
  "auditLog.get",
400
401
  "auditLogs.get",
401
402
  "dashboard.patch",
@@ -530,6 +531,9 @@
530
531
  "me.deviceCounts",
531
532
  "me.notebookMinuteCounts",
532
533
  "me.transferResources",
534
+ "me.invite",
535
+ "me.invites",
536
+ "me.respondToInvite",
533
537
  "orgs.*",
534
538
  "orgs.get",
535
539
  "orgs.post"