seam 2.157.0 → 2.158.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/lib/seam/resources/access_code.rb +18 -18
- data/lib/seam/resources/access_grant.rb +4 -4
- data/lib/seam/resources/access_method.rb +9 -9
- data/lib/seam/resources/acs_access_group.rb +3 -3
- data/lib/seam/resources/acs_credential.rb +35 -35
- data/lib/seam/resources/acs_encoder.rb +10 -10
- data/lib/seam/resources/acs_entrance.rb +20 -20
- data/lib/seam/resources/acs_system.rb +37 -37
- data/lib/seam/resources/acs_user.rb +35 -35
- data/lib/seam/resources/action_attempt.rb +101 -101
- data/lib/seam/resources/batch.rb +30 -30
- data/lib/seam/resources/client_session.rb +12 -12
- data/lib/seam/resources/connect_webview.rb +6 -6
- data/lib/seam/resources/connected_account.rb +9 -9
- data/lib/seam/resources/device.rb +84 -84
- data/lib/seam/resources/event.rb +60 -60
- data/lib/seam/resources/noise_threshold.rb +2 -2
- data/lib/seam/resources/phone.rb +1 -1
- data/lib/seam/resources/thermostat_daily_program.rb +1 -1
- data/lib/seam/resources/thermostat_schedule.rb +11 -11
- data/lib/seam/resources/unmanaged_access_code.rb +15 -15
- data/lib/seam/resources/unmanaged_access_grant.rb +4 -4
- data/lib/seam/resources/unmanaged_access_method.rb +9 -9
- data/lib/seam/resources/unmanaged_device.rb +10 -10
- data/lib/seam/resources/user_identity.rb +1 -1
- data/lib/seam/resources/webhook.rb +4 -4
- data/lib/seam/resources/workspace.rb +12 -12
- data/lib/seam/routes/access_codes.rb +28 -28
- data/lib/seam/routes/access_codes_simulate.rb +1 -1
- data/lib/seam/routes/access_codes_unmanaged.rb +9 -9
- data/lib/seam/routes/access_grants.rb +3 -3
- data/lib/seam/routes/access_methods.rb +2 -2
- data/lib/seam/routes/acs_access_groups.rb +7 -7
- data/lib/seam/routes/acs_credentials.rb +11 -11
- data/lib/seam/routes/acs_encoders.rb +5 -5
- data/lib/seam/routes/acs_encoders_simulate.rb +4 -4
- data/lib/seam/routes/acs_entrances.rb +5 -5
- data/lib/seam/routes/acs_systems.rb +3 -3
- data/lib/seam/routes/acs_users.rb +16 -16
- data/lib/seam/routes/action_attempts.rb +2 -2
- data/lib/seam/routes/client_sessions.rb +22 -22
- data/lib/seam/routes/connect_webviews.rb +11 -11
- data/lib/seam/routes/connected_accounts.rb +7 -7
- data/lib/seam/routes/connected_accounts_simulate.rb +1 -1
- data/lib/seam/routes/devices.rb +9 -9
- data/lib/seam/routes/devices_simulate.rb +3 -3
- data/lib/seam/routes/devices_unmanaged.rb +6 -6
- data/lib/seam/routes/events.rb +2 -2
- data/lib/seam/routes/instant_keys.rb +3 -3
- data/lib/seam/routes/locks.rb +5 -5
- data/lib/seam/routes/locks_simulate.rb +2 -2
- data/lib/seam/routes/noise_sensors.rb +1 -1
- data/lib/seam/routes/noise_sensors_noise_thresholds.rb +7 -7
- data/lib/seam/routes/noise_sensors_simulate.rb +1 -1
- data/lib/seam/routes/phones.rb +4 -4
- data/lib/seam/routes/phones_simulate.rb +1 -1
- data/lib/seam/routes/spaces.rb +4 -4
- data/lib/seam/routes/thermostats.rb +43 -43
- data/lib/seam/routes/thermostats_schedules.rb +11 -11
- data/lib/seam/routes/thermostats_simulate.rb +6 -6
- data/lib/seam/routes/user_identities.rb +15 -15
- data/lib/seam/routes/user_identities_unmanaged.rb +3 -3
- data/lib/seam/routes/webhooks.rb +5 -5
- data/lib/seam/routes/workspaces.rb +8 -8
- data/lib/seam/version.rb +1 -1
- metadata +1 -1
|
@@ -12,7 +12,7 @@ module Seam
|
|
|
12
12
|
@unmanaged ||= Seam::Clients::UserIdentitiesUnmanaged.new(client: @client, defaults: @defaults)
|
|
13
13
|
end
|
|
14
14
|
|
|
15
|
-
# Adds a specified [access system user](https://
|
|
15
|
+
# Adds a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) to a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
16
16
|
#
|
|
17
17
|
# You must specify either `user_identity_id` or `user_identity_key` to identify the user identity.
|
|
18
18
|
#
|
|
@@ -27,7 +27,7 @@ module Seam
|
|
|
27
27
|
nil
|
|
28
28
|
end
|
|
29
29
|
|
|
30
|
-
# Creates a new [user identity](https://
|
|
30
|
+
# Creates a new [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
31
31
|
# @param acs_system_ids [Array<String>, nil] List of access system IDs to associate with the new user identity through access system users. If there's no user with the same email address or phone number in the specified access systems, a new access system user is created. If there is an existing user with the same email or phone number in the specified access systems, the user is linked to the user identity.
|
|
32
32
|
# @param email_address [String, Seam::Null, nil] Unique email address for the new user identity.
|
|
33
33
|
# @param full_name [String, Seam::Null, nil] Full name of the user associated with the new user identity.
|
|
@@ -40,7 +40,7 @@ module Seam
|
|
|
40
40
|
Seam::Resources::UserIdentity.load_from_response(res.body["user_identity"])
|
|
41
41
|
end
|
|
42
42
|
|
|
43
|
-
# Deletes a specified [user identity](https://
|
|
43
|
+
# Deletes a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This deletes the user identity and all associated resources, including any [credentials](https://www.seam.co/docs/api/acs/credentials/object), [acs users](https://www.seam.co/docs/api/acs/users/object) and [client sessions](https://www.seam.co/docs/api/client_sessions/object).
|
|
44
44
|
# @param user_identity_id [String] ID of the user identity that you want to delete.
|
|
45
45
|
# @return [nil] OK
|
|
46
46
|
def delete(user_identity_id:)
|
|
@@ -49,7 +49,7 @@ module Seam
|
|
|
49
49
|
nil
|
|
50
50
|
end
|
|
51
51
|
|
|
52
|
-
# Generates a new [instant key](https://
|
|
52
|
+
# Generates a new [instant key](https://www.seam.co/docs/use-cases/granting-access/using-instant-keys) for a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
53
53
|
# @param user_identity_id [String] ID of the user identity for which you want to generate an instant key.
|
|
54
54
|
# @param customization_profile_id [String, nil]
|
|
55
55
|
# @param max_use_count [Float, nil] Maximum number of times the instant key can be used. Default: 1.
|
|
@@ -60,7 +60,7 @@ module Seam
|
|
|
60
60
|
Seam::Resources::InstantKey.load_from_response(res.body["instant_key"])
|
|
61
61
|
end
|
|
62
62
|
|
|
63
|
-
# Returns a specified [user identity](https://
|
|
63
|
+
# Returns a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
64
64
|
# @param user_identity_id [String, nil] ID of the user identity that you want to get.
|
|
65
65
|
# @param user_identity_key [String, nil]
|
|
66
66
|
# @return [Seam::Resources::UserIdentity] OK
|
|
@@ -74,7 +74,7 @@ module Seam
|
|
|
74
74
|
Seam::Resources::UserIdentity.load_from_response(res.body["user_identity"])
|
|
75
75
|
end
|
|
76
76
|
|
|
77
|
-
# Grants a specified [user identity](https://
|
|
77
|
+
# Grants a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](https://www.seam.co/docs/core-concepts/devices).
|
|
78
78
|
# @param device_id [String] ID of the managed device to which you want to grant access to the user identity.
|
|
79
79
|
# @param user_identity_id [String] ID of the user identity that you want to grant access to a device.
|
|
80
80
|
# @return [nil] OK
|
|
@@ -84,7 +84,7 @@ module Seam
|
|
|
84
84
|
nil
|
|
85
85
|
end
|
|
86
86
|
|
|
87
|
-
# Returns a list of all [user identities](https://
|
|
87
|
+
# Returns a list of all [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
88
88
|
# @param created_before [Time, nil] Timestamp by which to limit returned user identities. Returns user identities created before this timestamp.
|
|
89
89
|
# @param credential_manager_acs_system_id [String, nil] `acs_system_id` of the credential manager by which you want to filter the list of user identities.
|
|
90
90
|
# @param limit [Integer, nil] Maximum number of records to return per page.
|
|
@@ -98,7 +98,7 @@ module Seam
|
|
|
98
98
|
Seam::Resources::UserIdentity.load_from_response(res.body["user_identities"])
|
|
99
99
|
end
|
|
100
100
|
|
|
101
|
-
# Returns a list of all [devices](https://
|
|
101
|
+
# Returns a list of all [devices](https://www.seam.co/docs/core-concepts/devices) associated with a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This includes devices derived from the access grants assigned to the user identity and devices directly linked to the user identity.
|
|
102
102
|
# @param user_identity_id [String] ID of the user identity for which you want to retrieve all accessible devices.
|
|
103
103
|
# @return [Seam::Resources::Device] OK
|
|
104
104
|
def list_accessible_devices(user_identity_id:)
|
|
@@ -107,7 +107,7 @@ module Seam
|
|
|
107
107
|
Seam::Resources::Device.load_from_response(res.body["devices"])
|
|
108
108
|
end
|
|
109
109
|
|
|
110
|
-
# Returns a list of all [ACS entrances](https://
|
|
110
|
+
# Returns a list of all [ACS entrances](https://www.seam.co/docs/api/acs/entrances/object) accessible to a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This includes entrances derived from the access grants assigned to the user identity and entrances accessible through ACS users linked to the user identity.
|
|
111
111
|
# @param user_identity_id [String] ID of the user identity for which you want to retrieve all accessible entrances.
|
|
112
112
|
# @return [Seam::Resources::AcsEntrance] OK
|
|
113
113
|
def list_accessible_entrances(user_identity_id:)
|
|
@@ -116,7 +116,7 @@ module Seam
|
|
|
116
116
|
Seam::Resources::AcsEntrance.load_from_response(res.body["acs_entrances"])
|
|
117
117
|
end
|
|
118
118
|
|
|
119
|
-
# Returns a list of all [access systems](https://
|
|
119
|
+
# Returns a list of all [access systems](https://www.seam.co/docs/low-level-apis/access-systems) associated with a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
120
120
|
# @param user_identity_id [String] ID of the user identity for which you want to retrieve all access systems.
|
|
121
121
|
# @return [Seam::Resources::AcsSystem] OK
|
|
122
122
|
def list_acs_systems(user_identity_id:)
|
|
@@ -125,7 +125,7 @@ module Seam
|
|
|
125
125
|
Seam::Resources::AcsSystem.load_from_response(res.body["acs_systems"])
|
|
126
126
|
end
|
|
127
127
|
|
|
128
|
-
# Returns a list of all [access system users](https://
|
|
128
|
+
# Returns a list of all [access system users](https://www.seam.co/docs/low-level-apis/access-systems/user-management) assigned to a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
129
129
|
# @param user_identity_id [String] ID of the user identity for which you want to retrieve all access system users.
|
|
130
130
|
# @return [Seam::Resources::AcsUser] OK
|
|
131
131
|
def list_acs_users(user_identity_id:)
|
|
@@ -134,7 +134,7 @@ module Seam
|
|
|
134
134
|
Seam::Resources::AcsUser.load_from_response(res.body["acs_users"])
|
|
135
135
|
end
|
|
136
136
|
|
|
137
|
-
# Merges one or more [user identities](https://
|
|
137
|
+
# Merges one or more [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) into a primary user identity, for when the same person ended up with more than one user identity.
|
|
138
138
|
#
|
|
139
139
|
# The primary user identity takes on any email address or phone number it was missing from the user identities merged into it, and the merged user identities are then deleted. Their IDs and keys keep working: looking one up returns the primary user identity, and they are listed on it as `merged_user_identity_ids` and `merged_user_identity_keys`.
|
|
140
140
|
#
|
|
@@ -156,7 +156,7 @@ module Seam
|
|
|
156
156
|
nil
|
|
157
157
|
end
|
|
158
158
|
|
|
159
|
-
# Removes a specified [access system user](https://
|
|
159
|
+
# Removes a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) from a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
160
160
|
# @param acs_user_id [String] ID of the access system user that you want to remove from the user identity..
|
|
161
161
|
# @param user_identity_id [String] ID of the user identity from which you want to remove an access system user.
|
|
162
162
|
# @return [nil] OK
|
|
@@ -166,7 +166,7 @@ module Seam
|
|
|
166
166
|
nil
|
|
167
167
|
end
|
|
168
168
|
|
|
169
|
-
# Revokes access to a specified [device](https://
|
|
169
|
+
# Revokes access to a specified [device](https://www.seam.co/docs/core-concepts/devices) from a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
170
170
|
# @param device_id [String] ID of the managed device to which you want to revoke access from the user identity.
|
|
171
171
|
# @param user_identity_id [String] ID of the user identity from which you want to revoke access to a device.
|
|
172
172
|
# @return [nil] OK
|
|
@@ -176,7 +176,7 @@ module Seam
|
|
|
176
176
|
nil
|
|
177
177
|
end
|
|
178
178
|
|
|
179
|
-
# Updates a specified [user identity](https://
|
|
179
|
+
# Updates a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
180
180
|
# @param user_identity_id [String] ID of the user identity that you want to update.
|
|
181
181
|
# @param email_address [String, Seam::Null, nil] Unique email address for the user identity.
|
|
182
182
|
# @param full_name [String, Seam::Null, nil] Full name of the user associated with the user identity.
|
|
@@ -8,7 +8,7 @@ module Seam
|
|
|
8
8
|
@defaults = defaults
|
|
9
9
|
end
|
|
10
10
|
|
|
11
|
-
# Returns a specified unmanaged [user identity](https://
|
|
11
|
+
# Returns a specified unmanaged [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) (where is_managed = false).
|
|
12
12
|
# @param user_identity_id [String] ID of the unmanaged user identity that you want to get.
|
|
13
13
|
# @return [Seam::Resources::UnmanagedUserIdentity] OK
|
|
14
14
|
def get(user_identity_id:)
|
|
@@ -17,7 +17,7 @@ module Seam
|
|
|
17
17
|
Seam::Resources::UnmanagedUserIdentity.load_from_response(res.body["user_identity"])
|
|
18
18
|
end
|
|
19
19
|
|
|
20
|
-
# Returns a list of all unmanaged [user identities](https://
|
|
20
|
+
# Returns a list of all unmanaged [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) (where is_managed = false).
|
|
21
21
|
# @param created_before [Time, nil] Timestamp by which to limit returned unmanaged user identities. Returns user identities created before this timestamp.
|
|
22
22
|
# @param limit [Integer, nil] Maximum number of records to return per page.
|
|
23
23
|
# @param page_cursor [String, Seam::Null, nil] Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
|
|
@@ -29,7 +29,7 @@ module Seam
|
|
|
29
29
|
Seam::Resources::UnmanagedUserIdentity.load_from_response(res.body["user_identities"])
|
|
30
30
|
end
|
|
31
31
|
|
|
32
|
-
# Updates an unmanaged [user identity](https://
|
|
32
|
+
# Updates an unmanaged [user identity](https://www.seam.co/docs/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
35
|
# @param is_managed [TrueClass] Must be set to true to convert the unmanaged user identity to managed.
|
data/lib/seam/routes/webhooks.rb
CHANGED
|
@@ -8,7 +8,7 @@ module Seam
|
|
|
8
8
|
@defaults = defaults
|
|
9
9
|
end
|
|
10
10
|
|
|
11
|
-
# Creates a new [webhook](https://
|
|
11
|
+
# Creates a new [webhook](https://www.seam.co/docs/developer-tools/webhooks).
|
|
12
12
|
# @param url [String] URL for the new webhook.
|
|
13
13
|
# @param event_types [Array<String>, nil] Types of events that you want the new webhook to receive.
|
|
14
14
|
# @return [Seam::Resources::Webhook] OK
|
|
@@ -18,7 +18,7 @@ module Seam
|
|
|
18
18
|
Seam::Resources::Webhook.load_from_response(res.body["webhook"])
|
|
19
19
|
end
|
|
20
20
|
|
|
21
|
-
# Deletes a specified [webhook](https://
|
|
21
|
+
# Deletes a specified [webhook](https://www.seam.co/docs/developer-tools/webhooks).
|
|
22
22
|
# @param webhook_id [String] ID of the webhook that you want to delete.
|
|
23
23
|
# @return [nil] OK
|
|
24
24
|
def delete(webhook_id:)
|
|
@@ -27,7 +27,7 @@ module Seam
|
|
|
27
27
|
nil
|
|
28
28
|
end
|
|
29
29
|
|
|
30
|
-
# Gets a specified [webhook](https://
|
|
30
|
+
# Gets a specified [webhook](https://www.seam.co/docs/developer-tools/webhooks).
|
|
31
31
|
# @param webhook_id [String] ID of the webhook that you want to get.
|
|
32
32
|
# @return [Seam::Resources::Webhook] OK
|
|
33
33
|
def get(webhook_id:)
|
|
@@ -36,7 +36,7 @@ module Seam
|
|
|
36
36
|
Seam::Resources::Webhook.load_from_response(res.body["webhook"])
|
|
37
37
|
end
|
|
38
38
|
|
|
39
|
-
# Returns a list of all [webhooks](https://
|
|
39
|
+
# Returns a list of all [webhooks](https://www.seam.co/docs/developer-tools/webhooks).
|
|
40
40
|
# @return [Seam::Resources::Webhook] OK
|
|
41
41
|
def list
|
|
42
42
|
res = @client.get("/webhooks/list")
|
|
@@ -44,7 +44,7 @@ module Seam
|
|
|
44
44
|
Seam::Resources::Webhook.load_from_response(res.body["webhooks"])
|
|
45
45
|
end
|
|
46
46
|
|
|
47
|
-
# Updates a specified [webhook](https://
|
|
47
|
+
# Updates a specified [webhook](https://www.seam.co/docs/developer-tools/webhooks).
|
|
48
48
|
# @param event_types [Array<String>] Types of events that you want the webhook to receive.
|
|
49
49
|
# @param webhook_id [String] ID of the webhook that you want to update.
|
|
50
50
|
# @return [nil] OK
|
|
@@ -10,13 +10,13 @@ module Seam
|
|
|
10
10
|
@defaults = defaults
|
|
11
11
|
end
|
|
12
12
|
|
|
13
|
-
# Creates a new [workspace](https://
|
|
13
|
+
# Creates a new [workspace](https://www.seam.co/docs/core-concepts/workspaces).
|
|
14
14
|
# @param name [String] Name of the new workspace.
|
|
15
15
|
# @param company_name [String, nil] Company name for the new workspace.
|
|
16
16
|
# @deprecated company_name: Use `connect_partner_name` instead.
|
|
17
17
|
# @param connect_partner_name [String, Seam::Null, nil] Connect partner name for the new workspace.
|
|
18
|
-
# @param connect_webview_customization [Hash, nil] [Connect Webview](https://
|
|
19
|
-
# @param is_sandbox [Boolean, nil] Indicates whether the new workspace is a [sandbox workspace](https://
|
|
18
|
+
# @param connect_webview_customization [Hash, nil] [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews) customizations for the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
|
|
19
|
+
# @param is_sandbox [Boolean, nil] Indicates whether the new workspace is a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
|
|
20
20
|
# @param organization_id [String, nil] ID of the organization to associate with the new workspace. If omitted, the new workspace is associated with the organization that you administer, if you administer exactly one. If you administer no organization, Seam creates one for you and associates the new workspace with it.
|
|
21
21
|
# @param webview_logo_shape [String, nil]
|
|
22
22
|
# @deprecated webview_logo_shape: Use `connect_webview_customization.webview_logo_shape` instead.
|
|
@@ -33,7 +33,7 @@ module Seam
|
|
|
33
33
|
Seam::Resources::Workspace.load_from_response(res.body["workspace"])
|
|
34
34
|
end
|
|
35
35
|
|
|
36
|
-
# Returns the [workspace](https://
|
|
36
|
+
# Returns the [workspace](https://www.seam.co/docs/core-concepts/workspaces) associated with the authentication value.
|
|
37
37
|
# @return [Seam::Resources::Workspace] OK
|
|
38
38
|
def get
|
|
39
39
|
res = @client.get("/workspaces/get")
|
|
@@ -41,7 +41,7 @@ module Seam
|
|
|
41
41
|
Seam::Resources::Workspace.load_from_response(res.body["workspace"])
|
|
42
42
|
end
|
|
43
43
|
|
|
44
|
-
# Returns a list of [workspaces](https://
|
|
44
|
+
# Returns a list of [workspaces](https://www.seam.co/docs/core-concepts/workspaces) associated with the authentication value.
|
|
45
45
|
# @return [Seam::Resources::Workspace] OK
|
|
46
46
|
def list
|
|
47
47
|
res = @client.get("/workspaces/list")
|
|
@@ -49,7 +49,7 @@ module Seam
|
|
|
49
49
|
Seam::Resources::Workspace.load_from_response(res.body["workspaces"])
|
|
50
50
|
end
|
|
51
51
|
|
|
52
|
-
# Resets the [sandbox workspace](https://
|
|
52
|
+
# Resets the [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces) associated with the authentication value. Note that this endpoint is only available for sandbox workspaces.
|
|
53
53
|
# @return [Seam::Resources::ActionAttempt] OK
|
|
54
54
|
def reset_sandbox(wait_for_action_attempt: nil)
|
|
55
55
|
res = @client.post("/workspaces/reset_sandbox")
|
|
@@ -59,9 +59,9 @@ module Seam
|
|
|
59
59
|
Seam::ActionAttemptResolver.resolve(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
|
|
60
60
|
end
|
|
61
61
|
|
|
62
|
-
# Updates the [workspace](https://
|
|
62
|
+
# Updates the [workspace](https://www.seam.co/docs/core-concepts/workspaces) associated with the authentication value.
|
|
63
63
|
# @param connect_partner_name [String, nil] Connect partner name for the workspace.
|
|
64
|
-
# @param connect_webview_customization [Hash, nil] [Connect Webview](https://
|
|
64
|
+
# @param connect_webview_customization [Hash, nil] [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews) customizations for the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
|
|
65
65
|
# @param is_publishable_key_auth_enabled [Boolean, nil] Indicates whether publishable key authentication is enabled for this workspace.
|
|
66
66
|
# @param is_suspended [Boolean, nil] Indicates whether the workspace is suspended.
|
|
67
67
|
# @param name [String, nil] Name of the workspace.
|
data/lib/seam/version.rb
CHANGED