losant_rest 1.22.4 → 1.23.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (73) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +1290 -142
  3. data/docs/file.md +3 -3
  4. data/docs/files.md +2 -2
  5. data/docs/privateFile.md +222 -0
  6. data/docs/privateFiles.md +97 -0
  7. data/lib/platform_rest/client.rb +10 -2
  8. data/lib/platform_rest/file.rb +3 -3
  9. data/lib/platform_rest/files.rb +1 -1
  10. data/lib/platform_rest/private_file.rb +230 -0
  11. data/lib/platform_rest/private_files.rb +146 -0
  12. data/lib/platform_rest/version.rb +1 -1
  13. data/lib/platform_rest.rb +2 -0
  14. data/schemas/apiTokenPost.json +12 -2
  15. data/schemas/application.json +7 -0
  16. data/schemas/applicationClonePost.json +4 -0
  17. data/schemas/applicationCreationByTemplateResult.json +7 -0
  18. data/schemas/applicationDashboardPost.json +3 -1
  19. data/schemas/applicationExportPost.json +4 -0
  20. data/schemas/applicationImportExecutions.json +2 -0
  21. data/schemas/applicationPatch.json +4 -0
  22. data/schemas/applicationPost.json +4 -0
  23. data/schemas/applicationTemplate.json +3 -0
  24. data/schemas/applicationTemplates.json +3 -0
  25. data/schemas/applications.json +7 -0
  26. data/schemas/auditLog.json +1 -0
  27. data/schemas/auditLogFilter.json +1 -0
  28. data/schemas/auditLogs.json +1 -0
  29. data/schemas/credentialLinkedResources.json +18 -0
  30. data/schemas/dashboard.json +3 -1
  31. data/schemas/dashboardBlockSuggestCodePost.json +620 -0
  32. data/schemas/dashboardBlockSuggestCodeResponse.json +49 -0
  33. data/schemas/dashboardPatch.json +3 -1
  34. data/schemas/dashboardPost.json +3 -1
  35. data/schemas/dashboards.json +3 -1
  36. data/schemas/experienceLinkedResources.json +18 -0
  37. data/schemas/fileUploadPostResponse.json +103 -82
  38. data/schemas/files.json +1 -1
  39. data/schemas/flow.json +6 -0
  40. data/schemas/flowPatch.json +6 -0
  41. data/schemas/flowPost.json +6 -0
  42. data/schemas/flowVersion.json +12 -0
  43. data/schemas/flowVersionPost.json +6 -0
  44. data/schemas/flowVersions.json +12 -0
  45. data/schemas/flows.json +6 -0
  46. data/schemas/flowsImportPost.json +12 -0
  47. data/schemas/flowsImportResult.json +18 -0
  48. data/schemas/githubLogin.json +12 -2
  49. data/schemas/historicalSummaries.json +10 -0
  50. data/schemas/historicalSummary.json +10 -0
  51. data/schemas/importIntoApplicationOptions.json +1 -0
  52. data/schemas/importNewApplicationOptions.json +1 -0
  53. data/schemas/instance.json +7 -0
  54. data/schemas/instanceOrg.json +7 -0
  55. data/schemas/instanceOrgPatch.json +4 -0
  56. data/schemas/instanceOrgPost.json +4 -0
  57. data/schemas/instanceOrgs.json +7 -0
  58. data/schemas/instancePatch.json +4 -0
  59. data/schemas/instanceSandbox.json +6 -0
  60. data/schemas/instanceSandboxes.json +6 -0
  61. data/schemas/instances.json +7 -0
  62. data/schemas/me.json +6 -0
  63. data/schemas/notebook.json +9 -0
  64. data/schemas/notebookPatch.json +9 -0
  65. data/schemas/notebookPost.json +9 -0
  66. data/schemas/notebooks.json +9 -0
  67. data/schemas/org.json +7 -0
  68. data/schemas/orgs.json +7 -0
  69. data/schemas/samlResponse.json +12 -2
  70. data/schemas/suggestFunctionResponse.json +13 -1
  71. data/schemas/userCredentials.json +12 -2
  72. data/schemas/userPost.json +12 -2
  73. metadata +8 -2
@@ -1143,8 +1143,10 @@
1143
1143
  "vegaLite3",
1144
1144
  "vegaLite4",
1145
1145
  "vegaLite5",
1146
+ "vegaLite6",
1146
1147
  "vega4",
