@seamapi/types 1.490.0 → 1.492.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.
@@ -19087,170 +19087,1173 @@ export type Routes = {
19087
19087
  user_identity_id: string;
19088
19088
  /** Date and time at which the Instant Key expires. */
19089
19089
  expires_at: string;
19090
+ /** ID of the customization profile associated with the Instant Key. */
19091
+ customization_profile_id?: string | undefined;
19092
+ /** Customization profile associated with the Instant Key. */
19093
+ customization_profile?: {
19094
+ /** Primary color of the customization profile. */
19095
+ primary_color?: string | undefined;
19096
+ /** Secondary color of the customization profile. */
19097
+ secondary_color?: string | undefined;
19098
+ /** URL of the logo associated with the customization profile. */
19099
+ logo_url?: string | undefined;
19100
+ } | undefined;
19090
19101
  }[] | undefined;
19091
- };
19092
- };
19093
- };
19094
- '/access_methods/list': {
19095
- route: '/access_methods/list';
19096
- method: 'GET' | 'POST';
19097
- queryParams: {};
19098
- jsonBody: {};
19099
- commonParams: {
19100
- /** ID of Access Grant to list access methods for. */
19101
- access_grant_id: string;
19102
- /** ID of the device for which you want to retrieve all access methods. */
19103
- device_id?: string | undefined;
19104
- /** ID of the entrance for which you want to retrieve all access methods. */
19105
- acs_entrance_id?: string | undefined;
19106
- /** ID of the space for which you want to retrieve all access methods. */
19107
- space_id?: string | undefined;
19108
- };
19109
- formData: {};
19110
- jsonResponse: {
19111
- access_methods: {
19112
- /** ID of the Seam workspace associated with the access method. */
19113
- workspace_id: string;
19114
- /** ID of the access method. */
19115
- access_method_id: string;
19116
- /** Display name of the access method. */
19117
- display_name: string;
19118
- /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
19119
- mode: 'code' | 'card' | 'mobile_key';
19120
- /** Date and time at which the access method was created. */
19121
- created_at: string;
19122
- /** Date and time at which the access method was issued. */
19123
- issued_at: string | null;
19124
- /** Indicates whether the access method has been issued. */
19125
- is_issued: boolean;
19126
- /** URL of the Instant Key for mobile key access methods. */
19127
- instant_key_url?: string | undefined;
19128
- /** Token of the client session associated with the access method. */
19129
- client_session_token?: string | undefined;
19130
- /** Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method. */
19131
- is_encoding_required?: boolean | undefined;
19132
- /** The actual PIN code for code access methods. */
19133
- code?: string | undefined;
19134
- }[];
19135
- };
19136
- };
19137
- '/acs/access_groups/add_user': {
19138
- route: '/acs/access_groups/add_user';
19139
- method: 'PUT' | 'POST';
19140
- queryParams: {};
19141
- jsonBody: {};
19142
- commonParams: {
19143
- /** ID of the access group to which you want to add an access system user. */
19144
- acs_access_group_id: string;
19145
- /** ID of the access system user that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id. */
19146
- acs_user_id?: string | undefined;
19147
- /** ID of the desired user identity that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created. */
19148
- user_identity_id?: string | undefined;
19149
- };
19150
- formData: {};
19151
- jsonResponse: {};
19152
- };
19153
- '/acs/access_groups/get': {
19154
- route: '/acs/access_groups/get';
19155
- method: 'GET' | 'POST';
19156
- queryParams: {};
19157
- jsonBody: {};
19158
- commonParams: {
19159
- /** ID of the access group that you want to get. */
19160
- acs_access_group_id: string;
19161
- };
19162
- formData: {};
19163
- jsonResponse: {
19164
- /** Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.
19165
-
19166
- Some access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.
19167
-
19168
- To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems). */
19169
- acs_access_group: {
19170
- /** ID of the access group. */
19171
- acs_access_group_id: string;
19172
- /** ID of the access control system that contains the access group. */
19173
- acs_system_id: string;
19174
- /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group. */
19175
- workspace_id: string;
19176
- /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the access group. */
19177
- connected_account_id: string;
19178
- /** Name of the access group. */
19179
- name: string;
19180
- /**
19181
- * @deprecated Use `external_type`.*/
19182
- access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group';
19183
- /**
19184
- * @deprecated Use `external_type_display_name`.*/
19185
- access_group_type_display_name: string;
19186
- display_name: string;
19187
- /** Brand-specific terminology for the access group type. */
19188
- external_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group';
19189
- /** Display name that corresponds to the brand-specific terminology for the access group type. */
19190
- external_type_display_name: string;
19191
- /** Date and time at which the access group was created. */
19192
- created_at: string;
19193
- /** Warnings associated with the `acs_access_group`. */
19194
- warnings: {
19195
- /** Date and time at which Seam created the warning. */
19102
+ access_codes?: {
19103
+ /** Unique identifier for a group of access codes that share the same code. */
19104
+ common_code_key: string | null;
19105
+ /** Indicates whether the code is set on the device according to a preconfigured schedule. */
19106
+ is_scheduled_on_device?: boolean | undefined;
19107
+ /** Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration. */
19108
+ type: 'time_bound' | 'ongoing';
19109
+ /** Indicates whether the access code is waiting for a code assignment. */
19110
+ is_waiting_for_code_assignment?: boolean | undefined;
19111
+ /** Unique identifier for the access code. */
19112
+ access_code_id: string;
19113
+ /** Unique identifier for the device associated with the access code. */
19114
+ device_id: string;
19115
+ /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
19116
+ name: string | null;
19117
+ /** Code used for access. Typically, a numeric or alphanumeric string. */
19118
+ code: string | null;
19119
+ /** Date and time at which the access code was created. */
19196
19120
  created_at: string;
19197
- /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
19198
- message: string;
19199
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
19200
- warning_code: 'unknown_issue_with_acs_access_group';
19201
- }[];
19202
- is_managed: true;
19203
- };
19204
- };
19205
- };
19206
- '/acs/access_groups/list': {
19207
- route: '/acs/access_groups/list';
19208
- method: 'GET' | 'POST';
19209
- queryParams: {};
19210
- jsonBody: {};
19211
- commonParams: {
19212
- /** ID of the access system for which you want to retrieve all access groups. */
19213
- acs_system_id?: string | undefined;
19214
- /** ID of the access system user for which you want to retrieve all access groups. */
19215
- acs_user_id?: string | undefined;
19216
- /** ID of the user identity for which you want to retrieve all access groups. */
19217
- user_identity_id?: string | undefined;
19218
- };
19219
- formData: {};
19220
- jsonResponse: {
19221
- acs_access_groups: {
19222
- /** ID of the access group. */
19223
- acs_access_group_id: string;
19224
- /** ID of the access control system that contains the access group. */
19225
- acs_system_id: string;
19226
- /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group. */
19227
- workspace_id: string;
19228
- /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the access group. */
19229
- connected_account_id: string;
19230
- /** Name of the access group. */
19231
- name: string;
19232
- /**
19233
- * @deprecated Use `external_type`.*/
19234
- access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group';
19235
- /**
19236
- * @deprecated Use `external_type_display_name`.*/
19237
- access_group_type_display_name: string;
19238
- display_name: string;
19239
- /** Brand-specific terminology for the access group type. */
19240
- external_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group';
19241
- /** Display name that corresponds to the brand-specific terminology for the access group type. */
19242
- external_type_display_name: string;
19243
- /** Date and time at which the access group was created. */
19244
- created_at: string;
19245
- /** Warnings associated with the `acs_access_group`. */
19246
- warnings: {
19247
- /** Date and time at which Seam created the warning. */
19121
+ /** Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
19122
+ errors: ({
19123
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19124
+ message: string;
19125
+ /** Indicates that this is an access code error. */
19126
+ is_access_code_error: true;
19127
+ /** Date and time at which Seam created the error. */
19128
+ created_at?: string | undefined;
19129
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19130
+ error_code: 'smartthings_failed_to_set_access_code';
19131
+ } | {
19132
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19133
+ message: string;
19134
+ /** Indicates that this is an access code error. */
19135
+ is_access_code_error: true;
19136
+ /** Date and time at which Seam created the error. */
19137
+ created_at?: string | undefined;
19138
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19139
+ error_code: 'smartthings_failed_to_set_after_multiple_retries';
19140
+ } | {
19141
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19142
+ message: string;
19143
+ /** Indicates that this is an access code error. */
19144
+ is_access_code_error: true;
19145
+ /** Date and time at which Seam created the error. */
19146
+ created_at?: string | undefined;
19147
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19148
+ error_code: 'smartthings_no_free_slots_available';
19149
+ } | {
19150
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19151
+ message: string;
19152
+ /** Indicates that this is an access code error. */
19153
+ is_access_code_error: true;
19154
+ /** Date and time at which Seam created the error. */
19155
+ created_at?: string | undefined;
19156
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19157
+ error_code: 'failed_to_set_on_device';
19158
+ } | {
19159
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19160
+ message: string;
19161
+ /** Indicates that this is an access code error. */
19162
+ is_access_code_error: true;
19163
+ /** Date and time at which Seam created the error. */
19164
+ created_at?: string | undefined;
19165
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19166
+ error_code: 'failed_to_remove_from_device';
19167
+ } | {
19168
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19169
+ message: string;
19170
+ /** Indicates that this is an access code error. */
19171
+ is_access_code_error: true;
19172
+ /** Date and time at which Seam created the error. */
19173
+ created_at?: string | undefined;
19174
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19175
+ error_code: 'duplicate_code_on_device';
19176
+ } | {
19177
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19178
+ message: string;
19179
+ /** Indicates that this is an access code error. */
19180
+ is_access_code_error: true;
19181
+ /** Date and time at which Seam created the error. */
19182
+ created_at?: string | undefined;
19183
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19184
+ error_code: 'duplicate_code_attempt_prevented';
19185
+ } | {
19186
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19187
+ message: string;
19188
+ /** Indicates that this is an access code error. */
19189
+ is_access_code_error: true;
19190
+ /** Date and time at which Seam created the error. */
19191
+ created_at?: string | undefined;
19192
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19193
+ error_code: 'no_space_for_access_code_on_device';
19194
+ } | {
19195
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19196
+ message: string;
19197
+ /** Indicates that this is an access code error. */
19198
+ is_access_code_error: true;
19199
+ /** Date and time at which Seam created the error. */
19200
+ created_at?: string | undefined;
19201
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19202
+ error_code: 'igloohome_bridge_too_many_pending_jobs';
19203
+ } | {
19204
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19205
+ message: string;
19206
+ /** Indicates that this is an access code error. */
19207
+ is_access_code_error: true;
19208
+ /** Date and time at which Seam created the error. */
19209
+ created_at?: string | undefined;
19210
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19211
+ error_code: 'igloohome_bridge_offline';
19212
+ } | {
19213
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19214
+ message: string;
19215
+ /** Indicates that this is an access code error. */
19216
+ is_access_code_error: true;
19217
+ /** Date and time at which Seam created the error. */
19218
+ created_at?: string | undefined;
19219
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19220
+ error_code: 'igloohome_offline_access_code_no_variance_available';
19221
+ } | {
19222
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19223
+ message: string;
19224
+ /** Indicates that this is an access code error. */
19225
+ is_access_code_error: true;
19226
+ /** Date and time at which Seam created the error. */
19227
+ created_at?: string | undefined;
19228
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19229
+ error_code: 'kwikset_unable_to_confirm_code';
19230
+ } | {
19231
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19232
+ message: string;
19233
+ /** Indicates that this is an access code error. */
19234
+ is_access_code_error: true;
19235
+ /** Date and time at which Seam created the error. */
19236
+ created_at?: string | undefined;
19237
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19238
+ error_code: 'kwikset_unable_to_confirm_deletion';
19239
+ } | {
19240
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19241
+ message: string;
19242
+ /** Indicates that this is an access code error. */
19243
+ is_access_code_error: true;
19244
+ /** Date and time at which Seam created the error. */
19245
+ created_at?: string | undefined;
19246
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19247
+ error_code: 'code_modified_external_to_seam';
19248
+ } | {
19249
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19250
+ message: string;
19251
+ /** Indicates that this is an access code error. */
19252
+ is_access_code_error: true;
19253
+ /** Date and time at which Seam created the error. */
19254
+ created_at?: string | undefined;
19255
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19256
+ error_code: 'august_lock_invalid_code_length';
19257
+ } | {
19258
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19259
+ message: string;
19260
+ /** Indicates that this is an access code error. */
19261
+ is_access_code_error: true;
19262
+ /** Date and time at which Seam created the error. */
19263
+ created_at?: string | undefined;
19264
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19265
+ error_code: 'august_device_programming_delay';
19266
+ } | {
19267
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19268
+ message: string;
19269
+ /** Indicates that this is an access code error. */
19270
+ is_access_code_error: true;
19271
+ /** Date and time at which Seam created the error. */
19272
+ created_at?: string | undefined;
19273
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19274
+ error_code: 'august_device_slots_full';
19275
+ } | {
19276
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19277
+ message: string;
19278
+ /** Indicates that this is an access code error. */
19279
+ is_access_code_error: true;
19280
+ /** Date and time at which Seam created the error. */
19281
+ created_at?: string | undefined;
19282
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19283
+ error_code: 'august_lock_missing_keypad';
19284
+ } | {
19285
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19286
+ message: string;
19287
+ /** Indicates that this is an access code error. */
19288
+ is_access_code_error: true;
19289
+ /** Date and time at which Seam created the error. */
19290
+ created_at?: string | undefined;
19291
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19292
+ error_code: 'august_lock_temporarily_offline';
19293
+ } | {
19294
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19295
+ message: string;
19296
+ /** Indicates that this is an access code error. */
19297
+ is_access_code_error: true;
19298
+ /** Date and time at which Seam created the error. */
19299
+ created_at?: string | undefined;
19300
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19301
+ error_code: 'salto_ks_user_not_subscribed';
19302
+ } | {
19303
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19304
+ message: string;
19305
+ /** Indicates that this is an access code error. */
19306
+ is_access_code_error: true;
19307
+ /** Date and time at which Seam created the error. */
19308
+ created_at?: string | undefined;
19309
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19310
+ error_code: 'hubitat_device_programming_delay';
19311
+ } | {
19312
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19313
+ message: string;
19314
+ /** Indicates that this is an access code error. */
19315
+ is_access_code_error: true;
19316
+ /** Date and time at which Seam created the error. */
19317
+ created_at?: string | undefined;
19318
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19319
+ error_code: 'hubitat_no_free_positions_available';
19320
+ } | {
19321
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19322
+ message: string;
19323
+ /** Indicates that this is an access code error. */
19324
+ is_access_code_error: true;
19325
+ /** Date and time at which Seam created the error. */
19326
+ created_at?: string | undefined;
19327
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19328
+ error_code: 'wyze_duplicate_code_name';
19329
+ } | {
19330
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19331
+ message: string;
19332
+ /** Indicates that this is an access code error. */
19333
+ is_access_code_error: true;
19334
+ /** Date and time at which Seam created the error. */
19335
+ created_at?: string | undefined;
19336
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19337
+ error_code: 'wyze_potential_duplicate_code';
19338
+ } | {
19339
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19340
+ message: string;
19341
+ /** Indicates that this is an access code error. */
19342
+ is_access_code_error: true;
19343
+ /** Date and time at which Seam created the error. */
19344
+ created_at?: string | undefined;
19345
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19346
+ error_code: 'dormakaba_oracode_no_valid_user_level';
19347
+ } | {
19348
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19349
+ message: string;
19350
+ /** Indicates that the error is not a device error. */
19351
+ is_device_error: false;
19352
+ /** Date and time at which Seam created the error. */
19353
+ created_at: string;
19354
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19355
+ error_code: 'account_disconnected';
19356
+ /** Indicates that the error is a [connected account](https://docs.seam.co/latest/api/connected_accounts) error. */
19357
+ is_connected_account_error: true;
19358
+ } | {
19359
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19360
+ message: string;
19361
+ /** Indicates that the error is not a device error. */
19362
+ is_device_error: false;
19363
+ /** Date and time at which Seam created the error. */
19364
+ created_at: string;
19365
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19366
+ error_code: 'salto_ks_subscription_limit_exceeded';
19367
+ /** Indicates that the error is a [connected account](https://docs.seam.co/latest/api/connected_accounts) error. */
19368
+ is_connected_account_error: true;
19369
+ } | {
19370
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19371
+ message: string;
19372
+ /** Indicates that the error is a device error. */
19373
+ is_device_error: true;
19374
+ /** Date and time at which Seam created the error. */
19375
+ created_at: string;
19376
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19377
+ error_code: 'device_offline';
19378
+ } | {
19379
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19380
+ message: string;
19381
+ /** Indicates that the error is a device error. */
19382
+ is_device_error: true;
19383
+ /** Date and time at which Seam created the error. */
19384
+ created_at: string;
19385
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19386
+ error_code: 'device_removed';
19387
+ } | {
19388
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19389
+ message: string;
19390
+ /** Indicates that the error is a device error. */
19391
+ is_device_error: true;
19392
+ /** Date and time at which Seam created the error. */
19393
+ created_at: string;
19394
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19395
+ error_code: 'hub_disconnected';
19396
+ } | {
19397
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19398
+ message: string;
19399
+ /** Indicates that the error is a device error. */
19400
+ is_device_error: true;
19401
+ /** Date and time at which Seam created the error. */
19402
+ created_at: string;
19403
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19404
+ error_code: 'device_disconnected';
19405
+ } | {
19406
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19407
+ message: string;
19408
+ /** Indicates that the error is a device error. */
19409
+ is_device_error: true;
19410
+ /** Date and time at which Seam created the error. */
19411
+ created_at: string;
19412
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19413
+ error_code: 'empty_backup_access_code_pool';
19414
+ } | {
19415
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19416
+ message: string;
19417
+ /** Indicates that the error is a device error. */
19418
+ is_device_error: true;
19419
+ /** Date and time at which Seam created the error. */
19420
+ created_at: string;
19421
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19422
+ error_code: 'august_lock_not_authorized';
19423
+ } | {
19424
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19425
+ message: string;
19426
+ /** Indicates that the error is a device error. */
19427
+ is_device_error: true;
19428
+ /** Date and time at which Seam created the error. */
19429
+ created_at: string;
19430
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19431
+ error_code: 'august_lock_missing_bridge';
19432
+ } | {
19433
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19434
+ message: string;
19435
+ /** Indicates that the error is a device error. */
19436
+ is_device_error: true;
19437
+ /** Date and time at which Seam created the error. */
19438
+ created_at: string;
19439
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19440
+ error_code: 'ttlock_lock_not_paired_to_gateway';
19441
+ } | {
19442
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19443
+ message: string;
19444
+ /** Indicates that the error is a device error. */
19445
+ is_device_error: true;
19446
+ /** Date and time at which Seam created the error. */
19447
+ created_at: string;
19448
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19449
+ error_code: 'missing_device_credentials';
19450
+ } | {
19451
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19452
+ message: string;
19453
+ /** Indicates that the error is a device error. */
19454
+ is_device_error: true;
19455
+ /** Date and time at which Seam created the error. */
19456
+ created_at: string;
19457
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19458
+ error_code: 'auxiliary_heat_running';
19459
+ } | {
19460
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19461
+ message: string;
19462
+ /** Indicates that the error is a device error. */
19463
+ is_device_error: true;
19464
+ /** Date and time at which Seam created the error. */
19465
+ created_at: string;
19466
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19467
+ error_code: 'subscription_required';
19468
+ } | {
19469
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19470
+ message: string;
19471
+ /** Indicates that the error is a device error. */
19472
+ is_device_error: true;
19473
+ /** Date and time at which Seam created the error. */
19474
+ created_at: string;
19475
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19476
+ error_code: 'lockly_missing_wifi_bridge';
19477
+ } | {
19478
+ /** Date and time at which Seam created the error. */
19479
+ created_at: string;
19480
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19481
+ message: string;
19482
+ /** Indicates whether the error is related specifically to the connected account. */
19483
+ is_connected_account_error?: boolean | undefined;
19484
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
19485
+ is_bridge_error?: boolean | undefined;
19486
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19487
+ error_code: 'invalid_credentials';
19488
+ } | {
19489
+ /** Date and time at which Seam created the error. */
19490
+ created_at: string;
19491
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19492
+ message: string;
19493
+ /** Indicates whether the error is related specifically to the connected account. */
19494
+ is_connected_account_error?: boolean | undefined;
19495
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
19496
+ is_bridge_error?: boolean | undefined;
19497
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19498
+ error_code: 'bridge_disconnected';
19499
+ })[];
19500
+ /** Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
19501
+ warnings: ({
19502
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
19503
+ message: string;
19504
+ /** Date and time at which Seam created the warning. */
19505
+ created_at?: string | undefined;
19506
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
19507
+ warning_code: 'smartthings_failed_to_set_access_code';
19508
+ } | {
19509
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
19510
+ message: string;
19511
+ /** Date and time at which Seam created the warning. */
19512
+ created_at?: string | undefined;
19513
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
19514
+ warning_code: 'schlage_detected_duplicate';
19515
+ } | {
19516
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
19517
+ message: string;
19518
+ /** Date and time at which Seam created the warning. */
19519
+ created_at?: string | undefined;
19520
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
19521
+ warning_code: 'schlage_creation_outage';
19522
+ } | {
19523
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
19524
+ message: string;
19525
+ /** Date and time at which Seam created the warning. */
19526
+ created_at?: string | undefined;
19527
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
19528
+ warning_code: 'code_modified_external_to_seam';
19529
+ } | {
19530
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
19531
+ message: string;
19532
+ /** Date and time at which Seam created the warning. */
19533
+ created_at?: string | undefined;
19534
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
19535
+ warning_code: 'delay_in_setting_on_device';
19536
+ } | {
19537
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
19538
+ message: string;
19539
+ /** Date and time at which Seam created the warning. */
19540
+ created_at?: string | undefined;
19541
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
19542
+ warning_code: 'delay_in_removing_from_device';
19543
+ } | {
19544
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
19545
+ message: string;
19546
+ /** Date and time at which Seam created the warning. */
19547
+ created_at?: string | undefined;
19548
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
19549
+ warning_code: 'third_party_integration_detected';
19550
+ } | {
19551
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
19552
+ message: string;
19553
+ /** Date and time at which Seam created the warning. */
19554
+ created_at?: string | undefined;
19555
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
19556
+ warning_code: 'august_device_programming_delay';
19557
+ } | {
19558
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
19559
+ message: string;
19560
+ /** Date and time at which Seam created the warning. */
19561
+ created_at?: string | undefined;
19562
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19563
+ warning_code: 'august_lock_temporarily_offline';
19564
+ } | {
19565
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
19566
+ message: string;
19567
+ /** Date and time at which Seam created the warning. */
19568
+ created_at?: string | undefined;
19569
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
19570
+ warning_code: 'igloo_algopin_must_be_used_within_24_hours';
19571
+ } | {
19572
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
19573
+ message: string;
19574
+ /** Date and time at which Seam created the warning. */
19575
+ created_at?: string | undefined;
19576
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
19577
+ warning_code: 'management_transferred';
19578
+ } | {
19579
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
19580
+ message: string;
19581
+ /** Date and time at which Seam created the warning. */
19582
+ created_at?: string | undefined;
19583
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
19584
+ warning_code: 'kwikset_unable_to_confirm_code';
19585
+ })[];
19586
+ /** Indicates whether Seam manages the access code. */
19587
+ is_managed: true;
19588
+ /** Date and time at which the time-bound access code becomes active. */
19589
+ starts_at?: (string | null) | undefined;
19590
+ /** Date and time after which the time-bound access code becomes inactive. */
19591
+ ends_at?: (string | null) | undefined;
19592
+ /** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes). */
19593
+ status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
19594
+ /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
19595
+ is_backup_access_code_available: boolean;
19596
+ /** Indicates whether the access code is a backup code. */
19597
+ is_backup?: boolean | undefined;
19598
+ /** Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. */
19599
+ pulled_backup_access_code_id?: (string | null) | undefined;
19600
+ /** Indicates whether changes to the access code from external sources are permitted. */
19601
+ is_external_modification_allowed: boolean;
19602
+ /** Indicates whether the access code can only be used once. If `true`, the code becomes invalid after the first use. */
19603
+ is_one_time_use: boolean;
19604
+ /** Indicates whether the access code is intended for use in offline scenarios. If `true`, this code can be created on a device without a network connection. */
19605
+ is_offline_access_code: boolean;
19606
+ }[] | undefined;
19607
+ unmanaged_access_codes?: {
19608
+ /** Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration. */
19609
+ type: 'time_bound' | 'ongoing';
19610
+ /** Unique identifier for the access code. */
19611
+ access_code_id: string;
19612
+ /** Unique identifier for the device associated with the access code. */
19613
+ device_id: string;
19614
+ /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
19615
+ name: string | null;
19616
+ /** Code used for access. Typically, a numeric or alphanumeric string. */
19617
+ code: string | null;
19618
+ /** Date and time at which the access code was created. */
19248
19619
  created_at: string;
19249
- /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
19250
- message: string;
19251
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
19252
- warning_code: 'unknown_issue_with_acs_access_group';
19253
- }[];
19620
+ /** Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
19621
+ errors: ({
19622
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19623
+ message: string;
19624
+ /** Indicates that this is an access code error. */
19625
+ is_access_code_error: true;
19626
+ /** Date and time at which Seam created the error. */
19627
+ created_at?: string | undefined;
19628
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19629
+ error_code: 'smartthings_failed_to_set_access_code';
19630
+ } | {
19631
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19632
+ message: string;
19633
+ /** Indicates that this is an access code error. */
19634
+ is_access_code_error: true;
19635
+ /** Date and time at which Seam created the error. */
19636
+ created_at?: string | undefined;
19637
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19638
+ error_code: 'smartthings_failed_to_set_after_multiple_retries';
19639
+ } | {
19640
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19641
+ message: string;
19642
+ /** Indicates that this is an access code error. */
19643
+ is_access_code_error: true;
19644
+ /** Date and time at which Seam created the error. */
19645
+ created_at?: string | undefined;
19646
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19647
+ error_code: 'smartthings_no_free_slots_available';
19648
+ } | {
19649
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19650
+ message: string;
19651
+ /** Indicates that this is an access code error. */
19652
+ is_access_code_error: true;
19653
+ /** Date and time at which Seam created the error. */
19654
+ created_at?: string | undefined;
19655
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19656
+ error_code: 'failed_to_set_on_device';
19657
+ } | {
19658
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19659
+ message: string;
19660
+ /** Indicates that this is an access code error. */
19661
+ is_access_code_error: true;
19662
+ /** Date and time at which Seam created the error. */
19663
+ created_at?: string | undefined;
19664
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19665
+ error_code: 'failed_to_remove_from_device';
19666
+ } | {
19667
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19668
+ message: string;
19669
+ /** Indicates that this is an access code error. */
19670
+ is_access_code_error: true;
19671
+ /** Date and time at which Seam created the error. */
19672
+ created_at?: string | undefined;
19673
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19674
+ error_code: 'duplicate_code_on_device';
19675
+ } | {
19676
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19677
+ message: string;
19678
+ /** Indicates that this is an access code error. */
19679
+ is_access_code_error: true;
19680
+ /** Date and time at which Seam created the error. */
19681
+ created_at?: string | undefined;
19682
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19683
+ error_code: 'duplicate_code_attempt_prevented';
19684
+ } | {
19685
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19686
+ message: string;
19687
+ /** Indicates that this is an access code error. */
19688
+ is_access_code_error: true;
19689
+ /** Date and time at which Seam created the error. */
19690
+ created_at?: string | undefined;
19691
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19692
+ error_code: 'no_space_for_access_code_on_device';
19693
+ } | {
19694
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19695
+ message: string;
19696
+ /** Indicates that this is an access code error. */
19697
+ is_access_code_error: true;
19698
+ /** Date and time at which Seam created the error. */
19699
+ created_at?: string | undefined;
19700
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19701
+ error_code: 'igloohome_bridge_too_many_pending_jobs';
19702
+ } | {
19703
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19704
+ message: string;
19705
+ /** Indicates that this is an access code error. */
19706
+ is_access_code_error: true;
19707
+ /** Date and time at which Seam created the error. */
19708
+ created_at?: string | undefined;
19709
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19710
+ error_code: 'igloohome_bridge_offline';
19711
+ } | {
19712
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19713
+ message: string;
19714
+ /** Indicates that this is an access code error. */
19715
+ is_access_code_error: true;
19716
+ /** Date and time at which Seam created the error. */
19717
+ created_at?: string | undefined;
19718
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19719
+ error_code: 'igloohome_offline_access_code_no_variance_available';
19720
+ } | {
19721
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19722
+ message: string;
19723
+ /** Indicates that this is an access code error. */
19724
+ is_access_code_error: true;
19725
+ /** Date and time at which Seam created the error. */
19726
+ created_at?: string | undefined;
19727
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19728
+ error_code: 'kwikset_unable_to_confirm_code';
19729
+ } | {
19730
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19731
+ message: string;
19732
+ /** Indicates that this is an access code error. */
19733
+ is_access_code_error: true;
19734
+ /** Date and time at which Seam created the error. */
19735
+ created_at?: string | undefined;
19736
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19737
+ error_code: 'kwikset_unable_to_confirm_deletion';
19738
+ } | {
19739
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19740
+ message: string;
19741
+ /** Indicates that this is an access code error. */
19742
+ is_access_code_error: true;
19743
+ /** Date and time at which Seam created the error. */
19744
+ created_at?: string | undefined;
19745
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19746
+ error_code: 'code_modified_external_to_seam';
19747
+ } | {
19748
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19749
+ message: string;
19750
+ /** Indicates that this is an access code error. */
19751
+ is_access_code_error: true;
19752
+ /** Date and time at which Seam created the error. */
19753
+ created_at?: string | undefined;
19754
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19755
+ error_code: 'august_lock_invalid_code_length';
19756
+ } | {
19757
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19758
+ message: string;
19759
+ /** Indicates that this is an access code error. */
19760
+ is_access_code_error: true;
19761
+ /** Date and time at which Seam created the error. */
19762
+ created_at?: string | undefined;
19763
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19764
+ error_code: 'august_device_programming_delay';
19765
+ } | {
19766
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19767
+ message: string;
19768
+ /** Indicates that this is an access code error. */
19769
+ is_access_code_error: true;
19770
+ /** Date and time at which Seam created the error. */
19771
+ created_at?: string | undefined;
19772
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19773
+ error_code: 'august_device_slots_full';
19774
+ } | {
19775
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19776
+ message: string;
19777
+ /** Indicates that this is an access code error. */
19778
+ is_access_code_error: true;
19779
+ /** Date and time at which Seam created the error. */
19780
+ created_at?: string | undefined;
19781
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19782
+ error_code: 'august_lock_missing_keypad';
19783
+ } | {
19784
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19785
+ message: string;
19786
+ /** Indicates that this is an access code error. */
19787
+ is_access_code_error: true;
19788
+ /** Date and time at which Seam created the error. */
19789
+ created_at?: string | undefined;
19790
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19791
+ error_code: 'august_lock_temporarily_offline';
19792
+ } | {
19793
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19794
+ message: string;
19795
+ /** Indicates that this is an access code error. */
19796
+ is_access_code_error: true;
19797
+ /** Date and time at which Seam created the error. */
19798
+ created_at?: string | undefined;
19799
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19800
+ error_code: 'salto_ks_user_not_subscribed';
19801
+ } | {
19802
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19803
+ message: string;
19804
+ /** Indicates that this is an access code error. */
19805
+ is_access_code_error: true;
19806
+ /** Date and time at which Seam created the error. */
19807
+ created_at?: string | undefined;
19808
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19809
+ error_code: 'hubitat_device_programming_delay';
19810
+ } | {
19811
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19812
+ message: string;
19813
+ /** Indicates that this is an access code error. */
19814
+ is_access_code_error: true;
19815
+ /** Date and time at which Seam created the error. */
19816
+ created_at?: string | undefined;
19817
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19818
+ error_code: 'hubitat_no_free_positions_available';
19819
+ } | {
19820
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19821
+ message: string;
19822
+ /** Indicates that this is an access code error. */
19823
+ is_access_code_error: true;
19824
+ /** Date and time at which Seam created the error. */
19825
+ created_at?: string | undefined;
19826
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19827
+ error_code: 'wyze_duplicate_code_name';
19828
+ } | {
19829
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19830
+ message: string;
19831
+ /** Indicates that this is an access code error. */
19832
+ is_access_code_error: true;
19833
+ /** Date and time at which Seam created the error. */
19834
+ created_at?: string | undefined;
19835
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19836
+ error_code: 'wyze_potential_duplicate_code';
19837
+ } | {
19838
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19839
+ message: string;
19840
+ /** Indicates that this is an access code error. */
19841
+ is_access_code_error: true;
19842
+ /** Date and time at which Seam created the error. */
19843
+ created_at?: string | undefined;
19844
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19845
+ error_code: 'dormakaba_oracode_no_valid_user_level';
19846
+ } | {
19847
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19848
+ message: string;
19849
+ /** Indicates that the error is not a device error. */
19850
+ is_device_error: false;
19851
+ /** Date and time at which Seam created the error. */
19852
+ created_at: string;
19853
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19854
+ error_code: 'account_disconnected';
19855
+ /** Indicates that the error is a [connected account](https://docs.seam.co/latest/api/connected_accounts) error. */
19856
+ is_connected_account_error: true;
19857
+ } | {
19858
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19859
+ message: string;
19860
+ /** Indicates that the error is not a device error. */
19861
+ is_device_error: false;
19862
+ /** Date and time at which Seam created the error. */
19863
+ created_at: string;
19864
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19865
+ error_code: 'salto_ks_subscription_limit_exceeded';
19866
+ /** Indicates that the error is a [connected account](https://docs.seam.co/latest/api/connected_accounts) error. */
19867
+ is_connected_account_error: true;
19868
+ } | {
19869
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19870
+ message: string;
19871
+ /** Indicates that the error is a device error. */
19872
+ is_device_error: true;
19873
+ /** Date and time at which Seam created the error. */
19874
+ created_at: string;
19875
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19876
+ error_code: 'device_offline';
19877
+ } | {
19878
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19879
+ message: string;
19880
+ /** Indicates that the error is a device error. */
19881
+ is_device_error: true;
19882
+ /** Date and time at which Seam created the error. */
19883
+ created_at: string;
19884
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19885
+ error_code: 'device_removed';
19886
+ } | {
19887
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19888
+ message: string;
19889
+ /** Indicates that the error is a device error. */
19890
+ is_device_error: true;
19891
+ /** Date and time at which Seam created the error. */
19892
+ created_at: string;
19893
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19894
+ error_code: 'hub_disconnected';
19895
+ } | {
19896
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19897
+ message: string;
19898
+ /** Indicates that the error is a device error. */
19899
+ is_device_error: true;
19900
+ /** Date and time at which Seam created the error. */
19901
+ created_at: string;
19902
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19903
+ error_code: 'device_disconnected';
19904
+ } | {
19905
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19906
+ message: string;
19907
+ /** Indicates that the error is a device error. */
19908
+ is_device_error: true;
19909
+ /** Date and time at which Seam created the error. */
19910
+ created_at: string;
19911
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19912
+ error_code: 'empty_backup_access_code_pool';
19913
+ } | {
19914
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19915
+ message: string;
19916
+ /** Indicates that the error is a device error. */
19917
+ is_device_error: true;
19918
+ /** Date and time at which Seam created the error. */
19919
+ created_at: string;
19920
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19921
+ error_code: 'august_lock_not_authorized';
19922
+ } | {
19923
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19924
+ message: string;
19925
+ /** Indicates that the error is a device error. */
19926
+ is_device_error: true;
19927
+ /** Date and time at which Seam created the error. */
19928
+ created_at: string;
19929
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19930
+ error_code: 'august_lock_missing_bridge';
19931
+ } | {
19932
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19933
+ message: string;
19934
+ /** Indicates that the error is a device error. */
19935
+ is_device_error: true;
19936
+ /** Date and time at which Seam created the error. */
19937
+ created_at: string;
19938
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19939
+ error_code: 'ttlock_lock_not_paired_to_gateway';
19940
+ } | {
19941
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19942
+ message: string;
19943
+ /** Indicates that the error is a device error. */
19944
+ is_device_error: true;
19945
+ /** Date and time at which Seam created the error. */
19946
+ created_at: string;
19947
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19948
+ error_code: 'missing_device_credentials';
19949
+ } | {
19950
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19951
+ message: string;
19952
+ /** Indicates that the error is a device error. */
19953
+ is_device_error: true;
19954
+ /** Date and time at which Seam created the error. */
19955
+ created_at: string;
19956
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19957
+ error_code: 'auxiliary_heat_running';
19958
+ } | {
19959
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19960
+ message: string;
19961
+ /** Indicates that the error is a device error. */
19962
+ is_device_error: true;
19963
+ /** Date and time at which Seam created the error. */
19964
+ created_at: string;
19965
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19966
+ error_code: 'subscription_required';
19967
+ } | {
19968
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19969
+ message: string;
19970
+ /** Indicates that the error is a device error. */
19971
+ is_device_error: true;
19972
+ /** Date and time at which Seam created the error. */
19973
+ created_at: string;
19974
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19975
+ error_code: 'lockly_missing_wifi_bridge';
19976
+ } | {
19977
+ /** Date and time at which Seam created the error. */
19978
+ created_at: string;
19979
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19980
+ message: string;
19981
+ /** Indicates whether the error is related specifically to the connected account. */
19982
+ is_connected_account_error?: boolean | undefined;
19983
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
19984
+ is_bridge_error?: boolean | undefined;
19985
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19986
+ error_code: 'invalid_credentials';
19987
+ } | {
19988
+ /** Date and time at which Seam created the error. */
19989
+ created_at: string;
19990
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19991
+ message: string;
19992
+ /** Indicates whether the error is related specifically to the connected account. */
19993
+ is_connected_account_error?: boolean | undefined;
19994
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
19995
+ is_bridge_error?: boolean | undefined;
19996
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
19997
+ error_code: 'bridge_disconnected';
19998
+ })[];
19999
+ /** Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
20000
+ warnings: ({
20001
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
20002
+ message: string;
20003
+ /** Date and time at which Seam created the warning. */
20004
+ created_at?: string | undefined;
20005
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
20006
+ warning_code: 'smartthings_failed_to_set_access_code';
20007
+ } | {
20008
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
20009
+ message: string;
20010
+ /** Date and time at which Seam created the warning. */
20011
+ created_at?: string | undefined;
20012
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
20013
+ warning_code: 'schlage_detected_duplicate';
20014
+ } | {
20015
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
20016
+ message: string;
20017
+ /** Date and time at which Seam created the warning. */
20018
+ created_at?: string | undefined;
20019
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
20020
+ warning_code: 'schlage_creation_outage';
20021
+ } | {
20022
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
20023
+ message: string;
20024
+ /** Date and time at which Seam created the warning. */
20025
+ created_at?: string | undefined;
20026
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
20027
+ warning_code: 'code_modified_external_to_seam';
20028
+ } | {
20029
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
20030
+ message: string;
20031
+ /** Date and time at which Seam created the warning. */
20032
+ created_at?: string | undefined;
20033
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
20034
+ warning_code: 'delay_in_setting_on_device';
20035
+ } | {
20036
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
20037
+ message: string;
20038
+ /** Date and time at which Seam created the warning. */
20039
+ created_at?: string | undefined;
20040
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
20041
+ warning_code: 'delay_in_removing_from_device';
20042
+ } | {
20043
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
20044
+ message: string;
20045
+ /** Date and time at which Seam created the warning. */
20046
+ created_at?: string | undefined;
20047
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
20048
+ warning_code: 'third_party_integration_detected';
20049
+ } | {
20050
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
20051
+ message: string;
20052
+ /** Date and time at which Seam created the warning. */
20053
+ created_at?: string | undefined;
20054
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
20055
+ warning_code: 'august_device_programming_delay';
20056
+ } | {
20057
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
20058
+ message: string;
20059
+ /** Date and time at which Seam created the warning. */
20060
+ created_at?: string | undefined;
20061
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
20062
+ warning_code: 'august_lock_temporarily_offline';
20063
+ } | {
20064
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
20065
+ message: string;
20066
+ /** Date and time at which Seam created the warning. */
20067
+ created_at?: string | undefined;
20068
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
20069
+ warning_code: 'igloo_algopin_must_be_used_within_24_hours';
20070
+ } | {
20071
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
20072
+ message: string;
20073
+ /** Date and time at which Seam created the warning. */
20074
+ created_at?: string | undefined;
20075
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
20076
+ warning_code: 'management_transferred';
20077
+ } | {
20078
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
20079
+ message: string;
20080
+ /** Date and time at which Seam created the warning. */
20081
+ created_at?: string | undefined;
20082
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
20083
+ warning_code: 'kwikset_unable_to_confirm_code';
20084
+ })[];
20085
+ /** Indicates that Seam does not manage the access code. */
20086
+ is_managed: false;
20087
+ /** Date and time at which the time-bound access code becomes active. */
20088
+ starts_at?: (string | null) | undefined;
20089
+ /** Date and time after which the time-bound access code becomes inactive. */
20090
+ ends_at?: (string | null) | undefined;
20091
+ /** Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational. */
20092
+ status: 'set';
20093
+ }[] | undefined;
20094
+ };
20095
+ };
20096
+ };
20097
+ '/access_methods/list': {
20098
+ route: '/access_methods/list';
20099
+ method: 'GET' | 'POST';
20100
+ queryParams: {};
20101
+ jsonBody: {};
20102
+ commonParams: {
20103
+ /** ID of Access Grant to list access methods for. */
20104
+ access_grant_id: string;
20105
+ /** ID of the device for which you want to retrieve all access methods. */
20106
+ device_id?: string | undefined;
20107
+ /** ID of the entrance for which you want to retrieve all access methods. */
20108
+ acs_entrance_id?: string | undefined;
20109
+ /** ID of the space for which you want to retrieve all access methods. */
20110
+ space_id?: string | undefined;
20111
+ };
20112
+ formData: {};
20113
+ jsonResponse: {
20114
+ access_methods: {
20115
+ /** ID of the Seam workspace associated with the access method. */
20116
+ workspace_id: string;
20117
+ /** ID of the access method. */
20118
+ access_method_id: string;
20119
+ /** Display name of the access method. */
20120
+ display_name: string;
20121
+ /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
20122
+ mode: 'code' | 'card' | 'mobile_key';
20123
+ /** Date and time at which the access method was created. */
20124
+ created_at: string;
20125
+ /** Date and time at which the access method was issued. */
20126
+ issued_at: string | null;
20127
+ /** Indicates whether the access method has been issued. */
20128
+ is_issued: boolean;
20129
+ /** URL of the Instant Key for mobile key access methods. */
20130
+ instant_key_url?: string | undefined;
20131
+ /** Token of the client session associated with the access method. */
20132
+ client_session_token?: string | undefined;
20133
+ /** Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method. */
20134
+ is_encoding_required?: boolean | undefined;
20135
+ /** The actual PIN code for code access methods. */
20136
+ code?: string | undefined;
20137
+ }[];
20138
+ };
20139
+ };
20140
+ '/acs/access_groups/add_user': {
20141
+ route: '/acs/access_groups/add_user';
20142
+ method: 'PUT' | 'POST';
20143
+ queryParams: {};
20144
+ jsonBody: {};
20145
+ commonParams: {
20146
+ /** ID of the access group to which you want to add an access system user. */
20147
+ acs_access_group_id: string;
20148
+ /** ID of the access system user that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id. */
20149
+ acs_user_id?: string | undefined;
20150
+ /** ID of the desired user identity that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created. */
20151
+ user_identity_id?: string | undefined;
20152
+ };
20153
+ formData: {};
20154
+ jsonResponse: {};
20155
+ };
20156
+ '/acs/access_groups/get': {
20157
+ route: '/acs/access_groups/get';
20158
+ method: 'GET' | 'POST';
20159
+ queryParams: {};
20160
+ jsonBody: {};
20161
+ commonParams: {
20162
+ /** ID of the access group that you want to get. */
20163
+ acs_access_group_id: string;
20164
+ };
20165
+ formData: {};
20166
+ jsonResponse: {
20167
+ /** Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.
20168
+
20169
+ Some access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.
20170
+
20171
+ To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems). */
20172
+ acs_access_group: {
20173
+ /** ID of the access group. */
20174
+ acs_access_group_id: string;
20175
+ /** ID of the access control system that contains the access group. */
20176
+ acs_system_id: string;
20177
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group. */
20178
+ workspace_id: string;
20179
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the access group. */
20180
+ connected_account_id: string;
20181
+ /** Name of the access group. */
20182
+ name: string;
20183
+ /**
20184
+ * @deprecated Use `external_type`.*/
20185
+ access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group';
20186
+ /**
20187
+ * @deprecated Use `external_type_display_name`.*/
20188
+ access_group_type_display_name: string;
20189
+ display_name: string;
20190
+ /** Brand-specific terminology for the access group type. */
20191
+ external_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group';
20192
+ /** Display name that corresponds to the brand-specific terminology for the access group type. */
20193
+ external_type_display_name: string;
20194
+ /** Date and time at which the access group was created. */
20195
+ created_at: string;
20196
+ /** Warnings associated with the `acs_access_group`. */
20197
+ warnings: {
20198
+ /** Date and time at which Seam created the warning. */
20199
+ created_at: string;
20200
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
20201
+ message: string;
20202
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
20203
+ warning_code: 'unknown_issue_with_acs_access_group';
20204
+ }[];
20205
+ is_managed: true;
20206
+ };
20207
+ };
20208
+ };
20209
+ '/acs/access_groups/list': {
20210
+ route: '/acs/access_groups/list';
20211
+ method: 'GET' | 'POST';
20212
+ queryParams: {};
20213
+ jsonBody: {};
20214
+ commonParams: {
20215
+ /** ID of the access system for which you want to retrieve all access groups. */
20216
+ acs_system_id?: string | undefined;
20217
+ /** ID of the access system user for which you want to retrieve all access groups. */
20218
+ acs_user_id?: string | undefined;
20219
+ /** ID of the user identity for which you want to retrieve all access groups. */
20220
+ user_identity_id?: string | undefined;
20221
+ };
20222
+ formData: {};
20223
+ jsonResponse: {
20224
+ acs_access_groups: {
20225
+ /** ID of the access group. */
20226
+ acs_access_group_id: string;
20227
+ /** ID of the access control system that contains the access group. */
20228
+ acs_system_id: string;
20229
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group. */
20230
+ workspace_id: string;
20231
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the access group. */
20232
+ connected_account_id: string;
20233
+ /** Name of the access group. */
20234
+ name: string;
20235
+ /**
20236
+ * @deprecated Use `external_type`.*/
20237
+ access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group';
20238
+ /**
20239
+ * @deprecated Use `external_type_display_name`.*/
20240
+ access_group_type_display_name: string;
20241
+ display_name: string;
20242
+ /** Brand-specific terminology for the access group type. */
20243
+ external_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group';
20244
+ /** Display name that corresponds to the brand-specific terminology for the access group type. */
20245
+ external_type_display_name: string;
20246
+ /** Date and time at which the access group was created. */
20247
+ created_at: string;
20248
+ /** Warnings associated with the `acs_access_group`. */
20249
+ warnings: {
20250
+ /** Date and time at which Seam created the warning. */
20251
+ created_at: string;
20252
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
20253
+ message: string;
20254
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
20255
+ warning_code: 'unknown_issue_with_acs_access_group';
20256
+ }[];
19254
20257
  is_managed: true;
19255
20258
  }[];
19256
20259
  };
@@ -37621,6 +38624,17 @@ export type Routes = {
37621
38624
  user_identity_id: string;
37622
38625
  /** Date and time at which the Instant Key expires. */
37623
38626
  expires_at: string;
38627
+ /** ID of the customization profile associated with the Instant Key. */
38628
+ customization_profile_id?: string | undefined;
38629
+ /** Customization profile associated with the Instant Key. */
38630
+ customization_profile?: {
38631
+ /** Primary color of the customization profile. */
38632
+ primary_color?: string | undefined;
38633
+ /** Secondary color of the customization profile. */
38634
+ secondary_color?: string | undefined;
38635
+ /** URL of the logo associated with the customization profile. */
38636
+ logo_url?: string | undefined;
38637
+ } | undefined;
37624
38638
  };
37625
38639
  };
