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
|
@@ -120,63 +120,63 @@ module Seam
|
|
|
120
120
|
class Result < BaseResource
|
|
121
121
|
class AcsCredentialOnEncoder < BaseResource
|
|
122
122
|
class VisionlineMetadata < BaseResource
|
|
123
|
-
# Indicates whether the card associated with the [credential](https://
|
|
123
|
+
# Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is cancelled.
|
|
124
124
|
# @return [Boolean, nil]
|
|
125
125
|
attr_accessor :cancelled
|
|
126
|
-
# Format of the card associated with the [credential](https://
|
|
126
|
+
# Format of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
127
127
|
# @return [String, nil]
|
|
128
128
|
# Known values:
|
|
129
129
|
# - `TLCode`
|
|
130
130
|
# - `rfid48`
|
|
131
131
|
attr_accessor :card_format
|
|
132
|
-
# Holder of the card associated with the [credential](https://
|
|
132
|
+
# Holder of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
133
133
|
# @return [String, nil]
|
|
134
134
|
attr_accessor :card_holder
|
|
135
|
-
# Card ID for the Visionline card associated with the [credential](https://
|
|
135
|
+
# Card ID for the Visionline card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
136
136
|
# @return [String, nil]
|
|
137
137
|
attr_accessor :card_id
|
|
138
|
-
# IDs of the common [entrances](https://
|
|
138
|
+
# IDs of the common [entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
139
139
|
# @return [Array<String>]
|
|
140
140
|
attr_accessor :common_acs_entrance_ids
|
|
141
|
-
# Indicates whether the card associated with the [credential](https://
|
|
141
|
+
# Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is discarded.
|
|
142
142
|
# @return [Boolean, nil]
|
|
143
143
|
attr_accessor :discarded
|
|
144
|
-
# Indicates whether the card associated with the [credential](https://
|
|
144
|
+
# Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is expired.
|
|
145
145
|
# @return [Boolean, nil]
|
|
146
146
|
attr_accessor :expired
|
|
147
|
-
# IDs of the guest [entrances](https://
|
|
147
|
+
# IDs of the guest [entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
148
148
|
# @return [Array<String>]
|
|
149
149
|
attr_accessor :guest_acs_entrance_ids
|
|
150
|
-
# Number of issued cards associated with the [credential](https://
|
|
150
|
+
# Number of issued cards associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
151
151
|
# @return [Float, nil]
|
|
152
152
|
attr_accessor :number_of_issued_cards
|
|
153
|
-
# Indicates whether the card associated with the [credential](https://
|
|
153
|
+
# Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is overridden.
|
|
154
154
|
# @return [Boolean, nil]
|
|
155
155
|
attr_accessor :overridden
|
|
156
|
-
# Indicates whether the card associated with the [credential](https://
|
|
156
|
+
# Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is overwritten.
|
|
157
157
|
# @return [Boolean, nil]
|
|
158
158
|
attr_accessor :overwritten
|
|
159
|
-
# Indicates whether the card associated with the [credential](https://
|
|
159
|
+
# Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is pending auto-update.
|
|
160
160
|
# @return [Boolean, nil]
|
|
161
161
|
attr_accessor :pending_auto_update
|
|
162
162
|
end
|
|
163
163
|
|
|
164
|
-
# Visionline-specific metadata for the [credential](https://
|
|
164
|
+
# Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
165
165
|
# @return [VisionlineMetadata, nil]
|
|
166
166
|
resource_accessor :visionline_metadata, VisionlineMetadata
|
|
167
|
-
# A number or string that physically identifies the card associated with the [credential](https://
|
|
167
|
+
# A number or string that physically identifies the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
168
168
|
# @return [String, nil]
|
|
169
169
|
attr_accessor :card_number
|
|
170
170
|
# Indicates whether the credential has been issued (encoded onto a card).
|
|
171
171
|
# @return [Boolean, nil]
|
|
172
172
|
attr_accessor :is_issued
|
|
173
|
-
# Date and time at which the [credential](https://
|
|
173
|
+
# Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created.
|
|
174
174
|
# @return [Time, nil]
|
|
175
175
|
date_accessor :created_at
|
|
176
|
-
# Date and time at which the [credential](https://
|
|
176
|
+
# Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) will stop being usable.
|
|
177
177
|
# @return [Time, nil]
|
|
178
178
|
date_accessor :ends_at
|
|
179
|
-
# Date and time at which the [credential](https://
|
|
179
|
+
# Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) becomes usable.
|
|
180
180
|
# @return [Time, nil]
|
|
181
181
|
date_accessor :starts_at
|
|
182
182
|
end
|
|
@@ -275,22 +275,22 @@ module Seam
|
|
|
275
275
|
date_accessor :created_at
|
|
276
276
|
end
|
|
277
277
|
|
|
278
|
-
# Akiles-specific metadata for the [credential](https://
|
|
278
|
+
# Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
279
279
|
# @return [AkilesMetadata, nil]
|
|
280
280
|
resource_accessor :akiles_metadata, AkilesMetadata
|
|
281
|
-
# Vostio-specific metadata for the [credential](https://
|
|
281
|
+
# Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
282
282
|
# @return [AssaAbloyVostioMetadata, nil]
|
|
283
283
|
resource_accessor :assa_abloy_vostio_metadata, AssaAbloyVostioMetadata
|
|
284
|
-
# Visionline-specific metadata for the [credential](https://
|
|
284
|
+
# Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
285
285
|
# @return [VisionlineMetadata, nil]
|
|
286
286
|
resource_accessor :visionline_metadata, VisionlineMetadata
|
|
287
|
-
# Errors associated with the [credential](https://
|
|
287
|
+
# Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
288
288
|
# @return [Array<Errors>]
|
|
289
289
|
resource_list_accessor :errors, Errors
|
|
290
|
-
# Warnings associated with the [credential](https://
|
|
290
|
+
# Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
291
291
|
# @return [Array<Warnings>]
|
|
292
292
|
resource_list_accessor :warnings, Warnings
|
|
293
|
-
# Access method for the [credential](https://
|
|
293
|
+
# Access method for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.
|
|
294
294
|
# @return [String]
|
|
295
295
|
# Known values:
|
|
296
296
|
# - `code`
|
|
@@ -298,34 +298,34 @@ module Seam
|
|
|
298
298
|
# - `mobile_key`
|
|
299
299
|
# - `cloud_key`
|
|
300
300
|
attr_accessor :access_method
|
|
301
|
-
# ID of the [credential](https://
|
|
301
|
+
# ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
302
302
|
# @return [String]
|
|
303
303
|
attr_accessor :acs_credential_id
|
|
304
304
|
# ID of the credential pool to which the credential belongs.
|
|
305
305
|
# @return [String, nil]
|
|
306
306
|
attr_accessor :acs_credential_pool_id
|
|
307
|
-
# ID of the [access control system](https://
|
|
307
|
+
# ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
308
308
|
# @return [String]
|
|
309
309
|
attr_accessor :acs_system_id
|
|
310
|
-
# ID of the [ACS user](https://
|
|
310
|
+
# ID of the [ACS user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs.
|
|
311
311
|
# @return [String, nil]
|
|
312
312
|
attr_accessor :acs_user_id
|
|
313
|
-
# Number of the card associated with the [credential](https://
|
|
313
|
+
# Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
314
314
|
# @return [String, nil]
|
|
315
315
|
attr_accessor :card_number
|
|
316
|
-
# Access (PIN) code for the [credential](https://
|
|
316
|
+
# Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
317
317
|
# @return [String, nil]
|
|
318
318
|
attr_accessor :code
|
|
319
|
-
# ID of the [connected account](https://
|
|
319
|
+
# ID of the [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) to which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs.
|
|
320
320
|
# @return [String]
|
|
321
321
|
attr_accessor :connected_account_id
|
|
322
|
-
# Display name that corresponds to the [credential](https://
|
|
322
|
+
# Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type.
|
|
323
323
|
# @return [String]
|
|
324
324
|
attr_accessor :display_name
|
|
325
|
-
# Date and time at which the [credential](https://
|
|
325
|
+
# Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
|
|
326
326
|
# @return [String, nil]
|
|
327
327
|
attr_accessor :ends_at
|
|
328
|
-
# Brand-specific terminology for the [credential](https://
|
|
328
|
+
# Brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.
|
|
329
329
|
# @return [String, nil]
|
|
330
330
|
# Known values:
|
|
331
331
|
# - `pti_card`
|
|
@@ -343,42 +343,42 @@ module Seam
|
|
|
343
343
|
# - `kisi_credential`
|
|
344
344
|
# - `akiles_credential`
|
|
345
345
|
attr_accessor :external_type
|
|
346
|
-
# Display name that corresponds to the brand-specific terminology for the [credential](https://
|
|
346
|
+
# Display name that corresponds to the brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type.
|
|
347
347
|
# @return [String, nil]
|
|
348
348
|
attr_accessor :external_type_display_name
|
|
349
|
-
# Indicates whether the [credential](https://
|
|
349
|
+
# Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card.
|
|
350
350
|
# @return [Boolean, nil]
|
|
351
351
|
attr_accessor :is_issued
|
|
352
|
-
# Indicates whether the latest state of the [credential](https://
|
|
352
|
+
# Indicates whether the latest state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been synced from Seam to the provider.
|
|
353
353
|
# @return [Boolean, nil]
|
|
354
354
|
attr_accessor :is_latest_desired_state_synced_with_provider
|
|
355
355
|
# @return [Boolean]
|
|
356
356
|
attr_accessor :is_managed
|
|
357
|
-
# Indicates whether the [credential](https://
|
|
357
|
+
# Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://www.seam.co/docs/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
|
|
358
358
|
# @return [Boolean, nil]
|
|
359
359
|
attr_accessor :is_multi_phone_sync_credential
|
|
360
|
-
# Indicates whether the [credential](https://
|
|
360
|
+
# Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use.
|
|
361
361
|
# @return [Boolean, nil]
|
|
362
362
|
attr_accessor :is_one_time_use
|
|
363
|
-
# ID of the parent [credential](https://
|
|
363
|
+
# ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
364
364
|
# @return [String, nil]
|
|
365
365
|
attr_accessor :parent_acs_credential_id
|
|
366
|
-
# Date and time at which the [credential](https://
|
|
366
|
+
# Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
|
|
367
367
|
# @return [String, nil]
|
|
368
368
|
attr_accessor :starts_at
|
|
369
|
-
# ID of the [user identity](https://
|
|
369
|
+
# ID of the [user identity](https://www.seam.co/docs/api/user_identities/object) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs.
|
|
370
370
|
# @return [String, nil]
|
|
371
371
|
attr_accessor :user_identity_id
|
|
372
|
-
# ID of the workspace that contains the [credential](https://
|
|
372
|
+
# ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
373
373
|
# @return [String]
|
|
374
374
|
attr_accessor :workspace_id
|
|
375
|
-
# Date and time at which the [credential](https://
|
|
375
|
+
# Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created.
|
|
376
376
|
# @return [Time]
|
|
377
377
|
date_accessor :created_at
|
|
378
|
-
# Date and time at which the [credential](https://
|
|
378
|
+
# Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card.
|
|
379
379
|
# @return [Time, nil]
|
|
380
380
|
date_accessor :issued_at
|
|
381
|
-
# Date and time at which the state of the [credential](https://
|
|
381
|
+
# Date and time at which the state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was most recently synced from Seam to the provider.
|
|
382
382
|
# @return [Time, nil]
|
|
383
383
|
date_accessor :latest_desired_state_synced_with_provider_at
|
|
384
384
|
end
|
|
@@ -547,22 +547,22 @@ module Seam
|
|
|
547
547
|
date_accessor :created_at
|
|
548
548
|
end
|
|
549
549
|
|
|
550
|
-
# Akiles-specific metadata for the [credential](https://
|
|
550
|
+
# Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
551
551
|
# @return [AkilesMetadata, nil]
|
|
552
552
|
resource_accessor :akiles_metadata, AkilesMetadata
|
|
553
|
-
# Vostio-specific metadata for the [credential](https://
|
|
553
|
+
# Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
554
554
|
# @return [AssaAbloyVostioMetadata, nil]
|
|
555
555
|
resource_accessor :assa_abloy_vostio_metadata, AssaAbloyVostioMetadata
|
|
556
|
-
# Visionline-specific metadata for the [credential](https://
|
|
556
|
+
# Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
557
557
|
# @return [VisionlineMetadata, nil]
|
|
558
558
|
resource_accessor :visionline_metadata, VisionlineMetadata
|
|
559
|
-
# Errors associated with the [credential](https://
|
|
559
|
+
# Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
560
560
|
# @return [Array<Errors>]
|
|
561
561
|
resource_list_accessor :errors, Errors
|
|
562
|
-
# Warnings associated with the [credential](https://
|
|
562
|
+
# Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
563
563
|
# @return [Array<Warnings>]
|
|
564
564
|
resource_list_accessor :warnings, Warnings
|
|
565
|
-
# Access method for the [credential](https://
|
|
565
|
+
# Access method for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.
|
|
566
566
|
# @return [String]
|
|
567
567
|
# Known values:
|
|
568
568
|
# - `code`
|
|
@@ -570,34 +570,34 @@ module Seam
|
|
|
570
570
|
# - `mobile_key`
|
|
571
571
|
# - `cloud_key`
|
|
572
572
|
attr_accessor :access_method
|
|
573
|
-
# ID of the [credential](https://
|
|
573
|
+
# ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
574
574
|
# @return [String]
|
|
575
575
|
attr_accessor :acs_credential_id
|
|
576
576
|
# ID of the credential pool to which the credential belongs.
|
|
577
577
|
# @return [String, nil]
|
|
578
578
|
attr_accessor :acs_credential_pool_id
|
|
579
|
-
# ID of the [access control system](https://
|
|
579
|
+
# ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
580
580
|
# @return [String]
|
|
581
581
|
attr_accessor :acs_system_id
|
|
582
|
-
# ID of the [ACS user](https://
|
|
582
|
+
# ID of the [ACS user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs.
|
|
583
583
|
# @return [String, nil]
|
|
584
584
|
attr_accessor :acs_user_id
|
|
585
|
-
# Number of the card associated with the [credential](https://
|
|
585
|
+
# Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
586
586
|
# @return [String, nil]
|
|
587
587
|
attr_accessor :card_number
|
|
588
|
-
# Access (PIN) code for the [credential](https://
|
|
588
|
+
# Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
589
589
|
# @return [String, nil]
|
|
590
590
|
attr_accessor :code
|
|
591
|
-
# ID of the [connected account](https://
|
|
591
|
+
# ID of the [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) to which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs.
|
|
592
592
|
# @return [String]
|
|
593
593
|
attr_accessor :connected_account_id
|
|
594
|
-
# Display name that corresponds to the [credential](https://
|
|
594
|
+
# Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type.
|
|
595
595
|
# @return [String]
|
|
596
596
|
attr_accessor :display_name
|
|
597
|
-
# Date and time at which the [credential](https://
|
|
597
|
+
# Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
|
|
598
598
|
# @return [String, nil]
|
|
599
599
|
attr_accessor :ends_at
|
|
600
|
-
# Brand-specific terminology for the [credential](https://
|
|
600
|
+
# Brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.
|
|
601
601
|
# @return [String, nil]
|
|
602
602
|
# Known values:
|
|
603
603
|
# - `pti_card`
|
|
@@ -615,42 +615,42 @@ module Seam
|
|
|
615
615
|
# - `kisi_credential`
|
|
616
616
|
# - `akiles_credential`
|
|
617
617
|
attr_accessor :external_type
|
|
618
|
-
# Display name that corresponds to the brand-specific terminology for the [credential](https://
|
|
618
|
+
# Display name that corresponds to the brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type.
|
|
619
619
|
# @return [String, nil]
|
|
620
620
|
attr_accessor :external_type_display_name
|
|
621
|
-
# Indicates whether the [credential](https://
|
|
621
|
+
# Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card.
|
|
622
622
|
# @return [Boolean, nil]
|
|
623
623
|
attr_accessor :is_issued
|
|
624
|
-
# Indicates whether the latest state of the [credential](https://
|
|
624
|
+
# Indicates whether the latest state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been synced from Seam to the provider.
|
|
625
625
|
# @return [Boolean, nil]
|
|
626
626
|
attr_accessor :is_latest_desired_state_synced_with_provider
|
|
627
627
|
# @return [Boolean]
|
|
628
628
|
attr_accessor :is_managed
|
|
629
|
-
# Indicates whether the [credential](https://
|
|
629
|
+
# Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://www.seam.co/docs/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
|
|
630
630
|
# @return [Boolean, nil]
|
|
631
631
|
attr_accessor :is_multi_phone_sync_credential
|
|
632
|
-
# Indicates whether the [credential](https://
|
|
632
|
+
# Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use.
|
|
633
633
|
# @return [Boolean, nil]
|
|
634
634
|
attr_accessor :is_one_time_use
|
|
635
|
-
# ID of the parent [credential](https://
|
|
635
|
+
# ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
636
636
|
# @return [String, nil]
|
|
637
637
|
attr_accessor :parent_acs_credential_id
|
|
638
|
-
# Date and time at which the [credential](https://
|
|
638
|
+
# Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
|
|
639
639
|
# @return [String, nil]
|
|
640
640
|
attr_accessor :starts_at
|
|
641
|
-
# ID of the [user identity](https://
|
|
641
|
+
# ID of the [user identity](https://www.seam.co/docs/api/user_identities/object) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs.
|
|
642
642
|
# @return [String, nil]
|
|
643
643
|
attr_accessor :user_identity_id
|
|
644
|
-
# ID of the workspace that contains the [credential](https://
|
|
644
|
+
# ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
645
645
|
# @return [String]
|
|
646
646
|
attr_accessor :workspace_id
|
|
647
|
-
# Date and time at which the [credential](https://
|
|
647
|
+
# Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created.
|
|
648
648
|
# @return [Time]
|
|
649
649
|
date_accessor :created_at
|
|
650
|
-
# Date and time at which the [credential](https://
|
|
650
|
+
# Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card.
|
|
651
651
|
# @return [Time, nil]
|
|
652
652
|
date_accessor :issued_at
|
|
653
|
-
# Date and time at which the state of the [credential](https://
|
|
653
|
+
# Date and time at which the state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was most recently synced from Seam to the provider.
|
|
654
654
|
# @return [Time, nil]
|
|
655
655
|
date_accessor :latest_desired_state_synced_with_provider_at
|
|
656
656
|
end
|
|
@@ -789,22 +789,22 @@ module Seam
|
|
|
789
789
|
date_accessor :created_at
|
|
790
790
|
end
|
|
791
791
|
|
|
792
|
-
# Akiles-specific metadata for the [credential](https://
|
|
792
|
+
# Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
793
793
|
# @return [AkilesMetadata, nil]
|
|
794
794
|
resource_accessor :akiles_metadata, AkilesMetadata
|
|
795
|
-
# Vostio-specific metadata for the [credential](https://
|
|
795
|
+
# Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
796
796
|
# @return [AssaAbloyVostioMetadata, nil]
|
|
797
797
|
resource_accessor :assa_abloy_vostio_metadata, AssaAbloyVostioMetadata
|
|
798
|
-
# Visionline-specific metadata for the [credential](https://
|
|
798
|
+
# Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
799
799
|
# @return [VisionlineMetadata, nil]
|
|
800
800
|
resource_accessor :visionline_metadata, VisionlineMetadata
|
|
801
|
-
# Errors associated with the [credential](https://
|
|
801
|
+
# Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
802
802
|
# @return [Array<Errors>]
|
|
803
803
|
resource_list_accessor :errors, Errors
|
|
804
|
-
# Warnings associated with the [credential](https://
|
|
804
|
+
# Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
805
805
|
# @return [Array<Warnings>]
|
|
806
806
|
resource_list_accessor :warnings, Warnings
|
|
807
|
-
# Access method for the [credential](https://
|
|
807
|
+
# Access method for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.
|
|
808
808
|
# @return [String]
|
|
809
809
|
# Known values:
|
|
810
810
|
# - `code`
|
|
@@ -812,34 +812,34 @@ module Seam
|
|
|
812
812
|
# - `mobile_key`
|
|
813
813
|
# - `cloud_key`
|
|
814
814
|
attr_accessor :access_method
|
|
815
|
-
# ID of the [credential](https://
|
|
815
|
+
# ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
816
816
|
# @return [String]
|
|
817
817
|
attr_accessor :acs_credential_id
|
|
818
818
|
# ID of the credential pool to which the credential belongs.
|
|
819
819
|
# @return [String, nil]
|
|
820
820
|
attr_accessor :acs_credential_pool_id
|
|
821
|
-
# ID of the [access control system](https://
|
|
821
|
+
# ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
822
822
|
# @return [String]
|
|
823
823
|
attr_accessor :acs_system_id
|
|
824
|
-
# ID of the [ACS user](https://
|
|
824
|
+
# ID of the [ACS user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs.
|
|
825
825
|
# @return [String, nil]
|
|
826
826
|
attr_accessor :acs_user_id
|
|
827
|
-
# Number of the card associated with the [credential](https://
|
|
827
|
+
# Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
828
828
|
# @return [String, nil]
|
|
829
829
|
attr_accessor :card_number
|
|
830
|
-
# Access (PIN) code for the [credential](https://
|
|
830
|
+
# Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
831
831
|
# @return [String, nil]
|
|
832
832
|
attr_accessor :code
|
|
833
|
-
# ID of the [connected account](https://
|
|
833
|
+
# ID of the [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) to which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs.
|
|
834
834
|
# @return [String]
|
|
835
835
|
attr_accessor :connected_account_id
|
|
836
|
-
# Display name that corresponds to the [credential](https://
|
|
836
|
+
# Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type.
|
|
837
837
|
# @return [String]
|
|
838
838
|
attr_accessor :display_name
|
|
839
|
-
# Date and time at which the [credential](https://
|
|
839
|
+
# Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
|
|
840
840
|
# @return [String, nil]
|
|
841
841
|
attr_accessor :ends_at
|
|
842
|
-
# Brand-specific terminology for the [credential](https://
|
|
842
|
+
# Brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.
|
|
843
843
|
# @return [String, nil]
|
|
844
844
|
# Known values:
|
|
845
845
|
# - `pti_card`
|
|
@@ -857,43 +857,43 @@ module Seam
|
|
|
857
857
|
# - `kisi_credential`
|
|
858
858
|
# - `akiles_credential`
|
|
859
859
|
attr_accessor :external_type
|
|
860
|
-
# Display name that corresponds to the brand-specific terminology for the [credential](https://
|
|
860
|
+
# Display name that corresponds to the brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type.
|
|
861
861
|
# @return [String, nil]
|
|
862
862
|
attr_accessor :external_type_display_name
|
|
863
|
-
# Indicates whether the [credential](https://
|
|
863
|
+
# Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card.
|
|
864
864
|
# @return [Boolean, nil]
|
|
865
865
|
attr_accessor :is_issued
|
|
866
|
-
# Indicates whether the latest state of the [credential](https://
|
|
866
|
+
# Indicates whether the latest state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been synced from Seam to the provider.
|
|
867
867
|
# @return [Boolean, nil]
|
|
868
868
|
attr_accessor :is_latest_desired_state_synced_with_provider
|
|
869
869
|
# Indicates whether Seam manages the credential.
|
|
870
870
|
# @return [TrueClass]
|
|
871
871
|
attr_accessor :is_managed
|
|
872
|
-
# Indicates whether the [credential](https://
|
|
872
|
+
# Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://www.seam.co/docs/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
|
|
873
873
|
# @return [Boolean, nil]
|
|
874
874
|
attr_accessor :is_multi_phone_sync_credential
|
|
875
|
-
# Indicates whether the [credential](https://
|
|
875
|
+
# Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use.
|
|
876
876
|
# @return [Boolean, nil]
|
|
877
877
|
attr_accessor :is_one_time_use
|
|
878
|
-
# ID of the parent [credential](https://
|
|
878
|
+
# ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
879
879
|
# @return [String, nil]
|
|
880
880
|
attr_accessor :parent_acs_credential_id
|
|
881
|
-
# Date and time at which the [credential](https://
|
|
881
|
+
# Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
|
|
882
882
|
# @return [String, nil]
|
|
883
883
|
attr_accessor :starts_at
|
|
884
|
-
# ID of the [user identity](https://
|
|
884
|
+
# ID of the [user identity](https://www.seam.co/docs/api/user_identities/object) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs.
|
|
885
885
|
# @return [String, nil]
|
|
886
886
|
attr_accessor :user_identity_id
|
|
887
|
-
# ID of the workspace that contains the [credential](https://
|
|
887
|
+
# ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
888
888
|
# @return [String]
|
|
889
889
|
attr_accessor :workspace_id
|
|
890
|
-
# Date and time at which the [credential](https://
|
|
890
|
+
# Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created.
|
|
891
891
|
# @return [Time]
|
|
892
892
|
date_accessor :created_at
|
|
893
|
-
# Date and time at which the [credential](https://
|
|
893
|
+
# Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card.
|
|
894
894
|
# @return [Time, nil]
|
|
895
895
|
date_accessor :issued_at
|
|
896
|
-
# Date and time at which the state of the [credential](https://
|
|
896
|
+
# Date and time at which the state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was most recently synced from Seam to the provider.
|
|
897
897
|
# @return [Time, nil]
|
|
898
898
|
date_accessor :latest_desired_state_synced_with_provider_at
|
|
899
899
|
end
|
|
@@ -1015,13 +1015,13 @@ module Seam
|
|
|
1015
1015
|
date_accessor :created_at
|
|
1016
1016
|
end
|
|
1017
1017
|
|
|
1018
|
-
# Errors associated with the [access method](https://
|
|
1018
|
+
# Errors associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant).
|
|
1019
1019
|
# @return [Array<Errors>]
|
|
1020
1020
|
resource_list_accessor :errors, Errors
|
|
1021
|
-
# Pending mutations for the [access method](https://
|
|
1021
|
+
# Pending mutations for the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). Indicates operations that are in progress.
|
|
1022
1022
|
# @return [Array<PendingMutations>]
|
|
1023
1023
|
resource_list_accessor :pending_mutations, PendingMutations
|
|
1024
|
-
# Warnings associated with the [access method](https://
|
|
1024
|
+
# Warnings associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant).
|
|
1025
1025
|
# @return [Array<Warnings>]
|
|
1026
1026
|
resource_list_accessor :warnings, Warnings
|
|
1027
1027
|
# ID of the access method.
|