seam 2.141.2 → 2.143.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.
- checksums.yaml +4 -4
- data/Gemfile.lock +2 -2
- data/README.md +3 -1
- data/lib/seam/resources/access_code.rb +2 -2
- data/lib/seam/resources/acs_access_group.rb +1 -1
- data/lib/seam/resources/acs_credential.rb +1 -1
- data/lib/seam/resources/acs_user.rb +1 -1
- data/lib/seam/resources/connect_webview.rb +1 -1
- data/lib/seam/resources/connected_account.rb +1 -1
- data/lib/seam/resources/device.rb +4 -4
- data/lib/seam/resources/event.rb +2 -2
- data/lib/seam/resources/phone.rb +1 -1
- data/lib/seam/resources/unmanaged_access_code.rb +4 -4
- data/lib/seam/resources/unmanaged_device.rb +2 -2
- data/lib/seam/routes/access_grants_unmanaged.rb +1 -1
- data/lib/seam/routes/connect_webviews.rb +2 -2
- data/lib/seam/routes/connected_accounts.rb +2 -2
- data/lib/seam/routes/devices.rb +2 -2
- data/lib/seam/routes/devices_unmanaged.rb +2 -2
- data/lib/seam/routes/user_identities_unmanaged.rb +1 -1
- data/lib/seam/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 6b823828403595f0d453e29c8621df7f1a3019d731abe06c8e5d4b1d9d787d20
|
|
4
|
+
data.tar.gz: 6ef6463ebed149d5b759e864d98138ec8fe6864b1cf951aab406fdf263181995
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 349e0b0fd1e88fdb68bdaa503195430ccceb7537962fabfb2377ef9f7c2a64f8785580cd9546bef106cbeabf40241037b8bd832690712c242bc10fcfac3f4478
|
|
7
|
+
data.tar.gz: 032e4ba16a1829281886e23b837bc0ff18a5c5f4cbc57ae8bdd5efa9bde99a804cce394bb914bb93bae78a4dca449e30de60acb3e8c27a9d4f9a58691d073a95
|
data/Gemfile.lock
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
PATH
|
|
2
2
|
remote: .
|
|
3
3
|
specs:
|
|
4
|
-
seam (2.
|
|
4
|
+
seam (2.143.0)
|
|
5
5
|
faraday (~> 2.7)
|
|
6
6
|
faraday-retry (~> 2.2)
|
|
7
7
|
svix (~> 1.30)
|
|
@@ -171,7 +171,7 @@ CHECKSUMS
|
|
|
171
171
|
rubocop-ast (1.50.0) sha256=b9ca88300da0803ee222ad20cdb30494c0a784eed06fdc35d254b06d662788db
|
|
172
172
|
rubocop-performance (1.26.1) sha256=cd19b936ff196df85829d264b522fd4f98b6c89ad271fa52744a8c11b8f71834
|
|
173
173
|
ruby-progressbar (1.13.0) sha256=80fc9c47a9b640d6834e0dc7b3c94c9df37f08cb072b7761e4a71e22cff29b33
|
|
174
|
-
seam (2.
|
|
174
|
+
seam (2.143.0)
|
|
175
175
|
simplecov (1.1.1) sha256=25825ef13f0b2e74694d769817dad6ab8e90131dabdaa666e522fea105521e78
|
|
176
176
|
simplecov-console (0.9.5) sha256=b1108bcfff5f210143e2b8301698c367b01586f20d25a73e95475a5df6fc6ff6
|
|
177
177
|
standard (1.56.0) sha256=ae2af4d9669589162ac69ed5ef59dcf9f346d4afc81f7e62b84339310dfcb787
|
data/README.md
CHANGED
|
@@ -14,7 +14,9 @@ Please refer to the official [Seam Docs](https://docs.seam.co/latest/) to get st
|
|
|
14
14
|
Parts of this SDK are generated from always up-to-date type information
|
|
15
15
|
provided by [@seamapi/types](https://github.com/seamapi/types/).
|
|
16
16
|
This ensures all API methods, request shapes, and response shapes are
|
|
17
|
-
accurate and fully typed.
|
|
17
|
+
accurate and fully typed. Ruby cannot statically enforce literal booleans, so
|
|
18
|
+
the generated YARD types use `TrueClass` and `FalseClass` to document singleton
|
|
19
|
+
constraints.
|
|
18
20
|
|
|
19
21
|
<!-- toc -->
|
|
20
22
|
|
|
@@ -62,7 +62,7 @@ module Seam
|
|
|
62
62
|
# @return [String]
|
|
63
63
|
attr_accessor :error_code
|
|
64
64
|
# Indicates that this is an access code error.
|
|
65
|
-
# @return [
|
|
65
|
+
# @return [TrueClass]
|
|
66
66
|
attr_accessor :is_access_code_error
|
|
67
67
|
# Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).
|
|
68
68
|
# @return [Boolean, nil]
|
|
@@ -197,7 +197,7 @@ module Seam
|
|
|
197
197
|
# @return [Boolean]
|
|
198
198
|
attr_accessor :is_external_modification_allowed
|
|
199
199
|
# Indicates whether Seam manages the access code.
|
|
200
|
-
# @return [
|
|
200
|
+
# @return [TrueClass]
|
|
201
201
|
attr_accessor :is_managed
|
|
202
202
|
# Indicates whether the access code is intended for use in offline scenarios. If `true`, this code can be created on a device without a network connection.
|
|
203
203
|
# @return [Boolean]
|
|
@@ -135,7 +135,7 @@ module Seam
|
|
|
135
135
|
# @return [String]
|
|
136
136
|
attr_accessor :external_type_display_name
|
|
137
137
|
# Indicates whether Seam manages the access group.
|
|
138
|
-
# @return [
|
|
138
|
+
# @return [TrueClass]
|
|
139
139
|
attr_accessor :is_managed
|
|
140
140
|
# Name of the access group.
|
|
141
141
|
# @return [String]
|
|
@@ -150,7 +150,7 @@ module Seam
|
|
|
150
150
|
# @return [Boolean, nil]
|
|
151
151
|
attr_accessor :is_latest_desired_state_synced_with_provider
|
|
152
152
|
# Indicates whether Seam manages the credential.
|
|
153
|
-
# @return [
|
|
153
|
+
# @return [TrueClass]
|
|
154
154
|
attr_accessor :is_managed
|
|
155
155
|
# Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
|
|
156
156
|
# @return [Boolean, nil]
|
|
@@ -179,7 +179,7 @@ module Seam
|
|
|
179
179
|
# @return [String, nil]
|
|
180
180
|
attr_accessor :hid_acs_system_id
|
|
181
181
|
# Indicates whether Seam manages the access system user.
|
|
182
|
-
# @return [
|
|
182
|
+
# @return [TrueClass]
|
|
183
183
|
attr_accessor :is_managed
|
|
184
184
|
# Indicates whether the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) is currently [suspended](https://docs.seam.co/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users).
|
|
185
185
|
# @return [Boolean, nil]
|
|
@@ -33,7 +33,7 @@ module Seam
|
|
|
33
33
|
# @return [String, nil]
|
|
34
34
|
attr_accessor :connected_account_id
|
|
35
35
|
# Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.
|
|
36
|
-
# @return [Hash]
|
|
36
|
+
# @return [Hash{String => String, Boolean}]
|
|
37
37
|
attr_accessor :custom_metadata
|
|
38
38
|
# URL to which the Connect Webview should redirect when an unexpected error occurs.
|
|
39
39
|
# @return [String, nil]
|
|
@@ -125,7 +125,7 @@ module Seam
|
|
|
125
125
|
# @return [String]
|
|
126
126
|
attr_accessor :connected_account_id
|
|
127
127
|
# Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.
|
|
128
|
-
# @return [Hash]
|
|
128
|
+
# @return [Hash{String => String, Boolean}]
|
|
129
129
|
attr_accessor :custom_metadata
|
|
130
130
|
# Your unique key for the customer associated with this connected account.
|
|
131
131
|
# @return [String, nil]
|
|
@@ -1004,7 +1004,7 @@ module Seam
|
|
|
1004
1004
|
# @return [String, nil]
|
|
1005
1005
|
attr_accessor :end_date_recurrence_rule
|
|
1006
1006
|
# When `true`, the start and end must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`.
|
|
1007
|
-
# @return [
|
|
1007
|
+
# @return [TrueClass, nil]
|
|
1008
1008
|
attr_accessor :matching_start_end_time
|
|
1009
1009
|
# Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum.
|
|
1010
1010
|
# @return [String, nil]
|
|
@@ -1043,7 +1043,7 @@ module Seam
|
|
|
1043
1043
|
# @return [String, nil]
|
|
1044
1044
|
attr_accessor :end_date_recurrence_rule
|
|
1045
1045
|
# When `true`, the start and end must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`.
|
|
1046
|
-
# @return [
|
|
1046
|
+
# @return [TrueClass, nil]
|
|
1047
1047
|
attr_accessor :matching_start_end_time
|
|
1048
1048
|
# Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum.
|
|
1049
1049
|
# @return [String, nil]
|
|
@@ -1784,7 +1784,7 @@ module Seam
|
|
|
1784
1784
|
# @return [String]
|
|
1785
1785
|
attr_accessor :connected_account_id
|
|
1786
1786
|
# Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.
|
|
1787
|
-
# @return [Hash]
|
|
1787
|
+
# @return [Hash{String => String, Boolean}]
|
|
1788
1788
|
attr_accessor :custom_metadata
|
|
1789
1789
|
# ID of the device.
|
|
1790
1790
|
# @return [String]
|
|
@@ -1796,7 +1796,7 @@ module Seam
|
|
|
1796
1796
|
# @return [String]
|
|
1797
1797
|
attr_accessor :display_name
|
|
1798
1798
|
# Indicates whether Seam manages the device. See also [Managed and Unmanaged Devices](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices).
|
|
1799
|
-
# @return [
|
|
1799
|
+
# @return [TrueClass]
|
|
1800
1800
|
attr_accessor :is_managed
|
|
1801
1801
|
# Optional nickname to describe the device, settable through Seam.
|
|
1802
1802
|
# @return [String, nil]
|
data/lib/seam/resources/event.rb
CHANGED
|
@@ -268,7 +268,7 @@ module Seam
|
|
|
268
268
|
attr_accessor :code
|
|
269
269
|
# @return [String, nil]
|
|
270
270
|
attr_accessor :connect_webview_id
|
|
271
|
-
# @return [Hash, nil]
|
|
271
|
+
# @return [Hash{String => String, Boolean}, nil]
|
|
272
272
|
attr_accessor :connected_account_custom_metadata
|
|
273
273
|
# @return [String, nil]
|
|
274
274
|
attr_accessor :connected_account_id
|
|
@@ -289,7 +289,7 @@ module Seam
|
|
|
289
289
|
# Desired temperature, in °F, defined by the affected thermostat's cooling or heating set point.
|
|
290
290
|
# @return [Float, nil]
|
|
291
291
|
attr_accessor :desired_temperature_fahrenheit
|
|
292
|
-
# @return [Hash, nil]
|
|
292
|
+
# @return [Hash{String => String, Boolean}, nil]
|
|
293
293
|
attr_accessor :device_custom_metadata
|
|
294
294
|
# @return [String, nil]
|
|
295
295
|
attr_accessor :device_id
|
data/lib/seam/resources/phone.rb
CHANGED
|
@@ -71,7 +71,7 @@ module Seam
|
|
|
71
71
|
# @return [Array<Warnings>]
|
|
72
72
|
resource_list_accessor :warnings, Warnings
|
|
73
73
|
# Optional [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone.
|
|
74
|
-
# @return [Hash]
|
|
74
|
+
# @return [Hash{String => String, Boolean}]
|
|
75
75
|
attr_accessor :custom_metadata
|
|
76
76
|
# ID of the phone.
|
|
77
77
|
# @return [String]
|
|
@@ -64,7 +64,7 @@ module Seam
|
|
|
64
64
|
# @return [String]
|
|
65
65
|
attr_accessor :error_code
|
|
66
66
|
# Indicates that this is an access code error.
|
|
67
|
-
# @return [
|
|
67
|
+
# @return [TrueClass]
|
|
68
68
|
attr_accessor :is_access_code_error
|
|
69
69
|
# Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).
|
|
70
70
|
# @return [Boolean, nil]
|
|
@@ -130,10 +130,10 @@ module Seam
|
|
|
130
130
|
# @return [String]
|
|
131
131
|
attr_accessor :access_code_id
|
|
132
132
|
# Indicates that Seam cannot convert this unmanaged access code to a managed access code. Some providers do not support management of unmanaged access codes through API integrations.
|
|
133
|
-
# @return [
|
|
133
|
+
# @return [TrueClass, nil]
|
|
134
134
|
attr_accessor :cannot_be_managed
|
|
135
135
|
# Indicates that Seam cannot delete this unmanaged access code through the provider. If this access code needs to be deleted, it will only be possible from the manufacturer app.
|
|
136
|
-
# @return [
|
|
136
|
+
# @return [TrueClass, nil]
|
|
137
137
|
attr_accessor :cannot_delete_unmanaged_access_code
|
|
138
138
|
# Code used for access. Typically, a numeric or alphanumeric string.
|
|
139
139
|
# @return [String, nil]
|
|
@@ -142,7 +142,7 @@ module Seam
|
|
|
142
142
|
# @return [String]
|
|
143
143
|
attr_accessor :device_id
|
|
144
144
|
# Indicates that Seam does not manage the access code.
|
|
145
|
-
# @return [
|
|
145
|
+
# @return [FalseClass]
|
|
146
146
|
attr_accessor :is_managed
|
|
147
147
|
# Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).
|
|
148
148
|
# @return [String, nil]
|
|
@@ -222,7 +222,7 @@ module Seam
|
|
|
222
222
|
# @return [String]
|
|
223
223
|
attr_accessor :connected_account_id
|
|
224
224
|
# Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.
|
|
225
|
-
# @return [Hash]
|
|
225
|
+
# @return [Hash{String => String, Boolean}]
|
|
226
226
|
attr_accessor :custom_metadata
|
|
227
227
|
# ID of the device.
|
|
228
228
|
# @return [String]
|
|
@@ -231,7 +231,7 @@ module Seam
|
|
|
231
231
|
# @return [String]
|
|
232
232
|
attr_accessor :device_type
|
|
233
233
|
# Indicates that Seam does not manage the device.
|
|
234
|
-
# @return [
|
|
234
|
+
# @return [FalseClass]
|
|
235
235
|
attr_accessor :is_managed
|
|
236
236
|
# Unique identifier for the Seam workspace associated with the device.
|
|
237
237
|
# @return [String]
|
|
@@ -37,7 +37,7 @@ module Seam
|
|
|
37
37
|
#
|
|
38
38
|
# When converting an unmanaged access grant to managed, all associated access methods will also be converted to managed.
|
|
39
39
|
# @param access_grant_id [String] ID of the unmanaged Access Grant to update.
|
|
40
|
-
# @param is_managed [
|
|
40
|
+
# @param is_managed [TrueClass] Must be set to true to convert the unmanaged access grant to managed.
|
|
41
41
|
# @param access_grant_key [String, nil] Unique key for the access grant. If not provided, the existing key will be preserved.
|
|
42
42
|
# @return [nil] OK
|
|
43
43
|
def update(access_grant_id:, is_managed:, access_grant_key: nil)
|
|
@@ -18,7 +18,7 @@ module Seam
|
|
|
18
18
|
# @param accepted_capabilities [Array<String>, nil] List of accepted device capabilities that restrict the types of devices that can be connected through the Connect Webview. If not provided, defaults will be determined based on the accepted providers.
|
|
19
19
|
# @param accepted_providers [Array<String>, nil] Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://docs.seam.co/api/devices/list_device_providers) with no filters.
|
|
20
20
|
# @param automatically_manage_new_devices [Boolean, nil] Indicates whether newly-added devices should appear as [managed devices](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices). See also: [Customize the Behavior Settings of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews).
|
|
21
|
-
# @param custom_metadata [Hash, nil] Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview) enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any [connected accounts](https://docs.seam.co/core-concepts/connected-accounts) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](https://docs.seam.co/core-concepts/workspaces). You can also [filter Connect Webviews by custom metadata](https://docs.seam.co/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata).
|
|
21
|
+
# @param custom_metadata [Hash{String => String, Boolean}, nil] Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview) enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any [connected accounts](https://docs.seam.co/core-concepts/connected-accounts) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](https://docs.seam.co/core-concepts/workspaces). You can also [filter Connect Webviews by custom metadata](https://docs.seam.co/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata).
|
|
22
22
|
# @param custom_redirect_failure_url [String, nil] Alternative URL that you want to redirect the user to on an error. If you do not set this parameter, the Connect Webview falls back to the `custom_redirect_url`.
|
|
23
23
|
# @param custom_redirect_url [String, nil] URL that you want to redirect the user to after the provider login is complete.
|
|
24
24
|
# @param customer_key [String, nil] Associate the Connect Webview, the connected account, and all resources under the connected account with a customer. If the connected account already exists, it will be associated with the customer. If the connected account already exists, but is already associated with a customer, the Connect Webview will show an error.
|
|
@@ -55,7 +55,7 @@ module Seam
|
|
|
55
55
|
end
|
|
56
56
|
|
|
57
57
|
# Returns a list of all [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews).
|
|
58
|
-
# @param custom_metadata_has [Hash, nil] Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs.
|
|
58
|
+
# @param custom_metadata_has [Hash{String => String, Boolean}, nil] Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs.
|
|
59
59
|
# @param customer_key [String, nil] Customer key for which you want to list connect webviews.
|
|
60
60
|
# @param limit [Float, nil] Maximum number of records to return per page.
|
|
61
61
|
# @param page_cursor [String, Seam::Null, nil] Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
|
|
@@ -40,7 +40,7 @@ module Seam
|
|
|
40
40
|
end
|
|
41
41
|
|
|
42
42
|
# Returns a list of all [connected accounts](https://docs.seam.co/core-concepts/connected-accounts).
|
|
43
|
-
# @param custom_metadata_has [Hash, nil] Custom metadata pairs by which you want to filter connected accounts. Returns connected accounts with `custom_metadata` that contains all of the provided key:value pairs.
|
|
43
|
+
# @param custom_metadata_has [Hash{String => String, Boolean}, nil] Custom metadata pairs by which you want to filter connected accounts. Returns connected accounts with `custom_metadata` that contains all of the provided key:value pairs.
|
|
44
44
|
# @param customer_key [String, nil] Customer key by which you want to filter connected accounts.
|
|
45
45
|
# @param limit [Integer, nil] Maximum number of records to return per page.
|
|
46
46
|
# @param page_cursor [String, Seam::Null, nil] Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
|
|
@@ -67,7 +67,7 @@ module Seam
|
|
|
67
67
|
# @param connected_account_id [String] ID of the connected account that you want to update.
|
|
68
68
|
# @param accepted_capabilities [Array<String>, nil] List of accepted device capabilities that restrict the types of devices that can be connected through this connected account. Valid values are `lock`, `thermostat`, `noise_sensor`, and `access_control`.
|
|
69
69
|
# @param automatically_manage_new_devices [Boolean, nil] Indicates whether newly-added devices should appear as [managed devices](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices).
|
|
70
|
-
# @param custom_metadata [Hash, nil] Custom metadata that you want to associate with the connected account. Entirely replaces the existing custom metadata object. If a new Connect Webview contains custom metadata and is used to reconnect a connected account, the custom metadata from the Connect Webview will entirely replace the entire custom metadata object on the connected account. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](https://docs.seam.co/core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata).
|
|
70
|
+
# @param custom_metadata [Hash{String => String, Boolean}, nil] Custom metadata that you want to associate with the connected account. Entirely replaces the existing custom metadata object. If a new Connect Webview contains custom metadata and is used to reconnect a connected account, the custom metadata from the Connect Webview will entirely replace the entire custom metadata object on the connected account. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](https://docs.seam.co/core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata).
|
|
71
71
|
# @param customer_key [String, nil] The customer key to associate with this connected account. If provided, the connected account and all resources under the connected account will be moved to this customer. May only be provided if the connected account is not already associated with a customer.
|
|
72
72
|
# @param display_name [String, nil] Human-readable name for the connected account, shown in the dashboard. For example, `Booking from Airbnb House 1`.
|
|
73
73
|
# @return [nil] OK
|
data/lib/seam/routes/devices.rb
CHANGED
|
@@ -37,7 +37,7 @@ module Seam
|
|
|
37
37
|
# @param connected_account_id [String, nil] ID of the connected account for which you want to list devices.
|
|
38
38
|
# @param connected_account_ids [Array<String>, nil] Array of IDs of the connected accounts for which you want to list devices.
|
|
39
39
|
# @param created_before [Time, nil] Timestamp by which to limit returned devices. Returns devices created before this timestamp.
|
|
40
|
-
# @param custom_metadata_has [Hash, nil] Set of key:value [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.
|
|
40
|
+
# @param custom_metadata_has [Hash{String => String, Boolean}, nil] Set of key:value [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.
|
|
41
41
|
# @param customer_key [String, nil] Customer key for which you want to list devices.
|
|
42
42
|
# @param device_ids [Array<String>, nil] Array of device IDs for which you want to list devices.
|
|
43
43
|
# @param device_type [String, nil] Device type for which you want to list devices.
|
|
@@ -84,7 +84,7 @@ module Seam
|
|
|
84
84
|
# You can add or change [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) for a device, change the device's name, or [convert a managed device to unmanaged](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices).
|
|
85
85
|
# @param device_id [String] ID of the device that you want to update.
|
|
86
86
|
# @param backup_access_code_pool_enabled [Boolean, nil] Indicates whether the device's [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is enabled. Set to `false` to disable the pool: Seam stops refilling it and removes any backup codes that have not yet been pulled into active use.
|
|
87
|
-
# @param custom_metadata [Hash, nil] Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter devices by the desired metadata](https://docs.seam.co/core-concepts/devices/filtering-devices-by-custom-metadata).
|
|
87
|
+
# @param custom_metadata [Hash{String => String, Boolean}, nil] Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter devices by the desired metadata](https://docs.seam.co/core-concepts/devices/filtering-devices-by-custom-metadata).
|
|
88
88
|
# @param is_managed [Boolean, nil] Indicates whether the device is managed. To unmanage a device, set `is_managed` to `false`.
|
|
89
89
|
# @param name [String, Seam::Null, nil] Name for the device.
|
|
90
90
|
# @param properties [Hash, nil]
|
|
@@ -52,8 +52,8 @@ module Seam
|
|
|
52
52
|
#
|
|
53
53
|
# An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).
|
|
54
54
|
# @param device_id [String] ID of the unmanaged device that you want to update.
|
|
55
|
-
# @param custom_metadata [Hash, nil] Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs.
|
|
56
|
-
# @param is_managed [
|
|
55
|
+
# @param custom_metadata [Hash{String => String, Boolean}, nil] Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs.
|
|
56
|
+
# @param is_managed [TrueClass, nil] Indicates whether the device is managed. Set this parameter to `true` to convert an unmanaged device to managed.
|
|
57
57
|
# @return [nil] OK
|
|
58
58
|
def update(device_id:, custom_metadata: nil, is_managed: nil)
|
|
59
59
|
@client.patch("/devices/unmanaged/update", {device_id: device_id, custom_metadata: custom_metadata, is_managed: is_managed}.compact)
|
|
@@ -32,7 +32,7 @@ module Seam
|
|
|
32
32
|
# Updates an unmanaged [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) to make it managed.
|
|
33
33
|
#
|
|
34
34
|
# This endpoint can only be used to convert unmanaged user identities to managed ones by setting `is_managed` to `true`. It cannot be used to convert managed user identities back to unmanaged.
|
|
35
|
-
# @param is_managed [
|
|
35
|
+
# @param is_managed [TrueClass] Must be set to true to convert the unmanaged user identity to managed.
|
|
36
36
|
# @param user_identity_id [String] ID of the unmanaged user identity that you want to update.
|
|
37
37
|
# @param user_identity_key [String, nil] Unique key for the user identity. If not provided, the existing key will be preserved.
|
|
38
38
|
# @return [nil] OK
|
data/lib/seam/version.rb
CHANGED