1147
- "vega5"
1148
+ "vega5",
1149
+ "vega6"
1148
1150
  ]
1149
1151
  },
1150
1152
  "tooltipEventSubscribe": {
@@ -523,6 +523,12 @@
523
523
  },
524
524
  "update": {
525
525
  "type": "boolean"
526
+ },
527
+ "public": {
528
+ "type": "boolean"
529
+ },
530
+ "private": {
531
+ "type": "boolean"
526
532
  }
527
533
  },
528
534
  "additionalProperties": false
@@ -3654,6 +3660,12 @@
3654
3660
  },
3655
3661
  "update": {
3656
3662
  "type": "boolean"
3663
+ },
3664
+ "public": {
3665
+ "type": "boolean"
3666
+ },
3667
+ "private": {
3668
+ "type": "boolean"
3657
3669
  }
3658
3670
  },
3659
3671
  "additionalProperties": false
@@ -6694,6 +6706,12 @@
6694
6706
  },
6695
6707
  "update": {
6696
6708
  "type": "boolean"
6709
+ },
6710
+ "public": {
6711
+ "type": "boolean"
6712
+ },
6713
+ "private": {
6714
+ "type": "boolean"
6697
6715
  }
6698
6716
  },
6699
6717
  "additionalProperties": false
@@ -1,103 +1,124 @@
1
1
  {
2
2
  "$schema": "http://json-schema.org/draft-07/schema#",
3
- "type": "object",
4
- "properties": {
5
- "id": {
6
- "type": "string",
7
- "pattern": "^[A-Fa-f\\d]{24}$"
8
- },
9
- "applicationId": {
10
- "type": "string",
11
- "pattern": "^[A-Fa-f\\d]{24}$"
12
- },
13
- "creationDate": {
14
- "type": "string",
15
- "format": "date-time"
16
- },
17
- "lastUpdated": {
18
- "type": "string",
19
- "format": "date-time"
20
- },
21
- "authorId": {
22
- "type": "string",
23
- "pattern": "^[A-Fa-f\\d]{24}$"
24
- },
25
- "authorType": {
26
- "type": "string",
27
- "enum": [
28
- "flow",
29
- "user",
30
- "device",
31
- "apiToken",
32
- "notebook"
33
- ]
34
- },
35
- "status": {
36
- "type": "string",
37
- "enum": [
38
- "pending",
39
- "moving",
40
- "deleting",
41
- "completed"
42
- ]
43
- },
44
- "name": {
45
- "type": "string",
46
- "minLength": 1,
47
- "maxLength": 1024
48
- },
49
- "parentDirectory": {
50
- "type": "string",
51
- "maxLength": 1024
52
- },
53
- "type": {
54
- "type": "string",
55
- "enum": [
56
- "file",
57
- "directory"
58
- ]
59
- },
60
- "fileSize": {
61
- "type": "number"
62
- },
63
- "contentType": {
64
- "type": "string",
65
- "maxLength": 1024
66
- },
67
- "fileDimensions": {
3
+ "allOf": [
4
+ {
5
+ "title": "File Schema",
6
+ "description": "Schema for a single public or private file",
68
7
  "type": "object",
69
8
  "properties": {
70
- "width": {
71
- "type": "number"
9
+ "id": {
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
+ "authorId": {
26
+ "type": "string",
27
+ "pattern": "^[A-Fa-f\\d]{24}$"
28
+ },
29
+ "authorType": {
30
+ "type": "string",
31
+ "enum": [
32
+ "flow",
33
+ "user",
34
+ "device",
35
+ "apiToken",
36
+ "notebook"
37
+ ]
38
+ },
39
+ "status": {
40
+ "type": "string",
41
+ "enum": [
42
+ "pending",
43
+ "moving",
44
+ "deleting",
45
+ "completed"
46
+ ]
47
+ },
48
+ "name": {
49
+ "type": "string",
50
+ "minLength": 1,
51
+ "maxLength": 1024
52
+ },
53
+ "parentDirectory": {
54
+ "type": "string",
55
+ "maxLength": 1024
72
56
  },
73
- "height": {
57
+ "type": {
58
+ "type": "string",
59
+ "enum": [
60
+ "file",
61
+ "directory"
62
+ ]
63
+ },
64
+ "fileSize": {
74
65
  "type": "number"
66
+ },
67
+ "s3etag": {
68
+ "type": "string"
69
+ },
70
+ "contentType": {
71
+ "type": "string",
72
+ "maxLength": 1024
73
+ },
74
+ "fileDimensions": {
75
+ "type": "object",
76
+ "properties": {
77
+ "width": {
78
+ "type": "number"
79
+ },
80
+ "height": {
81
+ "type": "number"
82
+ }
83
+ }
84
+ },
85
+ "moveIntoId": {
86
+ "type": "string",
87
+ "pattern": "^[A-Fa-f\\d]{24}$"
88
+ },
89
+ "url": {
90
+ "type": "string"
75
91
  }
76
92
  }
77
93
  },
78
- "upload": {
94
+ {
79
95
  "type": "object",
80
96
  "properties": {
81
- "url": {
82
- "type": "string"
83
- },
84
- "fields": {
97
+ "upload": {
85
98
  "type": "object",
86
- "patternProperties": {
87
- "^.*$": {
88
- "type": "string"
89
- }
90
- },
91
99
  "properties": {
92
- "key": {
100
+ "url": {
93
101
  "type": "string"
94
102
  },
95
- "bucket": {
96
- "type": "string"
103
+ "fields": {
104
+ "type": "object",
105
+ "patternProperties": {
106
+ "^.*$": {
107
+ "type": "string"
108
+ }
109
+ },
110
+ "properties": {
111
+ "key": {
112
+ "type": "string"
113
+ },
114
+ "bucket": {
115
+ "type": "string"
116
+ }
117
+ }
97
118
  }
98
119
  }
99
120
  }
100
121
  }
101
122
  }
102
- }
123
+ ]
103
124
  }
data/schemas/files.json CHANGED
@@ -6,7 +6,7 @@
6
6
  "type": "array",
7
7
  "items": {
8
8
  "title": "File Schema",
9
- "description": "Schema for a single file",
9
+ "description": "Schema for a single public or private file",
10
10
  "type": "object",
11
11
  "properties": {
12
12
  "id": {
data/schemas/flow.json CHANGED
@@ -127,6 +127,12 @@
127
127
  },
128
128
  "update": {
129
129
  "type": "boolean"
130
+ },
131
+ "public": {
132
+ "type": "boolean"
133
+ },
134
+ "private": {
135
+ "type": "boolean"
130
136
  }
131
137
  },
132
138
  "additionalProperties": false
@@ -84,6 +84,12 @@
84
84
  },
85
85
  "update": {
86
86
  "type": "boolean"
87
+ },
88
+ "public": {
89
+ "type": "boolean"
90
+ },
91
+ "private": {
92
+ "type": "boolean"
87
93
  }
88
94
  },
89
95
  "additionalProperties": false
@@ -73,6 +73,12 @@
73
73
  },
74
74
  "update": {
75
75
  "type": "boolean"
76
+ },
77
+ "public": {
78
+ "type": "boolean"
79
+ },
80
+ "private": {
81
+ "type": "boolean"
76
82
  }
77
83
  },
78
84
  "additionalProperties": false
@@ -102,6 +102,12 @@
102
102
  },
103
103
  "update": {
104
104
  "type": "boolean"
105
+ },
106
+ "public": {
107
+ "type": "boolean"
108
+ },
109
+ "private": {
110
+ "type": "boolean"
105
111
  }
106
112
  },
107
113
  "additionalProperties": false
@@ -3142,6 +3148,12 @@
3142
3148
  },
3143
3149
  "update": {
3144
3150
  "type": "boolean"
3151
+ },
3152
+ "public": {
3153
+ "type": "boolean"
3154
+ },
3155
+ "private": {
3156
+ "type": "boolean"
3145
3157
  }
3146
3158
  },
3147
3159
  "additionalProperties": false
@@ -42,6 +42,12 @@
42
42
  },