37626
38640
  };
@@ -37650,6 +38664,17 @@ export type Routes = {
37650
38664
  user_identity_id: string;
37651
38665
  /** Date and time at which the Instant Key expires. */
37652
38666
  expires_at: string;
38667
+ /** ID of the customization profile associated with the Instant Key. */
38668
+ customization_profile_id?: string | undefined;
38669
+ /** Customization profile associated with the Instant Key. */
38670
+ customization_profile?: {
38671
+ /** Primary color of the customization profile. */
38672
+ primary_color?: string | undefined;
38673
+ /** Secondary color of the customization profile. */
38674
+ secondary_color?: string | undefined;
38675
+ /** URL of the logo associated with the customization profile. */
38676
+ logo_url?: string | undefined;
38677
+ } | undefined;
37653
38678
  }[];
37654
38679
  };
37655
38680
  };
@@ -74747,6 +75772,7 @@ export type Routes = {
74747
75772
  queryParams: {};
74748
75773
  jsonBody: {};
74749
75774
  commonParams: {
75775
+ customization_profile_id?: string | undefined;
74750
75776
  /** ID of the user identity for which you want to generate an instant key. */
74751
75777
  user_identity_id: string;
74752
75778
  /** Maximum number of times the instant key can be used. Default: 1. */
@@ -74772,6 +75798,17 @@ export type Routes = {
74772
75798
  user_identity_id: string;
74773
75799
  /** Date and time at which the Instant Key expires. */
74774
75800
  expires_at: string;
75801
+ /** ID of the customization profile associated with the Instant Key. */
75802
+ customization_profile_id?: string | undefined;
75803
+ /** Customization profile associated with the Instant Key. */
75804
+ customization_profile?: {
75805
+ /** Primary color of the customization profile. */
75806
+ primary_color?: string | undefined;
75807
+ /** Secondary color of the customization profile. */
75808
+ secondary_color?: string | undefined;
75809
+ /** URL of the logo associated with the customization profile. */
75810
+ logo_url?: string | undefined;
75811
+ } | undefined;
74775
75812
  };
74776
75813
  };
74777
75814
  };
