losant_rest 1.19.2 → 1.19.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/docs/_schemas.md +292 -2
- data/docs/application.md +40 -0
- data/lib/losant_rest/version.rb +1 -1
- data/lib/platform_rest/application.rb +48 -0
- data/lib/platform_rest/client.rb +2 -2
- data/schemas/apiTokenPost.json +1 -0
- data/schemas/applicationImportExecutions.json +205 -0
- data/schemas/authedUser.json +4 -0
- data/schemas/dataExport.json +1 -0
- data/schemas/devicesRemoveDataPost.json +2 -2
- data/schemas/githubLogin.json +1 -0
- data/schemas/importIntoApplicationOptions.json +4 -0
- data/schemas/instance.json +8 -0
- data/schemas/instancePatch.json +8 -0
- data/schemas/instances.json +8 -0
- data/schemas/samlResponse.json +1 -0
- data/schemas/userCredentials.json +1 -0
- data/schemas/userPost.json +8 -0
- metadata +3 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e2311856f8d4cb480eefc36c55fa6824192a59eaebaf8dfcf42a0c4780b943dd
|
4
|
+
data.tar.gz: 71592be949a004278b8733b85d2874c24c32d5814533a00f6db447f4a3ad0052
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e5bd93d63f5dbdf360666c96faeb2b9e81f90236c094e350a2f5e15c7bc998d21f3d9f5ecd4c51cf748befa0b2b377fa79ef218d55583f5d9a6a2792079b642a
|
7
|
+
data.tar.gz: c09105c57c44263c78d8ea127c98abc57c869ad278f8010d6ec1ba875a1ddd77749751c0ca21b6e5736b1583af8065b6f68e2d2c829b7b9ad3d7db10427e4079
|
data/docs/_schemas.md
CHANGED
@@ -29,6 +29,7 @@
|
|
29
29
|
* [Application Export Post Schema](#application-export-post-schema)
|
30
30
|
* [Application Export Result](#application-export-result)
|
31
31
|
* [Application Global Patch](#application-global-patch)
|
32
|
+
* [Application Import Executions](#application-import-executions)
|
32
33
|
* [Application Key](#application-key)
|
33
34
|
* [Application Key Patch](#application-key-patch)
|
34
35
|
* [Application Key Post](#application-key-post)
|
@@ -8792,6 +8793,7 @@ Schema for the body of an API Token creation request
|
|
8792
8793
|
"application.deviceCounts",
|
8793
8794
|
"application.notebookMinuteCounts",
|
8794
8795
|
"application.search",
|
8796
|
+
"application.importLogs",
|
8795
8797
|
"applicationApiToken.delete",
|
8796
8798
|
"applicationApiToken.get",
|
8797
8799
|
"applicationApiToken.patch",
|
@@ -17999,6 +18001,250 @@ Schema for the body of an Application Global modification request
|
|
17999
18001
|
|
18000
18002
|
<br/>
|
18001
18003
|
|
18004
|
+
## Application Import Executions
|
18005
|
+
|
18006
|
+
Schema for a list Application import executions
|
18007
|
+
|
18008
|
+
### <a name="application-import-executions-schema"></a> Schema
|
18009
|
+
|
18010
|
+
```json
|
18011
|
+
{
|
18012
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
18013
|
+
"type": "array",
|
18014
|
+
"items": {
|
18015
|
+
"type": "object",
|
18016
|
+
"properties": {
|
18017
|
+
"id": {
|
18018
|
+
"type": "string",
|
18019
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
18020
|
+
},
|
18021
|
+
"importSourceType": {
|
18022
|
+
"type": "string",
|
18023
|
+
"enum": [
|
18024
|
+
"importBundle",
|
18025
|
+
"importUrl",
|
18026
|
+
"fromApplication"
|
18027
|
+
]
|
18028
|
+
},
|
18029
|
+
"importExecutionId": {
|
18030
|
+
"type": "string",
|
18031
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
18032
|
+
},
|
18033
|
+
"applicationId": {
|
18034
|
+
"type": "string",
|
18035
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
18036
|
+
},
|
18037
|
+
"fromApplicationId": {
|
18038
|
+
"type": "string",
|
18039
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
18040
|
+
},
|
18041
|
+
"runQueuedAt": {
|
18042
|
+
"type": "string",
|
18043
|
+
"format": "date-time"
|
18044
|
+
},
|
18045
|
+
"runStartedAt": {
|
18046
|
+
"type": "string",
|
18047
|
+
"format": "date-time"
|
18048
|
+
},
|
18049
|
+
"runCompletedAt": {
|
18050
|
+
"type": "string",
|
18051
|
+
"format": "date-time"
|
18052
|
+
},
|
18053
|
+
"status": {
|
18054
|
+
"type": "string",
|
18055
|
+
"enum": [
|
18056
|
+
"queued",
|
18057
|
+
"inProgress",
|
18058
|
+
"completed",
|
18059
|
+
"errored",
|
18060
|
+
"failed"
|
18061
|
+
]
|
18062
|
+
},
|
18063
|
+
"dryRun": {
|
18064
|
+
"type": "boolean"
|
18065
|
+
},
|
18066
|
+
"conflictBehavior": {
|
18067
|
+
"type": "string",
|
18068
|
+
"enum": [
|
18069
|
+
"create",
|
18070
|
+
"error",
|
18071
|
+
"retain",
|
18072
|
+
"replace"
|
18073
|
+
],
|
18074
|
+
"default": "create"
|
18075
|
+
},
|
18076
|
+
"callbackUrl": {
|
18077
|
+
"type": "string",
|
18078
|
+
"format": "uri",
|
18079
|
+
"maxLength": 1024
|
18080
|
+
},
|
18081
|
+
"email": {
|
18082
|
+
"type": "string",
|
18083
|
+
"format": "email",
|
18084
|
+
"maxLength": 1024
|
18085
|
+
},
|
18086
|
+
"include": {
|
18087
|
+
"type": "array",
|
18088
|
+
"items": {
|
18089
|
+
"enum": [
|
18090
|
+
"ApplicationCertificateAuthority",
|
18091
|
+
"Dashboard",
|
18092
|
+
"DataTableRow",
|
18093
|
+
"DataTable",
|
18094
|
+
"DeviceRecipe",
|
18095
|
+
"Device",
|
18096
|
+
"ExperienceDevelopConfig",
|
18097
|
+
"ExperienceEndpoint",
|
18098
|
+
"ExperienceFlowVersion",
|
18099
|
+
"ExperienceGroup",
|
18100
|
+
"ExperienceUser",
|
18101
|
+
"ExperienceVersion",
|
18102
|
+
"ExperienceView",
|
18103
|
+
"File",
|
18104
|
+
"FlowVersion",
|
18105
|
+
"Flow",
|
18106
|
+
"Global",
|
18107
|
+
"Integration",
|
18108
|
+
"Notebook",
|
18109
|
+
"Webhook",
|
18110
|
+
"ResourceJob"
|
18111
|
+
]
|
18112
|
+
},
|
18113
|
+
"uniqueItems": true
|
18114
|
+
},
|
18115
|
+
"jobId": {
|
18116
|
+
"type": "string",
|
18117
|
+
"maxLength": 21
|
18118
|
+
},
|
18119
|
+
"sourceId": {
|
18120
|
+
"type": "string",
|
18121
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
18122
|
+
},
|
18123
|
+
"sourceType": {
|
18124
|
+
"type": "string",
|
18125
|
+
"enum": [
|
18126
|
+
"flow",
|
18127
|
+
"user",
|
18128
|
+
"device",
|
18129
|
+
"apiToken",
|
18130
|
+
"notebook"
|
18131
|
+
]
|
18132
|
+
},
|
18133
|
+
"error": {
|
18134
|
+
"type": "object",
|
18135
|
+
"properties": {
|
18136
|
+
"name": {
|
18137
|
+
"type": "string"
|
18138
|
+
},
|
18139
|
+
"message": {
|
18140
|
+
"type": "string"
|
18141
|
+
}
|
18142
|
+
}
|
18143
|
+
},
|
18144
|
+
"dryRunResults": {
|
18145
|
+
"type": "object",
|
18146
|
+
"properties": {
|
18147
|
+
"limitErrors": {
|
18148
|
+
"type": "array",
|
18149
|
+
"items": {
|
18150
|
+
"enum": [
|
18151
|
+
"ApplicationCertificateAuthority",
|
18152
|
+
"Dashboard",
|
18153
|
+
"DataTableRow",
|
18154
|
+
"DataTable",
|
18155
|
+
"DeviceRecipe",
|
18156
|
+
"Device",
|
18157
|
+
"ExperienceDevelopConfig",
|
18158
|
+
"ExperienceEndpoint",
|
18159
|
+
"ExperienceFlowVersion",
|
18160
|
+
"ExperienceGroup",
|
18161
|
+
"ExperienceUser",
|
18162
|
+
"ExperienceVersion",
|
18163
|
+
"ExperienceView",
|
18164
|
+
"File",
|
18165
|
+
"FlowVersion",
|
18166
|
+
"Flow",
|
18167
|
+
"Global",
|
18168
|
+
"Integration",
|
18169
|
+
"Notebook",
|
18170
|
+
"Webhook",
|
18171
|
+
"ResourceJob"
|
18172
|
+
]
|
18173
|
+
},
|
18174
|
+
"uniqueItems": true
|
18175
|
+
},
|
18176
|
+
"url": {
|
18177
|
+
"type": "string",
|
18178
|
+
"format": "uri",
|
18179
|
+
"maxLength": 1024
|
18180
|
+
}
|
18181
|
+
}
|
18182
|
+
},
|
18183
|
+
"validationErrors": {
|
18184
|
+
"type": "array",
|
18185
|
+
"items": {
|
18186
|
+
"type": "object",
|
18187
|
+
"properties": {
|
18188
|
+
"type": {
|
18189
|
+
"type": "string"
|
18190
|
+
},
|
18191
|
+
"name": {
|
18192
|
+
"type": "string"
|
18193
|
+
},
|
18194
|
+
"id": {
|
18195
|
+
"type": "string"
|
18196
|
+
},
|
18197
|
+
"message": {
|
18198
|
+
"type": "string"
|
18199
|
+
}
|
18200
|
+
}
|
18201
|
+
}
|
18202
|
+
},
|
18203
|
+
"importedFileUrl": {
|
18204
|
+
"type": "string",
|
18205
|
+
"format": "uri",
|
18206
|
+
"maxLength": 1024
|
18207
|
+
},
|
18208
|
+
"importUrl": {
|
18209
|
+
"type": "string",
|
18210
|
+
"format": "uri",
|
18211
|
+
"maxLength": 1024
|
18212
|
+
}
|
18213
|
+
}
|
18214
|
+
}
|
18215
|
+
}
|
18216
|
+
```
|
18217
|
+
### <a name="application-import-executions-example"></a> Example
|
18218
|
+
|
18219
|
+
```json
|
18220
|
+
[
|
18221
|
+
{
|
18222
|
+
"importExecutionId": "575ec76c7ae143cd83dc4a96",
|
18223
|
+
"id": "575ec76c7ae143cd83dc4a96",
|
18224
|
+
"importSourceType": "importBundle",
|
18225
|
+
"status": "completed",
|
18226
|
+
"conflictBehavior": "create",
|
18227
|
+
"dryRun": false,
|
18228
|
+
"email": "test@losant.com",
|
18229
|
+
"include": [
|
18230
|
+
"ExperienceUser",
|
18231
|
+
"ExperienceEndpoint",
|
18232
|
+
"ExperienceGroup",
|
18233
|
+
"ExperienceVersion",
|
18234
|
+
"ExperienceView"
|
18235
|
+
],
|
18236
|
+
"applicationId": "575ec8687ae143cd83dc4a97",
|
18237
|
+
"sourceId": "575ec8687ae143cd83dc4a96",
|
18238
|
+
"sourceType": "user",
|
18239
|
+
"runCompletedAt": "2016-06-13T04:00:00.000Z",
|
18240
|
+
"importedFileUrl": "https://example.com/my/filename.zip",
|
18241
|
+
"runStartedAt": "2016-06-13T04:00:00.000Z"
|
18242
|
+
}
|
18243
|
+
]
|
18244
|
+
```
|
18245
|
+
|
18246
|
+
<br/>
|
18247
|
+
|
18002
18248
|
## Application Key
|
18003
18249
|
|
18004
18250
|
Schema for a single Application Key
|
@@ -21124,6 +21370,10 @@ Schema for the successful response when authenticating a User
|
|
21124
21370
|
},
|
21125
21371
|
"needsToVerifyEmail": {
|
21126
21372
|
"type": "boolean"
|
21373
|
+
},
|
21374
|
+
"orgId": {
|
21375
|
+
"type": "string",
|
21376
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
21127
21377
|
}
|
21128
21378
|
},
|
21129
21379
|
"required": [
|
@@ -57579,6 +57829,7 @@ Schema for exporting data devices query
|
|
57579
57829
|
},
|
57580
57830
|
"attributes": {
|
57581
57831
|
"type": "array",
|
57832
|
+
"maxItems": 256,
|
57582
57833
|
"items": {
|
57583
57834
|
"type": "string",
|
57584
57835
|
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
@@ -71335,10 +71586,10 @@ Schema for the body of a bulk data removal request
|
|
71335
71586
|
},
|
71336
71587
|
{
|
71337
71588
|
"type": "array",
|
71338
|
-
"maxItems":
|
71589
|
+
"maxItems": 256,
|
71339
71590
|
"items": {
|
71340
71591
|
"type": "string",
|
71341
|
-
"
|
71592
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
71342
71593
|
}
|
71343
71594
|
}
|
71344
71595
|
]
|
@@ -126365,6 +126616,7 @@ Schema for the body of a Github login request
|
|
126365
126616
|
"application.deviceCounts",
|
126366
126617
|
"application.notebookMinuteCounts",
|
126367
126618
|
"application.search",
|
126619
|
+
"application.importLogs",
|
126368
126620
|
"applicationApiToken.delete",
|
126369
126621
|
"applicationApiToken.get",
|
126370
126622
|
"applicationApiToken.patch",
|
@@ -128121,6 +128373,10 @@ Schema for additional application import options
|
|
128121
128373
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
128122
128374
|
"type": "object",
|
128123
128375
|
"properties": {
|
128376
|
+
"fromApplicationId": {
|
128377
|
+
"type": "string",
|
128378
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
128379
|
+
},
|
128124
128380
|
"importUrl": {
|
128125
128381
|
"type": "string",
|
128126
128382
|
"format": "uri",
|
@@ -128632,6 +128888,14 @@ Schema for a single Instance
|
|
128632
128888
|
}
|
128633
128889
|
}
|
128634
128890
|
}
|
128891
|
+
},
|
128892
|
+
"mfaMode": {
|
128893
|
+
"type": "string",
|
128894
|
+
"enum": [
|
128895
|
+
"notRequired",
|
128896
|
+
"adminRequired",
|
128897
|
+
"required"
|
128898
|
+
]
|
128635
128899
|
}
|
128636
128900
|
}
|
128637
128901
|
}
|
@@ -134050,6 +134314,14 @@ Schema for instance patch request
|
|
134050
134314
|
}
|
134051
134315
|
},
|
134052
134316
|
"additionalProperties": false
|
134317
|
+
},
|
134318
|
+
"mfaMode": {
|
134319
|
+
"type": "string",
|
134320
|
+
"enum": [
|
134321
|
+
"notRequired",
|
134322
|
+
"adminRequired",
|
134323
|
+
"required"
|
134324
|
+
]
|
134053
134325
|
}
|
134054
134326
|
},
|
134055
134327
|
"additionalProperties": false
|
@@ -135683,6 +135955,14 @@ Schema for a collection of Instances
|
|
135683
135955
|
}
|
135684
135956
|
}
|
135685
135957
|
}
|
135958
|
+
},
|
135959
|
+
"mfaMode": {
|
135960
|
+
"type": "string",
|
135961
|
+
"enum": [
|
135962
|
+
"notRequired",
|
135963
|
+
"adminRequired",
|
135964
|
+
"required"
|
135965
|
+
]
|
135686
135966
|
}
|
135687
135967
|
}
|
135688
135968
|
}
|
@@ -149532,6 +149812,7 @@ SAML Response body for login
|
|
149532
149812
|
"application.deviceCounts",
|
149533
149813
|
"application.notebookMinuteCounts",
|
149534
149814
|
"application.search",
|
149815
|
+
"application.importLogs",
|
149535
149816
|
"applicationApiToken.delete",
|
149536
149817
|
"applicationApiToken.get",
|
149537
149818
|
"applicationApiToken.patch",
|
@@ -152334,6 +152615,7 @@ Schema for the body of a User authentication request
|
|
152334
152615
|
"application.deviceCounts",
|
152335
152616
|
"application.notebookMinuteCounts",
|
152336
152617
|
"application.search",
|
152618
|
+
"application.importLogs",
|
152337
152619
|
"applicationApiToken.delete",
|
152338
152620
|
"applicationApiToken.get",
|
152339
152621
|
"applicationApiToken.patch",
|
@@ -152908,6 +153190,7 @@ Schema for the body of a User creation request
|
|
152908
153190
|
"application.deviceCounts",
|
152909
153191
|
"application.notebookMinuteCounts",
|
152910
153192
|
"application.search",
|
153193
|
+
"application.importLogs",
|
152911
153194
|
"applicationApiToken.delete",
|
152912
153195
|
"applicationApiToken.get",
|
152913
153196
|
"applicationApiToken.patch",
|
@@ -153288,6 +153571,13 @@ Schema for the body of a User creation request
|
|
153288
153571
|
"tokenTTL": {
|
153289
153572
|
"type": "integer",
|
153290
153573
|
"minimum": 0
|
153574
|
+
},
|
153575
|
+
"inviteToken": {
|
153576
|
+
"type": "string",
|
153577
|
+
"minLength": 1
|
153578
|
+
},
|
153579
|
+
"acceptInvite": {
|
153580
|
+
"type": "boolean"
|
153291
153581
|
}
|
153292
153582
|
},
|
153293
153583
|
"anyOf": [
|
data/docs/application.md
CHANGED
@@ -18,6 +18,7 @@ parameters and the potential responses.
|
|
18
18
|
* [Get](#get)
|
19
19
|
* [Globals](#globals)
|
20
20
|
* [Import](#import)
|
21
|
+
* [Import Logs](#import-logs)
|
21
22
|
* [Mqtt Publish Message](#mqtt-publish-message)
|
22
23
|
* [Notebook Minute Counts](#notebook-minute-counts)
|
23
24
|
* [Patch](#patch)
|
@@ -499,6 +500,45 @@ all.Application, all.Organization, all.User, application.*, or application.impor
|
|
499
500
|
|
500
501
|
<br/>
|
501
502
|
|
503
|
+
## Import Logs
|
504
|
+
|
505
|
+
Retrieves information on application import logs
|
506
|
+
|
507
|
+
```ruby
|
508
|
+
result = client.application.import_logs(applicationId: my_application_id)
|
509
|
+
|
510
|
+
puts result
|
511
|
+
```
|
512
|
+
|
513
|
+
#### Authentication
|
514
|
+
The client must be configured with a valid api access token to call this
|
515
|
+
action. The token must include at least one of the following scopes:
|
516
|
+
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, application.*, or application.importLogs.
|
517
|
+
|
518
|
+
#### Available Parameters
|
519
|
+
|
520
|
+
| Name | Type | Required | Description | Default | Example |
|
521
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
522
|
+
| applicationId | string | Y | ID of the associated application | | 575ec8687ae143cd83dc4a97 |
|
523
|
+
| limit | string | N | Max log entries to return (ordered by time descending) | 1 | 10 |
|
524
|
+
| since | string | N | Look for log entries since this time (ms since epoch) | | 1465790400000 |
|
525
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
526
|
+
|
527
|
+
#### Successful Responses
|
528
|
+
|
529
|
+
| Code | Type | Description |
|
530
|
+
| ---- | ---- | ----------- |
|
531
|
+
| 200 | [Application Import Executions](_schemas.md#application-import-executions) | Application log objects |
|
532
|
+
|
533
|
+
#### Error Responses
|
534
|
+
|
535
|
+
| Code | Type | Description |
|
536
|
+
| ---- | ---- | ----------- |
|
537
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
538
|
+
| 404 | [Error](_schemas.md#error) | Error if application was not found |
|
539
|
+
|
540
|
+
<br/>
|
541
|
+
|
502
542
|
## Mqtt Publish Message
|
503
543
|
|
504
544
|
Publishes the given message to the given MQTT topic
|
data/lib/losant_rest/version.rb
CHANGED
@@ -542,6 +542,54 @@ module PlatformRest
|
|
542
542
|
body: body)
|
543
543
|
end
|
544
544
|
|
545
|
+
# Retrieves information on application import logs
|
546
|
+
#
|
547
|
+
# Authentication:
|
548
|
+
# The client must be configured with a valid api
|
549
|
+
# access token to call this action. The token
|
550
|
+
# must include at least one of the following scopes:
|
551
|
+
# all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, application.*, or application.importLogs.
|
552
|
+
#
|
553
|
+
# Parameters:
|
554
|
+
# * {string} applicationId - ID of the associated application
|
555
|
+
# * {string} limit - Max log entries to return (ordered by time descending)
|
556
|
+
# * {string} since - Look for log entries since this time (ms since epoch)
|
557
|
+
# * {string} losantdomain - Domain scope of request (rarely needed)
|
558
|
+
# * {boolean} _actions - Return resource actions in response
|
559
|
+
# * {boolean} _links - Return resource link in response
|
560
|
+
# * {boolean} _embedded - Return embedded resources in response
|
561
|
+
#
|
562
|
+
# Responses:
|
563
|
+
# * 200 - Application log objects (https://api.losant.com/#/definitions/applicationImportExecutions)
|
564
|
+
#
|
565
|
+
# Errors:
|
566
|
+
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
567
|
+
# * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
|
568
|
+
def import_logs(params = {})
|
569
|
+
params = Utils.symbolize_hash_keys(params)
|
570
|
+
query_params = { _actions: false, _links: true, _embedded: true }
|
571
|
+
headers = {}
|
572
|
+
body = nil
|
573
|
+
|
574
|
+
raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
|
575
|
+
|
576
|
+
query_params[:limit] = params[:limit] if params.has_key?(:limit)
|
577
|
+
query_params[:since] = params[:since] if params.has_key?(:since)
|
578
|
+
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
579
|
+
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
580
|
+
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
581
|
+
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
582
|
+
|
583
|
+
path = "/applications/#{params[:applicationId]}/importLogs"
|
584
|
+
|
585
|
+
@client.request(
|
586
|
+
method: :get,
|
587
|
+
path: path,
|
588
|
+
query: query_params,
|
589
|
+
headers: headers,
|
590
|
+
body: body)
|
591
|
+
end
|
592
|
+
|
545
593
|
# Publishes the given message to the given MQTT topic
|
546
594
|
#
|
547
595
|
# Authentication:
|
data/lib/platform_rest/client.rb
CHANGED
@@ -27,7 +27,7 @@ module PlatformRest
|
|
27
27
|
#
|
28
28
|
# User API for accessing platform data
|
29
29
|
#
|
30
|
-
# Built For Version 1.26.
|
30
|
+
# Built For Version 1.26.3
|
31
31
|
class Client
|
32
32
|
attr_accessor :auth_token, :url
|
33
33
|
|
@@ -390,7 +390,7 @@ module PlatformRest
|
|
390
390
|
|
391
391
|
headers["Accept"] = "application/json"
|
392
392
|
headers["Content-Type"] = "application/json"
|
393
|
-
headers["Accept-Version"] = "^1.26.
|
393
|
+
headers["Accept-Version"] = "^1.26.3"
|
394
394
|
headers["Authorization"] = "Bearer #{self.auth_token}" if self.auth_token
|
395
395
|
path = self.url + options.fetch(:path, "")
|
396
396
|
|
data/schemas/apiTokenPost.json
CHANGED
@@ -0,0 +1,205 @@
|
|
1
|
+
{
|
2
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
3
|
+
"type": "array",
|
4
|
+
"items": {
|
5
|
+
"type": "object",
|
6
|
+
"properties": {
|
7
|
+
"id": {
|
8
|
+
"type": "string",
|
9
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
10
|
+
},
|
11
|
+
"importSourceType": {
|
12
|
+
"type": "string",
|
13
|
+
"enum": [
|
14
|
+
"importBundle",
|
15
|
+
"importUrl",
|
16
|
+
"fromApplication"
|
17
|
+
]
|
18
|
+
},
|
19
|
+
"importExecutionId": {
|
20
|
+
"type": "string",
|
21
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
22
|
+
},
|
23
|
+
"applicationId": {
|
24
|
+
"type": "string",
|
25
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
26
|
+
},
|
27
|
+
"fromApplicationId": {
|
28
|
+
"type": "string",
|
29
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
30
|
+
},
|
31
|
+
"runQueuedAt": {
|
32
|
+
"type": "string",
|
33
|
+
"format": "date-time"
|
34
|
+
},
|
35
|
+
"runStartedAt": {
|
36
|
+
"type": "string",
|
37
|
+
"format": "date-time"
|
38
|
+
},
|
39
|
+
"runCompletedAt": {
|
40
|
+
"type": "string",
|
41
|
+
"format": "date-time"
|
42
|
+
},
|
43
|
+
"status": {
|
44
|
+
"type": "string",
|
45
|
+
"enum": [
|
46
|
+
"queued",
|
47
|
+
"inProgress",
|
48
|
+
"completed",
|
49
|
+
"errored",
|
50
|
+
"failed"
|
51
|
+
]
|
52
|
+
},
|
53
|
+
"dryRun": {
|
54
|
+
"type": "boolean"
|
55
|
+
},
|
56
|
+
"conflictBehavior": {
|
57
|
+
"type": "string",
|
58
|
+
"enum": [
|
59
|
+
"create",
|
60
|
+
"error",
|
61
|
+
"retain",
|
62
|
+
"replace"
|
63
|
+
],
|
64
|
+
"default": "create"
|
65
|
+
},
|
66
|
+
"callbackUrl": {
|
67
|
+
"type": "string",
|
68
|
+
"format": "uri",
|
69
|
+
"maxLength": 1024
|
70
|
+
},
|
71
|
+
"email": {
|
72
|
+
"type": "string",
|
73
|
+
"format": "email",
|
74
|
+
"maxLength": 1024
|
75
|
+
},
|
76
|
+
"include": {
|
77
|
+
"type": "array",
|
78
|
+
"items": {
|
79
|
+
"enum": [
|
80
|
+
"ApplicationCertificateAuthority",
|
81
|
+
"Dashboard",
|
82
|
+
"DataTableRow",
|
83
|
+
"DataTable",
|
84
|
+
"DeviceRecipe",
|
85
|
+
"Device",
|
86
|
+
"ExperienceDevelopConfig",
|
87
|
+
"ExperienceEndpoint",
|
88
|
+
"ExperienceFlowVersion",
|
89
|
+
"ExperienceGroup",
|
90
|
+
"ExperienceUser",
|
91
|
+
"ExperienceVersion",
|
92
|
+
"ExperienceView",
|
93
|
+
"File",
|
94
|
+
"FlowVersion",
|
95
|
+
"Flow",
|
96
|
+
"Global",
|
97
|
+
"Integration",
|
98
|
+
"Notebook",
|
99
|
+
"Webhook",
|
100
|
+
"ResourceJob"
|
101
|
+
]
|
102
|
+
},
|
103
|
+
"uniqueItems": true
|
104
|
+
},
|
105
|
+
"jobId": {
|
106
|
+
"type": "string",
|
107
|
+
"maxLength": 21
|
108
|
+
},
|
109
|
+
"sourceId": {
|
110
|
+
"type": "string",
|
111
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
112
|
+
},
|
113
|
+
"sourceType": {
|
114
|
+
"type": "string",
|
115
|
+
"enum": [
|
116
|
+
"flow",
|
117
|
+
"user",
|
118
|
+
"device",
|
119
|
+
"apiToken",
|
120
|
+
"notebook"
|
121
|
+
]
|
122
|
+
},
|
123
|
+
"error": {
|
124
|
+
"type": "object",
|
125
|
+
"properties": {
|
126
|
+
"name": {
|
127
|
+
"type": "string"
|
128
|
+
},
|
129
|
+
"message": {
|
130
|
+
"type": "string"
|
131
|
+
}
|
132
|
+
}
|
133
|
+
},
|
134
|
+
"dryRunResults": {
|
135
|
+
"type": "object",
|
136
|
+
"properties": {
|
137
|
+
"limitErrors": {
|
138
|
+
"type": "array",
|
139
|
+
"items": {
|
140
|
+
"enum": [
|
141
|
+
"ApplicationCertificateAuthority",
|
142
|
+
"Dashboard",
|
143
|
+
"DataTableRow",
|
144
|
+
"DataTable",
|
145
|
+
"DeviceRecipe",
|
146
|
+
"Device",
|
147
|
+
"ExperienceDevelopConfig",
|
148
|
+
"ExperienceEndpoint",
|
149
|
+
"ExperienceFlowVersion",
|
150
|
+
"ExperienceGroup",
|
151
|
+
"ExperienceUser",
|
152
|
+
"ExperienceVersion",
|
153
|
+
"ExperienceView",
|
154
|
+
"File",
|
155
|
+
"FlowVersion",
|
156
|
+
"Flow",
|
157
|
+
"Global",
|
158
|
+
"Integration",
|
159
|
+
"Notebook",
|
160
|
+
"Webhook",
|
161
|
+
"ResourceJob"
|
162
|
+
]
|
163
|
+
},
|
164
|
+
"uniqueItems": true
|
165
|
+
},
|
166
|
+
"url": {
|
167
|
+
"type": "string",
|
168
|
+
"format": "uri",
|
169
|
+
"maxLength": 1024
|
170
|
+
}
|
171
|
+
}
|
172
|
+
},
|
173
|
+
"validationErrors": {
|
174
|
+
"type": "array",
|
175
|
+
"items": {
|
176
|
+
"type": "object",
|
177
|
+
"properties": {
|
178
|
+
"type": {
|
179
|
+
"type": "string"
|
180
|
+
},
|
181
|
+
"name": {
|
182
|
+
"type": "string"
|
183
|
+
},
|
184
|
+
"id": {
|
185
|
+
"type": "string"
|
186
|
+
},
|
187
|
+
"message": {
|
188
|
+
"type": "string"
|
189
|
+
}
|
190
|
+
}
|
191
|
+
}
|
192
|
+
},
|
193
|
+
"importedFileUrl": {
|
194
|
+
"type": "string",
|
195
|
+
"format": "uri",
|
196
|
+
"maxLength": 1024
|
197
|
+
},
|
198
|
+
"importUrl": {
|
199
|
+
"type": "string",
|
200
|
+
"format": "uri",
|
201
|
+
"maxLength": 1024
|
202
|
+
}
|
203
|
+
}
|
204
|
+
}
|
205
|
+
}
|
data/schemas/authedUser.json
CHANGED
data/schemas/dataExport.json
CHANGED
data/schemas/githubLogin.json
CHANGED
data/schemas/instance.json
CHANGED
data/schemas/instancePatch.json
CHANGED
data/schemas/instances.json
CHANGED
data/schemas/samlResponse.json
CHANGED
data/schemas/userPost.json
CHANGED
@@ -165,6 +165,7 @@
|
|
165
165
|
"application.deviceCounts",
|
166
166
|
"application.notebookMinuteCounts",
|
167
167
|
"application.search",
|
168
|
+
"application.importLogs",
|
168
169
|
"applicationApiToken.delete",
|
169
170
|
"applicationApiToken.get",
|
170
171
|
"applicationApiToken.patch",
|
@@ -545,6 +546,13 @@
|
|
545
546
|
"tokenTTL": {
|
546
547
|
"type": "integer",
|
547
548
|
"minimum": 0
|
549
|
+
},
|
550
|
+
"inviteToken": {
|
551
|
+
"type": "string",
|
552
|
+
"minLength": 1
|
553
|
+
},
|
554
|
+
"acceptInvite": {
|
555
|
+
"type": "boolean"
|
548
556
|
}
|
549
557
|
},
|
550
558
|
"anyOf": [
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: losant_rest
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.19.
|
4
|
+
version: 1.19.3
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Michael Kuehl
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-
|
11
|
+
date: 2023-12-15 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: httparty
|
@@ -385,6 +385,7 @@ files:
|
|
385
385
|
- schemas/applicationExportPost.json
|
386
386
|
- schemas/applicationExportResult.json
|
387
387
|
- schemas/applicationGlobalPatch.json
|
388
|
+
- schemas/applicationImportExecutions.json
|
388
389
|
- schemas/applicationImportOptions.json
|
389
390
|
- schemas/applicationKey.json
|
390
391
|
- schemas/applicationKeyPatch.json
|