43
43
  "update": {
44
44
  "type": "boolean"
45
+ },
46
+ "public": {
47
+ "type": "boolean"
48
+ },
49
+ "private": {
50
+ "type": "boolean"
45
51
  }
46
52
  },
47
53
  "additionalProperties": false
@@ -109,6 +109,12 @@
109
109
  },
110
110
  "update": {
111
111
  "type": "boolean"
112
+ },
113
+ "public": {
114
+ "type": "boolean"
115
+ },
116
+ "private": {
117
+ "type": "boolean"
112
118
  }
113
119
  },
114
120
  "additionalProperties": false
@@ -3149,6 +3155,12 @@
3149
3155
  },
3150
3156
  "update": {
3151
3157
  "type": "boolean"
3158
+ },
3159
+ "public": {
3160
+ "type": "boolean"
3161
+ },
3162
+ "private": {
3163
+ "type": "boolean"
3152
3164
  }
3153
3165
  },
3154
3166
  "additionalProperties": false
data/schemas/flows.json CHANGED
@@ -134,6 +134,12 @@
134
134
  },
135
135
  "update": {
136
136
  "type": "boolean"
137
+ },
138
+ "public": {
139
+ "type": "boolean"
140
+ },
141
+ "private": {
142
+ "type": "boolean"
137
143
  }
