@seamapi/types 1.749.0 → 1.751.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.
@@ -11918,6 +11918,8 @@ export type Routes = {
11918
11918
  can_unlock_with_code?: boolean | undefined;
11919
11919
  /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
11920
11920
  can_belong_to_reservation?: boolean | undefined;
11921
+ /** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
11922
+ can_unlock_with_cloud_key?: boolean | undefined;
11921
11923
  }[] | undefined;
11922
11924
  connected_accounts?: {
11923
11925
  /** ID of the connected account. */
@@ -16129,6 +16131,8 @@ export type Routes = {
16129
16131
  can_unlock_with_code?: boolean | undefined;
16130
16132
  /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
16131
16133
  can_belong_to_reservation?: boolean | undefined;
16134
+ /** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
16135
+ can_unlock_with_cloud_key?: boolean | undefined;
16132
16136
  }[] | undefined;
16133
16137
  access_grants?: {
16134
16138
  /** ID of the Seam workspace associated with the Access Grant. */
@@ -17469,6 +17473,8 @@ export type Routes = {
17469
17473
  can_unlock_with_code?: boolean | undefined;
17470
17474
  /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
17471
17475
  can_belong_to_reservation?: boolean | undefined;
17476
+ /** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
17477
+ can_unlock_with_cloud_key?: boolean | undefined;
17472
17478
  }[];
17473
17479
  };
17474
17480
  maxDuration: undefined;
@@ -19127,6 +19133,8 @@ export type Routes = {
19127
19133
  can_unlock_with_code?: boolean | undefined;
19128
19134
  /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
19129
19135
  can_belong_to_reservation?: boolean | undefined;
19136
+ /** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
19137
+ can_unlock_with_cloud_key?: boolean | undefined;
19130
19138
  }[];
19131
19139
  };
19132
19140
  maxDuration: undefined;
@@ -22631,6 +22639,8 @@ export type Routes = {
22631
22639
  can_unlock_with_code?: boolean | undefined;
22632
22640
  /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
22633
22641
  can_belong_to_reservation?: boolean | undefined;
22642
+ /** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
22643
+ can_unlock_with_cloud_key?: boolean | undefined;
22634
22644
  };
22635
22645
  };
22636
22646
  maxDuration: undefined;
@@ -22810,6 +22820,8 @@ export type Routes = {
22810
22820
  can_unlock_with_code?: boolean | undefined;
22811
22821
  /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
22812
22822
  can_belong_to_reservation?: boolean | undefined;
22823
+ /** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
22824
+ can_unlock_with_cloud_key?: boolean | undefined;
22813
22825
  }[];
22814
22826
  /** Information about the current page of results. */
22815
22827
  pagination: {
@@ -22970,6 +22982,1283 @@ export type Routes = {
22970
22982
  };
22971
22983
  maxDuration: undefined;
22972
22984
  };
22985
+ '/acs/entrances/unlock': {
22986
+ route: '/acs/entrances/unlock';
22987
+ method: 'POST';
22988
+ queryParams: {};
22989
+ jsonBody: {};
22990
+ commonParams: {
22991
+ /** ID of the entrance to unlock. */
22992
+ acs_entrance_id: string;
22993
+ /** ID of the cloud_key credential to use for the unlock operation. */
22994
+ acs_credential_id: string;
22995
+ };
22996
+ formData: {};
22997
+ jsonResponse: {
22998
+ /** Represents an action attempt that enables you to keep track of the progress of your action that affects a physical device or system.actions against a device. Action attempts are useful because the physical world is intrinsically asynchronous.
22999
+
23000
+ When you request for a device to perform an action, the Seam API immediately returns an action attempt object. In the background, the Seam API performs the action.
23001
+
23002
+ See also [Action Attempts](https://docs.seam.co/latest/core-concepts/action-attempts). */
23003
+ action_attempt: {
23004
+ /** ID of the action attempt. */
23005
+ action_attempt_id: string;
23006
+ status: 'pending';
23007
+ /** Result of the action attempt. Null for pending action attempts. */
23008
+ result: null;
23009
+ /** Errors associated with the action attempt. Null for pending action attempts. */
23010
+ error: null;
23011
+ /** Action attempt to track the status of locking a door. */
23012
+ action_type: 'LOCK_DOOR';
23013
+ } | {
23014
+ /** ID of the action attempt. */
23015
+ action_attempt_id: string;
23016
+ status: 'success';
23017
+ /** Errors associated with the action attempt. Null for successful action attempts. */
23018
+ error: null;
23019
+ /** Action attempt to track the status of locking a door. */
23020
+ action_type: 'LOCK_DOOR';
23021
+ /** Result of the action. */
23022
+ result: {
23023
+ /** Indicates whether the device confirmed that the lock action occurred. */
23024
+ was_confirmed_by_device?: boolean | undefined;
23025
+ };
23026
+ } | {
23027
+ /** ID of the action attempt. */
23028
+ action_attempt_id: string;
23029
+ status: 'error';
23030
+ /** Result of the action attempt. Null for failed action attempts. */
23031
+ result: null;
23032
+ /** Action attempt to track the status of locking a door. */
23033
+ action_type: 'LOCK_DOOR';
23034
+ /** Error associated with the action. */
23035
+ error: {
23036
+ /** Type of the error. */
23037
+ type: string;
23038
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23039
+ message: string;
23040
+ };
23041
+ } | {
23042
+ /** ID of the action attempt. */
23043
+ action_attempt_id: string;
23044
+ status: 'pending';
23045
+ /** Result of the action attempt. Null for pending action attempts. */
23046
+ result: null;
23047
+ /** Errors associated with the action attempt. Null for pending action attempts. */
23048
+ error: null;
23049
+ /** Action attempt to track the status of unlocking a door. */
23050
+ action_type: 'UNLOCK_DOOR';
23051
+ } | {
23052
+ /** ID of the action attempt. */
23053
+ action_attempt_id: string;
23054
+ status: 'success';
23055
+ /** Errors associated with the action attempt. Null for successful action attempts. */
23056
+ error: null;
23057
+ /** Action attempt to track the status of unlocking a door. */
23058
+ action_type: 'UNLOCK_DOOR';
23059
+ /** Result of the action. */
23060
+ result: {
23061
+ /** Indicates whether the device confirmed that the unlock action occurred. */
23062
+ was_confirmed_by_device?: boolean | undefined;
23063
+ };
23064
+ } | {
23065
+ /** ID of the action attempt. */
23066
+ action_attempt_id: string;
23067
+ status: 'error';
23068
+ /** Result of the action attempt. Null for failed action attempts. */
23069
+ result: null;
23070
+ /** Action attempt to track the status of unlocking a door. */
23071
+ action_type: 'UNLOCK_DOOR';
23072
+ /** Error associated with the action. */
23073
+ error: {
23074
+ /** Type of the error. */
23075
+ type: string;
23076
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23077
+ message: string;
23078
+ };
23079
+ } | {
23080
+ /** ID of the action attempt. */
23081
+ action_attempt_id: string;
23082
+ status: 'pending';
23083
+ /** Result of the action attempt. Null for pending action attempts. */
23084
+ result: null;
23085
+ /** Errors associated with the action attempt. Null for pending action attempts. */
23086
+ error: null;
23087
+ /** Action attempt to track the status of scanning a credential. */
23088
+ action_type: 'SCAN_CREDENTIAL';
23089
+ } | {
23090
+ /** ID of the action attempt. */
23091
+ action_attempt_id: string;
23092
+ status: 'success';
23093
+ /** Errors associated with the action attempt. Null for successful action attempts. */
23094
+ error: null;
23095
+ /** Action attempt to track the status of scanning a credential. */
23096
+ action_type: 'SCAN_CREDENTIAL';
23097
+ /** Result of scanning a card. If the attempt was successful, includes a snapshot of credential data read from the physical encoder, the corresponding data stored on Seam and the access system, and any associated warnings. */
23098
+ result: {
23099
+ /** Snapshot of credential data read from the physical encoder. */
23100
+ acs_credential_on_encoder: {
23101
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
23102
+ created_at: string | null;
23103
+ is_issued: boolean | null;
23104
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) becomes usable. */
23105
+ starts_at: string | null;
23106
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) will stop being usable. */
23107
+ ends_at: string | null;
23108
+ /** A number or string that physically identifies the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23109
+ card_number: string | null;
23110
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23111
+ visionline_metadata?: {
23112
+ /** Card ID for the Visionline card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23113
+ card_id: string;
23114
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is cancelled. */
23115
+ cancelled: boolean;
23116
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is discarded. */
23117
+ discarded: boolean;
23118
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is expired. */
23119
+ expired: boolean;
23120
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overwritten. */
23121
+ overwritten: boolean;
23122
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overridden. */
23123
+ overridden?: boolean | undefined;
23124
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is pending auto-update. */
23125
+ pending_auto_update: boolean;
23126
+ /** Format of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23127
+ card_format: 'TLCode' | 'rfid48';
23128
+ /** Holder of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23129
+ card_holder?: string | undefined;
23130
+ /** Number of issued cards associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23131
+ number_of_issued_cards: number;
23132
+ /** IDs of the guest [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23133
+ guest_acs_entrance_ids?: string[] | undefined;
23134
+ /** IDs of the common [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23135
+ common_acs_entrance_ids?: string[] | undefined;
23136
+ } | undefined;
23137
+ } | null;
23138
+ /** Corresponding credential data as stored on Seam and the access system. */
23139
+ acs_credential_on_seam: ({
23140
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23141
+ acs_credential_id: string;
23142
+ /** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
23143
+ acs_user_id?: string | undefined;
23144
+ /** ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
23145
+ user_identity_id?: string | undefined;
23146
+ /** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
23147
+ connected_account_id: string;
23148
+ acs_credential_pool_id?: string | undefined;
23149
+ /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23150
+ acs_system_id: string;
23151
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23152
+ parent_acs_credential_id?: string | undefined;
23153
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
23154
+ display_name: string;
23155
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23156
+ code?: (string | undefined) | null;
23157
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
23158
+ is_one_time_use?: boolean | undefined;
23159
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23160
+ card_number?: (string | undefined) | null;
23161
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
23162
+ is_issued?: boolean | undefined;
23163
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
23164
+ issued_at?: (string | undefined) | null;
23165
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
23166
+ access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
23167
+ /** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
23168
+ external_type?: ('pti_card' | 'brivo_credential' | 'brivo_digital_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key' | 'latch_access' | 'dormakaba_ambiance_credential' | 'hotek_card') | undefined;
23169
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
23170
+ external_type_display_name?: string | undefined;
23171
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
23172
+ created_at: string;
23173
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23174
+ workspace_id: string;
23175
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
23176
+ starts_at?: string | undefined;
23177
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
23178
+ ends_at?: string | undefined;
23179
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23180
+ errors: {
23181
+ error_code: string;
23182
+ message: string;
23183
+ }[];
23184
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23185
+ warnings: ({
23186
+ /** Date and time at which Seam created the warning. */
23187
+ created_at: string;
23188
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23189
+ message: string;
23190
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23191
+ warning_code: 'waiting_to_be_issued';
23192
+ } | {
23193
+ /** Date and time at which Seam created the warning. */
23194
+ created_at: string;
23195
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23196
+ message: string;
23197
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23198
+ warning_code: 'schedule_externally_modified';
23199
+ } | {
23200
+ /** Date and time at which Seam created the warning. */
23201
+ created_at: string;
23202
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23203
+ message: string;
23204
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23205
+ warning_code: 'schedule_modified';
23206
+ } | {
23207
+ /** Date and time at which Seam created the warning. */
23208
+ created_at: string;
23209
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23210
+ message: string;
23211
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23212
+ warning_code: 'being_deleted';
23213
+ } | {
23214
+ /** Date and time at which Seam created the warning. */
23215
+ created_at: string;
23216
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23217
+ message: string;
23218
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23219
+ warning_code: 'unknown_issue_with_acs_credential';
23220
+ } | {
23221
+ /** Date and time at which Seam created the warning. */
23222
+ created_at: string;
23223
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23224
+ message: string;
23225
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23226
+ warning_code: 'needs_to_be_reissued';
23227
+ })[];
23228
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
23229
+ is_multi_phone_sync_credential?: boolean | undefined;
23230
+ /** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
23231
+ is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
23232
+ /** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
23233
+ latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
23234
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23235
+ visionline_metadata?: {
23236
+ /** Card function type in the Visionline access system. */
23237
+ card_function_type: 'guest' | 'staff';
23238
+ /** IDs of the credentials to which you want to join. */
23239
+ joiner_acs_credential_ids?: string[] | undefined;
23240
+ /** Guest entrance IDs in the Visionline access system. */
23241
+ guest_acs_entrance_ids?: string[] | undefined;
23242
+ /** Common entrance IDs in the Visionline access system. */
23243
+ common_acs_entrance_ids?: string[] | undefined;
23244
+ /** Indicates whether the credential is valid. */
23245
+ is_valid?: boolean | undefined;
23246
+ /** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
23247
+ auto_join?: boolean | undefined;
23248
+ /** ID of the card in the Visionline access system. */
23249
+ card_id?: string | undefined;
23250
+ /** ID of the credential in the Visionline access system. */
23251
+ credential_id?: string | undefined;
23252
+ } | undefined;
23253
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23254
+ assa_abloy_vostio_metadata?: {
23255
+ /** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
23256
+ auto_join?: boolean | undefined;
23257
+ /** IDs of the guest entrances to override in the Vostio access system. */
23258
+ override_guest_acs_entrance_ids?: string[] | undefined;
23259
+ /** Key ID in the Vostio access system. */
23260
+ key_id?: string | undefined;
23261
+ /** Key issuing request ID in the Vostio access system. */
23262
+ key_issuing_request_id?: string | undefined;
23263
+ /** Names of the doors to which to grant access in the Vostio access system. */
23264
+ door_names?: string[] | undefined;
23265
+ /** Endpoint ID in the Vostio access system. */
23266
+ endpoint_id?: string | undefined;
23267
+ } | undefined;
23268
+ is_managed: true;
23269
+ } | {
23270
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23271
+ acs_credential_id: string;
23272
+ /** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
23273
+ acs_user_id?: string | undefined;
23274
+ /** ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
23275
+ user_identity_id?: string | undefined;
23276
+ /** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
23277
+ connected_account_id: string;
23278
+ acs_credential_pool_id?: string | undefined;
23279
+ /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23280
+ acs_system_id: string;
23281
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23282
+ parent_acs_credential_id?: string | undefined;
23283
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
23284
+ display_name: string;
23285
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23286
+ code?: (string | undefined) | null;
23287
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
23288
+ is_one_time_use?: boolean | undefined;
23289
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23290
+ card_number?: (string | undefined) | null;
23291
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
23292
+ is_issued?: boolean | undefined;
23293
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
23294
+ issued_at?: (string | undefined) | null;
23295
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
23296
+ access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
23297
+ /** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
23298
+ external_type?: ('pti_card' | 'brivo_credential' | 'brivo_digital_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key' | 'latch_access' | 'dormakaba_ambiance_credential' | 'hotek_card') | undefined;
23299
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
23300
+ external_type_display_name?: string | undefined;
23301
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
23302
+ created_at: string;
23303
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23304
+ workspace_id: string;
23305
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
23306
+ starts_at?: string | undefined;
23307
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
23308
+ ends_at?: string | undefined;
23309
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23310
+ errors: {
23311
+ error_code: string;
23312
+ message: string;
23313
+ }[];
23314
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23315
+ warnings: ({
23316
+ /** Date and time at which Seam created the warning. */
23317
+ created_at: string;
23318
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23319
+ message: string;
23320
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23321
+ warning_code: 'waiting_to_be_issued';
23322
+ } | {
23323
+ /** Date and time at which Seam created the warning. */
23324
+ created_at: string;
23325
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23326
+ message: string;
23327
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23328
+ warning_code: 'schedule_externally_modified';
23329
+ } | {
23330
+ /** Date and time at which Seam created the warning. */
23331
+ created_at: string;
23332
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23333
+ message: string;
23334
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23335
+ warning_code: 'schedule_modified';
23336
+ } | {
23337
+ /** Date and time at which Seam created the warning. */
23338
+ created_at: string;
23339
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23340
+ message: string;
23341
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23342
+ warning_code: 'being_deleted';
23343
+ } | {
23344
+ /** Date and time at which Seam created the warning. */
23345
+ created_at: string;
23346
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23347
+ message: string;
23348
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23349
+ warning_code: 'unknown_issue_with_acs_credential';
23350
+ } | {
23351
+ /** Date and time at which Seam created the warning. */
23352
+ created_at: string;
23353
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23354
+ message: string;
23355
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23356
+ warning_code: 'needs_to_be_reissued';
23357
+ })[];
23358
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
23359
+ is_multi_phone_sync_credential?: boolean | undefined;
23360
+ /** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
23361
+ is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
23362
+ /** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
23363
+ latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
23364
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23365
+ visionline_metadata?: {
23366
+ /** Card function type in the Visionline access system. */
23367
+ card_function_type: 'guest' | 'staff';
23368
+ /** IDs of the credentials to which you want to join. */
23369
+ joiner_acs_credential_ids?: string[] | undefined;
23370
+ /** Guest entrance IDs in the Visionline access system. */
23371
+ guest_acs_entrance_ids?: string[] | undefined;
23372
+ /** Common entrance IDs in the Visionline access system. */
23373
+ common_acs_entrance_ids?: string[] | undefined;
23374
+ /** Indicates whether the credential is valid. */
23375
+ is_valid?: boolean | undefined;
23376
+ /** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
23377
+ auto_join?: boolean | undefined;
23378
+ /** ID of the card in the Visionline access system. */
23379
+ card_id?: string | undefined;
23380
+ /** ID of the credential in the Visionline access system. */
23381
+ credential_id?: string | undefined;
23382
+ } | undefined;
23383
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23384
+ assa_abloy_vostio_metadata?: {
23385
+ /** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
23386
+ auto_join?: boolean | undefined;
23387
+ /** IDs of the guest entrances to override in the Vostio access system. */
23388
+ override_guest_acs_entrance_ids?: string[] | undefined;
23389
+ /** Key ID in the Vostio access system. */
23390
+ key_id?: string | undefined;
23391
+ /** Key issuing request ID in the Vostio access system. */
23392
+ key_issuing_request_id?: string | undefined;
23393
+ /** Names of the doors to which to grant access in the Vostio access system. */
23394
+ door_names?: string[] | undefined;
23395
+ /** Endpoint ID in the Vostio access system. */
23396
+ endpoint_id?: string | undefined;
23397
+ } | undefined;
23398
+ is_managed: false;
23399
+ }) | null;
23400
+ /** Warnings related to scanning the credential, such as mismatches between the credential data currently encoded on the card and the corresponding data stored on Seam and the access system. */
23401
+ warnings: {
23402
+ /** Indicates a warning related to scanning a credential. */
23403
+ warning_code: 'acs_credential_on_encoder_out_of_sync' | 'acs_credential_on_seam_not_found';
23404
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23405
+ warning_message: string;
23406
+ }[];
23407
+ };
23408
+ } | {
23409
+ /** ID of the action attempt. */
23410
+ action_attempt_id: string;
23411
+ status: 'error';
23412
+ /** Result of the action attempt. Null for failed action attempts. */
23413
+ result: null;
23414
+ /** Action attempt to track the status of scanning a credential. */
23415
+ action_type: 'SCAN_CREDENTIAL';
23416
+ error: {
23417
+ /** Type of the error associated with the action attempt. */
23418
+ type: 'uncategorized_error';
23419
+ /** Message for the error associated with the action attempt. */
23420
+ message: string;
23421
+ } | {
23422
+ /** Type of the error associated with the action attempt. */
23423
+ type: 'action_attempt_expired';
23424
+ /** Message for the error associated with the action attempt. */
23425
+ message: string;
23426
+ } | {
23427
+ /** Error type to indicate that there is no credential on the encoder. */
23428
+ type: 'no_credential_on_encoder';
23429
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23430
+ message: string;
23431
+ } | {
23432
+ /** Error type to indicate that the encoder is not online. */
23433
+ type: 'encoder_not_online';
23434
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23435
+ message: string;
23436
+ };
23437
+ } | {
23438
+ /** ID of the action attempt. */
23439
+ action_attempt_id: string;
23440
+ status: 'pending';
23441
+ /** Result of the action attempt. Null for pending action attempts. */
23442
+ result: null;
23443
+ /** Errors associated with the action attempt. Null for pending action attempts. */
23444
+ error: null;
23445
+ /** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
23446
+ action_type: 'ENCODE_CREDENTIAL';
23447
+ } | {
23448
+ /** ID of the action attempt. */
23449
+ action_attempt_id: string;
23450
+ status: 'success';
23451
+ /** Errors associated with the action attempt. Null for successful action attempts. */
23452
+ error: null;
23453
+ /** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
23454
+ action_type: 'ENCODE_CREDENTIAL';
23455
+ /** Result of an encoding attempt. If the attempt was successful, includes the credential data that was encoded onto the card. */
23456
+ result: {
23457
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23458
+ acs_credential_id: string;
23459
+ /** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
23460
+ acs_user_id?: string | undefined;
23461
+ /** ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
23462
+ user_identity_id?: string | undefined;
23463
+ /** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
23464
+ connected_account_id: string;
23465
+ acs_credential_pool_id?: string | undefined;
23466
+ /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23467
+ acs_system_id: string;
23468
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23469
+ parent_acs_credential_id?: string | undefined;
23470
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
23471
+ display_name: string;
23472
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23473
+ code?: (string | undefined) | null;
23474
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
23475
+ is_one_time_use?: boolean | undefined;
23476
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23477
+ card_number?: (string | undefined) | null;
23478
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
23479
+ is_issued?: boolean | undefined;
23480
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
23481
+ issued_at?: (string | undefined) | null;
23482
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
23483
+ access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
23484
+ /** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
23485
+ external_type?: ('pti_card' | 'brivo_credential' | 'brivo_digital_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key' | 'latch_access' | 'dormakaba_ambiance_credential' | 'hotek_card') | undefined;
23486
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
23487
+ external_type_display_name?: string | undefined;
23488
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
23489
+ created_at: string;
23490
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23491
+ workspace_id: string;
23492
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
23493
+ starts_at?: string | undefined;
23494
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
23495
+ ends_at?: string | undefined;
23496
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23497
+ errors: {
23498
+ error_code: string;
23499
+ message: string;
23500
+ }[];
23501
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23502
+ warnings: ({
23503
+ /** Date and time at which Seam created the warning. */
23504
+ created_at: string;
23505
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23506
+ message: string;
23507
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23508
+ warning_code: 'waiting_to_be_issued';
23509
+ } | {
23510
+ /** Date and time at which Seam created the warning. */
23511
+ created_at: string;
23512
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23513
+ message: string;
23514
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23515
+ warning_code: 'schedule_externally_modified';
23516
+ } | {
23517
+ /** Date and time at which Seam created the warning. */
23518
+ created_at: string;
23519
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23520
+ message: string;
23521
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23522
+ warning_code: 'schedule_modified';
23523
+ } | {
23524
+ /** Date and time at which Seam created the warning. */
23525
+ created_at: string;
23526
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23527
+ message: string;
23528
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23529
+ warning_code: 'being_deleted';
23530
+ } | {
23531
+ /** Date and time at which Seam created the warning. */
23532
+ created_at: string;
23533
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23534
+ message: string;
23535
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23536
+ warning_code: 'unknown_issue_with_acs_credential';
23537
+ } | {
23538
+ /** Date and time at which Seam created the warning. */
23539
+ created_at: string;
23540
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23541
+ message: string;
23542
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23543
+ warning_code: 'needs_to_be_reissued';
23544
+ })[];
23545
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
23546
+ is_multi_phone_sync_credential?: boolean | undefined;
23547
+ /** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
23548
+ is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
23549
+ /** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
23550
+ latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
23551
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23552
+ visionline_metadata?: {
23553
+ /** Card function type in the Visionline access system. */
23554
+ card_function_type: 'guest' | 'staff';
23555
+ /** IDs of the credentials to which you want to join. */
23556
+ joiner_acs_credential_ids?: string[] | undefined;
23557
+ /** Guest entrance IDs in the Visionline access system. */
23558
+ guest_acs_entrance_ids?: string[] | undefined;
23559
+ /** Common entrance IDs in the Visionline access system. */
23560
+ common_acs_entrance_ids?: string[] | undefined;
23561
+ /** Indicates whether the credential is valid. */
23562
+ is_valid?: boolean | undefined;
23563
+ /** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
23564
+ auto_join?: boolean | undefined;
23565
+ /** ID of the card in the Visionline access system. */
23566
+ card_id?: string | undefined;
23567
+ /** ID of the credential in the Visionline access system. */
23568
+ credential_id?: string | undefined;
23569
+ } | undefined;
23570
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23571
+ assa_abloy_vostio_metadata?: {
23572
+ /** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
23573
+ auto_join?: boolean | undefined;
23574
+ /** IDs of the guest entrances to override in the Vostio access system. */
23575
+ override_guest_acs_entrance_ids?: string[] | undefined;
23576
+ /** Key ID in the Vostio access system. */
23577
+ key_id?: string | undefined;
23578
+ /** Key issuing request ID in the Vostio access system. */
23579
+ key_issuing_request_id?: string | undefined;
23580
+ /** Names of the doors to which to grant access in the Vostio access system. */
23581
+ door_names?: string[] | undefined;
23582
+ /** Endpoint ID in the Vostio access system. */
23583
+ endpoint_id?: string | undefined;
23584
+ } | undefined;
23585
+ is_managed: true;
23586
+ } | {
23587
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23588
+ acs_credential_id: string;
23589
+ /** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
23590
+ acs_user_id?: string | undefined;
23591
+ /** ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
23592
+ user_identity_id?: string | undefined;
23593
+ /** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
23594
+ connected_account_id: string;
23595
+ acs_credential_pool_id?: string | undefined;
23596
+ /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23597
+ acs_system_id: string;
23598
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23599
+ parent_acs_credential_id?: string | undefined;
23600
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
23601
+ display_name: string;
23602
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23603
+ code?: (string | undefined) | null;
23604
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
23605
+ is_one_time_use?: boolean | undefined;
23606
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23607
+ card_number?: (string | undefined) | null;
23608
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
23609
+ is_issued?: boolean | undefined;
23610
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
23611
+ issued_at?: (string | undefined) | null;
23612
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
23613
+ access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
23614
+ /** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
23615
+ external_type?: ('pti_card' | 'brivo_credential' | 'brivo_digital_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key' | 'latch_access' | 'dormakaba_ambiance_credential' | 'hotek_card') | undefined;
23616
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
23617
+ external_type_display_name?: string | undefined;
23618
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
23619
+ created_at: string;
23620
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23621
+ workspace_id: string;
23622
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
23623
+ starts_at?: string | undefined;
23624
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
23625
+ ends_at?: string | undefined;
23626
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23627
+ errors: {
23628
+ error_code: string;
23629
+ message: string;
23630
+ }[];
23631
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23632
+ warnings: ({
23633
+ /** Date and time at which Seam created the warning. */
23634
+ created_at: string;
23635
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23636
+ message: string;
23637
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23638
+ warning_code: 'waiting_to_be_issued';
23639
+ } | {
23640
+ /** Date and time at which Seam created the warning. */
23641
+ created_at: string;
23642
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23643
+ message: string;
23644
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23645
+ warning_code: 'schedule_externally_modified';
23646
+ } | {
23647
+ /** Date and time at which Seam created the warning. */
23648
+ created_at: string;
23649
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23650
+ message: string;
23651
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23652
+ warning_code: 'schedule_modified';
23653
+ } | {
23654
+ /** Date and time at which Seam created the warning. */
23655
+ created_at: string;
23656
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23657
+ message: string;
23658
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23659
+ warning_code: 'being_deleted';
23660
+ } | {
23661
+ /** Date and time at which Seam created the warning. */
23662
+ created_at: string;
23663
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23664
+ message: string;
23665
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23666
+ warning_code: 'unknown_issue_with_acs_credential';
23667
+ } | {
23668
+ /** Date and time at which Seam created the warning. */
23669
+ created_at: string;
23670
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23671
+ message: string;
23672
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23673
+ warning_code: 'needs_to_be_reissued';
23674
+ })[];
23675
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
23676
+ is_multi_phone_sync_credential?: boolean | undefined;
23677
+ /** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
23678
+ is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
23679
+ /** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
23680
+ latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
23681
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23682
+ visionline_metadata?: {
23683
+ /** Card function type in the Visionline access system. */
23684
+ card_function_type: 'guest' | 'staff';
23685
+ /** IDs of the credentials to which you want to join. */
23686
+ joiner_acs_credential_ids?: string[] | undefined;
23687
+ /** Guest entrance IDs in the Visionline access system. */
23688
+ guest_acs_entrance_ids?: string[] | undefined;
23689
+ /** Common entrance IDs in the Visionline access system. */
23690
+ common_acs_entrance_ids?: string[] | undefined;
23691
+ /** Indicates whether the credential is valid. */
23692
+ is_valid?: boolean | undefined;
23693
+ /** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
23694
+ auto_join?: boolean | undefined;
23695
+ /** ID of the card in the Visionline access system. */
23696
+ card_id?: string | undefined;
23697
+ /** ID of the credential in the Visionline access system. */
23698
+ credential_id?: string | undefined;
23699
+ } | undefined;
23700
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23701
+ assa_abloy_vostio_metadata?: {
23702
+ /** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
23703
+ auto_join?: boolean | undefined;
23704
+ /** IDs of the guest entrances to override in the Vostio access system. */
23705
+ override_guest_acs_entrance_ids?: string[] | undefined;
23706
+ /** Key ID in the Vostio access system. */
23707
+ key_id?: string | undefined;
23708
+ /** Key issuing request ID in the Vostio access system. */
23709
+ key_issuing_request_id?: string | undefined;
23710
+ /** Names of the doors to which to grant access in the Vostio access system. */
23711
+ door_names?: string[] | undefined;
23712
+ /** Endpoint ID in the Vostio access system. */
23713
+ endpoint_id?: string | undefined;
23714
+ } | undefined;
23715
+ is_managed: false;
23716
+ };
23717
+ } | {
23718
+ /** ID of the action attempt. */
23719
+ action_attempt_id: string;
23720
+ status: 'error';
23721
+ /** Result of the action attempt. Null for failed action attempts. */
23722
+ result: null;
23723
+ /** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
23724
+ action_type: 'ENCODE_CREDENTIAL';
23725
+ error: {
23726
+ /** Type of the error associated with the action attempt. */
23727
+ type: 'uncategorized_error';
23728
+ /** Message for the error associated with the action attempt. */
23729
+ message: string;
23730
+ } | {
23731
+ /** Type of the error associated with the action attempt. */
23732
+ type: 'action_attempt_expired';
23733
+ /** Message for the error associated with the action attempt. */
23734
+ message: string;
23735
+ } | {
23736
+ /** Error type to indicate that there is no credential on the encoder. */
23737
+ type: 'no_credential_on_encoder';
23738
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23739
+ message: string;
23740
+ } | {
23741
+ /** Error type to indicate an incompatible card format. */
23742
+ type: 'incompatible_card_format';
23743
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23744
+ message: string;
23745
+ } | {
23746
+ /** Error type to indicate that the affected credential cannot be reissued. */
23747
+ type: 'credential_cannot_be_reissued';
23748
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23749
+ message: string;
23750
+ } | {
23751
+ /** Error type to indicate that the encoder is not online. */
23752
+ type: 'encoder_not_online';
23753
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23754
+ message: string;
23755
+ };
23756
+ } | {
23757
+ /** ID of the action attempt. */
23758
+ action_attempt_id: string;
23759
+ status: 'pending';
23760
+ /** Result of the action attempt. Null for pending action attempts. */
23761
+ result: null;
23762
+ /** Errors associated with the action attempt. Null for pending action attempts. */
23763
+ error: null;
23764
+ /** Action attempt to track the status of resetting a sandbox workspace. */
23765
+ action_type: 'RESET_SANDBOX_WORKSPACE';
23766
+ } | {
23767
+ /** ID of the action attempt. */
23768
+ action_attempt_id: string;
23769
+ status: 'success';
23770
+ /** Errors associated with the action attempt. Null for successful action attempts. */
23771
+ error: null;
23772
+ /** Action attempt to track the status of resetting a sandbox workspace. */
23773
+ action_type: 'RESET_SANDBOX_WORKSPACE';
23774
+ /** Result of the action. */
23775
+ result: {};
23776
+ } | {
23777
+ /** ID of the action attempt. */
23778
+ action_attempt_id: string;
23779
+ status: 'error';
23780
+ /** Result of the action attempt. Null for failed action attempts. */
23781
+ result: null;
23782
+ /** Action attempt to track the status of resetting a sandbox workspace. */
23783
+ action_type: 'RESET_SANDBOX_WORKSPACE';
23784
+ /** Error associated with the action. */
23785
+ error: {
23786
+ /** Type of the error. */
23787
+ type: string;
23788
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23789
+ message: string;
23790
+ };
23791
+ } | {
23792
+ /** ID of the action attempt. */
23793
+ action_attempt_id: string;
23794
+ status: 'pending';
23795
+ /** Result of the action attempt. Null for pending action attempts. */
23796
+ result: null;
23797
+ /** Errors associated with the action attempt. Null for pending action attempts. */
23798
+ error: null;
23799
+ /** Action attempt to track the status of setting the fan mode on a thermostat. */
23800
+ action_type: 'SET_FAN_MODE';
23801
+ } | {
23802
+ /** ID of the action attempt. */
23803
+ action_attempt_id: string;
23804
+ status: 'success';
23805
+ /** Errors associated with the action attempt. Null for successful action attempts. */
23806
+ error: null;
23807
+ /** Action attempt to track the status of setting the fan mode on a thermostat. */
23808
+ action_type: 'SET_FAN_MODE';
23809
+ /** Result of the action. */
23810
+ result: {};
23811
+ } | {
23812
+ /** ID of the action attempt. */
23813
+ action_attempt_id: string;
23814
+ status: 'error';
23815
+ /** Result of the action attempt. Null for failed action attempts. */
23816
+ result: null;
23817
+ /** Action attempt to track the status of setting the fan mode on a thermostat. */
23818
+ action_type: 'SET_FAN_MODE';
23819
+ /** Error associated with the action. */
23820
+ error: {
23821
+ /** Type of the error. */
23822
+ type: string;
23823
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23824
+ message: string;
23825
+ };
23826
+ } | {
23827
+ /** ID of the action attempt. */
23828
+ action_attempt_id: string;
23829
+ status: 'pending';
23830
+ /** Result of the action attempt. Null for pending action attempts. */
23831
+ result: null;
23832
+ /** Errors associated with the action attempt. Null for pending action attempts. */
23833
+ error: null;
23834
+ /** Action attempt to track the status of setting the HVAC mode on a thermostat. */
23835
+ action_type: 'SET_HVAC_MODE';
23836
+ } | {
23837
+ /** ID of the action attempt. */
23838
+ action_attempt_id: string;
23839
+ status: 'success';
23840
+ /** Errors associated with the action attempt. Null for successful action attempts. */
23841
+ error: null;
23842
+ /** Action attempt to track the status of setting the HVAC mode on a thermostat. */
23843
+ action_type: 'SET_HVAC_MODE';
23844
+ /** Result of the action. */
23845
+ result: {};
23846
+ } | {
23847
+ /** ID of the action attempt. */
23848
+ action_attempt_id: string;
23849
+ status: 'error';
23850
+ /** Result of the action attempt. Null for failed action attempts. */
23851
+ result: null;
23852
+ /** Action attempt to track the status of setting the HVAC mode on a thermostat. */
23853
+ action_type: 'SET_HVAC_MODE';
23854
+ /** Error associated with the action. */
23855
+ error: {
23856
+ /** Type of the error. */
23857
+ type: string;
23858
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23859
+ message: string;
23860
+ };
23861
+ } | {
23862
+ /** ID of the action attempt. */
23863
+ action_attempt_id: string;
23864
+ status: 'pending';
23865
+ /** Result of the action attempt. Null for pending action attempts. */
23866
+ result: null;
23867
+ /** Errors associated with the action attempt. Null for pending action attempts. */
23868
+ error: null;
23869
+ /** Action attempt to track the status of a climate preset activation. */
23870
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
23871
+ } | {
23872
+ /** ID of the action attempt. */
23873
+ action_attempt_id: string;
23874
+ status: 'success';
23875
+ /** Errors associated with the action attempt. Null for successful action attempts. */
23876
+ error: null;
23877
+ /** Action attempt to track the status of a climate preset activation. */
23878
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
23879
+ /** Result of the action. */
23880
+ result: {};
23881
+ } | {
23882
+ /** ID of the action attempt. */
23883
+ action_attempt_id: string;
23884
+ status: 'error';
23885
+ /** Result of the action attempt. Null for failed action attempts. */
23886
+ result: null;
23887
+ /** Action attempt to track the status of a climate preset activation. */
23888
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
23889
+ /** Error associated with the action. */
23890
+ error: {
23891
+ /** Type of the error. */
23892
+ type: string;
23893
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23894
+ message: string;
23895
+ };
23896
+ } | {
23897
+ /** ID of the action attempt. */
23898
+ action_attempt_id: string;
23899
+ status: 'pending';
23900
+ /** Result of the action attempt. Null for pending action attempts. */
23901
+ result: null;
23902
+ /** Errors associated with the action attempt. Null for pending action attempts. */
23903
+ error: null;
23904
+ /** Action attempt to track the status of simulating a keypad code entry. */
23905
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
23906
+ } | {
23907
+ /** ID of the action attempt. */
23908
+ action_attempt_id: string;
23909
+ status: 'success';
23910
+ /** Errors associated with the action attempt. Null for successful action attempts. */
23911
+ error: null;
23912
+ /** Action attempt to track the status of simulating a keypad code entry. */
23913
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
23914
+ /** Result of the action. */
23915
+ result: {};
23916
+ } | {
23917
+ /** ID of the action attempt. */
23918
+ action_attempt_id: string;
23919
+ status: 'error';
23920
+ /** Result of the action attempt. Null for failed action attempts. */
23921
+ result: null;
23922
+ /** Action attempt to track the status of simulating a keypad code entry. */
23923
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
23924
+ /** Error associated with the action. */
23925
+ error: {
23926
+ /** Type of the error. */
23927
+ type: string;
23928
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23929
+ message: string;
23930
+ };
23931
+ } | {
23932
+ /** ID of the action attempt. */
23933
+ action_attempt_id: string;
23934
+ status: 'pending';
23935
+ /** Result of the action attempt. Null for pending action attempts. */
23936
+ result: null;
23937
+ /** Errors associated with the action attempt. Null for pending action attempts. */
23938
+ error: null;
23939
+ /** Action attempt to track the status of simulating a manual lock action using a keypad. */
23940
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
23941
+ } | {
23942
+ /** ID of the action attempt. */
23943
+ action_attempt_id: string;
23944
+ status: 'success';
23945
+ /** Errors associated with the action attempt. Null for successful action attempts. */
23946
+ error: null;
23947
+ /** Action attempt to track the status of simulating a manual lock action using a keypad. */
23948
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
23949
+ /** Result of the action. */
23950
+ result: {};
23951
+ } | {
23952
+ /** ID of the action attempt. */
23953
+ action_attempt_id: string;
23954
+ status: 'error';
23955
+ /** Result of the action attempt. Null for failed action attempts. */
23956
+ result: null;
23957
+ /** Action attempt to track the status of simulating a manual lock action using a keypad. */
23958
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
23959
+ /** Error associated with the action. */
23960
+ error: {
23961
+ /** Type of the error. */
23962
+ type: string;
23963
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23964
+ message: string;
23965
+ };
23966
+ } | {
23967
+ /** ID of the action attempt. */
23968
+ action_attempt_id: string;
23969
+ status: 'pending';
23970
+ /** Result of the action attempt. Null for pending action attempts. */
23971
+ result: null;
23972
+ /** Errors associated with the action attempt. Null for pending action attempts. */
23973
+ error: null;
23974
+ /** Action attempt to track the status of pushing thermostat programs. */
23975
+ action_type: 'PUSH_THERMOSTAT_PROGRAMS';
23976
+ } | {
23977
+ /** ID of the action attempt. */
23978
+ action_attempt_id: string;
23979
+ status: 'success';
23980
+ /** Errors associated with the action attempt. Null for successful action attempts. */
23981
+ error: null;
23982
+ /** Action attempt to track the status of pushing thermostat programs. */
23983
+ action_type: 'PUSH_THERMOSTAT_PROGRAMS';
23984
+ /** Result of the action. */
23985
+ result: {};
23986
+ } | {
23987
+ /** ID of the action attempt. */
23988
+ action_attempt_id: string;
23989
+ status: 'error';
23990
+ /** Result of the action attempt. Null for failed action attempts. */
23991
+ result: null;
23992
+ /** Action attempt to track the status of pushing thermostat programs. */
23993
+ action_type: 'PUSH_THERMOSTAT_PROGRAMS';
23994
+ /** Error associated with the action. */
23995
+ error: {
23996
+ /** Type of the error. */
23997
+ type: string;
23998
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23999
+ message: string;
24000
+ };
24001
+ } | {
24002
+ /** ID of the action attempt. */
24003
+ action_attempt_id: string;
24004
+ status: 'pending';
24005
+ /** Result of the action attempt. Null for pending action attempts. */
24006
+ result: null;
24007
+ /** Errors associated with the action attempt. Null for pending action attempts. */
24008
+ error: null;
24009
+ /** Syncing access codes is pending. */
24010
+ action_type: 'SYNC_ACCESS_CODES';
24011
+ } | {
24012
+ /** ID of the action attempt. */
24013
+ action_attempt_id: string;
24014
+ status: 'success';
24015
+ /** Errors associated with the action attempt. Null for successful action attempts. */
24016
+ error: null;
24017
+ /** Syncing access codes succeeded. */
24018
+ action_type: 'SYNC_ACCESS_CODES';
24019
+ /** Result of the action. */
24020
+ result: {};
24021
+ } | {
24022
+ /** ID of the action attempt. */
24023
+ action_attempt_id: string;
24024
+ status: 'error';
24025
+ /** Result of the action attempt. Null for failed action attempts. */
24026
+ result: null;
24027
+ /** Syncing access codes failed. */
24028
+ action_type: 'SYNC_ACCESS_CODES';
24029
+ /** Error associated with the action. */
24030
+ error: {
24031
+ /** Type of the error. */
24032
+ type: string;
24033
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
24034
+ message: string;
24035
+ };
24036
+ } | {
24037
+ /** ID of the action attempt. */
24038
+ action_attempt_id: string;
24039
+ status: 'pending';
24040
+ /** Result of the action attempt. Null for pending action attempts. */
24041
+ result: null;
24042
+ /** Errors associated with the action attempt. Null for pending action attempts. */
24043
+ error: null;
24044
+ /** Creating an access code is pending. */
24045
+ action_type: 'CREATE_ACCESS_CODE';
24046
+ } | {
24047
+ /** ID of the action attempt. */
24048
+ action_attempt_id: string;
24049
+ status: 'success';
24050
+ /** Errors associated with the action attempt. Null for successful action attempts. */
24051
+ error: null;
24052
+ /** Creating an access code succeeded. */
24053
+ action_type: 'CREATE_ACCESS_CODE';
24054
+ /** Result of the action. */
24055
+ result: {
24056
+ /** Created access code. */
24057
+ access_code?: any;
24058
+ };
24059
+ } | {
24060
+ /** ID of the action attempt. */
24061
+ action_attempt_id: string;
24062
+ status: 'error';
24063
+ /** Result of the action attempt. Null for failed action attempts. */
24064
+ result: null;
24065
+ /** Creating an access code failed. */
24066
+ action_type: 'CREATE_ACCESS_CODE';
24067
+ /** Error associated with the action. */
24068
+ error: {
24069
+ /** Type of the error. */
24070
+ type: string;
24071
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
24072
+ message: string;
24073
+ };
24074
+ } | {
24075
+ /** ID of the action attempt. */
24076
+ action_attempt_id: string;
24077
+ status: 'pending';
24078
+ /** Result of the action attempt. Null for pending action attempts. */
24079
+ result: null;
24080
+ /** Errors associated with the action attempt. Null for pending action attempts. */
24081
+ error: null;
24082
+ /** Deleting an access code is pending. */
24083
+ action_type: 'DELETE_ACCESS_CODE';
24084
+ } | {
24085
+ /** ID of the action attempt. */
24086
+ action_attempt_id: string;
24087
+ status: 'success';
24088
+ /** Errors associated with the action attempt. Null for successful action attempts. */
24089
+ error: null;
24090
+ /** Deleting an access code succeeded. */
24091
+ action_type: 'DELETE_ACCESS_CODE';
24092
+ /** Result of the action. */
24093
+ result: {};
24094
+ } | {
24095
+ /** ID of the action attempt. */
24096
+ action_attempt_id: string;
24097
+ status: 'error';
24098
+ /** Result of the action attempt. Null for failed action attempts. */
24099
+ result: null;
24100
+ /** Deleting an access code failed. */
24101
+ action_type: 'DELETE_ACCESS_CODE';
24102
+ /** Error associated with the action. */
24103
+ error: {
24104
+ /** Type of the error. */
24105
+ type: string;
24106
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
24107
+ message: string;
24108
+ };
24109
+ } | {
24110
+ /** ID of the action attempt. */
24111
+ action_attempt_id: string;
24112
+ status: 'pending';
24113
+ /** Result of the action attempt. Null for pending action attempts. */
24114
+ result: null;
24115
+ /** Errors associated with the action attempt. Null for pending action attempts. */
24116
+ error: null;
24117
+ /** Updating an access code is pending. */
24118
+ action_type: 'UPDATE_ACCESS_CODE';
24119
+ } | {
24120
+ /** ID of the action attempt. */
24121
+ action_attempt_id: string;
24122
+ status: 'success';
24123
+ /** Errors associated with the action attempt. Null for successful action attempts. */
24124
+ error: null;
24125
+ /** Updating an access code succeeded. */
24126
+ action_type: 'UPDATE_ACCESS_CODE';
24127
+ /** Result of the action. */
24128
+ result: {
24129
+ /** Updated access code. */
24130
+ access_code?: any;
24131
+ };
24132
+ } | {
24133
+ /** ID of the action attempt. */
24134
+ action_attempt_id: string;
24135
+ status: 'error';
24136
+ /** Result of the action attempt. Null for failed action attempts. */
24137
+ result: null;
24138
+ /** Updating an access code failed. */
24139
+ action_type: 'UPDATE_ACCESS_CODE';
24140
+ /** Error associated with the action. */
24141
+ error: {
24142
+ /** Type of the error. */
24143
+ type: string;
24144
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
24145
+ message: string;
24146
+ };
24147
+ } | {
24148
+ /** ID of the action attempt. */
24149
+ action_attempt_id: string;
24150
+ status: 'pending';
24151
+ /** Result of the action attempt. Null for pending action attempts. */
24152
+ result: null;
24153
+ /** Errors associated with the action attempt. Null for pending action attempts. */
24154
+ error: null;
24155
+ /** Creating a noise threshold is pending. */
24156
+ action_type: 'CREATE_NOISE_THRESHOLD';
24157
+ } | {
24158
+ /** ID of the action attempt. */
24159
+ action_attempt_id: string;
24160
+ status: 'success';
24161
+ /** Errors associated with the action attempt. Null for successful action attempts. */
24162
+ error: null;
24163
+ /** Creating a noise threshold succeeded. */
24164
+ action_type: 'CREATE_NOISE_THRESHOLD';
24165
+ /** Result of the action. */
24166
+ result: {
24167
+ /** Created noise threshold. */
24168
+ noise_threshold?: any;
24169
+ };
24170
+ } | {
24171
+ /** ID of the action attempt. */
24172
+ action_attempt_id: string;
24173
+ status: 'error';
24174
+ /** Result of the action attempt. Null for failed action attempts. */
24175
+ result: null;
24176
+ /** Creating a noise threshold failed. */
24177
+ action_type: 'CREATE_NOISE_THRESHOLD';
24178
+ /** Error associated with the action. */
24179
+ error: {
24180
+ /** Type of the error. */
24181
+ type: string;
24182
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
24183
+ message: string;
24184
+ };
24185
+ } | {
24186
+ /** ID of the action attempt. */
24187
+ action_attempt_id: string;
24188
+ status: 'pending';
24189
+ /** Result of the action attempt. Null for pending action attempts. */
24190
+ result: null;
24191
+ /** Errors associated with the action attempt. Null for pending action attempts. */
24192
+ error: null;
24193
+ /** Deleting a noise threshold is pending. */
24194
+ action_type: 'DELETE_NOISE_THRESHOLD';
24195
+ } | {
24196
+ /** ID of the action attempt. */
24197
+ action_attempt_id: string;
24198
+ status: 'success';
24199
+ /** Errors associated with the action attempt. Null for successful action attempts. */
24200
+ error: null;
24201
+ /** Deleting a noise threshold succeeded. */
24202
+ action_type: 'DELETE_NOISE_THRESHOLD';
24203
+ /** Result of the action. */
24204
+ result: {};
24205
+ } | {
24206
+ /** ID of the action attempt. */
24207
+ action_attempt_id: string;
24208
+ status: 'error';
24209
+ /** Result of the action attempt. Null for failed action attempts. */
24210
+ result: null;
24211
+ /** Deleting a noise threshold failed. */
24212
+ action_type: 'DELETE_NOISE_THRESHOLD';
24213
+ /** Error associated with the action. */
24214
+ error: {
24215
+ /** Type of the error. */
24216
+ type: string;
24217
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
24218
+ message: string;
24219
+ };
24220
+ } | {
24221
+ /** ID of the action attempt. */
24222
+ action_attempt_id: string;
24223
+ status: 'pending';
24224
+ /** Result of the action attempt. Null for pending action attempts. */
24225
+ result: null;
24226
+ /** Errors associated with the action attempt. Null for pending action attempts. */
24227
+ error: null;
24228
+ /** Updating a noise threshold is pending. */
24229
+ action_type: 'UPDATE_NOISE_THRESHOLD';
24230
+ } | {
24231
+ /** ID of the action attempt. */
24232
+ action_attempt_id: string;
24233
+ status: 'success';
24234
+ /** Errors associated with the action attempt. Null for successful action attempts. */
24235
+ error: null;
24236
+ /** Updating a noise threshold succeeded. */
24237
+ action_type: 'UPDATE_NOISE_THRESHOLD';
24238
+ /** Result of the action. */
24239
+ result: {
24240
+ /** Updated noise threshold. */
24241
+ noise_threshold?: any;
24242
+ };
24243
+ } | {
24244
+ /** ID of the action attempt. */
24245
+ action_attempt_id: string;
24246
+ status: 'error';
24247
+ /** Result of the action attempt. Null for failed action attempts. */
24248
+ result: null;
24249
+ /** Updating a noise threshold failed. */
24250
+ action_type: 'UPDATE_NOISE_THRESHOLD';
24251
+ /** Error associated with the action. */
24252
+ error: {
24253
+ /** Type of the error. */
24254
+ type: string;
24255
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
24256
+ message: string;
24257
+ };
24258
+ };
24259
+ };
24260
+ maxDuration: undefined;
24261
+ };
22973
24262
  '/acs/systems/get': {
22974
24263
  route: '/acs/systems/get';
22975
24264
  method: 'GET' | 'POST';
@@ -24390,6 +25679,8 @@ export type Routes = {
24390
25679
  can_unlock_with_code?: boolean | undefined;
24391
25680
  /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
24392
25681
  can_belong_to_reservation?: boolean | undefined;
25682
+ /** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
25683
+ can_unlock_with_cloud_key?: boolean | undefined;
24393
25684
  }[];
24394
25685
  };
24395
25686
  maxDuration: undefined;
@@ -58332,7 +59623,10 @@ export type Routes = {
58332
59623
  method: 'GET' | 'POST';
58333
59624
  queryParams: {};
58334
59625
  jsonBody: {};
58335
- commonParams: {};
59626
+ commonParams: {
59627
+ /** Key of the customer to get automation config for. */
59628
+ customer_key?: string | undefined;
59629
+ };
58336
59630
  formData: {};
58337
59631
  jsonResponse: {
58338
59632
  access_rules?: {
@@ -58414,6 +59708,8 @@ export type Routes = {
58414
59708
  method: 'PATCH' | 'POST';
58415
59709
  queryParams: {};
58416
59710
  jsonBody: {
59711
+ /** Key of the customer to update automation config for. */
59712
+ customer_key?: string | undefined;
58417
59713
  /** Access automation rules configuration. */
58418
59714
  access_rules?: {
58419
59715
  reservation_created?: {
@@ -58706,10 +60002,7 @@ export type Routes = {
58706
60002
  method: 'GET' | 'POST';
58707
60003
  queryParams: {};
58708
60004
  jsonBody: {};
58709
- commonParams: {
58710
- /** Key of the customer. */
58711
- customer_key: string;
58712
- };
60005
+ commonParams: {};
58713
60006
  formData: {};
58714
60007
  jsonResponse: {
58715
60008
  automation: {
@@ -63054,6 +64347,8 @@ export type Routes = {
63054
64347
  can_unlock_with_code?: boolean | undefined;
63055
64348
  /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
63056
64349
  can_belong_to_reservation?: boolean | undefined;
64350
+ /** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
64351
+ can_unlock_with_cloud_key?: boolean | undefined;
63057
64352
  }[];
63058
64353
  }[];
63059
64354
  }[];
@@ -64763,6 +66058,8 @@ export type Routes = {
64763
66058
  can_unlock_with_code?: boolean | undefined;
64764
66059
  /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
64765
66060
  can_belong_to_reservation?: boolean | undefined;
66061
+ /** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
66062
+ can_unlock_with_cloud_key?: boolean | undefined;
64766
66063
  }[] | undefined;
64767
66064
  connected_accounts?: {
64768
66065
  /** ID of the connected account. */
@@ -86828,6 +88125,8 @@ export type Routes = {
86828
88125
  can_unlock_with_code?: boolean | undefined;
86829
88126
  /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
86830
88127
  can_belong_to_reservation?: boolean | undefined;
88128
+ /** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
88129
+ can_unlock_with_cloud_key?: boolean | undefined;
86831
88130
  }[] | undefined;
86832
88131
  acs_systems?: {
86833
88132
  /** ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */