seam 2.138.0 → 2.140.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 +69 -66
- data/README.md +12 -0
- data/lib/seam/http_single_workspace.rb +34 -2
- data/lib/seam/http_without_workspace.rb +41 -12
- data/lib/seam/paginator.rb +4 -1
- data/lib/seam/request.rb +5 -1
- data/lib/seam/resources/access_code.rb +74 -0
- data/lib/seam/resources/access_grant.rb +60 -0
- data/lib/seam/resources/access_method.rb +39 -0
- data/lib/seam/resources/acs_access_group.rb +45 -0
- data/lib/seam/resources/acs_credential.rb +67 -0
- data/lib/seam/resources/acs_encoder.rb +11 -0
- data/lib/seam/resources/acs_entrance.rb +95 -0
- data/lib/seam/resources/acs_system.rb +36 -0
- data/lib/seam/resources/acs_user.rb +66 -0
- data/lib/seam/resources/action_attempt.rb +192 -0
- data/lib/seam/resources/batch.rb +24 -0
- data/lib/seam/resources/client_session.rb +12 -0
- data/lib/seam/resources/connect_webview.rb +19 -0
- data/lib/seam/resources/connected_account.rb +50 -0
- data/lib/seam/resources/customer_portal.rb +5 -0
- data/lib/seam/resources/device.rb +622 -4
- data/lib/seam/resources/device_provider.rb +24 -0
- data/lib/seam/resources/event.rb +142 -3
- data/lib/seam/resources/instant_key.rb +13 -0
- data/lib/seam/resources/noise_threshold.rb +7 -0
- data/lib/seam/resources/pagination.rb +3 -0
- data/lib/seam/resources/phone.rb +29 -0
- data/lib/seam/resources/space.rb +19 -0
- data/lib/seam/resources/thermostat_daily_program.rb +9 -0
- data/lib/seam/resources/thermostat_schedule.rb +15 -0
- data/lib/seam/resources/unmanaged_access_code.rb +51 -0
- data/lib/seam/resources/unmanaged_access_grant.rb +56 -0
- data/lib/seam/resources/unmanaged_access_method.rb +36 -0
- data/lib/seam/resources/unmanaged_device.rb +80 -0
- data/lib/seam/resources/unmanaged_user_identity.rb +20 -0
- data/lib/seam/resources/user_identity.rb +21 -0
- data/lib/seam/resources/webhook.rb +4 -0
- data/lib/seam/resources/workspace.rb +15 -0
- data/lib/seam/routes/access_codes.rb +79 -79
- data/lib/seam/routes/access_codes_simulate.rb +3 -3
- data/lib/seam/routes/access_codes_unmanaged.rb +27 -23
- data/lib/seam/routes/access_grants.rb +57 -45
- data/lib/seam/routes/access_grants_unmanaged.rb +13 -13
- data/lib/seam/routes/access_methods.rb +32 -24
- data/lib/seam/routes/access_methods_unmanaged.rb +7 -7
- data/lib/seam/routes/acs_access_groups.rb +21 -21
- data/lib/seam/routes/acs_credentials.rb +40 -40
- data/lib/seam/routes/acs_encoders.rb +16 -16
- data/lib/seam/routes/acs_encoders_simulate.rb +11 -11
- data/lib/seam/routes/acs_entrances.rb +20 -20
- data/lib/seam/routes/acs_systems.rb +11 -11
- data/lib/seam/routes/acs_users.rb +83 -55
- data/lib/seam/routes/action_attempts.rb +6 -6
- data/lib/seam/routes/client_sessions.rb +38 -34
- data/lib/seam/routes/connect_webviews.rb +20 -20
- data/lib/seam/routes/connected_accounts.rb +24 -20
- data/lib/seam/routes/connected_accounts_simulate.rb +1 -1
- data/lib/seam/routes/customers.rb +50 -50
- data/lib/seam/routes/devices.rb +33 -29
- data/lib/seam/routes/devices_simulate.rb +7 -7
- data/lib/seam/routes/devices_unmanaged.rb +25 -26
- data/lib/seam/routes/events.rb +40 -32
- data/lib/seam/routes/instant_keys.rb +11 -7
- data/lib/seam/routes/locks.rb +20 -27
- data/lib/seam/routes/locks_simulate.rb +3 -3
- data/lib/seam/routes/noise_sensors.rb +8 -19
- data/lib/seam/routes/noise_sensors_noise_thresholds.rb +21 -21
- data/lib/seam/routes/noise_sensors_simulate.rb +1 -1
- data/lib/seam/routes/phones.rb +7 -7
- data/lib/seam/routes/phones_simulate.rb +4 -4
- data/lib/seam/routes/spaces.rb +53 -45
- data/lib/seam/routes/thermostats.rb +75 -86
- data/lib/seam/routes/thermostats_daily_programs.rb +9 -9
- data/lib/seam/routes/thermostats_schedules.rb +22 -22
- data/lib/seam/routes/thermostats_simulate.rb +9 -9
- data/lib/seam/routes/user_identities.rb +50 -46
- data/lib/seam/routes/user_identities_unmanaged.rb +11 -11
- data/lib/seam/routes/webhooks.rb +10 -10
- data/lib/seam/routes/workspaces.rb +19 -19
- data/lib/seam/version.rb +1 -1
- metadata +8 -11
|
@@ -6,128 +6,188 @@ module Seam
|
|
|
6
6
|
class AccessGrant < BaseResource
|
|
7
7
|
class Errors < BaseResource
|
|
8
8
|
# Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
9
|
+
# @return [String]
|
|
9
10
|
attr_accessor :error_code
|
|
10
11
|
# Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
12
|
+
# @return [String]
|
|
11
13
|
attr_accessor :message
|
|
12
14
|
# IDs of the devices that did not receive an access code at grant creation. Use these to identify which specific devices failed when the message reports a partial failure.
|
|
15
|
+
# @return [Array<String>]
|
|
13
16
|
attr_accessor :missing_device_ids
|
|
14
17
|
# Date and time at which Seam created the error.
|
|
18
|
+
# @return [Time]
|
|
15
19
|
date_accessor :created_at
|
|
16
20
|
end
|
|
17
21
|
|
|
18
22
|
class PendingMutations < BaseResource
|
|
19
23
|
class From < BaseResource
|
|
20
24
|
# Previous device IDs where access codes existed.
|
|
25
|
+
# @return [Array<String>]
|
|
21
26
|
attr_accessor :device_ids
|
|
22
27
|
# Previous end time for access.
|
|
28
|
+
# @return [Time, nil]
|
|
23
29
|
date_accessor :ends_at
|
|
24
30
|
# Previous start time for access.
|
|
31
|
+
# @return [Time, nil]
|
|
25
32
|
date_accessor :starts_at
|
|
26
33
|
end
|
|
27
34
|
|
|
28
35
|
class To < BaseResource
|
|
29
36
|
# Common code key to ensure PIN code reuse across devices.
|
|
37
|
+
# @return [String, nil]
|
|
30
38
|
attr_accessor :common_code_key
|
|
31
39
|
# New device IDs where access codes should be created.
|
|
40
|
+
# @return [Array<String>]
|
|
32
41
|
attr_accessor :device_ids
|
|
33
42
|
# New end time for access.
|
|
43
|
+
# @return [Time, nil]
|
|
34
44
|
date_accessor :ends_at
|
|
35
45
|
# New start time for access.
|
|
46
|
+
# @return [Time, nil]
|
|
36
47
|
date_accessor :starts_at
|
|
37
48
|
end
|
|
38
49
|
|
|
50
|
+
# @return [From]
|
|
39
51
|
resource_accessor :from, From
|
|
52
|
+
# @return [To]
|
|
40
53
|
resource_accessor :to, To
|
|
41
54
|
# IDs of the access methods being updated.
|
|
55
|
+
# @return [Array<String>]
|
|
42
56
|
attr_accessor :access_method_ids
|
|
43
57
|
# Detailed description of the mutation.
|
|
58
|
+
# @return [String]
|
|
44
59
|
attr_accessor :message
|
|
60
|
+
# @return [String]
|
|
45
61
|
attr_accessor :mutation_code
|
|
46
62
|
# Date and time at which the mutation was created.
|
|
63
|
+
# @return [Time]
|
|
47
64
|
date_accessor :created_at
|
|
48
65
|
end
|
|
49
66
|
|
|
50
67
|
class RequestedAccessMethods < BaseResource
|
|
51
68
|
# Specific PIN code to use for this access method. Only applicable when mode is 'code'.
|
|
69
|
+
# @return [String, nil]
|
|
52
70
|
attr_accessor :code
|
|
53
71
|
# IDs of the access methods created for the requested access method.
|
|
72
|
+
# @return [Array<String>]
|
|
54
73
|
attr_accessor :created_access_method_ids
|
|
55
74
|
# Display name of the access method.
|
|
75
|
+
# @return [String]
|
|
56
76
|
attr_accessor :display_name
|
|
57
77
|
# Maximum number of times the instant key can be used. Only applicable when mode is 'mobile_key'. Defaults to 1 if not specified.
|
|
78
|
+
# @return [Integer, nil]
|
|
58
79
|
attr_accessor :instant_key_max_use_count
|
|
59
80
|
# Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.
|
|
81
|
+
# @return [String]
|
|
60
82
|
attr_accessor :mode
|
|
61
83
|
# Date and time at which the requested access method was added to the Access Grant.
|
|
84
|
+
# @return [Time]
|
|
62
85
|
date_accessor :created_at
|
|
63
86
|
end
|
|
64
87
|
|
|
65
88
|
class Warnings < BaseResource
|
|
66
89
|
class FailedDevices < BaseResource
|
|
67
90
|
# Device whose access code could not be revoked.
|
|
91
|
+
# @return [String]
|
|
68
92
|
attr_accessor :device_id
|
|
69
93
|
# Reason the access code could not be revoked (e.g. `offline_access_code_not_revocable`).
|
|
94
|
+
# @return [String]
|
|
70
95
|
attr_accessor :error_code
|
|
71
96
|
# Human-readable description of why revocation failed.
|
|
97
|
+
# @return [String]
|
|
72
98
|
attr_accessor :message
|
|
73
99
|
end
|
|
74
100
|
|
|
101
|
+
# Devices whose access codes could not be revoked during reconciliation. Present when the provider does not support revoking an offline access code (e.g. Dormakaba oracode with exhausted override budget).
|
|
102
|
+
# @return [Array<FailedDevices>]
|
|
75
103
|
resource_list_accessor :failed_devices, FailedDevices
|
|
76
104
|
# IDs of the access methods being updated.
|
|
105
|
+
# @return [Array<String>]
|
|
77
106
|
attr_accessor :access_method_ids
|
|
107
|
+
# @return [String]
|
|
78
108
|
attr_accessor :device_id
|
|
79
109
|
# Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
110
|
+
# @return [String]
|
|
80
111
|
attr_accessor :message
|
|
81
112
|
# The new PIN code that was assigned instead.
|
|
113
|
+
# @return [String]
|
|
82
114
|
attr_accessor :new_code
|
|
83
115
|
# The originally requested PIN code that was unavailable.
|
|
116
|
+
# @return [String]
|
|
84
117
|
attr_accessor :original_code
|
|
85
118
|
# Specific reason why the grant's times are not programmable on the device.
|
|
119
|
+
# @return [String]
|
|
86
120
|
attr_accessor :reason
|
|
87
121
|
# Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
122
|
+
# @return [String]
|
|
88
123
|
attr_accessor :warning_code
|
|
89
124
|
# Date and time at which Seam created the warning.
|
|
125
|
+
# @return [Time]
|
|
90
126
|
date_accessor :created_at
|
|
91
127
|
end
|
|
92
128
|
|
|
129
|
+
# Errors associated with the [access grant](https://docs.seam.co/use-cases/granting-access).
|
|
130
|
+
# @return [Array<Errors>]
|
|
93
131
|
resource_list_accessor :errors, Errors
|
|
132
|
+
# List of pending mutations for the access grant. This shows updates that are in progress.
|
|
133
|
+
# @return [Array<PendingMutations>]
|
|
94
134
|
resource_list_accessor :pending_mutations, PendingMutations
|
|
135
|
+
# Access methods that the user requested for the Access Grant.
|
|
136
|
+
# @return [Array<RequestedAccessMethods>]
|
|
95
137
|
resource_list_accessor :requested_access_methods, RequestedAccessMethods
|
|
138
|
+
# Warnings associated with the [access grant](https://docs.seam.co/use-cases/granting-access).
|
|
139
|
+
# @return [Array<Warnings>]
|
|
96
140
|
resource_list_accessor :warnings, Warnings
|
|
97
141
|
# ID of the Access Grant.
|
|
142
|
+
# @return [String]
|
|
98
143
|
attr_accessor :access_grant_id
|
|
99
144
|
# Unique key for the access grant within the workspace.
|
|
145
|
+
# @return [String, nil]
|
|
100
146
|
attr_accessor :access_grant_key
|
|
101
147
|
# IDs of the access methods created for the Access Grant.
|
|
148
|
+
# @return [Array<String>]
|
|
102
149
|
attr_accessor :access_method_ids
|
|
103
150
|
# Client Session Token. Only returned if the Access Grant has a mobile_key access method.
|
|
151
|
+
# @return [String, nil]
|
|
104
152
|
attr_accessor :client_session_token
|
|
105
153
|
# ID of the customization profile associated with the Access Grant.
|
|
154
|
+
# @return [String, nil]
|
|
106
155
|
attr_accessor :customization_profile_id
|
|
107
156
|
# Display name of the Access Grant.
|
|
157
|
+
# @return [String]
|
|
108
158
|
attr_accessor :display_name
|
|
109
159
|
# Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method.
|
|
160
|
+
# @return [String, nil]
|
|
110
161
|
attr_accessor :instant_key_url
|
|
162
|
+
# @return [Array<String>]
|
|
111
163
|
# @deprecated Use `space_ids`.
|
|
112
164
|
attr_accessor :location_ids
|
|
113
165
|
# Name of the Access Grant. If not provided, the display name will be computed.
|
|
166
|
+
# @return [String, nil]
|
|
114
167
|
attr_accessor :name
|
|
115
168
|
# Reservation key for the access grant.
|
|
169
|
+
# @return [String, nil]
|
|
116
170
|
attr_accessor :reservation_key
|
|
117
171
|
# IDs of the spaces to which the Access Grant gives access.
|
|
172
|
+
# @return [Array<String>]
|
|
118
173
|
attr_accessor :space_ids
|
|
119
174
|
# ID of user identity to which the Access Grant gives access.
|
|
175
|
+
# @return [String]
|
|
120
176
|
attr_accessor :user_identity_id
|
|
121
177
|
# ID of the Seam workspace associated with the Access Grant.
|
|
178
|
+
# @return [String]
|
|
122
179
|
attr_accessor :workspace_id
|
|
123
180
|
|
|
124
181
|
# Date and time at which the Access Grant was created.
|
|
182
|
+
# @return [Time]
|
|
125
183
|
date_accessor :created_at
|
|
126
184
|
|
|
127
185
|
# Date and time at which the Access Grant ends.
|
|
186
|
+
# @return [Time, nil]
|
|
128
187
|
date_accessor :ends_at
|
|
129
188
|
|
|
130
189
|
# Date and time at which the Access Grant starts.
|
|
190
|
+
# @return [Time]
|
|
131
191
|
date_accessor :starts_at
|
|
132
192
|
end
|
|
133
193
|
end
|
|
@@ -6,84 +6,123 @@ module Seam
|
|
|
6
6
|
class AccessMethod < BaseResource
|
|
7
7
|
class Errors < BaseResource
|
|
8
8
|
# Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
9
|
+
# @return [String]
|
|
9
10
|
attr_accessor :error_code
|
|
10
11
|
# Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
12
|
+
# @return [String]
|
|
11
13
|
attr_accessor :message
|
|
12
14
|
# Date and time at which Seam created the error.
|
|
15
|
+
# @return [Time]
|
|
13
16
|
date_accessor :created_at
|
|
14
17
|
end
|
|
15
18
|
|
|
16
19
|
class PendingMutations < BaseResource
|
|
17
20
|
class From < BaseResource
|
|
21
|
+
# @return [Array<String>]
|
|
18
22
|
attr_accessor :device_ids
|
|
19
23
|
# Previous end time for access.
|
|
24
|
+
# @return [Time, nil]
|
|
20
25
|
date_accessor :ends_at
|
|
21
26
|
# Previous start time for access.
|
|
27
|
+
# @return [Time, nil]
|
|
22
28
|
date_accessor :starts_at
|
|
23
29
|
end
|
|
24
30
|
|
|
25
31
|
class To < BaseResource
|
|
32
|
+
# @return [Array<String>]
|
|
26
33
|
attr_accessor :device_ids
|
|
27
34
|
# New end time for access.
|
|
35
|
+
# @return [Time, nil]
|
|
28
36
|
date_accessor :ends_at
|
|
29
37
|
# New start time for access.
|
|
38
|
+
# @return [Time, nil]
|
|
30
39
|
date_accessor :starts_at
|
|
31
40
|
end
|
|
32
41
|
|
|
42
|
+
# @return [From]
|
|
33
43
|
resource_accessor :from, From
|
|
44
|
+
# @return [To]
|
|
34
45
|
resource_accessor :to, To
|
|
35
46
|
# Detailed description of the mutation.
|
|
47
|
+
# @return [String]
|
|
36
48
|
attr_accessor :message
|
|
49
|
+
# @return [String]
|
|
37
50
|
attr_accessor :mutation_code
|
|
38
51
|
# Date and time at which the mutation was created.
|
|
52
|
+
# @return [Time]
|
|
39
53
|
date_accessor :created_at
|
|
40
54
|
end
|
|
41
55
|
|
|
42
56
|
class Warnings < BaseResource
|
|
43
57
|
# Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
58
|
+
# @return [String]
|
|
44
59
|
attr_accessor :message
|
|
45
60
|
# ID of the original access method from which this backup access method was split, if applicable.
|
|
61
|
+
# @return [String, nil]
|
|
46
62
|
attr_accessor :original_access_method_id
|
|
47
63
|
# Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
64
|
+
# @return [String]
|
|
48
65
|
attr_accessor :warning_code
|
|
49
66
|
# Date and time at which Seam created the warning.
|
|
67
|
+
# @return [Time]
|
|
50
68
|
date_accessor :created_at
|
|
51
69
|
end
|
|
52
70
|
|
|
71
|
+
# Errors associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).
|
|
72
|
+
# @return [Array<Errors>]
|
|
53
73
|
resource_list_accessor :errors, Errors
|
|
74
|
+
# Pending mutations for the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant). Indicates operations that are in progress.
|
|
75
|
+
# @return [Array<PendingMutations>]
|
|
54
76
|
resource_list_accessor :pending_mutations, PendingMutations
|
|
77
|
+
# Warnings associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).
|
|
78
|
+
# @return [Array<Warnings>]
|
|
55
79
|
resource_list_accessor :warnings, Warnings
|
|
56
80
|
# ID of the access method.
|
|
81
|
+
# @return [String]
|
|
57
82
|
attr_accessor :access_method_id
|
|
58
83
|
# Token of the client session associated with the access method.
|
|
84
|
+
# @return [String, nil]
|
|
59
85
|
attr_accessor :client_session_token
|
|
60
86
|
# The actual PIN code for code access methods.
|
|
87
|
+
# @return [String, nil]
|
|
61
88
|
attr_accessor :code
|
|
62
89
|
# ID of the customization profile associated with the access method.
|
|
90
|
+
# @return [String, nil]
|
|
63
91
|
attr_accessor :customization_profile_id
|
|
64
92
|
# Display name of the access method.
|
|
93
|
+
# @return [String]
|
|
65
94
|
attr_accessor :display_name
|
|
66
95
|
# URL of the Instant Key for mobile key access methods.
|
|
96
|
+
# @return [String, nil]
|
|
67
97
|
attr_accessor :instant_key_url
|
|
68
98
|
# Indicates whether an existing card credential must be assigned to this access method before it can be issued. Only applies to card-mode access methods on systems that support credential assignment.
|
|
99
|
+
# @return [Boolean, nil]
|
|
69
100
|
attr_accessor :is_assignment_required
|
|
70
101
|
# Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method.
|
|
102
|
+
# @return [Boolean, nil]
|
|
71
103
|
attr_accessor :is_encoding_required
|
|
72
104
|
# Indicates whether the access method has been issued.
|
|
105
|
+
# @return [Boolean]
|
|
73
106
|
attr_accessor :is_issued
|
|
74
107
|
# Indicates whether the access method is ready for card assignment. This is true when the access method is in card mode, has not yet been issued, and the system supports credential assignment.
|
|
108
|
+
# @return [Boolean, nil]
|
|
75
109
|
attr_accessor :is_ready_for_assignment
|
|
76
110
|
# Indicates whether the access method is ready to be encoded. This is true when the credential has been created and the card has not yet been issued.
|
|
111
|
+
# @return [Boolean, nil]
|
|
77
112
|
attr_accessor :is_ready_for_encoding
|
|
78
113
|
# Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.
|
|
114
|
+
# @return [String]
|
|
79
115
|
attr_accessor :mode
|
|
80
116
|
# ID of the Seam workspace associated with the access method.
|
|
117
|
+
# @return [String]
|
|
81
118
|
attr_accessor :workspace_id
|
|
82
119
|
|
|
83
120
|
# Date and time at which the access method was created.
|
|
121
|
+
# @return [Time]
|
|
84
122
|
date_accessor :created_at
|
|
85
123
|
|
|
86
124
|
# Date and time at which the access method was issued.
|
|
125
|
+
# @return [Time, nil]
|
|
87
126
|
date_accessor :issued_at
|
|
88
127
|
end
|
|
89
128
|
end
|
|
@@ -10,97 +10,142 @@ module Seam
|
|
|
10
10
|
class AcsAccessGroup < BaseResource
|
|
11
11
|
class AccessSchedule < BaseResource
|
|
12
12
|
# Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
|
|
13
|
+
# @return [Time, nil]
|
|
13
14
|
date_accessor :ends_at
|
|
14
15
|
# Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
|
|
16
|
+
# @return [Time]
|
|
15
17
|
date_accessor :starts_at
|
|
16
18
|
end
|
|
17
19
|
|
|
18
20
|
class Errors < BaseResource
|
|
19
21
|
# Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
22
|
+
# @return [String]
|
|
20
23
|
attr_accessor :error_code
|
|
21
24
|
# Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
25
|
+
# @return [String]
|
|
22
26
|
attr_accessor :message
|
|
23
27
|
# Date and time at which Seam created the error.
|
|
28
|
+
# @return [Time]
|
|
24
29
|
date_accessor :created_at
|
|
25
30
|
end
|
|
26
31
|
|
|
27
32
|
class PendingMutations < BaseResource
|
|
28
33
|
class From < BaseResource
|
|
29
34
|
# Old entrance ID.
|
|
35
|
+
# @return [String, nil]
|
|
30
36
|
attr_accessor :acs_entrance_id
|
|
31
37
|
# Old user ID.
|
|
38
|
+
# @return [String, nil]
|
|
32
39
|
attr_accessor :acs_user_id
|
|
33
40
|
# Name of the access group.
|
|
41
|
+
# @return [String, nil]
|
|
34
42
|
attr_accessor :name
|
|
35
43
|
# Ending time for the access schedule.
|
|
44
|
+
# @return [Time, nil]
|
|
36
45
|
date_accessor :ends_at
|
|
37
46
|
# Starting time for the access schedule.
|
|
47
|
+
# @return [Time, nil]
|
|
38
48
|
date_accessor :starts_at
|
|
39
49
|
end
|
|
40
50
|
|
|
41
51
|
class To < BaseResource
|
|
42
52
|
# New entrance ID.
|
|
53
|
+
# @return [String, nil]
|
|
43
54
|
attr_accessor :acs_entrance_id
|
|
44
55
|
# New user ID.
|
|
56
|
+
# @return [String, nil]
|
|
45
57
|
attr_accessor :acs_user_id
|
|
46
58
|
# Name of the access group.
|
|
59
|
+
# @return [String, nil]
|
|
47
60
|
attr_accessor :name
|
|
48
61
|
# Ending time for the access schedule.
|
|
62
|
+
# @return [Time, nil]
|
|
49
63
|
date_accessor :ends_at
|
|
50
64
|
# Starting time for the access schedule.
|
|
65
|
+
# @return [Time, nil]
|
|
51
66
|
date_accessor :starts_at
|
|
52
67
|
end
|
|
53
68
|
|
|
69
|
+
# @return [From]
|
|
54
70
|
resource_accessor :from, From
|
|
71
|
+
# @return [To]
|
|
55
72
|
resource_accessor :to, To
|
|
56
73
|
# ID of the user involved in the scheduled change.
|
|
74
|
+
# @return [String]
|
|
57
75
|
attr_accessor :acs_user_id
|
|
58
76
|
# Detailed description of the mutation.
|
|
77
|
+
# @return [String]
|
|
59
78
|
attr_accessor :message
|
|
79
|
+
# @return [String]
|
|
60
80
|
attr_accessor :mutation_code
|
|
61
81
|
# Whether the user is scheduled to be added to or removed from this access group.
|
|
82
|
+
# @return [String]
|
|
62
83
|
attr_accessor :variant
|
|
63
84
|
# Date and time at which the mutation was created.
|
|
85
|
+
# @return [Time]
|
|
64
86
|
date_accessor :created_at
|
|
65
87
|
end
|
|
66
88
|
|
|
67
89
|
class Warnings < BaseResource
|
|
68
90
|
# Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
91
|
+
# @return [String]
|
|
69
92
|
attr_accessor :message
|
|
70
93
|
# Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
94
|
+
# @return [String]
|
|
71
95
|
attr_accessor :warning_code
|
|
72
96
|
# Date and time at which Seam created the warning.
|
|
97
|
+
# @return [Time]
|
|
73
98
|
date_accessor :created_at
|
|
74
99
|
end
|
|
75
100
|
|
|
101
|
+
# `starts_at` and `ends_at` timestamps for the access group's access.
|
|
102
|
+
# @return [AccessSchedule, nil]
|
|
76
103
|
resource_accessor :access_schedule, AccessSchedule
|
|
104
|
+
# Errors associated with the `acs_access_group`.
|
|
105
|
+
# @return [Array<Errors>]
|
|
77
106
|
resource_list_accessor :errors, Errors
|
|
107
|
+
# Collection of pending mutations for the access group. Represents operations that have been requested but not yet completed on the integrated access system.
|
|
108
|
+
# @return [Array<PendingMutations>]
|
|
78
109
|
resource_list_accessor :pending_mutations, PendingMutations
|
|
110
|
+
# Warnings associated with the `acs_access_group`.
|
|
111
|
+
# @return [Array<Warnings>]
|
|
79
112
|
resource_list_accessor :warnings, Warnings
|
|
113
|
+
# @return [String]
|
|
80
114
|
# @deprecated Use `external_type`.
|
|
81
115
|
attr_accessor :access_group_type
|
|
116
|
+
# @return [String]
|
|
82
117
|
# @deprecated Use `external_type_display_name`.
|
|
83
118
|
attr_accessor :access_group_type_display_name
|
|
84
119
|
# ID of the access group.
|
|
120
|
+
# @return [String]
|
|
85
121
|
attr_accessor :acs_access_group_id
|
|
86
122
|
# ID of the access control system that contains the access group.
|
|
123
|
+
# @return [String]
|
|
87
124
|
attr_accessor :acs_system_id
|
|
88
125
|
# ID of the connected account that contains the access group.
|
|
126
|
+
# @return [String]
|
|
89
127
|
attr_accessor :connected_account_id
|
|
90
128
|
# Display name for the access group.
|
|
129
|
+
# @return [String]
|
|
91
130
|
attr_accessor :display_name
|
|
92
131
|
# Brand-specific terminology for the access group type.
|
|
132
|
+
# @return [String]
|
|
93
133
|
attr_accessor :external_type
|
|
94
134
|
# Display name that corresponds to the brand-specific terminology for the access group type.
|
|
135
|
+
# @return [String]
|
|
95
136
|
attr_accessor :external_type_display_name
|
|
96
137
|
# Indicates whether Seam manages the access group.
|
|
138
|
+
# @return [Boolean]
|
|
97
139
|
attr_accessor :is_managed
|
|
98
140
|
# Name of the access group.
|
|
141
|
+
# @return [String]
|
|
99
142
|
attr_accessor :name
|
|
100
143
|
# ID of the workspace that contains the access group.
|
|
144
|
+
# @return [String]
|
|
101
145
|
attr_accessor :workspace_id
|
|
102
146
|
|
|
103
147
|
# Date and time at which the access group was created.
|
|
148
|
+
# @return [Time]
|
|
104
149
|
date_accessor :created_at
|
|
105
150
|
end
|
|
106
151
|
end
|
|
@@ -10,110 +10,177 @@ module Seam
|
|
|
10
10
|
#
|
|
11
11
|
# For granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach. Use the lower-level ACS credential API directly only when you specifically need to manage individual credentials.
|
|
12
12
|
class AcsCredential < BaseResource
|
|
13
|
+
class AkilesMetadata < BaseResource
|
|
14
|
+
# ID of the Akiles member PIN.
|
|
15
|
+
# @return [String, nil]
|
|
16
|
+
attr_accessor :member_pin_id
|
|
17
|
+
end
|
|
18
|
+
|
|
13
19
|
class AssaAbloyVostioMetadata < BaseResource
|
|
14
20
|
# Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors.
|
|
21
|
+
# @return [Boolean, nil]
|
|
15
22
|
attr_accessor :auto_join
|
|
16
23
|
# Names of the doors to which to grant access in the Vostio access system.
|
|
24
|
+
# @return [Array<String>]
|
|
17
25
|
attr_accessor :door_names
|
|
18
26
|
# Endpoint ID in the Vostio access system.
|
|
27
|
+
# @return [String, nil]
|
|
19
28
|
attr_accessor :endpoint_id
|
|
20
29
|
# Key ID in the Vostio access system.
|
|
30
|
+
# @return [String, nil]
|
|
21
31
|
attr_accessor :key_id
|
|
22
32
|
# Key issuing request ID in the Vostio access system.
|
|
33
|
+
# @return [String, nil]
|
|
23
34
|
attr_accessor :key_issuing_request_id
|
|
24
35
|
# IDs of the guest entrances to override in the Vostio access system.
|
|
36
|
+
# @return [Array<String>]
|
|
25
37
|
attr_accessor :override_guest_acs_entrance_ids
|
|
26
38
|
end
|
|
27
39
|
|
|
28
40
|
class Errors < BaseResource
|
|
41
|
+
# @return [String]
|
|
29
42
|
attr_accessor :error_code
|
|
43
|
+
# @return [String]
|
|
30
44
|
attr_accessor :message
|
|
31
45
|
# Date and time at which Seam created the error.
|
|
46
|
+
# @return [Time]
|
|
32
47
|
date_accessor :created_at
|
|
33
48
|
end
|
|
34
49
|
|
|
35
50
|
class VisionlineMetadata < BaseResource
|
|
36
51
|
# Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors.
|
|
52
|
+
# @return [Boolean, nil]
|
|
37
53
|
attr_accessor :auto_join
|
|
38
54
|
# Card function type in the Visionline access system.
|
|
55
|
+
# @return [String, nil]
|
|
39
56
|
attr_accessor :card_function_type
|
|
40
57
|
# ID of the card in the Visionline access system.
|
|
58
|
+
# @return [String, nil]
|
|
41
59
|
attr_accessor :card_id
|
|
42
60
|
# Common entrance IDs in the Visionline access system.
|
|
61
|
+
# @return [Array<String>]
|
|
43
62
|
attr_accessor :common_acs_entrance_ids
|
|
44
63
|
# ID of the credential in the Visionline access system.
|
|
64
|
+
# @return [String, nil]
|
|
45
65
|
attr_accessor :credential_id
|
|
46
66
|
# Guest entrance IDs in the Visionline access system.
|
|
67
|
+
# @return [Array<String>]
|
|
47
68
|
attr_accessor :guest_acs_entrance_ids
|
|
48
69
|
# Indicates whether the credential is valid.
|
|
70
|
+
# @return [Boolean, nil]
|
|
49
71
|
attr_accessor :is_valid
|
|
50
72
|
# IDs of the credentials to which you want to join.
|
|
73
|
+
# @return [Array<String>]
|
|
51
74
|
attr_accessor :joiner_acs_credential_ids
|
|
52
75
|
end
|
|
53
76
|
|
|
54
77
|
class Warnings < BaseResource
|
|
55
78
|
# Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
79
|
+
# @return [String]
|
|
56
80
|
attr_accessor :message
|
|
81
|
+
# The PIN code that was assigned instead.
|
|
82
|
+
# @return [String]
|
|
83
|
+
attr_accessor :new_code
|
|
84
|
+
# The originally requested PIN code that could not be used.
|
|
85
|
+
# @return [String]
|
|
86
|
+
attr_accessor :original_code
|
|
57
87
|
# Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
88
|
+
# @return [String]
|
|
58
89
|
attr_accessor :warning_code
|
|
59
90
|
# Date and time at which Seam created the warning.
|
|
91
|
+
# @return [Time]
|
|
60
92
|
date_accessor :created_at
|
|
61
93
|
end
|
|
62
94
|
|
|
95
|
+
# Akiles-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
|
|
96
|
+
# @return [AkilesMetadata, nil]
|
|
97
|
+
resource_accessor :akiles_metadata, AkilesMetadata
|
|
98
|
+
# Vostio-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
|
|
99
|
+
# @return [AssaAbloyVostioMetadata, nil]
|
|
63
100
|
resource_accessor :assa_abloy_vostio_metadata, AssaAbloyVostioMetadata
|
|
101
|
+
# Visionline-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
|
|
102
|
+
# @return [VisionlineMetadata, nil]
|
|
64
103
|
resource_accessor :visionline_metadata, VisionlineMetadata
|
|
104
|
+
# Errors associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
|
|
105
|
+
# @return [Array<Errors>]
|
|
65
106
|
resource_list_accessor :errors, Errors
|
|
107
|
+
# Warnings associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
|
|
108
|
+
# @return [Array<Warnings>]
|
|
66
109
|
resource_list_accessor :warnings, Warnings
|
|
67
110
|
# Access method for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.
|
|
111
|
+
# @return [String]
|
|
68
112
|
attr_accessor :access_method
|
|
69
113
|
# ID of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
|
|
114
|
+
# @return [String]
|
|
70
115
|
attr_accessor :acs_credential_id
|
|
71
116
|
# ID of the credential pool to which the credential belongs.
|
|
117
|
+
# @return [String, nil]
|
|
72
118
|
attr_accessor :acs_credential_pool_id
|
|
73
119
|
# ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
|
|
120
|
+
# @return [String]
|
|
74
121
|
attr_accessor :acs_system_id
|
|
75
122
|
# ID of the [ACS user](https://docs.seam.co/low-level-apis/access-systems/user-management) to whom the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs.
|
|
123
|
+
# @return [String, nil]
|
|
76
124
|
attr_accessor :acs_user_id
|
|
77
125
|
# Number of the card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
|
|
126
|
+
# @return [String, nil]
|
|
78
127
|
attr_accessor :card_number
|
|
79
128
|
# Access (PIN) code for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
|
|
129
|
+
# @return [String, nil]
|
|
80
130
|
attr_accessor :code
|
|
81
131
|
# ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs.
|
|
132
|
+
# @return [String]
|
|
82
133
|
attr_accessor :connected_account_id
|
|
83
134
|
# Display name that corresponds to the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) type.
|
|
135
|
+
# @return [String]
|
|
84
136
|
attr_accessor :display_name
|
|
85
137
|
# Date and time at which the [credential](https://docs.seam.co/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`.
|
|
138
|
+
# @return [String, nil]
|
|
86
139
|
attr_accessor :ends_at
|
|
87
140
|
# Brand-specific terminology for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.
|
|
141
|
+
# @return [String, nil]
|
|
88
142
|
attr_accessor :external_type
|
|
89
143
|
# Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) type.
|
|
144
|
+
# @return [String, nil]
|
|
90
145
|
attr_accessor :external_type_display_name
|
|
91
146
|
# Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) has been encoded onto a card.
|
|
147
|
+
# @return [Boolean, nil]
|
|
92
148
|
attr_accessor :is_issued
|
|
93
149
|
# Indicates whether the latest state of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) has been synced from Seam to the provider.
|
|
150
|
+
# @return [Boolean, nil]
|
|
94
151
|
attr_accessor :is_latest_desired_state_synced_with_provider
|
|
95
152
|
# Indicates whether Seam manages the credential.
|
|
153
|
+
# @return [Boolean]
|
|
96
154
|
attr_accessor :is_managed
|
|
97
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
|
+
# @return [Boolean, nil]
|
|
98
157
|
attr_accessor :is_multi_phone_sync_credential
|
|
99
158
|
# Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use.
|
|
159
|
+
# @return [Boolean, nil]
|
|
100
160
|
attr_accessor :is_one_time_use
|
|
101
161
|
# ID of the parent [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
|
|
162
|
+
# @return [String, nil]
|
|
102
163
|
attr_accessor :parent_acs_credential_id
|
|
103
164
|
# Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
|
|
165
|
+
# @return [String, nil]
|
|
104
166
|
attr_accessor :starts_at
|
|
105
167
|
# ID of the [user identity](https://docs.seam.co/api/user_identities) to whom the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs.
|
|
168
|
+
# @return [String, nil]
|
|
106
169
|
attr_accessor :user_identity_id
|
|
107
170
|
# ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
|
|
171
|
+
# @return [String]
|
|
108
172
|
attr_accessor :workspace_id
|
|
109
173
|
|
|
110
174
|
# Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created.
|
|
175
|
+
# @return [Time]
|
|
111
176
|
date_accessor :created_at
|
|
112
177
|
|
|
113
178
|
# Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was encoded onto a card.
|
|
179
|
+
# @return [Time, nil]
|
|
114
180
|
date_accessor :issued_at
|
|
115
181
|
|
|
116
182
|
# Date and time at which the state of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was most recently synced from Seam to the provider.
|
|
183
|
+
# @return [Time, nil]
|
|
117
184
|
date_accessor :latest_desired_state_synced_with_provider_at
|
|
118
185
|
end
|
|
119
186
|
end
|
|
@@ -19,26 +19,37 @@ module Seam
|
|
|
19
19
|
class AcsEncoder < BaseResource
|
|
20
20
|
class Errors < BaseResource
|
|
21
21
|
# Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
22
|
+
# @return [String]
|
|
22
23
|
attr_accessor :error_code
|
|
23
24
|
# Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
25
|
+
# @return [String]
|
|
24
26
|
attr_accessor :message
|
|
25
27
|
# Date and time at which Seam created the error.
|
|
28
|
+
# @return [Time]
|
|
26
29
|
date_accessor :created_at
|
|
27
30
|
end
|
|
28
31
|
|
|
32
|
+
# Errors associated with the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
|
|
33
|
+
# @return [Array<Errors>]
|
|
29
34
|
resource_list_accessor :errors, Errors
|
|
30
35
|
# ID of the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
|
|
36
|
+
# @return [String]
|
|
31
37
|
attr_accessor :acs_encoder_id
|
|
32
38
|
# ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
|
|
39
|
+
# @return [String]
|
|
33
40
|
attr_accessor :acs_system_id
|
|
34
41
|
# ID of the connected account that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
|
|
42
|
+
# @return [String]
|
|
35
43
|
attr_accessor :connected_account_id
|
|
36
44
|
# Display name for the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
|
|
45
|
+
# @return [String]
|
|
37
46
|
attr_accessor :display_name
|
|
38
47
|
# ID of the workspace that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
|
|
48
|
+
# @return [String]
|
|
39
49
|
attr_accessor :workspace_id
|
|
40
50
|
|
|
41
51
|
# Date and time at which the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) was created.
|
|
52
|
+
# @return [Time]
|
|
42
53
|
date_accessor :created_at
|
|
43
54
|
end
|
|
44
55
|
end
|