138
144
  },
139
145
  "additionalProperties": false
@@ -87,6 +87,12 @@
87
87
  },
88
88
  "update": {
89
89
  "type": "boolean"
90
+ },
91
+ "public": {
92
+ "type": "boolean"
93
+ },
94
+ "private": {
95
+ "type": "boolean"
90
96
  }
91
97
  },
92
98
  "additionalProperties": false
@@ -3116,6 +3122,12 @@
3116
3122
  },
3117
3123
  "update": {
3118
3124
  "type": "boolean"
3125
+ },
3126
+ "public": {
3127
+ "type": "boolean"
3128
+ },
3129
+ "private": {
3130
+ "type": "boolean"
3119
3131
  }
3120
3132
  },
3121
3133
  "additionalProperties": false
@@ -135,6 +135,12 @@
135
135
  },
136
136
  "update": {
137
137
  "type": "boolean"
138
+ },
139
+ "public": {
140
+ "type": "boolean"
141
+ },
142
+ "private": {
143
+ "type": "boolean"
138
144
  }
139
145
  },
140
146
  "additionalProperties": false
@@ -3215,6 +3221,12 @@
3215
3221
  },
3216
3222
  "update": {
3217
3223
  "type": "boolean"
3224
+ },
3225
+ "public": {
3226
+ "type": "boolean"
3227
+ },
3228
+ "private": {
3229
+ "type": "boolean"
3218
3230
  }
3219
3231
  },
3220
3232
  "additionalProperties": false
@@ -6255,6 +6267,12 @@
6255
6267
  },
6256
6268
  "update": {
6257
6269
  "type": "boolean"
6270
+ },
6271
+ "public": {
6272
+ "type": "boolean"
6273
+ },
6274
+ "private": {
6275
+ "type": "boolean"
6258
6276
  }
6259
6277
  },
6260
6278
  "additionalProperties": false
@@ -77,10 +77,12 @@
77
77
  "flows.*",
78
78
  "flowVersion.*",
79
79
  "flowVersions.*",
80
- "resourceJobs.*",
81
- "resourceJob.*",
82
80
  "notebook.*",
83
81
  "notebooks.*",
82
+ "privateFile.*",
83
+ "privateFiles.*",
84
+ "resourceJobs.*",
85
+ "resourceJob.*",
84
86
  "webhook.*",
85
87
  "webhooks.*",
86
88
  "application.applyTemplate",
@@ -317,6 +319,13 @@
317
319
  "notebook.upload",
318
320
  "notebooks.get",
319
321
  "notebooks.post",
322
+ "privateFile.get",
323
+ "privateFile.patch",
324
+ "privateFile.move",
325
+ "privateFile.delete",
326
+ "privateFile.upload",
327
+ "privateFiles.get",
328
+ "privateFiles.post",
320
329
  "resourceJob.get",
321
330
  "resourceJob.logs",
322
331
  "resourceJob.patch",
@@ -353,6 +362,7 @@
353
362
  "dashboard.patch",
354
363
  "dashboard.delete",
355
364
  "dashboard.sendReport",
365
+ "dashboard.suggestCode",
356
366
  "dashboards.get",
357
367
  "dashboards.post",
358
368
  "org.get",
@@ -132,6 +132,10 @@
132
132
  "type": "integer",
133
133
  "minimum": 0
134
134
  },