@@ -83901,6 +84938,1009 @@ export type Routes = {
83901
84938
  user_identity_id: string;
83902
84939
  /** Date and time at which the Instant Key expires. */
83903
84940
  expires_at: string;
84941
+ /** ID of the customization profile associated with the Instant Key. */
84942
+ customization_profile_id?: string | undefined;
84943
+ /** Customization profile associated with the Instant Key. */
84944
+ customization_profile?: {
84945
+ /** Primary color of the customization profile. */
84946
+ primary_color?: string | undefined;
84947
+ /** Secondary color of the customization profile. */
84948
+ secondary_color?: string | undefined;
84949
+ /** URL of the logo associated with the customization profile. */
84950
+ logo_url?: string | undefined;
84951
+ } | undefined;
84952
+ }[] | undefined;
84953
+ access_codes?: {
84954
+ /** Unique identifier for a group of access codes that share the same code. */
84955
+ common_code_key: string | null;
84956
+ /** Indicates whether the code is set on the device according to a preconfigured schedule. */
84957
+ is_scheduled_on_device?: boolean | undefined;
84958
+ /** Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration. */
84959
+ type: 'time_bound' | 'ongoing';
84960
+ /** Indicates whether the access code is waiting for a code assignment. */
84961
+ is_waiting_for_code_assignment?: boolean | undefined;
84962
+ /** Unique identifier for the access code. */
84963
+ access_code_id: string;
84964
+ /** Unique identifier for the device associated with the access code. */
84965
+ device_id: string;
84966
+ /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
84967
+ name: string | null;
84968
+ /** Code used for access. Typically, a numeric or alphanumeric string. */
84969
+ code: string | null;
84970
+ /** Date and time at which the access code was created. */
84971
+ created_at: string;
84972
+ /** Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
84973
+ errors: ({
84974
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
84975
+ message: string;
84976
+ /** Indicates that this is an access code error. */
84977
+ is_access_code_error: true;
84978
+ /** Date and time at which Seam created the error. */
84979
+ created_at?: string | undefined;
84980
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
84981
+ error_code: 'smartthings_failed_to_set_access_code';
84982
+ } | {
84983
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
84984
+ message: string;
84985
+ /** Indicates that this is an access code error. */
84986
+ is_access_code_error: true;
84987
+ /** Date and time at which Seam created the error. */
84988
+ created_at?: string | undefined;
84989
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
84990
+ error_code: 'smartthings_failed_to_set_after_multiple_retries';
84991
+ } | {
84992
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
84993
+ message: string;
84994
+ /** Indicates that this is an access code error. */
84995
+ is_access_code_error: true;
84996
+ /** Date and time at which Seam created the error. */
84997
+ created_at?: string | undefined;
84998
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
84999
+ error_code: 'smartthings_no_free_slots_available';
85000
+ } | {
85001
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85002
+ message: string;
85003
+ /** Indicates that this is an access code error. */
85004
+ is_access_code_error: true;
85005
+ /** Date and time at which Seam created the error. */
85006
+ created_at?: string | undefined;
85007
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85008
+ error_code: 'failed_to_set_on_device';
85009
+ } | {
85010
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85011
+ message: string;
85012
+ /** Indicates that this is an access code error. */
85013
+ is_access_code_error: true;
85014
+ /** Date and time at which Seam created the error. */
85015
+ created_at?: string | undefined;
85016
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85017
+ error_code: 'failed_to_remove_from_device';
85018
+ } | {
85019
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85020
+ message: string;
85021
+ /** Indicates that this is an access code error. */
85022
+ is_access_code_error: true;
85023
+ /** Date and time at which Seam created the error. */
85024
+ created_at?: string | undefined;
85025
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85026
+ error_code: 'duplicate_code_on_device';
85027
+ } | {
85028
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85029
+ message: string;
85030
+ /** Indicates that this is an access code error. */
85031
+ is_access_code_error: true;
85032
+ /** Date and time at which Seam created the error. */
85033
+ created_at?: string | undefined;
85034
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85035
+ error_code: 'duplicate_code_attempt_prevented';
85036
+ } | {
85037
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85038
+ message: string;
85039
+ /** Indicates that this is an access code error. */
85040
+ is_access_code_error: true;
85041
+ /** Date and time at which Seam created the error. */
85042
+ created_at?: string | undefined;
85043
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85044
+ error_code: 'no_space_for_access_code_on_device';
85045
+ } | {
85046
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85047
+ message: string;
85048
+ /** Indicates that this is an access code error. */
85049
+ is_access_code_error: true;
85050
+ /** Date and time at which Seam created the error. */
85051
+ created_at?: string | undefined;
85052
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85053
+ error_code: 'igloohome_bridge_too_many_pending_jobs';
85054
+ } | {
85055
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85056
+ message: string;
85057
+ /** Indicates that this is an access code error. */
85058
+ is_access_code_error: true;
85059
+ /** Date and time at which Seam created the error. */
85060
+ created_at?: string | undefined;
85061
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85062
+ error_code: 'igloohome_bridge_offline';
85063
+ } | {
85064
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85065
+ message: string;
85066
+ /** Indicates that this is an access code error. */
85067
+ is_access_code_error: true;
85068
+ /** Date and time at which Seam created the error. */
85069
+ created_at?: string | undefined;
85070
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85071
+ error_code: 'igloohome_offline_access_code_no_variance_available';
85072
+ } | {
85073
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85074
+ message: string;
85075
+ /** Indicates that this is an access code error. */
85076
+ is_access_code_error: true;
85077
+ /** Date and time at which Seam created the error. */
85078
+ created_at?: string | undefined;
85079
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85080
+ error_code: 'kwikset_unable_to_confirm_code';
85081
+ } | {
85082
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85083
+ message: string;
85084
+ /** Indicates that this is an access code error. */
85085
+ is_access_code_error: true;
85086
+ /** Date and time at which Seam created the error. */
85087
+ created_at?: string | undefined;
85088
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85089
+ error_code: 'kwikset_unable_to_confirm_deletion';
85090
+ } | {
85091
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85092
+ message: string;
85093
+ /** Indicates that this is an access code error. */
85094
+ is_access_code_error: true;
85095
+ /** Date and time at which Seam created the error. */
85096
+ created_at?: string | undefined;
85097
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85098
+ error_code: 'code_modified_external_to_seam';
85099
+ } | {
85100
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85101
+ message: string;
85102
+ /** Indicates that this is an access code error. */
85103
+ is_access_code_error: true;
85104
+ /** Date and time at which Seam created the error. */
85105
+ created_at?: string | undefined;
85106
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85107
+ error_code: 'august_lock_invalid_code_length';
85108
+ } | {
85109
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85110
+ message: string;
85111
+ /** Indicates that this is an access code error. */
85112
+ is_access_code_error: true;
85113
+ /** Date and time at which Seam created the error. */
85114
+ created_at?: string | undefined;
85115
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85116
+ error_code: 'august_device_programming_delay';
85117
+ } | {
85118
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85119
+ message: string;
85120
+ /** Indicates that this is an access code error. */
85121
+ is_access_code_error: true;
85122
+ /** Date and time at which Seam created the error. */
85123
+ created_at?: string | undefined;
85124
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85125
+ error_code: 'august_device_slots_full';
85126
+ } | {
85127
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85128
+ message: string;
85129
+ /** Indicates that this is an access code error. */
85130
+ is_access_code_error: true;
85131
+ /** Date and time at which Seam created the error. */
85132
+ created_at?: string | undefined;
85133
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85134
+ error_code: 'august_lock_missing_keypad';
85135
+ } | {
85136
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85137
+ message: string;
85138
+ /** Indicates that this is an access code error. */
85139
+ is_access_code_error: true;
85140
+ /** Date and time at which Seam created the error. */
85141
+ created_at?: string | undefined;
85142
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85143
+ error_code: 'august_lock_temporarily_offline';
85144
+ } | {
85145
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85146
+ message: string;
85147
+ /** Indicates that this is an access code error. */
85148
+ is_access_code_error: true;
85149
+ /** Date and time at which Seam created the error. */
85150
+ created_at?: string | undefined;
85151
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85152
+ error_code: 'salto_ks_user_not_subscribed';
85153
+ } | {
85154
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85155
+ message: string;
85156
+ /** Indicates that this is an access code error. */
85157
+ is_access_code_error: true;
85158
+ /** Date and time at which Seam created the error. */
85159
+ created_at?: string | undefined;
85160
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85161
+ error_code: 'hubitat_device_programming_delay';
85162
+ } | {
85163
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85164
+ message: string;
85165
+ /** Indicates that this is an access code error. */
85166
+ is_access_code_error: true;
85167
+ /** Date and time at which Seam created the error. */
85168
+ created_at?: string | undefined;
85169
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85170
+ error_code: 'hubitat_no_free_positions_available';
85171
+ } | {
85172
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85173
+ message: string;
85174
+ /** Indicates that this is an access code error. */
85175
+ is_access_code_error: true;
85176
+ /** Date and time at which Seam created the error. */
85177
+ created_at?: string | undefined;
85178
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85179
+ error_code: 'wyze_duplicate_code_name';
85180
+ } | {
85181
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85182
+ message: string;
85183
+ /** Indicates that this is an access code error. */
85184
+ is_access_code_error: true;
85185
+ /** Date and time at which Seam created the error. */
85186
+ created_at?: string | undefined;
85187
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85188
+ error_code: 'wyze_potential_duplicate_code';
85189
+ } | {
85190
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85191
+ message: string;
85192
+ /** Indicates that this is an access code error. */
85193
+ is_access_code_error: true;
85194
+ /** Date and time at which Seam created the error. */
85195
+ created_at?: string | undefined;
85196
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85197
+ error_code: 'dormakaba_oracode_no_valid_user_level';
85198
+ } | {
85199
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85200
+ message: string;
85201
+ /** Indicates that the error is not a device error. */
85202
+ is_device_error: false;
85203
+ /** Date and time at which Seam created the error. */
85204
+ created_at: string;
85205
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85206
+ error_code: 'account_disconnected';
85207
+ /** Indicates that the error is a [connected account](https://docs.seam.co/latest/api/connected_accounts) error. */
85208
+ is_connected_account_error: true;
85209
+ } | {
85210
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85211
+ message: string;
85212
+ /** Indicates that the error is not a device error. */
85213
+ is_device_error: false;
85214
+ /** Date and time at which Seam created the error. */
85215
+ created_at: string;
85216
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85217
+ error_code: 'salto_ks_subscription_limit_exceeded';
85218
+ /** Indicates that the error is a [connected account](https://docs.seam.co/latest/api/connected_accounts) error. */
85219
+ is_connected_account_error: true;
85220
+ } | {
85221
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85222
+ message: string;
85223
+ /** Indicates that the error is a device error. */
85224
+ is_device_error: true;
85225
+ /** Date and time at which Seam created the error. */
85226
+ created_at: string;
85227
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85228
+ error_code: 'device_offline';
85229
+ } | {
85230
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85231
+ message: string;
85232
+ /** Indicates that the error is a device error. */
85233
+ is_device_error: true;
85234
+ /** Date and time at which Seam created the error. */
85235
+ created_at: string;
85236
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85237
+ error_code: 'device_removed';
85238
+ } | {
85239
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85240
+ message: string;
85241
+ /** Indicates that the error is a device error. */
85242
+ is_device_error: true;
85243
+ /** Date and time at which Seam created the error. */
85244
+ created_at: string;
85245
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85246
+ error_code: 'hub_disconnected';
85247
+ } | {
85248
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85249
+ message: string;
85250
+ /** Indicates that the error is a device error. */
85251
+ is_device_error: true;
85252
+ /** Date and time at which Seam created the error. */
85253
+ created_at: string;
85254
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85255
+ error_code: 'device_disconnected';
85256
+ } | {
85257
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85258
+ message: string;
85259
+ /** Indicates that the error is a device error. */
85260
+ is_device_error: true;
85261
+ /** Date and time at which Seam created the error. */
85262
+ created_at: string;
85263
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85264
+ error_code: 'empty_backup_access_code_pool';
85265
+ } | {
85266
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85267
+ message: string;
85268
+ /** Indicates that the error is a device error. */
85269
+ is_device_error: true;
85270
+ /** Date and time at which Seam created the error. */
85271
+ created_at: string;
85272
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85273
+ error_code: 'august_lock_not_authorized';
85274
+ } | {
85275
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85276
+ message: string;
85277
+ /** Indicates that the error is a device error. */
85278
+ is_device_error: true;
85279
+ /** Date and time at which Seam created the error. */
85280
+ created_at: string;
85281
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85282
+ error_code: 'august_lock_missing_bridge';
85283
+ } | {
85284
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85285
+ message: string;
85286
+ /** Indicates that the error is a device error. */
85287
+ is_device_error: true;
85288
+ /** Date and time at which Seam created the error. */
85289
+ created_at: string;
85290
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85291
+ error_code: 'ttlock_lock_not_paired_to_gateway';
85292
+ } | {
85293
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85294
+ message: string;
85295
+ /** Indicates that the error is a device error. */
85296
+ is_device_error: true;
85297
+ /** Date and time at which Seam created the error. */
85298
+ created_at: string;
85299
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85300
+ error_code: 'missing_device_credentials';
85301
+ } | {
85302
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85303
+ message: string;
85304
+ /** Indicates that the error is a device error. */
85305
+ is_device_error: true;
85306
+ /** Date and time at which Seam created the error. */
85307
+ created_at: string;
85308
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85309
+ error_code: 'auxiliary_heat_running';
85310
+ } | {
85311
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85312
+ message: string;
85313
+ /** Indicates that the error is a device error. */
85314
+ is_device_error: true;
85315
+ /** Date and time at which Seam created the error. */
85316
+ created_at: string;
85317
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85318
+ error_code: 'subscription_required';
85319
+ } | {
85320
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85321
+ message: string;
85322
+ /** Indicates that the error is a device error. */
85323
+ is_device_error: true;
85324
+ /** Date and time at which Seam created the error. */
85325
+ created_at: string;
85326
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85327
+ error_code: 'lockly_missing_wifi_bridge';
85328
+ } | {
85329
+ /** Date and time at which Seam created the error. */
85330
+ created_at: string;
85331
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85332
+ message: string;
85333
+ /** Indicates whether the error is related specifically to the connected account. */
85334
+ is_connected_account_error?: boolean | undefined;
85335
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
85336
+ is_bridge_error?: boolean | undefined;
85337
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85338
+ error_code: 'invalid_credentials';
85339
+ } | {
85340
+ /** Date and time at which Seam created the error. */
85341
+ created_at: string;
85342
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85343
+ message: string;
85344
+ /** Indicates whether the error is related specifically to the connected account. */
85345
+ is_connected_account_error?: boolean | undefined;
85346
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
85347
+ is_bridge_error?: boolean | undefined;
85348
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85349
+ error_code: 'bridge_disconnected';
85350
+ })[];
85351
+ /** Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
85352
+ warnings: ({
85353
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
85354
+ message: string;
85355
+ /** Date and time at which Seam created the warning. */
85356
+ created_at?: string | undefined;
85357
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
85358
+ warning_code: 'smartthings_failed_to_set_access_code';
85359
+ } | {
85360
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
85361
+ message: string;
85362
+ /** Date and time at which Seam created the warning. */
85363
+ created_at?: string | undefined;
85364
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
85365
+ warning_code: 'schlage_detected_duplicate';
85366
+ } | {
85367
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
85368
+ message: string;
85369
+ /** Date and time at which Seam created the warning. */
85370
+ created_at?: string | undefined;
85371
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
85372
+ warning_code: 'schlage_creation_outage';
85373
+ } | {
85374
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
85375
+ message: string;
85376
+ /** Date and time at which Seam created the warning. */
85377
+ created_at?: string | undefined;
85378
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
85379
+ warning_code: 'code_modified_external_to_seam';
85380
+ } | {
85381
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
85382
+ message: string;
85383
+ /** Date and time at which Seam created the warning. */
85384
+ created_at?: string | undefined;
85385
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
85386
+ warning_code: 'delay_in_setting_on_device';
85387
+ } | {
85388
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
85389
+ message: string;
85390
+ /** Date and time at which Seam created the warning. */
85391
+ created_at?: string | undefined;
85392
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
85393
+ warning_code: 'delay_in_removing_from_device';
85394
+ } | {
85395
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
85396
+ message: string;
85397
+ /** Date and time at which Seam created the warning. */
85398
+ created_at?: string | undefined;
85399
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
85400
+ warning_code: 'third_party_integration_detected';
85401
+ } | {
85402
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
85403
+ message: string;
85404
+ /** Date and time at which Seam created the warning. */
85405
+ created_at?: string | undefined;
85406
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
85407
+ warning_code: 'august_device_programming_delay';
85408
+ } | {
85409
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
85410
+ message: string;
85411
+ /** Date and time at which Seam created the warning. */
85412
+ created_at?: string | undefined;
85413
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85414
+ warning_code: 'august_lock_temporarily_offline';
85415
+ } | {
85416
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
85417
+ message: string;
85418
+ /** Date and time at which Seam created the warning. */
85419
+ created_at?: string | undefined;
85420
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
85421
+ warning_code: 'igloo_algopin_must_be_used_within_24_hours';
85422
+ } | {
85423
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
85424
+ message: string;
85425
+ /** Date and time at which Seam created the warning. */
85426
+ created_at?: string | undefined;
85427
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
85428
+ warning_code: 'management_transferred';
85429
+ } | {
85430
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
85431
+ message: string;
85432
+ /** Date and time at which Seam created the warning. */
85433
+ created_at?: string | undefined;
85434
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
85435
+ warning_code: 'kwikset_unable_to_confirm_code';
85436
+ })[];
85437
+ /** Indicates whether Seam manages the access code. */
85438
+ is_managed: true;
85439
+ /** Date and time at which the time-bound access code becomes active. */
85440
+ starts_at?: (string | null) | undefined;
85441
+ /** Date and time after which the time-bound access code becomes inactive. */
85442
+ ends_at?: (string | null) | undefined;
85443
+ /** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes). */
85444
+ status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
85445
+ /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
85446
+ is_backup_access_code_available: boolean;
85447
+ /** Indicates whether the access code is a backup code. */
85448
+ is_backup?: boolean | undefined;
85449
+ /** Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. */
85450
+ pulled_backup_access_code_id?: (string | null) | undefined;
85451
+ /** Indicates whether changes to the access code from external sources are permitted. */
85452
+ is_external_modification_allowed: boolean;
85453
+ /** Indicates whether the access code can only be used once. If `true`, the code becomes invalid after the first use. */
85454
+ is_one_time_use: boolean;
85455
+ /** Indicates whether the access code is intended for use in offline scenarios. If `true`, this code can be created on a device without a network connection. */
85456
+ is_offline_access_code: boolean;
85457
+ }[] | undefined;
85458
+ unmanaged_access_codes?: {
85459
+ /** Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration. */
85460
+ type: 'time_bound' | 'ongoing';
85461
+ /** Unique identifier for the access code. */
85462
+ access_code_id: string;
85463
+ /** Unique identifier for the device associated with the access code. */
85464
+ device_id: string;
85465
+ /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
85466
+ name: string | null;
85467
+ /** Code used for access. Typically, a numeric or alphanumeric string. */
85468
+ code: string | null;
85469
+ /** Date and time at which the access code was created. */
85470
+ created_at: string;
85471
+ /** Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
85472
+ errors: ({
85473
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85474
+ message: string;
85475
+ /** Indicates that this is an access code error. */
85476
+ is_access_code_error: true;
85477
+ /** Date and time at which Seam created the error. */
85478
+ created_at?: string | undefined;
85479
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85480
+ error_code: 'smartthings_failed_to_set_access_code';
85481
+ } | {
85482
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85483
+ message: string;
85484
+ /** Indicates that this is an access code error. */
85485
+ is_access_code_error: true;
85486
+ /** Date and time at which Seam created the error. */
85487
+ created_at?: string | undefined;
85488
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85489
+ error_code: 'smartthings_failed_to_set_after_multiple_retries';
85490
+ } | {
85491
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85492
+ message: string;
85493
+ /** Indicates that this is an access code error. */
85494
+ is_access_code_error: true;
85495
+ /** Date and time at which Seam created the error. */
85496
+ created_at?: string | undefined;
85497
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85498
+ error_code: 'smartthings_no_free_slots_available';
85499
+ } | {
85500
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85501
+ message: string;
85502
+ /** Indicates that this is an access code error. */
85503
+ is_access_code_error: true;
85504
+ /** Date and time at which Seam created the error. */
85505
+ created_at?: string | undefined;
85506
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85507
+ error_code: 'failed_to_set_on_device';
85508
+ } | {
85509
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85510
+ message: string;
85511
+ /** Indicates that this is an access code error. */
85512
+ is_access_code_error: true;
85513
+ /** Date and time at which Seam created the error. */
85514
+ created_at?: string | undefined;
85515
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85516
+ error_code: 'failed_to_remove_from_device';
85517
+ } | {
85518
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85519
+ message: string;
85520
+ /** Indicates that this is an access code error. */
85521
+ is_access_code_error: true;
85522
+ /** Date and time at which Seam created the error. */
85523
+ created_at?: string | undefined;
85524
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85525
+ error_code: 'duplicate_code_on_device';
85526
+ } | {
85527
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85528
+ message: string;
85529
+ /** Indicates that this is an access code error. */
85530
+ is_access_code_error: true;
85531
+ /** Date and time at which Seam created the error. */
85532
+ created_at?: string | undefined;
85533
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85534
+ error_code: 'duplicate_code_attempt_prevented';
85535
+ } | {
85536
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85537
+ message: string;
85538
+ /** Indicates that this is an access code error. */
85539
+ is_access_code_error: true;
85540
+ /** Date and time at which Seam created the error. */
85541
+ created_at?: string | undefined;
85542
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85543
+ error_code: 'no_space_for_access_code_on_device';
85544
+ } | {
85545
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85546
+ message: string;
85547
+ /** Indicates that this is an access code error. */
85548
+ is_access_code_error: true;
85549
+ /** Date and time at which Seam created the error. */
85550
+ created_at?: string | undefined;
85551
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85552
+ error_code: 'igloohome_bridge_too_many_pending_jobs';
85553
+ } | {
85554
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85555
+ message: string;
85556
+ /** Indicates that this is an access code error. */
85557
+ is_access_code_error: true;
85558
+ /** Date and time at which Seam created the error. */
85559
+ created_at?: string | undefined;
85560
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85561
+ error_code: 'igloohome_bridge_offline';
85562
+ } | {
85563
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85564
+ message: string;
85565
+ /** Indicates that this is an access code error. */
85566
+ is_access_code_error: true;
85567
+ /** Date and time at which Seam created the error. */
85568
+ created_at?: string | undefined;
85569
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85570
+ error_code: 'igloohome_offline_access_code_no_variance_available';
85571
+ } | {
85572
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85573
+ message: string;
85574
+ /** Indicates that this is an access code error. */
85575
+ is_access_code_error: true;
85576
+ /** Date and time at which Seam created the error. */
85577
+ created_at?: string | undefined;
85578
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85579
+ error_code: 'kwikset_unable_to_confirm_code';
85580
+ } | {
85581
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85582
+ message: string;
85583
+ /** Indicates that this is an access code error. */
85584
+ is_access_code_error: true;
85585
+ /** Date and time at which Seam created the error. */
85586
+ created_at?: string | undefined;
85587
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85588
+ error_code: 'kwikset_unable_to_confirm_deletion';
85589
+ } | {
85590
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85591
+ message: string;
85592
+ /** Indicates that this is an access code error. */
85593
+ is_access_code_error: true;
85594
+ /** Date and time at which Seam created the error. */
85595
+ created_at?: string | undefined;
85596
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85597
+ error_code: 'code_modified_external_to_seam';
85598
+ } | {
85599
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85600
+ message: string;
85601
+ /** Indicates that this is an access code error. */
85602
+ is_access_code_error: true;
85603
+ /** Date and time at which Seam created the error. */
85604
+ created_at?: string | undefined;
85605
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85606
+ error_code: 'august_lock_invalid_code_length';
85607
+ } | {
85608
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85609
+ message: string;
85610
+ /** Indicates that this is an access code error. */
85611
+ is_access_code_error: true;
85612
+ /** Date and time at which Seam created the error. */
85613
+ created_at?: string | undefined;
85614
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85615
+ error_code: 'august_device_programming_delay';
85616
+ } | {
85617
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85618
+ message: string;
85619
+ /** Indicates that this is an access code error. */
85620
+ is_access_code_error: true;
85621
+ /** Date and time at which Seam created the error. */
85622
+ created_at?: string | undefined;
85623
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85624
+ error_code: 'august_device_slots_full';
85625
+ } | {
85626
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85627
+ message: string;
85628
+ /** Indicates that this is an access code error. */
85629
+ is_access_code_error: true;
85630
+ /** Date and time at which Seam created the error. */
85631
+ created_at?: string | undefined;
85632
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85633
+ error_code: 'august_lock_missing_keypad';
85634
+ } | {
85635
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85636
+ message: string;
85637
+ /** Indicates that this is an access code error. */
85638
+ is_access_code_error: true;
85639
+ /** Date and time at which Seam created the error. */
85640
+ created_at?: string | undefined;
85641
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85642
+ error_code: 'august_lock_temporarily_offline';
85643
+ } | {
85644
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85645
+ message: string;
85646
+ /** Indicates that this is an access code error. */
85647
+ is_access_code_error: true;
85648
+ /** Date and time at which Seam created the error. */
85649
+ created_at?: string | undefined;
85650
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85651
+ error_code: 'salto_ks_user_not_subscribed';
85652
+ } | {
85653
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85654
+ message: string;
85655
+ /** Indicates that this is an access code error. */
85656
+ is_access_code_error: true;
85657
+ /** Date and time at which Seam created the error. */
85658
+ created_at?: string | undefined;
85659
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85660
+ error_code: 'hubitat_device_programming_delay';
85661
+ } | {
85662
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85663
+ message: string;
85664
+ /** Indicates that this is an access code error. */
85665
+ is_access_code_error: true;
85666
+ /** Date and time at which Seam created the error. */
85667
+ created_at?: string | undefined;
85668
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85669
+ error_code: 'hubitat_no_free_positions_available';
85670
+ } | {
85671
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85672
+ message: string;
85673
+ /** Indicates that this is an access code error. */
85674
+ is_access_code_error: true;
85675
+ /** Date and time at which Seam created the error. */
85676
+ created_at?: string | undefined;
85677
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85678
+ error_code: 'wyze_duplicate_code_name';
85679
+ } | {
85680
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85681
+ message: string;
85682
+ /** Indicates that this is an access code error. */
85683
+ is_access_code_error: true;
85684
+ /** Date and time at which Seam created the error. */
85685
+ created_at?: string | undefined;
85686
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85687
+ error_code: 'wyze_potential_duplicate_code';
85688
+ } | {
85689
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85690
+ message: string;
85691
+ /** Indicates that this is an access code error. */
85692
+ is_access_code_error: true;
85693
+ /** Date and time at which Seam created the error. */
85694
+ created_at?: string | undefined;
85695
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85696
+ error_code: 'dormakaba_oracode_no_valid_user_level';
85697
+ } | {
85698
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85699
+ message: string;
85700
+ /** Indicates that the error is not a device error. */
85701
+ is_device_error: false;
85702
+ /** Date and time at which Seam created the error. */
85703
+ created_at: string;
85704
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85705
+ error_code: 'account_disconnected';
85706
+ /** Indicates that the error is a [connected account](https://docs.seam.co/latest/api/connected_accounts) error. */
85707
+ is_connected_account_error: true;
85708
+ } | {
85709
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85710
+ message: string;
85711
+ /** Indicates that the error is not a device error. */
85712
+ is_device_error: false;
85713
+ /** Date and time at which Seam created the error. */
85714
+ created_at: string;
85715
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85716
+ error_code: 'salto_ks_subscription_limit_exceeded';
85717
+ /** Indicates that the error is a [connected account](https://docs.seam.co/latest/api/connected_accounts) error. */
85718
+ is_connected_account_error: true;
85719
+ } | {
85720
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85721
+ message: string;
85722
+ /** Indicates that the error is a device error. */
85723
+ is_device_error: true;
85724
+ /** Date and time at which Seam created the error. */
85725
+ created_at: string;
85726
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85727
+ error_code: 'device_offline';
85728
+ } | {
85729
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85730
+ message: string;
85731
+ /** Indicates that the error is a device error. */
85732
+ is_device_error: true;
85733
+ /** Date and time at which Seam created the error. */
85734
+ created_at: string;
85735
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85736
+ error_code: 'device_removed';
85737
+ } | {
85738
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85739
+ message: string;
85740
+ /** Indicates that the error is a device error. */
85741
+ is_device_error: true;
85742
+ /** Date and time at which Seam created the error. */
85743
+ created_at: string;
85744
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85745
+ error_code: 'hub_disconnected';
85746
+ } | {
85747
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85748
+ message: string;
85749
+ /** Indicates that the error is a device error. */
85750
+ is_device_error: true;
85751
+ /** Date and time at which Seam created the error. */
85752
+ created_at: string;
85753
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85754
+ error_code: 'device_disconnected';
85755
+ } | {
85756
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85757
+ message: string;
85758
+ /** Indicates that the error is a device error. */
85759
+ is_device_error: true;
85760
+ /** Date and time at which Seam created the error. */
85761
+ created_at: string;
85762
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85763
+ error_code: 'empty_backup_access_code_pool';
85764
+ } | {
85765
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85766
+ message: string;
85767
+ /** Indicates that the error is a device error. */
85768
+ is_device_error: true;
85769
+ /** Date and time at which Seam created the error. */
85770
+ created_at: string;
85771
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85772
+ error_code: 'august_lock_not_authorized';
85773
+ } | {
85774
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85775
+ message: string;
85776
+ /** Indicates that the error is a device error. */
85777
+ is_device_error: true;
85778
+ /** Date and time at which Seam created the error. */
85779
+ created_at: string;
85780
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85781
+ error_code: 'august_lock_missing_bridge';
85782
+ } | {
85783
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85784
+ message: string;
85785
+ /** Indicates that the error is a device error. */
85786
+ is_device_error: true;
85787
+ /** Date and time at which Seam created the error. */
85788
+ created_at: string;
85789
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85790
+ error_code: 'ttlock_lock_not_paired_to_gateway';
85791
+ } | {
85792
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85793
+ message: string;
85794
+ /** Indicates that the error is a device error. */
85795
+ is_device_error: true;
85796
+ /** Date and time at which Seam created the error. */
85797
+ created_at: string;
85798
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85799
+ error_code: 'missing_device_credentials';
85800
+ } | {
85801
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85802
+ message: string;
85803
+ /** Indicates that the error is a device error. */
85804
+ is_device_error: true;
85805
+ /** Date and time at which Seam created the error. */
85806
+ created_at: string;
85807
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85808
+ error_code: 'auxiliary_heat_running';
85809
+ } | {
85810
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85811
+ message: string;
85812
+ /** Indicates that the error is a device error. */
85813
+ is_device_error: true;
85814
+ /** Date and time at which Seam created the error. */
85815
+ created_at: string;
85816
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85817
+ error_code: 'subscription_required';
85818
+ } | {
85819
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85820
+ message: string;
85821
+ /** Indicates that the error is a device error. */
85822
+ is_device_error: true;
85823
+ /** Date and time at which Seam created the error. */
85824
+ created_at: string;
85825
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85826
+ error_code: 'lockly_missing_wifi_bridge';
85827
+ } | {
85828
+ /** Date and time at which Seam created the error. */
85829
+ created_at: string;
85830
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85831
+ message: string;
85832
+ /** Indicates whether the error is related specifically to the connected account. */
85833
+ is_connected_account_error?: boolean | undefined;
85834
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
85835
+ is_bridge_error?: boolean | undefined;
85836
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85837
+ error_code: 'invalid_credentials';
85838
+ } | {
85839
+ /** Date and time at which Seam created the error. */
85840
+ created_at: string;
85841
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85842
+ message: string;
85843
+ /** Indicates whether the error is related specifically to the connected account. */
85844
+ is_connected_account_error?: boolean | undefined;
85845
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
85846
+ is_bridge_error?: boolean | undefined;
85847
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85848
+ error_code: 'bridge_disconnected';
85849
+ })[];
85850
+ /** Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
85851
+ warnings: ({
85852
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
85853
+ message: string;
85854
+ /** Date and time at which Seam created the warning. */
85855
+ created_at?: string | undefined;
85856
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
85857
+ warning_code: 'smartthings_failed_to_set_access_code';
85858
+ } | {
85859
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
85860
+ message: string;
85861
+ /** Date and time at which Seam created the warning. */
85862
+ created_at?: string | undefined;
85863
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
85864
+ warning_code: 'schlage_detected_duplicate';
85865
+ } | {
85866
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
85867
+ message: string;
85868
+ /** Date and time at which Seam created the warning. */
85869
+ created_at?: string | undefined;
85870
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
85871
+ warning_code: 'schlage_creation_outage';
85872
+ } | {
85873
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
85874
+ message: string;
85875
+ /** Date and time at which Seam created the warning. */
85876
+ created_at?: string | undefined;
85877
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
85878
+ warning_code: 'code_modified_external_to_seam';
85879
+ } | {
85880
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
85881
+ message: string;
85882
+ /** Date and time at which Seam created the warning. */
85883
+ created_at?: string | undefined;
85884
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
85885
+ warning_code: 'delay_in_setting_on_device';
85886
+ } | {
85887
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
85888
+ message: string;
85889
+ /** Date and time at which Seam created the warning. */
85890
+ created_at?: string | undefined;
85891
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
85892
+ warning_code: 'delay_in_removing_from_device';
85893
+ } | {
85894
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
85895
+ message: string;
85896
+ /** Date and time at which Seam created the warning. */
85897
+ created_at?: string | undefined;
85898
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
85899
+ warning_code: 'third_party_integration_detected';
85900
+ } | {
85901
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
85902
+ message: string;
85903
+ /** Date and time at which Seam created the warning. */
85904
+ created_at?: string | undefined;
85905
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
85906
+ warning_code: 'august_device_programming_delay';
85907
+ } | {
85908
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
85909
+ message: string;
85910
+ /** Date and time at which Seam created the warning. */
85911
+ created_at?: string | undefined;
85912
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
85913
+ warning_code: 'august_lock_temporarily_offline';
85914
+ } | {
85915
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
85916
+ message: string;
85917
+ /** Date and time at which Seam created the warning. */
85918
+ created_at?: string | undefined;
85919
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
85920
+ warning_code: 'igloo_algopin_must_be_used_within_24_hours';
85921
+ } | {
85922
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
85923
+ message: string;
85924
+ /** Date and time at which Seam created the warning. */
85925
+ created_at?: string | undefined;
85926
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
85927
+ warning_code: 'management_transferred';
85928
+ } | {
85929
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
85930
+ message: string;
85931
+ /** Date and time at which Seam created the warning. */
85932
+ created_at?: string | undefined;
85933
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
85934
+ warning_code: 'kwikset_unable_to_confirm_code';
85935
+ })[];
85936
+ /** Indicates that Seam does not manage the access code. */
85937
+ is_managed: false;
85938
+ /** Date and time at which the time-bound access code becomes active. */
85939
+ starts_at?: (string | null) | undefined;
85940
+ /** Date and time after which the time-bound access code becomes inactive. */
85941
+ ends_at?: (string | null) | undefined;
85942
+ /** Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational. */
85943
+ status: 'set';
83904
85944
  }[] | undefined;
83905
85945
  };
83906
85946
  };