@seamapi/types 1.487.0 → 1.489.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.
@@ -10109,8 +10109,8 @@ export type Routes = {
10109
10109
  commonParams: {
10110
10110
  /** IDs of the access grants that you want to get along with their related resources. */
10111
10111
  access_grant_ids: string[];
10112
- include?: ('spaces' | 'devices' | 'acs_entrances' | 'connected_accounts' | 'acs_systems' | 'user_identity')[] | undefined;
10113
- exclude?: ('spaces' | 'devices' | 'acs_entrances' | 'connected_accounts' | 'acs_systems' | 'user_identity')[] | undefined;
10112
+ include?: ('spaces' | 'devices' | 'acs_entrances' | 'connected_accounts' | 'acs_systems' | 'user_identity' | 'acs_access_groups')[] | undefined;
10113
+ exclude?: ('spaces' | 'devices' | 'acs_entrances' | 'connected_accounts' | 'acs_systems' | 'user_identity' | 'acs_access_groups')[] | undefined;
10114
10114
  };
10115
10115
  formData: {};
10116
10116
  jsonResponse: {
@@ -11740,6 +11740,41 @@ export type Routes = {
11740
11740
  misconfigured_acs_entrance_ids?: string[] | undefined;
11741
11741
  })[];
11742
11742
  }[] | undefined;
11743
+ acs_access_groups?: {
11744
+ /** ID of the access group. */
11745
+ acs_access_group_id: string;
11746
+ /** ID of the access control system that contains the access group. */
11747
+ acs_system_id: string;
11748
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group. */
11749
+ workspace_id: string;
11750
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the access group. */
11751
+ connected_account_id: string;
11752
+ /** Name of the access group. */
11753
+ name: string;
11754
+ /**
11755
+ * @deprecated Use `external_type`.*/
11756
+ access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group';
11757
+ /**
11758
+ * @deprecated Use `external_type_display_name`.*/
11759
+ access_group_type_display_name: string;
11760
+ display_name: string;
11761
+ /** Brand-specific terminology for the access group type. */
11762
+ external_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group';
11763
+ /** Display name that corresponds to the brand-specific terminology for the access group type. */
11764
+ external_type_display_name: string;
11765
+ /** Date and time at which the access group was created. */
11766
+ created_at: string;
11767
+ /** Warnings associated with the `acs_access_group`. */
11768
+ warnings: {
11769
+ /** Date and time at which Seam created the warning. */
11770
+ created_at: string;
11771
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
11772
+ message: string;
11773
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
11774
+ warning_code: 'unknown_issue_with_acs_access_group';
11775
+ }[];
11776
+ is_managed: true;
11777
+ }[] | undefined;
11743
11778
  };
11744
11779
  };
11745
11780
  };
@@ -14940,6 +14975,268 @@ export type Routes = {
14940
14975
  /** Display name for the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). */
14941
14976
  display_name: string;
14942
14977
  }[] | undefined;