135
+ "privatefile": {
136
+ "type": "integer",
137
+ "minimum": 0
138
+ },
135
139
  "resourcejob": {
136
140
  "type": "integer",
137
141
  "minimum": 0
@@ -288,6 +292,12 @@
288
292
  "notebookMinutesCount": {
289
293
  "type": "number"
290
294
  },
295
+ "privateFileCount": {
296
+ "type": "number"
297
+ },
298
+ "privateFileTotalSizeMb": {
299
+ "type": "number"
300
+ },
291
301
  "webhookCount": {
292
302
  "type": "number"
293
303
  },
@@ -125,6 +125,10 @@
125
125
  "type": "integer",
126
126
  "minimum": 0
127
127
  },
128
+ "privatefile": {
129
+ "type": "integer",
130
+ "minimum": 0
131
+ },
128
132
  "resourcejob": {
129
133
  "type": "integer",
130
134
  "minimum": 0
@@ -281,6 +285,12 @@
281
285
  "notebookMinutesCount": {
282
286
  "type": "number"
283
287
  },
288
+ "privateFileCount": {
289
+ "type": "number"
290
+ },
291
+ "privateFileTotalSizeMb": {
292
+ "type": "number"
293
+ },
284
294
  "webhookCount": {
285
295
  "type": "number"
286
296
  },
@@ -57,6 +57,7 @@
57
57
  "Global",
58
58
  "Integration",
59
59
  "Notebook",
60
+ "PrivateFile",
60
61
  "Webhook",
61
62
  "ResourceJob"
62
63
  ]
@@ -35,6 +35,7 @@
35
35
  "Global",
36
36
  "Integration",
37
37
  "Notebook",
38
+ "PrivateFile",
38
39
  "Webhook",
39
40
  "ResourceJob"
40
41
  ]
@@ -165,6 +165,9 @@
165
165
  "notebook": {
166
166
  "type": "integer"
167
167
  },
168
+ "privatefile": {
169
+ "type": "integer"
170
+ },
168
171
  "resourcejob": {
169
172
  "type": "integer"
170
173
  },
@@ -291,6 +294,10 @@
291
294
  "type": "integer",
292
295
  "minimum": 0
293
296
  },
297
+ "privatefile": {
298
+ "type": "integer",
299
+ "minimum": 0
300
+ },
294
301
  "resourcejob": {
295
302
  "type": "integer",
296
303
  "minimum": 0
@@ -122,6 +122,10 @@
122
122
  "type": "integer",
123
123
  "minimum": 0
124
124
  },
125
+ "privatefile": {
126
+ "type": "integer",
127
+ "minimum": 0
128
+ },
125
129
  "resourcejob": {
126
130
  "type": "integer",
127
131
  "minimum": 0
@@ -243,6 +247,9 @@
243
247
  "notebookCount": {
244
248
  "type": "integer"
245
249
  },
250
+ "privateFileCount": {
251
+ "type": "integer"
252
+ },
246
253
  "resourceJobCount": {
247
254
  "type": "integer"
248
255
  },
@@ -102,6 +102,10 @@
102
102
  "type": "integer",
103
103
  "minimum": 0
104
104
  },
105
+ "privatefile": {
106
+ "type": "integer",
107
+ "minimum": 0
108
+ },
105
109
  "resourcejob": {
106
110
  "type": "integer",
107
111
  "minimum": 0
@@ -102,6 +102,10 @@
102
102
  "type": "integer",
103
103
  "minimum": 0
104
104
  },
105
+ "privatefile": {
106
+ "type": "integer",
107
+ "minimum": 0
108
+ },
105
109
  "resourcejob": {
106
110
  "type": "integer",
107
111
  "minimum": 0
@@ -129,6 +129,10 @@
129
129
  "type": "integer",
130
130
  "minimum": 0
131
131
  },
132
+ "privatefile": {
133
+ "type": "integer",
134
+ "minimum": 0
135
+ },
132
136
  "resourcejob": {
133
137
  "type": "integer",
134
138
  "minimum": 0
@@ -250,6 +254,9 @@
250
254
  "notebookCount": {
251
255
  "type": "integer"
252
256
  },
257
+ "privateFileCount": {
258
+ "type": "integer"
259
+ },
253
260
  "resourceJobCount": {
254
261
  "type": "integer"
255
262
  },
@@ -150,6 +150,10 @@
150
150
  "type": "integer",
151
151
  "minimum": 0
152
152
  },
153
+ "privatefile": {
154
+ "type": "integer",
155
+ "minimum": 0
156
+ },
153
157
  "resourcejob": {
154
158
  "type": "integer",
155
159
  "minimum": 0