losant_rest 1.22.3 → 1.22.4
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.
- checksums.yaml +4 -4
- data/docs/_schemas.md +23 -3
- data/docs/me.md +11 -1
- data/lib/platform_rest/client.rb +2 -2
- data/lib/platform_rest/me.rb +21 -1
- data/lib/platform_rest/version.rb +1 -1
- data/schemas/me.json +5 -0
- data/schemas/suggestFunctionPost.json +2 -1
- data/schemas/webhook.json +3 -0
- data/schemas/webhookPatch.json +3 -0
- data/schemas/webhookPost.json +3 -0
- data/schemas/webhooks.json +3 -0
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b9576dfc1daa413cd74db4ce763352867fa67d6cb1cd3dad9f2046355987bdb7
|
4
|
+
data.tar.gz: b84d6750365ffbfbf899f3700b1b661d515618d7b43e506b8c69810164404f1e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4c8991955b18676ff737d0ca5da9e28813d7b600d274d14f1ea4233d778d1bda0c82f26dfbd344a33c95b6cb96681381cfe3a0177a487b68342a34113be5de96
|
7
|
+
data.tar.gz: bb39334e6d1e27b9c9622b347270e73bd3c2c61e765cdb338a7a7c026446b41f7cad94cbef3965f9fc7ffdbe03c27521575f53ae8e5b0a897624173007f85d5d
|
data/docs/_schemas.md
CHANGED
@@ -82587,7 +82587,8 @@ Schema for the body of a Devices modification request
|
|
82587
82587
|
"575ecec57ae143cd83dc4a9f",
|
82588
82588
|
"575ecec57ae143cd83dc4a9e",
|
82589
82589
|
"575ecec57ae143cd83dc4a9a"
|
82590
|
-
]
|
82590
|
+
],
|
82591
|
+
"email": "email@example.com"
|
82591
82592
|
}
|
82592
82593
|
```
|
82593
82594
|
|
@@ -84699,7 +84700,8 @@ Schema for the body of a bulk data removal request
|
|
84699
84700
|
"attributes": [
|
84700
84701
|
"deleteMyData",
|
84701
84702
|
"mineToo"
|
84702
|
-
]
|
84703
|
+
],
|
84704
|
+
"callbackUrl": "https://example.com/cb"
|
84703
84705
|
}
|
84704
84706
|
```
|
84705
84707
|
|
@@ -160612,6 +160614,11 @@ Schema for information about the currently authenticated user
|
|
160612
160614
|
"format": "email",
|
160613
160615
|
"maxLength": 1024
|
160614
160616
|
},
|
160617
|
+
"requestedEmail": {
|
160618
|
+
"type": "string",
|
160619
|
+
"format": "email",
|
160620
|
+
"maxLength": 1024
|
160621
|
+
},
|
160615
160622
|
"firstName": {
|
160616
160623
|
"type": "string",
|
160617
160624
|
"minLength": 1,
|
@@ -173533,7 +173540,8 @@ Schema for the body of a workflow suggestion function request
|
|
173533
173540
|
"type": "string",
|
173534
173541
|
"minLength": 1,
|
173535
173542
|
"maxLength": 8192
|
173536
|
-
}
|
173543
|
+
},
|
173544
|
+
"payload": {}
|
173537
173545
|
},
|
173538
173546
|
"required": [
|
173539
173547
|
"text"
|
@@ -178027,6 +178035,9 @@ Schema for a single Webhook
|
|
178027
178035
|
},
|
178028
178036
|
"annotateMultipart": {
|
178029
178037
|
"type": "boolean"
|
178038
|
+
},
|
178039
|
+
"enabled": {
|
178040
|
+
"type": "boolean"
|
178030
178041
|
}
|
178031
178042
|
}
|
178032
178043
|
}
|
@@ -178114,6 +178125,9 @@ Schema for the body of a Webhook modification request
|
|
178114
178125
|
},
|
178115
178126
|
"annotateMultipart": {
|
178116
178127
|
"type": "boolean"
|
178128
|
+
},
|
178129
|
+
"enabled": {
|
178130
|
+
"type": "boolean"
|
178117
178131
|
}
|
178118
178132
|
},
|
178119
178133
|
"additionalProperties": false
|
@@ -178195,6 +178209,9 @@ Schema for the body of a Webhook creation request
|
|
178195
178209
|
},
|
178196
178210
|
"annotateMultipart": {
|
178197
178211
|
"type": "boolean"
|
178212
|
+
},
|
178213
|
+
"enabled": {
|
178214
|
+
"type": "boolean"
|
178198
178215
|
}
|
178199
178216
|
},
|
178200
178217
|
"required": [
|
@@ -178309,6 +178326,9 @@ Schema for a collection of Webhooks
|
|
178309
178326
|
},
|
178310
178327
|
"annotateMultipart": {
|
178311
178328
|
"type": "boolean"
|
178329
|
+
},
|
178330
|
+
"enabled": {
|
178331
|
+
"type": "boolean"
|
178312
178332
|
}
|
178313
178333
|
}
|
178314
178334
|
}
|
data/docs/me.md
CHANGED
@@ -194,6 +194,9 @@ all.User, me.*, or me.disableTwoFactorAuth.
|
|
194
194
|
| Name | Type | Required | Description | Default | Example |
|
195
195
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
196
196
|
| data | [Disable Multi-Factor Authentication](_schemas.md#disable-multi-factor-authentication) | Y | Object containing multi-factor authentication properties | | [Disable Multi-Factor Authentication Example](_schemas.md#disable-multi-factor-authentication-example) |
|
197
|
+
| includeRecent | string | N | Should the user include recent app/dashboard info | | true |
|
198
|
+
| summaryExclude | string | N | Comma-separated list of summary fields to exclude from user summary | | payloadCount |
|
199
|
+
| summaryInclude | string | N | Comma-separated list of summary fields to include in user summary | | payloadCount |
|
197
200
|
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
198
201
|
|
199
202
|
#### Successful Responses
|
@@ -229,6 +232,9 @@ all.User, me.*, or me.disconnectGithub.
|
|
229
232
|
|
230
233
|
| Name | Type | Required | Description | Default | Example |
|
231
234
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
235
|
+
| includeRecent | string | N | Should the user include recent app/dashboard info | | true |
|
236
|
+
| summaryExclude | string | N | Comma-separated list of summary fields to exclude from user summary | | payloadCount |
|
237
|
+
| summaryInclude | string | N | Comma-separated list of summary fields to include in user summary | | payloadCount |
|
232
238
|
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
233
239
|
|
234
240
|
#### Successful Responses
|
@@ -265,6 +271,9 @@ all.User, me.*, or me.enableTwoFactorAuth.
|
|
265
271
|
| Name | Type | Required | Description | Default | Example |
|
266
272
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
267
273
|
| data | [Enable Multi-Factor Authentication](_schemas.md#enable-multi-factor-authentication) | Y | Object containing multi-factor authentication properties | | [Enable Multi-Factor Authentication Example](_schemas.md#enable-multi-factor-authentication-example) |
|
274
|
+
| includeRecent | string | N | Should the user include recent app/dashboard info | | true |
|
275
|
+
| summaryExclude | string | N | Comma-separated list of summary fields to exclude from user summary | | payloadCount |
|
276
|
+
| summaryInclude | string | N | Comma-separated list of summary fields to include in user summary | | payloadCount |
|
268
277
|
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
269
278
|
|
270
279
|
#### Successful Responses
|
@@ -372,7 +381,7 @@ all.User, all.User.read, me.*, or me.get.
|
|
372
381
|
|
373
382
|
| Name | Type | Required | Description | Default | Example |
|
374
383
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
375
|
-
| includeRecent |
|
384
|
+
| includeRecent | string | N | Should the user include recent app/dashboard info | | true |
|
376
385
|
| summaryExclude | string | N | Comma-separated list of summary fields to exclude from user summary | | payloadCount |
|
377
386
|
| summaryInclude | string | N | Comma-separated list of summary fields to include in user summary | | payloadCount |
|
378
387
|
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
@@ -519,6 +528,7 @@ all.User, me.*, or me.patch.
|
|
519
528
|
| Name | Type | Required | Description | Default | Example |
|
520
529
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
521
530
|
| user | [Me Patch](_schemas.md#me-patch) | Y | Object containing new user properties | | [Me Patch Example](_schemas.md#me-patch-example) |
|
531
|
+
| includeRecent | string | N | Should the user include recent app/dashboard info | | true |
|
522
532
|
| summaryExclude | string | N | Comma-separated list of summary fields to exclude from user summary | | payloadCount |
|
523
533
|
| summaryInclude | string | N | Comma-separated list of summary fields to include in user summary | | payloadCount |
|
524
534
|
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
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.28.
|
30
|
+
# Built For Version 1.28.4
|
31
31
|
class Client
|
32
32
|
attr_accessor :auth_token, :url
|
33
33
|
|
@@ -422,7 +422,7 @@ module PlatformRest
|
|
422
422
|
|
423
423
|
headers["Accept"] = "application/json"
|
424
424
|
headers["Content-Type"] = "application/json"
|
425
|
-
headers["Accept-Version"] = "^1.28.
|
425
|
+
headers["Accept-Version"] = "^1.28.4"
|
426
426
|
headers["Authorization"] = "Bearer #{self.auth_token}" if self.auth_token
|
427
427
|
path = self.url + options.fetch(:path, "")
|
428
428
|
|
data/lib/platform_rest/me.rb
CHANGED
@@ -218,6 +218,9 @@ module PlatformRest
|
|
218
218
|
#
|
219
219
|
# Parameters:
|
220
220
|
# * {hash} data - Object containing multi-factor authentication properties (https://api.losant.com/#/definitions/multiFactorAuthDisable)
|
221
|
+
# * {string} includeRecent - Should the user include recent app/dashboard info
|
222
|
+
# * {string} summaryExclude - Comma-separated list of summary fields to exclude from user summary
|
223
|
+
# * {string} summaryInclude - Comma-separated list of summary fields to include in user summary
|
221
224
|
# * {string} losantdomain - Domain scope of request (rarely needed)
|
222
225
|
# * {boolean} _actions - Return resource actions in response
|
223
226
|
# * {boolean} _links - Return resource link in response
|
@@ -237,6 +240,9 @@ module PlatformRest
|
|
237
240
|
raise ArgumentError.new("data is required") unless params.has_key?(:data)
|
238
241
|
|
239
242
|
body = params[:data] if params.has_key?(:data)
|
243
|
+
query_params[:includeRecent] = params[:includeRecent] if params.has_key?(:includeRecent)
|
244
|
+
query_params[:summaryExclude] = params[:summaryExclude] if params.has_key?(:summaryExclude)
|
245
|
+
query_params[:summaryInclude] = params[:summaryInclude] if params.has_key?(:summaryInclude)
|
240
246
|
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
241
247
|
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
242
248
|
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
@@ -261,6 +267,9 @@ module PlatformRest
|
|
261
267
|
# all.User, me.*, or me.disconnectGithub.
|
262
268
|
#
|
263
269
|
# Parameters:
|
270
|
+
# * {string} includeRecent - Should the user include recent app/dashboard info
|
271
|
+
# * {string} summaryExclude - Comma-separated list of summary fields to exclude from user summary
|
272
|
+
# * {string} summaryInclude - Comma-separated list of summary fields to include in user summary
|
264
273
|
# * {string} losantdomain - Domain scope of request (rarely needed)
|
265
274
|
# * {boolean} _actions - Return resource actions in response
|
266
275
|
# * {boolean} _links - Return resource link in response
|
@@ -278,6 +287,9 @@ module PlatformRest
|
|
278
287
|
body = nil
|
279
288
|
|
280
289
|
|
290
|
+
query_params[:includeRecent] = params[:includeRecent] if params.has_key?(:includeRecent)
|
291
|
+
query_params[:summaryExclude] = params[:summaryExclude] if params.has_key?(:summaryExclude)
|
292
|
+
query_params[:summaryInclude] = params[:summaryInclude] if params.has_key?(:summaryInclude)
|
281
293
|
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
282
294
|
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
283
295
|
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
@@ -303,6 +315,9 @@ module PlatformRest
|
|
303
315
|
#
|
304
316
|
# Parameters:
|
305
317
|
# * {hash} data - Object containing multi-factor authentication properties (https://api.losant.com/#/definitions/multiFactorAuthEnable)
|
318
|
+
# * {string} includeRecent - Should the user include recent app/dashboard info
|
319
|
+
# * {string} summaryExclude - Comma-separated list of summary fields to exclude from user summary
|
320
|
+
# * {string} summaryInclude - Comma-separated list of summary fields to include in user summary
|
306
321
|
# * {string} losantdomain - Domain scope of request (rarely needed)
|
307
322
|
# * {boolean} _actions - Return resource actions in response
|
308
323
|
# * {boolean} _links - Return resource link in response
|
@@ -322,6 +337,9 @@ module PlatformRest
|
|
322
337
|
raise ArgumentError.new("data is required") unless params.has_key?(:data)
|
323
338
|
|
324
339
|
body = params[:data] if params.has_key?(:data)
|
340
|
+
query_params[:includeRecent] = params[:includeRecent] if params.has_key?(:includeRecent)
|
341
|
+
query_params[:summaryExclude] = params[:summaryExclude] if params.has_key?(:summaryExclude)
|
342
|
+
query_params[:summaryInclude] = params[:summaryInclude] if params.has_key?(:summaryInclude)
|
325
343
|
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
326
344
|
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
327
345
|
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
@@ -433,7 +451,7 @@ module PlatformRest
|
|
433
451
|
# all.User, all.User.read, me.*, or me.get.
|
434
452
|
#
|
435
453
|
# Parameters:
|
436
|
-
# * {
|
454
|
+
# * {string} includeRecent - Should the user include recent app/dashboard info
|
437
455
|
# * {string} summaryExclude - Comma-separated list of summary fields to exclude from user summary
|
438
456
|
# * {string} summaryInclude - Comma-separated list of summary fields to include in user summary
|
439
457
|
# * {string} losantdomain - Domain scope of request (rarely needed)
|
@@ -610,6 +628,7 @@ module PlatformRest
|
|
610
628
|
#
|
611
629
|
# Parameters:
|
612
630
|
# * {hash} user - Object containing new user properties (https://api.losant.com/#/definitions/mePatch)
|
631
|
+
# * {string} includeRecent - Should the user include recent app/dashboard info
|
613
632
|
# * {string} summaryExclude - Comma-separated list of summary fields to exclude from user summary
|
614
633
|
# * {string} summaryInclude - Comma-separated list of summary fields to include in user summary
|
615
634
|
# * {string} losantdomain - Domain scope of request (rarely needed)
|
@@ -631,6 +650,7 @@ module PlatformRest
|
|
631
650
|
raise ArgumentError.new("user is required") unless params.has_key?(:user)
|
632
651
|
|
633
652
|
body = params[:user] if params.has_key?(:user)
|
653
|
+
query_params[:includeRecent] = params[:includeRecent] if params.has_key?(:includeRecent)
|
634
654
|
query_params[:summaryExclude] = params[:summaryExclude] if params.has_key?(:summaryExclude)
|
635
655
|
query_params[:summaryInclude] = params[:summaryInclude] if params.has_key?(:summaryInclude)
|
636
656
|
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
data/schemas/me.json
CHANGED
data/schemas/webhook.json
CHANGED
data/schemas/webhookPatch.json
CHANGED
data/schemas/webhookPost.json
CHANGED
data/schemas/webhooks.json
CHANGED
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.22.
|
4
|
+
version: 1.22.4
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Michael Kuehl
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2025-09-
|
11
|
+
date: 2025-09-23 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: httparty
|