14978
+ acs_credentials?: {
14979
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
14980
+ acs_credential_id: string;
14981
+ /** 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. */
14982
+ acs_user_id?: string | undefined;
14983
+ /** 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. */
14984
+ user_identity_id?: string | undefined;
14985
+ /** 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. */
14986
+ connected_account_id: string;
14987
+ acs_credential_pool_id?: string | undefined;
14988
+ /** 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). */
14989
+ acs_system_id: string;
14990
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
14991
+ parent_acs_credential_id?: string | undefined;
14992
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
14993
+ display_name: string;
14994
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
14995
+ code?: (string | undefined) | null;
14996
+ /** 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. */
14997
+ is_one_time_use?: boolean | undefined;
14998
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
14999
+ card_number?: (string | undefined) | null;
15000
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
15001
+ is_issued?: boolean | undefined;
15002
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
15003
+ issued_at?: (string | undefined) | null;
15004
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
15005
+ access_method: 'code' | 'card' | 'mobile_key';
15006
+ /** 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`. */
15007
+ external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key' | 'latch_access') | undefined;
15008
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
15009
+ external_type_display_name?: string | undefined;
15010
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
15011
+ created_at: string;
15012
+ /** 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). */
15013
+ workspace_id: string;
15014
+ /** 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. */
15015
+ starts_at?: string | undefined;
15016
+ /** 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`. */
15017
+ ends_at?: string | undefined;
15018
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
15019
+ errors: {
15020
+ error_code: string;
15021
+ message: string;
15022
+ }[];
15023
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
15024
+ warnings: ({
15025
+ /** Date and time at which Seam created the warning. */
15026
+ created_at: string;
15027
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
15028
+ message: string;
15029
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
15030
+ warning_code: 'waiting_to_be_issued';
15031
+ } | {
15032
+ /** Date and time at which Seam created the warning. */
15033
+ created_at: string;
15034
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
15035
+ message: string;
15036
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
15037
+ warning_code: 'schedule_externally_modified';
15038
+ } | {
15039
+ /** Date and time at which Seam created the warning. */
15040
+ created_at: string;
15041
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
15042
+ message: string;
15043
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
15044
+ warning_code: 'schedule_modified';
15045
+ } | {
15046
+ /** Date and time at which Seam created the warning. */
15047
+ created_at: string;
15048
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
15049
+ message: string;
15050
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
15051
+ warning_code: 'being_deleted';
15052
+ } | {
15053
+ /** Date and time at which Seam created the warning. */
15054
+ created_at: string;
15055
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
15056
+ message: string;
15057
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
15058
+ warning_code: 'unknown_issue_with_acs_credential';
15059
+ } | {
15060
+ /** Date and time at which Seam created the warning. */
15061
+ created_at: string;
15062
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
15063
+ message: string;
15064
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
15065
+ warning_code: 'needs_to_be_reissued';
15066
+ })[];
15067
+ /** 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). */
15068
+ is_multi_phone_sync_credential?: boolean | undefined;
15069
+ /** 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. */
15070
+ is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
15071
+ /** 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. */
15072
+ latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
15073
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
15074
+ visionline_metadata?: {
15075
+ /** Card function type in the Visionline access system. */
15076
+ card_function_type: 'guest' | 'staff';
15077
+ /** IDs of the credentials to which you want to join. */
15078
+ joiner_acs_credential_ids?: string[] | undefined;
15079
+ /** Guest entrance IDs in the Visionline access system. */
15080
+ guest_acs_entrance_ids?: string[] | undefined;
15081
+ /** Common entrance IDs in the Visionline access system. */
15082
+ common_acs_entrance_ids?: string[] | undefined;
15083
+ /** Indicates whether the credential is valid. */
15084
+ is_valid?: boolean | undefined;
15085
+ /** 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. */
15086
+ auto_join?: boolean | undefined;
15087
+ /** ID of the card in the Visionline access system. */
15088
+ card_id?: string | undefined;
15089
+ /** ID of the credential in the Visionline access system. */
15090
+ credential_id?: string | undefined;
15091
+ } | undefined;
15092
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
15093
+ assa_abloy_vostio_metadata?: {
15094
+ /** 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. */
15095
+ auto_join?: boolean | undefined;
15096
+ /** IDs of the guest entrances to override in the Vostio access system. */
15097
+ override_guest_acs_entrance_ids?: string[] | undefined;
15098
+ /** Key ID in the Vostio access system. */
15099
+ key_id?: string | undefined;
15100
+ /** Key issuing request ID in the Vostio access system. */
15101
+ key_issuing_request_id?: string | undefined;
15102
+ /** Names of the doors to which to grant access in the Vostio access system. */
15103
+ door_names?: string[] | undefined;
15104
+ /** Endpoint ID in the Vostio access system. */
15105
+ endpoint_id?: string | undefined;
15106
+ } | undefined;
15107
+ is_managed: true;
15108
+ }[] | undefined;
15109
+ unmanaged_acs_credentials?: {
15110
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
15111
+ acs_credential_id: string;
15112
+ /** 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. */
15113
+ acs_user_id?: string | undefined;
15114
+ /** 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. */
15115
+ user_identity_id?: string | undefined;
15116
+ /** 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. */
15117
+ connected_account_id: string;
15118
+ acs_credential_pool_id?: string | undefined;
15119
+ /** 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). */
15120
+ acs_system_id: string;
15121
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
15122
+ parent_acs_credential_id?: string | undefined;
15123
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
15124
+ display_name: string;
15125
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
15126
+ code?: (string | undefined) | null;
15127
+ /** 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. */
15128
+ is_one_time_use?: boolean | undefined;
15129
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
15130
+ card_number?: (string | undefined) | null;
15131
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
15132
+ is_issued?: boolean | undefined;
15133
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
15134
+ issued_at?: (string | undefined) | null;
15135
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
15136
+ access_method: 'code' | 'card' | 'mobile_key';
15137
+ /** 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`. */
15138
+ external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key' | 'latch_access') | undefined;
15139
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
15140
+ external_type_display_name?: string | undefined;
15141
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
15142
+ created_at: string;
15143
+ /** 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). */
15144
+ workspace_id: string;
15145
+ /** 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. */
15146
+ starts_at?: string | undefined;
15147
+ /** 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`. */
15148
+ ends_at?: string | undefined;
15149
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
15150
+ errors: {
15151
+ error_code: string;
15152
+ message: string;
15153
+ }[];
15154
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
15155
+ warnings: ({
15156
+ /** Date and time at which Seam created the warning. */
15157
+ created_at: string;
15158
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
15159
+ message: string;
15160
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
15161
+ warning_code: 'waiting_to_be_issued';
15162
+ } | {
15163
+ /** Date and time at which Seam created the warning. */
15164
+ created_at: string;
15165
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
15166
+ message: string;
15167
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
15168
+ warning_code: 'schedule_externally_modified';
15169
+ } | {
15170
+ /** Date and time at which Seam created the warning. */
15171
+ created_at: string;
15172
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
15173
+ message: string;
15174
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
15175
+ warning_code: 'schedule_modified';
15176
+ } | {
15177
+ /** Date and time at which Seam created the warning. */
15178
+ created_at: string;
15179
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
15180
+ message: string;
15181
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
15182
+ warning_code: 'being_deleted';
15183
+ } | {
15184
+ /** Date and time at which Seam created the warning. */
15185
+ created_at: string;
15186
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
15187
+ message: string;
15188
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
15189
+ warning_code: 'unknown_issue_with_acs_credential';
15190
+ } | {
15191
+ /** Date and time at which Seam created the warning. */
15192
+ created_at: string;
15193
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
15194
+ message: string;
15195
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
15196
+ warning_code: 'needs_to_be_reissued';
15197
+ })[];
15198
+ /** 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). */
15199
+ is_multi_phone_sync_credential?: boolean | undefined;
15200
+ /** 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. */
15201
+ is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
15202
+ /** 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. */
15203
+ latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
15204
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
15205
+ visionline_metadata?: {
15206
+ /** Card function type in the Visionline access system. */
15207
+ card_function_type: 'guest' | 'staff';
15208
+ /** IDs of the credentials to which you want to join. */
15209
+ joiner_acs_credential_ids?: string[] | undefined;
15210
+ /** Guest entrance IDs in the Visionline access system. */
15211
+ guest_acs_entrance_ids?: string[] | undefined;
15212
+ /** Common entrance IDs in the Visionline access system. */
15213
+ common_acs_entrance_ids?: string[] | undefined;
15214
+ /** Indicates whether the credential is valid. */
15215
+ is_valid?: boolean | undefined;
15216
+ /** 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. */
15217
+ auto_join?: boolean | undefined;
15218
+ /** ID of the card in the Visionline access system. */
15219
+ card_id?: string | undefined;
15220
+ /** ID of the credential in the Visionline access system. */
15221
+ credential_id?: string | undefined;
15222
+ } | undefined;
15223
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
15224
+ assa_abloy_vostio_metadata?: {
15225
+ /** 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. */
15226
+ auto_join?: boolean | undefined;
15227
+ /** IDs of the guest entrances to override in the Vostio access system. */
15228
+ override_guest_acs_entrance_ids?: string[] | undefined;
15229
+ /** Key ID in the Vostio access system. */
15230
+ key_id?: string | undefined;
15231
+ /** Key issuing request ID in the Vostio access system. */
15232
+ key_issuing_request_id?: string | undefined;
15233
+ /** Names of the doors to which to grant access in the Vostio access system. */
15234
+ door_names?: string[] | undefined;
15235
+ /** Endpoint ID in the Vostio access system. */
15236
+ endpoint_id?: string | undefined;
15237
+ } | undefined;
15238
+ is_managed: false;
15239
+ }[] | undefined;
14943
15240
  action_attempts?: ({
14944
15241
  /** ID of the action attempt. */
14945
15242
  action_attempt_id: string;
@@ -79492,6 +79789,268 @@ export type Routes = {
79492
79789
  /** Display name for the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). */
79493
79790
  display_name: string;
79494
79791
  }[] | undefined;
79792
+ acs_credentials?: {
79793
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
79794
+ acs_credential_id: string;
79795
+ /** 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. */
79796
+ acs_user_id?: string | undefined;
79797
+ /** 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. */
79798
+ user_identity_id?: string | undefined;
79799
+ /** 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. */
79800
+ connected_account_id: string;
79801
+ acs_credential_pool_id?: string | undefined;
79802
+ /** 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). */
79803
+ acs_system_id: string;
79804
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
79805
+ parent_acs_credential_id?: string | undefined;
79806
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
79807
+ display_name: string;
79808
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
79809
+ code?: (string | undefined) | null;
79810
+ /** 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. */
79811
+ is_one_time_use?: boolean | undefined;
79812
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
79813
+ card_number?: (string | undefined) | null;
79814
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
79815
+ is_issued?: boolean | undefined;
79816
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
79817
+ issued_at?: (string | undefined) | null;
79818
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
79819
+ access_method: 'code' | 'card' | 'mobile_key';
79820
+ /** 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`. */
79821
+ external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key' | 'latch_access') | undefined;
79822
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
79823
+ external_type_display_name?: string | undefined;
79824
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
79825
+ created_at: string;
79826
+ /** 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). */
79827
+ workspace_id: string;
79828
+ /** 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. */
79829
+ starts_at?: string | undefined;
79830
+ /** 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`. */
79831
+ ends_at?: string | undefined;
79832
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
79833
+ errors: {
79834
+ error_code: string;
79835
+ message: string;
79836
+ }[];
79837
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
79838
+ warnings: ({
79839
+ /** Date and time at which Seam created the warning. */
79840
+ created_at: string;
79841
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
79842
+ message: string;
79843
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
79844
+ warning_code: 'waiting_to_be_issued';
79845
+ } | {
79846
+ /** Date and time at which Seam created the warning. */
79847
+ created_at: string;
79848
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
79849
+ message: string;
79850
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
79851
+ warning_code: 'schedule_externally_modified';
79852
+ } | {
79853
+ /** Date and time at which Seam created the warning. */
79854
+ created_at: string;
79855
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
79856
+ message: string;
79857
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
79858
+ warning_code: 'schedule_modified';
79859
+ } | {
79860
+ /** Date and time at which Seam created the warning. */
79861
+ created_at: string;
79862
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
79863
+ message: string;
79864
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
79865
+ warning_code: 'being_deleted';
79866
+ } | {
79867
+ /** Date and time at which Seam created the warning. */
79868
+ created_at: string;
79869
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
79870
+ message: string;
79871
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
79872
+ warning_code: 'unknown_issue_with_acs_credential';
79873
+ } | {
79874
+ /** Date and time at which Seam created the warning. */
79875
+ created_at: string;
79876
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
79877
+ message: string;
79878
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
79879
+ warning_code: 'needs_to_be_reissued';
79880
+ })[];
79881
+ /** 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). */
79882
+ is_multi_phone_sync_credential?: boolean | undefined;
79883
+ /** 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. */
79884
+ is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
79885
+ /** 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. */
79886
+ latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
79887
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
79888
+ visionline_metadata?: {
79889
+ /** Card function type in the Visionline access system. */
79890
+ card_function_type: 'guest' | 'staff';
79891
+ /** IDs of the credentials to which you want to join. */
79892
+ joiner_acs_credential_ids?: string[] | undefined;
79893
+ /** Guest entrance IDs in the Visionline access system. */
79894
+ guest_acs_entrance_ids?: string[] | undefined;
79895
+ /** Common entrance IDs in the Visionline access system. */
79896
+ common_acs_entrance_ids?: string[] | undefined;
79897
+ /** Indicates whether the credential is valid. */
79898
+ is_valid?: boolean | undefined;
79899
+ /** 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. */
79900
+ auto_join?: boolean | undefined;
79901
+ /** ID of the card in the Visionline access system. */
79902
+ card_id?: string | undefined;
79903
+ /** ID of the credential in the Visionline access system. */
79904
+ credential_id?: string | undefined;
79905
+ } | undefined;
79906
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
79907
+ assa_abloy_vostio_metadata?: {
79908
+ /** 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. */
79909
+ auto_join?: boolean | undefined;
79910
+ /** IDs of the guest entrances to override in the Vostio access system. */
79911
+ override_guest_acs_entrance_ids?: string[] | undefined;
79912
+ /** Key ID in the Vostio access system. */
79913
+ key_id?: string | undefined;
79914
+ /** Key issuing request ID in the Vostio access system. */
79915
+ key_issuing_request_id?: string | undefined;
79916
+ /** Names of the doors to which to grant access in the Vostio access system. */
79917
+ door_names?: string[] | undefined;
79918
+ /** Endpoint ID in the Vostio access system. */
79919
+ endpoint_id?: string | undefined;
79920
+ } | undefined;
79921
+ is_managed: true;
79922
+ }[] | undefined;
79923
+ unmanaged_acs_credentials?: {
79924
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
79925
+ acs_credential_id: string;
79926
+ /** 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. */
79927
+ acs_user_id?: string | undefined;
79928
+ /** 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. */
79929
+ user_identity_id?: string | undefined;
79930
+ /** 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. */
79931
+ connected_account_id: string;
79932
+ acs_credential_pool_id?: string | undefined;
79933
+ /** 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). */
79934
+ acs_system_id: string;
79935
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
79936
+ parent_acs_credential_id?: string | undefined;
79937
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
79938
+ display_name: string;
79939
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
79940
+ code?: (string | undefined) | null;
79941
+ /** 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. */
79942
+ is_one_time_use?: boolean | undefined;
79943
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
79944
+ card_number?: (string | undefined) | null;
79945
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
79946
+ is_issued?: boolean | undefined;
79947
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
79948
+ issued_at?: (string | undefined) | null;
79949
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
79950
+ access_method: 'code' | 'card' | 'mobile_key';
79951
+ /** 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`. */
79952
+ external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key' | 'latch_access') | undefined;
79953
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
79954
+ external_type_display_name?: string | undefined;
79955
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
79956
+ created_at: string;
79957
+ /** 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). */
79958
+ workspace_id: string;
79959
+ /** 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. */
79960
+ starts_at?: string | undefined;
79961
+ /** 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`. */
79962
+ ends_at?: string | undefined;
79963
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
79964
+ errors: {
79965
+ error_code: string;
79966
+ message: string;
79967
+ }[];
79968
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
79969
+ warnings: ({
79970
+ /** Date and time at which Seam created the warning. */
79971
+ created_at: string;
79972
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
79973
+ message: string;
79974
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
79975
+ warning_code: 'waiting_to_be_issued';
79976
+ } | {
79977
+ /** Date and time at which Seam created the warning. */
79978
+ created_at: string;
79979
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
79980
+ message: string;
79981
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
79982
+ warning_code: 'schedule_externally_modified';
79983
+ } | {
79984
+ /** Date and time at which Seam created the warning. */
79985
+ created_at: string;
79986
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
79987
+ message: string;
79988
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
79989
+ warning_code: 'schedule_modified';
79990
+ } | {
79991
+ /** Date and time at which Seam created the warning. */
79992
+ created_at: string;
79993
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
79994
+ message: string;
79995
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
79996
+ warning_code: 'being_deleted';
79997
+ } | {
79998
+ /** Date and time at which Seam created the warning. */
79999
+ created_at: string;
80000
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
80001
+ message: string;
80002
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
80003
+ warning_code: 'unknown_issue_with_acs_credential';
80004
+ } | {
80005
+ /** Date and time at which Seam created the warning. */
80006
+ created_at: string;
80007
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
80008
+ message: string;
80009
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
80010
+ warning_code: 'needs_to_be_reissued';
80011
+ })[];
80012
+ /** 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). */
80013
+ is_multi_phone_sync_credential?: boolean | undefined;
80014
+ /** 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. */
80015
+ is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
80016
+ /** 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. */
80017
+ latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
80018
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
80019
+ visionline_metadata?: {
80020
+ /** Card function type in the Visionline access system. */
80021
+ card_function_type: 'guest' | 'staff';
80022
+ /** IDs of the credentials to which you want to join. */
80023
+ joiner_acs_credential_ids?: string[] | undefined;
80024
+ /** Guest entrance IDs in the Visionline access system. */
80025
+ guest_acs_entrance_ids?: string[] | undefined;
80026
+ /** Common entrance IDs in the Visionline access system. */
80027
+ common_acs_entrance_ids?: string[] | undefined;
80028
+ /** Indicates whether the credential is valid. */
80029
+ is_valid?: boolean | undefined;
80030
+ /** 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. */
80031
+ auto_join?: boolean | undefined;
80032
+ /** ID of the card in the Visionline access system. */
80033
+ card_id?: string | undefined;
80034
+ /** ID of the credential in the Visionline access system. */
80035
+ credential_id?: string | undefined;
80036
+ } | undefined;
80037
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
80038
+ assa_abloy_vostio_metadata?: {
80039
+ /** 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. */
80040
+ auto_join?: boolean | undefined;
80041
+ /** IDs of the guest entrances to override in the Vostio access system. */
80042
+ override_guest_acs_entrance_ids?: string[] | undefined;
80043
+ /** Key ID in the Vostio access system. */
80044
+ key_id?: string | undefined;
80045
+ /** Key issuing request ID in the Vostio access system. */
80046
+ key_issuing_request_id?: string | undefined;
80047
+ /** Names of the doors to which to grant access in the Vostio access system. */
80048
+ door_names?: string[] | undefined;
80049
+ /** Endpoint ID in the Vostio access system. */
80050
+ endpoint_id?: string | undefined;
80051
+ } | undefined;
80052
+ is_managed: false;
80053
+ }[] | undefined;
79495
80054
  action_attempts?: ({
79496
80055
  /** ID of the action attempt. */
79497
80056
  action_attempt_id: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.487.0",
3
+ "version": "1.489.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",