@seamapi/types 1.392.1 → 1.394.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.
- package/dist/connect.cjs +121 -3
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +310 -0
- package/lib/seam/connect/models/acs/acs-users/acs-user.d.ts +72 -0
- package/lib/seam/connect/models/acs/acs-users/acs-user.js +15 -0
- package/lib/seam/connect/models/acs/acs-users/acs-user.js.map +1 -1
- package/lib/seam/connect/models/acs/metadata/assa-abloy-vostio.js +1 -0
- package/lib/seam/connect/models/acs/metadata/assa-abloy-vostio.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +71 -0
- package/lib/seam/connect/openapi.js +104 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +191 -0
- package/package.json +2 -2
- package/src/lib/seam/connect/models/acs/acs-users/acs-user.ts +18 -0
- package/src/lib/seam/connect/models/acs/metadata/assa-abloy-vostio.ts +1 -0
- package/src/lib/seam/connect/openapi.ts +112 -0
- package/src/lib/seam/connect/route-types.ts +224 -0
|
@@ -9011,6 +9011,12 @@ export interface Routes {
|
|
|
9011
9011
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
9012
9012
|
message: string;
|
|
9013
9013
|
error_code: 'failed_to_delete_on_acs_system';
|
|
9014
|
+
} | {
|
|
9015
|
+
/** Date and time at which Seam created the error. */
|
|
9016
|
+
created_at: string;
|
|
9017
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
9018
|
+
message: string;
|
|
9019
|
+
error_code: 'latch_conflict_with_resident_user';
|
|
9014
9020
|
}>;
|
|
9015
9021
|
/** Pending mutations associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Seam is in the process of pushing these mutations to the integrated access system. */
|
|
9016
9022
|
pending_mutations?: Array<{
|
|
@@ -9084,6 +9090,8 @@ export interface Routes {
|
|
|
9084
9090
|
acs_access_group_id: string | null;
|
|
9085
9091
|
};
|
|
9086
9092
|
}> | undefined;
|
|
9093
|
+
/** The last time an internal sync job completed for this ACS user. */
|
|
9094
|
+
last_successful_sync_at: string | null;
|
|
9087
9095
|
/** Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
|
|
9088
9096
|
full_name?: string | undefined;
|
|
9089
9097
|
/**
|
|
@@ -14983,6 +14991,12 @@ export interface Routes {
|
|
|
14983
14991
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
14984
14992
|
message: string;
|
|
14985
14993
|
error_code: 'failed_to_delete_on_acs_system';
|
|
14994
|
+
} | {
|
|
14995
|
+
/** Date and time at which Seam created the error. */
|
|
14996
|
+
created_at: string;
|
|
14997
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
14998
|
+
message: string;
|
|
14999
|
+
error_code: 'latch_conflict_with_resident_user';
|
|
14986
15000
|
}>;
|
|
14987
15001
|
/** Pending mutations associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Seam is in the process of pushing these mutations to the integrated access system. */
|
|
14988
15002
|
pending_mutations?: Array<{
|
|
@@ -15056,6 +15070,8 @@ export interface Routes {
|
|
|
15056
15070
|
acs_access_group_id: string | null;
|
|
15057
15071
|
};
|
|
15058
15072
|
}> | undefined;
|
|
15073
|
+
/** The last time an internal sync job completed for this ACS user. */
|
|
15074
|
+
last_successful_sync_at: string | null;
|
|
15059
15075
|
/** Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
|
|
15060
15076
|
full_name?: string | undefined;
|
|
15061
15077
|
/**
|
|
@@ -15187,6 +15203,12 @@ export interface Routes {
|
|
|
15187
15203
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
15188
15204
|
message: string;
|
|
15189
15205
|
error_code: 'failed_to_delete_on_acs_system';
|
|
15206
|
+
} | {
|
|
15207
|
+
/** Date and time at which Seam created the error. */
|
|
15208
|
+
created_at: string;
|
|
15209
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
15210
|
+
message: string;
|
|
15211
|
+
error_code: 'latch_conflict_with_resident_user';
|
|
15190
15212
|
}>;
|
|
15191
15213
|
/** Pending mutations associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Seam is in the process of pushing these mutations to the integrated access system. */
|
|
15192
15214
|
pending_mutations?: Array<{
|
|
@@ -15260,6 +15282,8 @@ export interface Routes {
|
|
|
15260
15282
|
acs_access_group_id: string | null;
|
|
15261
15283
|
};
|
|
15262
15284
|
}> | undefined;
|
|
15285
|
+
/** The last time an internal sync job completed for this ACS user. */
|
|
15286
|
+
last_successful_sync_at: string | null;
|
|
15263
15287
|
/** Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
|
|
15264
15288
|
full_name?: string | undefined;
|
|
15265
15289
|
/**
|
|
@@ -15387,6 +15411,12 @@ export interface Routes {
|
|
|
15387
15411
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
15388
15412
|
message: string;
|
|
15389
15413
|
error_code: 'failed_to_delete_on_acs_system';
|
|
15414
|
+
} | {
|
|
15415
|
+
/** Date and time at which Seam created the error. */
|
|
15416
|
+
created_at: string;
|
|
15417
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
15418
|
+
message: string;
|
|
15419
|
+
error_code: 'latch_conflict_with_resident_user';
|
|
15390
15420
|
}>;
|
|
15391
15421
|
/** Pending mutations associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Seam is in the process of pushing these mutations to the integrated access system. */
|
|
15392
15422
|
pending_mutations?: Array<{
|
|
@@ -15460,6 +15490,8 @@ export interface Routes {
|
|
|
15460
15490
|
acs_access_group_id: string | null;
|
|
15461
15491
|
};
|
|
15462
15492
|
}> | undefined;
|
|
15493
|
+
/** The last time an internal sync job completed for this ACS user. */
|
|
15494
|
+
last_successful_sync_at: string | null;
|
|
15463
15495
|
/** Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
|
|
15464
15496
|
full_name?: string | undefined;
|
|
15465
15497
|
/**
|
|
@@ -15696,6 +15728,12 @@ export interface Routes {
|
|
|
15696
15728
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
15697
15729
|
message: string;
|
|
15698
15730
|
error_code: 'failed_to_delete_on_acs_system';
|
|
15731
|
+
} | {
|
|
15732
|
+
/** Date and time at which Seam created the error. */
|
|
15733
|
+
created_at: string;
|
|
15734
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
15735
|
+
message: string;
|
|
15736
|
+
error_code: 'latch_conflict_with_resident_user';
|
|
15699
15737
|
}>;
|
|
15700
15738
|
/** Pending mutations associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Seam is in the process of pushing these mutations to the integrated access system. */
|
|
15701
15739
|
pending_mutations?: Array<{
|
|
@@ -15769,6 +15807,8 @@ export interface Routes {
|
|
|
15769
15807
|
acs_access_group_id: string | null;
|
|
15770
15808
|
};
|
|
15771
15809
|
}> | undefined;
|
|
15810
|
+
/** The last time an internal sync job completed for this ACS user. */
|
|
15811
|
+
last_successful_sync_at: string | null;
|
|
15772
15812
|
/** Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
|
|
15773
15813
|
full_name?: string | undefined;
|
|
15774
15814
|
/**
|
|
@@ -15886,6 +15926,12 @@ export interface Routes {
|
|
|
15886
15926
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
15887
15927
|
message: string;
|
|
15888
15928
|
error_code: 'failed_to_delete_on_acs_system';
|
|
15929
|
+
} | {
|
|
15930
|
+
/** Date and time at which Seam created the error. */
|
|
15931
|
+
created_at: string;
|
|
15932
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
15933
|
+
message: string;
|
|
15934
|
+
error_code: 'latch_conflict_with_resident_user';
|
|
15889
15935
|
}>;
|
|
15890
15936
|
/** Pending mutations associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Seam is in the process of pushing these mutations to the integrated access system. */
|
|
15891
15937
|
pending_mutations?: Array<{
|
|
@@ -15959,6 +16005,8 @@ export interface Routes {
|
|
|
15959
16005
|
acs_access_group_id: string | null;
|
|
15960
16006
|
};
|
|
15961
16007
|
}> | undefined;
|
|
16008
|
+
/** The last time an internal sync job completed for this ACS user. */
|
|
16009
|
+
last_successful_sync_at: string | null;
|
|
15962
16010
|
/** Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
|
|
15963
16011
|
full_name?: string | undefined;
|
|
15964
16012
|
/**
|
|
@@ -36902,6 +36950,129 @@ export interface Routes {
|
|
|
36902
36950
|
};
|
|
36903
36951
|
};
|
|
36904
36952
|
};
|
|
36953
|
+
'/seam/mobile_sdk/v1/acs/credentials/list': {
|
|
36954
|
+
route: '/seam/mobile_sdk/v1/acs/credentials/list';
|
|
36955
|
+
method: 'GET' | 'POST';
|
|
36956
|
+
queryParams: {};
|
|
36957
|
+
jsonBody: {};
|
|
36958
|
+
commonParams: {};
|
|
36959
|
+
formData: {};
|
|
36960
|
+
jsonResponse: {
|
|
36961
|
+
acs_credentials: Array<{
|
|
36962
|
+
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
36963
|
+
acs_credential_id: string;
|
|
36964
|
+
/** 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. */
|
|
36965
|
+
acs_user_id?: string | undefined;
|
|
36966
|
+
acs_credential_pool_id?: string | undefined;
|
|
36967
|
+
/** 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). */
|
|
36968
|
+
acs_system_id: string;
|
|
36969
|
+
/** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
36970
|
+
parent_acs_credential_id?: string | undefined;
|
|
36971
|
+
/** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
36972
|
+
display_name: string;
|
|
36973
|
+
/** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
36974
|
+
code?: (string | undefined) | null;
|
|
36975
|
+
/** 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. */
|
|
36976
|
+
is_one_time_use?: boolean | undefined;
|
|
36977
|
+
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
36978
|
+
card_number?: (string | undefined) | null;
|
|
36979
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
36980
|
+
is_issued?: boolean | undefined;
|
|
36981
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
36982
|
+
issued_at?: (string | undefined) | null;
|
|
36983
|
+
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
|
|
36984
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
36985
|
+
/** 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`. */
|
|
36986
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key' | 'latch_access') | undefined;
|
|
36987
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
36988
|
+
external_type_display_name?: string | undefined;
|
|
36989
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
36990
|
+
created_at: string;
|
|
36991
|
+
/** 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). */
|
|
36992
|
+
workspace_id: string;
|
|
36993
|
+
/** 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. */
|
|
36994
|
+
starts_at?: string | undefined;
|
|
36995
|
+
/** 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`. */
|
|
36996
|
+
ends_at?: string | undefined;
|
|
36997
|
+
/** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
36998
|
+
errors: Array<{
|
|
36999
|
+
error_code: string;
|
|
37000
|
+
message: string;
|
|
37001
|
+
}>;
|
|
37002
|
+
/** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
37003
|
+
warnings: Array<{
|
|
37004
|
+
/** Date and time at which Seam created the warning. */
|
|
37005
|
+
created_at: string;
|
|
37006
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
37007
|
+
message: string;
|
|
37008
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
37009
|
+
warning_code: 'waiting_to_be_issued';
|
|
37010
|
+
} | {
|
|
37011
|
+
/** Date and time at which Seam created the warning. */
|
|
37012
|
+
created_at: string;
|
|
37013
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
37014
|
+
message: string;
|
|
37015
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
37016
|
+
warning_code: 'schedule_externally_modified';
|
|
37017
|
+
} | {
|
|
37018
|
+
/** Date and time at which Seam created the warning. */
|
|
37019
|
+
created_at: string;
|
|
37020
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
37021
|
+
message: string;
|
|
37022
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
37023
|
+
warning_code: 'schedule_modified';
|
|
37024
|
+
} | {
|
|
37025
|
+
/** Date and time at which Seam created the warning. */
|
|
37026
|
+
created_at: string;
|
|
37027
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
37028
|
+
message: string;
|
|
37029
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
37030
|
+
warning_code: 'being_deleted';
|
|
37031
|
+
} | {
|
|
37032
|
+
/** Date and time at which Seam created the warning. */
|
|
37033
|
+
created_at: string;
|
|
37034
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
37035
|
+
message: string;
|
|
37036
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
37037
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
37038
|
+
} | {
|
|
37039
|
+
/** Date and time at which Seam created the warning. */
|
|
37040
|
+
created_at: string;
|
|
37041
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
37042
|
+
message: string;
|
|
37043
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
37044
|
+
warning_code: 'needs_to_be_reissued';
|
|
37045
|
+
}>;
|
|
37046
|
+
/** 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-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
|
|
37047
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
37048
|
+
/** 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. */
|
|
37049
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
37050
|
+
/** 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. */
|
|
37051
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
37052
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
37053
|
+
visionline_metadata?: {
|
|
37054
|
+
card_function_type: 'guest' | 'staff';
|
|
37055
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
37056
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
37057
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
37058
|
+
is_valid?: boolean | undefined;
|
|
37059
|
+
auto_join?: boolean | undefined;
|
|
37060
|
+
card_id?: string | undefined;
|
|
37061
|
+
credential_id?: string | undefined;
|
|
37062
|
+
} | undefined;
|
|
37063
|
+
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
37064
|
+
assa_abloy_vostio_metadata?: {
|
|
37065
|
+
auto_join?: boolean | undefined;
|
|
37066
|
+
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
37067
|
+
key_id?: string | undefined;
|
|
37068
|
+
key_issuing_request_id?: string | undefined;
|
|
37069
|
+
door_names?: string[] | undefined;
|
|
37070
|
+
endpoint_id?: string | undefined;
|
|
37071
|
+
} | undefined;
|
|
37072
|
+
is_managed: true;
|
|
37073
|
+
}>;
|
|
37074
|
+
};
|
|
37075
|
+
};
|
|
36905
37076
|
'/thermostats/activate_climate_preset': {
|
|
36906
37077
|
route: '/thermostats/activate_climate_preset';
|
|
36907
37078
|
method: 'POST';
|
|
@@ -38263,6 +38434,7 @@ export interface Routes {
|
|
|
38263
38434
|
} | undefined;
|
|
38264
38435
|
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
38265
38436
|
assa_abloy_vostio_metadata?: {
|
|
38437
|
+
auto_join?: boolean | undefined;
|
|
38266
38438
|
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
38267
38439
|
key_id?: string | undefined;
|
|
38268
38440
|
key_issuing_request_id?: string | undefined;
|
|
@@ -38374,6 +38546,7 @@ export interface Routes {
|
|
|
38374
38546
|
} | undefined;
|
|
38375
38547
|
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
38376
38548
|
assa_abloy_vostio_metadata?: {
|
|
38549
|
+
auto_join?: boolean | undefined;
|
|
38377
38550
|
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
38378
38551
|
key_id?: string | undefined;
|
|
38379
38552
|
key_issuing_request_id?: string | undefined;
|
|
@@ -38596,6 +38769,7 @@ export interface Routes {
|
|
|
38596
38769
|
} | undefined;
|
|
38597
38770
|
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
38598
38771
|
assa_abloy_vostio_metadata?: {
|
|
38772
|
+
auto_join?: boolean | undefined;
|
|
38599
38773
|
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
38600
38774
|
key_id?: string | undefined;
|
|
38601
38775
|
key_issuing_request_id?: string | undefined;
|
|
@@ -38707,6 +38881,7 @@ export interface Routes {
|
|
|
38707
38881
|
} | undefined;
|
|
38708
38882
|
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
38709
38883
|
assa_abloy_vostio_metadata?: {
|
|
38884
|
+
auto_join?: boolean | undefined;
|
|
38710
38885
|
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
38711
38886
|
key_id?: string | undefined;
|
|
38712
38887
|
key_issuing_request_id?: string | undefined;
|
|
@@ -39375,6 +39550,7 @@ export interface Routes {
|
|
|
39375
39550
|
} | undefined;
|
|
39376
39551
|
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
39377
39552
|
assa_abloy_vostio_metadata?: {
|
|
39553
|
+
auto_join?: boolean | undefined;
|
|
39378
39554
|
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
39379
39555
|
key_id?: string | undefined;
|
|
39380
39556
|
key_issuing_request_id?: string | undefined;
|
|
@@ -39486,6 +39662,7 @@ export interface Routes {
|
|
|
39486
39662
|
} | undefined;
|
|
39487
39663
|
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
39488
39664
|
assa_abloy_vostio_metadata?: {
|
|
39665
|
+
auto_join?: boolean | undefined;
|
|
39489
39666
|
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
39490
39667
|
key_id?: string | undefined;
|
|
39491
39668
|
key_issuing_request_id?: string | undefined;
|
|
@@ -39708,6 +39885,7 @@ export interface Routes {
|
|
|
39708
39885
|
} | undefined;
|
|
39709
39886
|
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
39710
39887
|
assa_abloy_vostio_metadata?: {
|
|
39888
|
+
auto_join?: boolean | undefined;
|
|
39711
39889
|
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
39712
39890
|
key_id?: string | undefined;
|
|
39713
39891
|
key_issuing_request_id?: string | undefined;
|
|
@@ -39819,6 +39997,7 @@ export interface Routes {
|
|
|
39819
39997
|
} | undefined;
|
|
39820
39998
|
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
39821
39999
|
assa_abloy_vostio_metadata?: {
|
|
40000
|
+
auto_join?: boolean | undefined;
|
|
39822
40001
|
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
39823
40002
|
key_id?: string | undefined;
|
|
39824
40003
|
key_issuing_request_id?: string | undefined;
|
|
@@ -41700,6 +41879,7 @@ export interface Routes {
|
|
|
41700
41879
|
} | undefined;
|
|
41701
41880
|
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
41702
41881
|
assa_abloy_vostio_metadata?: {
|
|
41882
|
+
auto_join?: boolean | undefined;
|
|
41703
41883
|
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
41704
41884
|
key_id?: string | undefined;
|
|
41705
41885
|
key_issuing_request_id?: string | undefined;
|
|
@@ -41811,6 +41991,7 @@ export interface Routes {
|
|
|
41811
41991
|
} | undefined;
|
|
41812
41992
|
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
41813
41993
|
assa_abloy_vostio_metadata?: {
|
|
41994
|
+
auto_join?: boolean | undefined;
|
|
41814
41995
|
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
41815
41996
|
key_id?: string | undefined;
|
|
41816
41997
|
key_issuing_request_id?: string | undefined;
|
|
@@ -42033,6 +42214,7 @@ export interface Routes {
|
|
|
42033
42214
|
} | undefined;
|
|
42034
42215
|
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
42035
42216
|
assa_abloy_vostio_metadata?: {
|
|
42217
|
+
auto_join?: boolean | undefined;
|
|
42036
42218
|
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
42037
42219
|
key_id?: string | undefined;
|
|
42038
42220
|
key_issuing_request_id?: string | undefined;
|
|
@@ -42144,6 +42326,7 @@ export interface Routes {
|
|
|
42144
42326
|
} | undefined;
|
|
42145
42327
|
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
42146
42328
|
assa_abloy_vostio_metadata?: {
|
|
42329
|
+
auto_join?: boolean | undefined;
|
|
42147
42330
|
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
42148
42331
|
key_id?: string | undefined;
|
|
42149
42332
|
key_issuing_request_id?: string | undefined;
|
|
@@ -53263,6 +53446,12 @@ export interface Routes {
|
|
|
53263
53446
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
53264
53447
|
message: string;
|
|
53265
53448
|
error_code: 'failed_to_delete_on_acs_system';
|
|
53449
|
+
} | {
|
|
53450
|
+
/** Date and time at which Seam created the error. */
|
|
53451
|
+
created_at: string;
|
|
53452
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
53453
|
+
message: string;
|
|
53454
|
+
error_code: 'latch_conflict_with_resident_user';
|
|
53266
53455
|
}>;
|
|
53267
53456
|
/** Pending mutations associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Seam is in the process of pushing these mutations to the integrated access system. */
|
|
53268
53457
|
pending_mutations?: Array<{
|
|
@@ -53336,6 +53525,8 @@ export interface Routes {
|
|
|
53336
53525
|
acs_access_group_id: string | null;
|
|
53337
53526
|
};
|
|
53338
53527
|
}> | undefined;
|
|
53528
|
+
/** The last time an internal sync job completed for this ACS user. */
|
|
53529
|
+
last_successful_sync_at: string | null;
|
|
53339
53530
|
/** Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
|
|
53340
53531
|
full_name?: string | undefined;
|
|
53341
53532
|
/**
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@seamapi/types",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.394.0",
|
|
4
4
|
"description": "TypeScript types for the Seam API.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "index.js",
|
|
@@ -92,7 +92,7 @@
|
|
|
92
92
|
"zod": "^3.24.0"
|
|
93
93
|
},
|
|
94
94
|
"devDependencies": {
|
|
95
|
-
"@seamapi/blueprint": "^0.
|
|
95
|
+
"@seamapi/blueprint": "^0.41.0",
|
|
96
96
|
"@types/node": "^20.8.10",
|
|
97
97
|
"concurrently": "^8.2.0",
|
|
98
98
|
"del-cli": "^5.0.0",
|
|
@@ -68,6 +68,14 @@ const acs_users_failed_to_delete_on_acs_system = common_acs_user_error
|
|
|
68
68
|
`Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not deleted on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).`,
|
|
69
69
|
)
|
|
70
70
|
|
|
71
|
+
const acs_users_latch_conflict_with_resident_user = common_acs_user_error
|
|
72
|
+
.extend({
|
|
73
|
+
error_code: z.literal('latch_conflict_with_resident_user'),
|
|
74
|
+
})
|
|
75
|
+
.describe(
|
|
76
|
+
`Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created from the Seam API but also exists on Mission Control. This is unsupported. Contact Seam [support](mailto:support@seam.co).`,
|
|
77
|
+
)
|
|
78
|
+
|
|
71
79
|
const acs_user_errors = z
|
|
72
80
|
.discriminatedUnion('error_code', [
|
|
73
81
|
acs_users_deleted_externally,
|
|
@@ -75,6 +83,7 @@ const acs_user_errors = z
|
|
|
75
83
|
acs_users_failed_to_create_on_acs_system,
|
|
76
84
|
acs_users_failed_to_update_on_acs_system,
|
|
77
85
|
acs_users_failed_to_delete_on_acs_system,
|
|
86
|
+
acs_users_latch_conflict_with_resident_user,
|
|
78
87
|
])
|
|
79
88
|
.describe(
|
|
80
89
|
'Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
@@ -93,6 +102,9 @@ export const acs_users_error_map = z.object({
|
|
|
93
102
|
failed_to_delete_on_acs_system: acs_users_failed_to_delete_on_acs_system
|
|
94
103
|
.optional()
|
|
95
104
|
.nullable(),
|
|
105
|
+
latch_conflict_with_resident_user: acs_users_latch_conflict_with_resident_user
|
|
106
|
+
.optional()
|
|
107
|
+
.nullable(),
|
|
96
108
|
})
|
|
97
109
|
|
|
98
110
|
export type AcsUsersErrorMap = z.infer<typeof acs_users_error_map>
|
|
@@ -325,6 +337,12 @@ const common_acs_user = z
|
|
|
325
337
|
.describe(
|
|
326
338
|
'Pending mutations associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Seam is in the process of pushing these mutations to the integrated access system.',
|
|
327
339
|
),
|
|
340
|
+
last_successful_sync_at: z.string().datetime().nullable().describe(`
|
|
341
|
+
---
|
|
342
|
+
undocumented: Only used internally.
|
|
343
|
+
---
|
|
344
|
+
The last time an internal sync job completed for this ACS user.
|
|
345
|
+
`),
|
|
328
346
|
})
|
|
329
347
|
.merge(user_fields)
|
|
330
348
|
|
|
@@ -13,6 +13,7 @@ export type AcsEntranceAssaAbloyVostioMetadata = z.infer<
|
|
|
13
13
|
>
|
|
14
14
|
|
|
15
15
|
export const acs_credential_vostio_metadata = z.object({
|
|
16
|
+
// auto_join does not exist in the Vostio API and is an abstraction made by Seam
|
|
16
17
|
auto_join: z.boolean().optional(),
|
|
17
18
|
override_guest_acs_entrance_ids: z.string().array().optional(),
|
|
18
19
|
key_id: z.string().optional(),
|
|
@@ -2895,6 +2895,29 @@ export default {
|
|
|
2895
2895
|
required: ['created_at', 'message', 'error_code'],
|
|
2896
2896
|
type: 'object',
|
|
2897
2897
|
},
|
|
2898
|
+
{
|
|
2899
|
+
description:
|
|
2900
|
+
'Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created from the Seam API but also exists on Mission Control. This is unsupported. Contact Seam [support](mailto:support@seam.co).',
|
|
2901
|
+
properties: {
|
|
2902
|
+
created_at: {
|
|
2903
|
+
description:
|
|
2904
|
+
'Date and time at which Seam created the error.',
|
|
2905
|
+
format: 'date-time',
|
|
2906
|
+
type: 'string',
|
|
2907
|
+
},
|
|
2908
|
+
error_code: {
|
|
2909
|
+
enum: ['latch_conflict_with_resident_user'],
|
|
2910
|
+
type: 'string',
|
|
2911
|
+
},
|
|
2912
|
+
message: {
|
|
2913
|
+
description:
|
|
2914
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
2915
|
+
type: 'string',
|
|
2916
|
+
},
|
|
2917
|
+
},
|
|
2918
|
+
required: ['created_at', 'message', 'error_code'],
|
|
2919
|
+
type: 'object',
|
|
2920
|
+
},
|
|
2898
2921
|
],
|
|
2899
2922
|
},
|
|
2900
2923
|
type: 'array',
|
|
@@ -2931,6 +2954,14 @@ export default {
|
|
|
2931
2954
|
'Indicates whether the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).',
|
|
2932
2955
|
type: 'boolean',
|
|
2933
2956
|
},
|
|
2957
|
+
last_successful_sync_at: {
|
|
2958
|
+
description:
|
|
2959
|
+
'The last time an internal sync job completed for this ACS user.',
|
|
2960
|
+
format: 'date-time',
|
|
2961
|
+
nullable: true,
|
|
2962
|
+
type: 'string',
|
|
2963
|
+
'x-undocumented': 'Only used internally.',
|
|
2964
|
+
},
|
|
2934
2965
|
pending_mutations: {
|
|
2935
2966
|
description:
|
|
2936
2967
|
'Pending mutations associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Seam is in the process of pushing these mutations to the integrated access system.',
|
|
@@ -3325,6 +3356,7 @@ export default {
|
|
|
3325
3356
|
'display_name',
|
|
3326
3357
|
'warnings',
|
|
3327
3358
|
'errors',
|
|
3359
|
+
'last_successful_sync_at',
|
|
3328
3360
|
'is_managed',
|
|
3329
3361
|
],
|
|
3330
3362
|
type: 'object',
|
|
@@ -17222,6 +17254,29 @@ export default {
|
|
|
17222
17254
|
required: ['created_at', 'message', 'error_code'],
|
|
17223
17255
|
type: 'object',
|
|
17224
17256
|
},
|
|
17257
|
+
{
|
|
17258
|
+
description:
|
|
17259
|
+
'Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created from the Seam API but also exists on Mission Control. This is unsupported. Contact Seam [support](mailto:support@seam.co).',
|
|
17260
|
+
properties: {
|
|
17261
|
+
created_at: {
|
|
17262
|
+
description:
|
|
17263
|
+
'Date and time at which Seam created the error.',
|
|
17264
|
+
format: 'date-time',
|
|
17265
|
+
type: 'string',
|
|
17266
|
+
},
|
|
17267
|
+
error_code: {
|
|
17268
|
+
enum: ['latch_conflict_with_resident_user'],
|
|
17269
|
+
type: 'string',
|
|
17270
|
+
},
|
|
17271
|
+
message: {
|
|
17272
|
+
description:
|
|
17273
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
17274
|
+
type: 'string',
|
|
17275
|
+
},
|
|
17276
|
+
},
|
|
17277
|
+
required: ['created_at', 'message', 'error_code'],
|
|
17278
|
+
type: 'object',
|
|
17279
|
+
},
|
|
17225
17280
|
],
|
|
17226
17281
|
},
|
|
17227
17282
|
type: 'array',
|
|
@@ -17258,6 +17313,14 @@ export default {
|
|
|
17258
17313
|
'Indicates whether the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).',
|
|
17259
17314
|
type: 'boolean',
|
|
17260
17315
|
},
|
|
17316
|
+
last_successful_sync_at: {
|
|
17317
|
+
description:
|
|
17318
|
+
'The last time an internal sync job completed for this ACS user.',
|
|
17319
|
+
format: 'date-time',
|
|
17320
|
+
nullable: true,
|
|
17321
|
+
type: 'string',
|
|
17322
|
+
'x-undocumented': 'Only used internally.',
|
|
17323
|
+
},
|
|
17261
17324
|
pending_mutations: {
|
|
17262
17325
|
description:
|
|
17263
17326
|
'Pending mutations associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Seam is in the process of pushing these mutations to the integrated access system.',
|
|
@@ -17652,6 +17715,7 @@ export default {
|
|
|
17652
17715
|
'display_name',
|
|
17653
17716
|
'warnings',
|
|
17654
17717
|
'errors',
|
|
17718
|
+
'last_successful_sync_at',
|
|
17655
17719
|
'is_managed',
|
|
17656
17720
|
],
|
|
17657
17721
|
type: 'object',
|
|
@@ -29837,6 +29901,54 @@ export default {
|
|
|
29837
29901
|
'x-undocumented': 'Seam Instant Key only.',
|
|
29838
29902
|
},
|
|
29839
29903
|
},
|
|
29904
|
+
'/seam/mobile_sdk/v1/acs/credentials/list': {
|
|
29905
|
+
post: {
|
|
29906
|
+
description: 'Returns a list of all ACS credentials.',
|
|
29907
|
+
operationId: 'seamMobileSdkV1AcsCredentialsListPost',
|
|
29908
|
+
requestBody: {
|
|
29909
|
+
content: {
|
|
29910
|
+
'application/json': { schema: { properties: {}, type: 'object' } },
|
|
29911
|
+
},
|
|
29912
|
+
},
|
|
29913
|
+
responses: {
|
|
29914
|
+
200: {
|
|
29915
|
+
content: {
|
|
29916
|
+
'application/json': {
|
|
29917
|
+
schema: {
|
|
29918
|
+
properties: {
|
|
29919
|
+
acs_credentials: {
|
|
29920
|
+
items: { $ref: '#/components/schemas/acs_credential' },
|
|
29921
|
+
type: 'array',
|
|
29922
|
+
},
|
|
29923
|
+
ok: { type: 'boolean' },
|
|
29924
|
+
},
|
|
29925
|
+
required: ['acs_credentials', 'ok'],
|
|
29926
|
+
type: 'object',
|
|
29927
|
+
},
|
|
29928
|
+
},
|
|
29929
|
+
},
|
|
29930
|
+
description: 'OK',
|
|
29931
|
+
},
|
|
29932
|
+
400: { description: 'Bad Request' },
|
|
29933
|
+
401: { description: 'Unauthorized' },
|
|
29934
|
+
},
|
|
29935
|
+
security: [{ client_session: [] }],
|
|
29936
|
+
summary: '/seam/mobile_sdk/v1/acs/credentials/list',
|
|
29937
|
+
tags: ['/acs'],
|
|
29938
|
+
'x-fern-sdk-group-name': [
|
|
29939
|
+
'seam',
|
|
29940
|
+
'mobile_sdk',
|
|
29941
|
+
'v1',
|
|
29942
|
+
'acs',
|
|
29943
|
+
'credentials',
|
|
29944
|
+
],
|
|
29945
|
+
'x-fern-sdk-method-name': 'list',
|
|
29946
|
+
'x-fern-sdk-return-value': 'acs_credentials',
|
|
29947
|
+
'x-response-key': 'acs_credentials',
|
|
29948
|
+
'x-title': 'List Credentials',
|
|
29949
|
+
'x-undocumented': 'Mobile SDK only.',
|
|
29950
|
+
},
|
|
29951
|
+
},
|
|
29840
29952
|
'/thermostats/activate_climate_preset': {
|
|
29841
29953
|
post: {
|
|
29842
29954
|
description:
|