@seamapi/types 1.392.0 → 1.393.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 +100 -3
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +285 -1
- package/lib/seam/connect/models/acs/acs-users/acs-user.d.ts +66 -0
- package/lib/seam/connect/models/acs/acs-users/acs-user.js +9 -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 +65 -0
- package/lib/seam/connect/openapi.js +89 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +178 -1
- package/package.json +1 -1
- package/src/lib/seam/connect/models/acs/acs-users/acs-user.ts +12 -0
- package/src/lib/seam/connect/models/acs/metadata/assa-abloy-vostio.ts +1 -0
- package/src/lib/seam/connect/openapi.ts +95 -0
- package/src/lib/seam/connect/route-types.ts +211 -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<{
|
|
@@ -9856,7 +9862,7 @@ export interface Routes {
|
|
|
9856
9862
|
} | {
|
|
9857
9863
|
/** ID of the user identity for which you want to retrieve all credentials. */
|
|
9858
9864
|
user_identity_id: string;
|
|
9859
|
-
}) & {
|
|
9865
|
+
} | {}) & {
|
|
9860
9866
|
/** Number of credentials to return. */
|
|
9861
9867
|
limit?: number;
|
|
9862
9868
|
/** Date and time, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format, before which events to return were created. */
|
|
@@ -14983,6 +14989,12 @@ export interface Routes {
|
|
|
14983
14989
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
14984
14990
|
message: string;
|
|
14985
14991
|
error_code: 'failed_to_delete_on_acs_system';
|
|
14992
|
+
} | {
|
|
14993
|
+
/** Date and time at which Seam created the error. */
|
|
14994
|
+
created_at: string;
|
|
14995
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
14996
|
+
message: string;
|
|
14997
|
+
error_code: 'latch_conflict_with_resident_user';
|
|
14986
14998
|
}>;
|
|
14987
14999
|
/** 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
15000
|
pending_mutations?: Array<{
|
|
@@ -15187,6 +15199,12 @@ export interface Routes {
|
|
|
15187
15199
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
15188
15200
|
message: string;
|
|
15189
15201
|
error_code: 'failed_to_delete_on_acs_system';
|
|
15202
|
+
} | {
|
|
15203
|
+
/** Date and time at which Seam created the error. */
|
|
15204
|
+
created_at: string;
|
|
15205
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
15206
|
+
message: string;
|
|
15207
|
+
error_code: 'latch_conflict_with_resident_user';
|
|
15190
15208
|
}>;
|
|
15191
15209
|
/** 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
15210
|
pending_mutations?: Array<{
|
|
@@ -15387,6 +15405,12 @@ export interface Routes {
|
|
|
15387
15405
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
15388
15406
|
message: string;
|
|
15389
15407
|
error_code: 'failed_to_delete_on_acs_system';
|
|
15408
|
+
} | {
|
|
15409
|
+
/** Date and time at which Seam created the error. */
|
|
15410
|
+
created_at: string;
|
|
15411
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
15412
|
+
message: string;
|
|
15413
|
+
error_code: 'latch_conflict_with_resident_user';
|
|
15390
15414
|
}>;
|
|
15391
15415
|
/** 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
15416
|
pending_mutations?: Array<{
|
|
@@ -15696,6 +15720,12 @@ export interface Routes {
|
|
|
15696
15720
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
15697
15721
|
message: string;
|
|
15698
15722
|
error_code: 'failed_to_delete_on_acs_system';
|
|
15723
|
+
} | {
|
|
15724
|
+
/** Date and time at which Seam created the error. */
|
|
15725
|
+
created_at: string;
|
|
15726
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
15727
|
+
message: string;
|
|
15728
|
+
error_code: 'latch_conflict_with_resident_user';
|
|
15699
15729
|
}>;
|
|
15700
15730
|
/** 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
15731
|
pending_mutations?: Array<{
|
|
@@ -15886,6 +15916,12 @@ export interface Routes {
|
|
|
15886
15916
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
15887
15917
|
message: string;
|
|
15888
15918
|
error_code: 'failed_to_delete_on_acs_system';
|
|
15919
|
+
} | {
|
|
15920
|
+
/** Date and time at which Seam created the error. */
|
|
15921
|
+
created_at: string;
|
|
15922
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
15923
|
+
message: string;
|
|
15924
|
+
error_code: 'latch_conflict_with_resident_user';
|
|
15889
15925
|
}>;
|
|
15890
15926
|
/** 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
15927
|
pending_mutations?: Array<{
|
|
@@ -36902,6 +36938,129 @@ export interface Routes {
|
|
|
36902
36938
|
};
|
|
36903
36939
|
};
|
|
36904
36940
|
};
|
|
36941
|
+
'/seam/mobile_sdk/v1/acs/credentials/list': {
|
|
36942
|
+
route: '/seam/mobile_sdk/v1/acs/credentials/list';
|
|
36943
|
+
method: 'GET' | 'POST';
|
|
36944
|
+
queryParams: {};
|
|
36945
|
+
jsonBody: {};
|
|
36946
|
+
commonParams: {};
|
|
36947
|
+
formData: {};
|
|
36948
|
+
jsonResponse: {
|
|
36949
|
+
acs_credentials: Array<{
|
|
36950
|
+
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
36951
|
+
acs_credential_id: string;
|
|
36952
|
+
/** 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. */
|
|
36953
|
+
acs_user_id?: string | undefined;
|
|
36954
|
+
acs_credential_pool_id?: string | undefined;
|
|
36955
|
+
/** 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). */
|
|
36956
|
+
acs_system_id: string;
|
|
36957
|
+
/** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
36958
|
+
parent_acs_credential_id?: string | undefined;
|
|
36959
|
+
/** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
36960
|
+
display_name: string;
|
|
36961
|
+
/** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
36962
|
+
code?: (string | undefined) | null;
|
|
36963
|
+
/** 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. */
|
|
36964
|
+
is_one_time_use?: boolean | undefined;
|
|
36965
|
+
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
36966
|
+
card_number?: (string | undefined) | null;
|
|
36967
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
36968
|
+
is_issued?: boolean | undefined;
|
|
36969
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
36970
|
+
issued_at?: (string | undefined) | null;
|
|
36971
|
+
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
|
|
36972
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
36973
|
+
/** 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`. */
|
|
36974
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key' | 'latch_access') | undefined;
|
|
36975
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
36976
|
+
external_type_display_name?: string | undefined;
|
|
36977
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
36978
|
+
created_at: string;
|
|
36979
|
+
/** 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). */
|
|
36980
|
+
workspace_id: string;
|
|
36981
|
+
/** 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. */
|
|
36982
|
+
starts_at?: string | undefined;
|
|
36983
|
+
/** 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`. */
|
|
36984
|
+
ends_at?: string | undefined;
|
|
36985
|
+
/** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
36986
|
+
errors: Array<{
|
|
36987
|
+
error_code: string;
|
|
36988
|
+
message: string;
|
|
36989
|
+
}>;
|
|
36990
|
+
/** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
36991
|
+
warnings: Array<{
|
|
36992
|
+
/** Date and time at which Seam created the warning. */
|
|
36993
|
+
created_at: string;
|
|
36994
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
36995
|
+
message: string;
|
|
36996
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
36997
|
+
warning_code: 'waiting_to_be_issued';
|
|
36998
|
+
} | {
|
|
36999
|
+
/** Date and time at which Seam created the warning. */
|
|
37000
|
+
created_at: string;
|
|
37001
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
37002
|
+
message: string;
|
|
37003
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
37004
|
+
warning_code: 'schedule_externally_modified';
|
|
37005
|
+
} | {
|
|
37006
|
+
/** Date and time at which Seam created the warning. */
|
|
37007
|
+
created_at: string;
|
|
37008
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
37009
|
+
message: string;
|
|
37010
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
37011
|
+
warning_code: 'schedule_modified';
|
|
37012
|
+
} | {
|
|
37013
|
+
/** Date and time at which Seam created the warning. */
|
|
37014
|
+
created_at: string;
|
|
37015
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
37016
|
+
message: string;
|
|
37017
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
37018
|
+
warning_code: 'being_deleted';
|
|
37019
|
+
} | {
|
|
37020
|
+
/** Date and time at which Seam created the warning. */
|
|
37021
|
+
created_at: string;
|
|
37022
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
37023
|
+
message: string;
|
|
37024
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
37025
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
37026
|
+
} | {
|
|
37027
|
+
/** Date and time at which Seam created the warning. */
|
|
37028
|
+
created_at: string;
|
|
37029
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
37030
|
+
message: string;
|
|
37031
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
37032
|
+
warning_code: 'needs_to_be_reissued';
|
|
37033
|
+
}>;
|
|
37034
|
+
/** 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). */
|
|
37035
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
37036
|
+
/** 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. */
|
|
37037
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
37038
|
+
/** 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. */
|
|
37039
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
37040
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
37041
|
+
visionline_metadata?: {
|
|
37042
|
+
card_function_type: 'guest' | 'staff';
|
|
37043
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
37044
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
37045
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
37046
|
+
is_valid?: boolean | undefined;
|
|
37047
|
+
auto_join?: boolean | undefined;
|
|
37048
|
+
card_id?: string | undefined;
|
|
37049
|
+
credential_id?: string | undefined;
|
|
37050
|
+
} | undefined;
|
|
37051
|
+
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
37052
|
+
assa_abloy_vostio_metadata?: {
|
|
37053
|
+
auto_join?: boolean | undefined;
|
|
37054
|
+
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
37055
|
+
key_id?: string | undefined;
|
|
37056
|
+
key_issuing_request_id?: string | undefined;
|
|
37057
|
+
door_names?: string[] | undefined;
|
|
37058
|
+
endpoint_id?: string | undefined;
|
|
37059
|
+
} | undefined;
|
|
37060
|
+
is_managed: true;
|
|
37061
|
+
}>;
|
|
37062
|
+
};
|
|
37063
|
+
};
|
|
36905
37064
|
'/thermostats/activate_climate_preset': {
|
|
36906
37065
|
route: '/thermostats/activate_climate_preset';
|
|
36907
37066
|
method: 'POST';
|
|
@@ -38263,6 +38422,7 @@ export interface Routes {
|
|
|
38263
38422
|
} | undefined;
|
|
38264
38423
|
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
38265
38424
|
assa_abloy_vostio_metadata?: {
|
|
38425
|
+
auto_join?: boolean | undefined;
|
|
38266
38426
|
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
38267
38427
|
key_id?: string | undefined;
|
|
38268
38428
|
key_issuing_request_id?: string | undefined;
|
|
@@ -38374,6 +38534,7 @@ export interface Routes {
|
|
|
38374
38534
|
} | undefined;
|
|
38375
38535
|
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
38376
38536
|
assa_abloy_vostio_metadata?: {
|
|
38537
|
+
auto_join?: boolean | undefined;
|
|
38377
38538
|
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
38378
38539
|
key_id?: string | undefined;
|
|
38379
38540
|
key_issuing_request_id?: string | undefined;
|
|
@@ -38596,6 +38757,7 @@ export interface Routes {
|
|
|
38596
38757
|
} | undefined;
|
|
38597
38758
|
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
38598
38759
|
assa_abloy_vostio_metadata?: {
|
|
38760
|
+
auto_join?: boolean | undefined;
|
|
38599
38761
|
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
38600
38762
|
key_id?: string | undefined;
|
|
38601
38763
|
key_issuing_request_id?: string | undefined;
|
|
@@ -38707,6 +38869,7 @@ export interface Routes {
|
|
|
38707
38869
|
} | undefined;
|
|
38708
38870
|
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
38709
38871
|
assa_abloy_vostio_metadata?: {
|
|
38872
|
+
auto_join?: boolean | undefined;
|
|
38710
38873
|
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
38711
38874
|
key_id?: string | undefined;
|
|
38712
38875
|
key_issuing_request_id?: string | undefined;
|
|
@@ -39375,6 +39538,7 @@ export interface Routes {
|
|
|
39375
39538
|
} | undefined;
|
|
39376
39539
|
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
39377
39540
|
assa_abloy_vostio_metadata?: {
|
|
39541
|
+
auto_join?: boolean | undefined;
|
|
39378
39542
|
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
39379
39543
|
key_id?: string | undefined;
|
|
39380
39544
|
key_issuing_request_id?: string | undefined;
|
|
@@ -39486,6 +39650,7 @@ export interface Routes {
|
|
|
39486
39650
|
} | undefined;
|
|
39487
39651
|
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
39488
39652
|
assa_abloy_vostio_metadata?: {
|
|
39653
|
+
auto_join?: boolean | undefined;
|
|
39489
39654
|
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
39490
39655
|
key_id?: string | undefined;
|
|
39491
39656
|
key_issuing_request_id?: string | undefined;
|
|
@@ -39708,6 +39873,7 @@ export interface Routes {
|
|
|
39708
39873
|
} | undefined;
|
|
39709
39874
|
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
39710
39875
|
assa_abloy_vostio_metadata?: {
|
|
39876
|
+
auto_join?: boolean | undefined;
|
|
39711
39877
|
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
39712
39878
|
key_id?: string | undefined;
|
|
39713
39879
|
key_issuing_request_id?: string | undefined;
|
|
@@ -39819,6 +39985,7 @@ export interface Routes {
|
|
|
39819
39985
|
} | undefined;
|
|
39820
39986
|
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
39821
39987
|
assa_abloy_vostio_metadata?: {
|
|
39988
|
+
auto_join?: boolean | undefined;
|
|
39822
39989
|
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
39823
39990
|
key_id?: string | undefined;
|
|
39824
39991
|
key_issuing_request_id?: string | undefined;
|
|
@@ -41700,6 +41867,7 @@ export interface Routes {
|
|
|
41700
41867
|
} | undefined;
|
|
41701
41868
|
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
41702
41869
|
assa_abloy_vostio_metadata?: {
|
|
41870
|
+
auto_join?: boolean | undefined;
|
|
41703
41871
|
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
41704
41872
|
key_id?: string | undefined;
|
|
41705
41873
|
key_issuing_request_id?: string | undefined;
|
|
@@ -41811,6 +41979,7 @@ export interface Routes {
|
|
|
41811
41979
|
} | undefined;
|
|
41812
41980
|
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
41813
41981
|
assa_abloy_vostio_metadata?: {
|
|
41982
|
+
auto_join?: boolean | undefined;
|
|
41814
41983
|
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
41815
41984
|
key_id?: string | undefined;
|
|
41816
41985
|
key_issuing_request_id?: string | undefined;
|
|
@@ -42033,6 +42202,7 @@ export interface Routes {
|
|
|
42033
42202
|
} | undefined;
|
|
42034
42203
|
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
42035
42204
|
assa_abloy_vostio_metadata?: {
|
|
42205
|
+
auto_join?: boolean | undefined;
|
|
42036
42206
|
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
42037
42207
|
key_id?: string | undefined;
|
|
42038
42208
|
key_issuing_request_id?: string | undefined;
|
|
@@ -42144,6 +42314,7 @@ export interface Routes {
|
|
|
42144
42314
|
} | undefined;
|
|
42145
42315
|
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
42146
42316
|
assa_abloy_vostio_metadata?: {
|
|
42317
|
+
auto_join?: boolean | undefined;
|
|
42147
42318
|
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
42148
42319
|
key_id?: string | undefined;
|
|
42149
42320
|
key_issuing_request_id?: string | undefined;
|
|
@@ -53263,6 +53434,12 @@ export interface Routes {
|
|
|
53263
53434
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
53264
53435
|
message: string;
|
|
53265
53436
|
error_code: 'failed_to_delete_on_acs_system';
|
|
53437
|
+
} | {
|
|
53438
|
+
/** Date and time at which Seam created the error. */
|
|
53439
|
+
created_at: string;
|
|
53440
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
53441
|
+
message: string;
|
|
53442
|
+
error_code: 'latch_conflict_with_resident_user';
|
|
53266
53443
|
}>;
|
|
53267
53444
|
/** 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
53445
|
pending_mutations?: Array<{
|
package/package.json
CHANGED
|
@@ -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>
|
|
@@ -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',
|
|
@@ -17222,6 +17245,29 @@ export default {
|
|
|
17222
17245
|
required: ['created_at', 'message', 'error_code'],
|
|
17223
17246
|
type: 'object',
|
|
17224
17247
|
},
|
|
17248
|
+
{
|
|
17249
|
+
description:
|
|
17250
|
+
'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).',
|
|
17251
|
+
properties: {
|
|
17252
|
+
created_at: {
|
|
17253
|
+
description:
|
|
17254
|
+
'Date and time at which Seam created the error.',
|
|
17255
|
+
format: 'date-time',
|
|
17256
|
+
type: 'string',
|
|
17257
|
+
},
|
|
17258
|
+
error_code: {
|
|
17259
|
+
enum: ['latch_conflict_with_resident_user'],
|
|
17260
|
+
type: 'string',
|
|
17261
|
+
},
|
|
17262
|
+
message: {
|
|
17263
|
+
description:
|
|
17264
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
17265
|
+
type: 'string',
|
|
17266
|
+
},
|
|
17267
|
+
},
|
|
17268
|
+
required: ['created_at', 'message', 'error_code'],
|
|
17269
|
+
type: 'object',
|
|
17270
|
+
},
|
|
17225
17271
|
],
|
|
17226
17272
|
},
|
|
17227
17273
|
type: 'array',
|
|
@@ -21829,6 +21875,7 @@ export default {
|
|
|
21829
21875
|
required: ['user_identity_id'],
|
|
21830
21876
|
type: 'object',
|
|
21831
21877
|
},
|
|
21878
|
+
{ properties: {}, type: 'object' },
|
|
21832
21879
|
],
|
|
21833
21880
|
},
|
|
21834
21881
|
{
|
|
@@ -29836,6 +29883,54 @@ export default {
|
|
|
29836
29883
|
'x-undocumented': 'Seam Instant Key only.',
|
|
29837
29884
|
},
|
|
29838
29885
|
},
|
|
29886
|
+
'/seam/mobile_sdk/v1/acs/credentials/list': {
|
|
29887
|
+
post: {
|
|
29888
|
+
description: 'Returns a list of all ACS credentials.',
|
|
29889
|
+
operationId: 'seamMobileSdkV1AcsCredentialsListPost',
|
|
29890
|
+
requestBody: {
|
|
29891
|
+
content: {
|
|
29892
|
+
'application/json': { schema: { properties: {}, type: 'object' } },
|
|
29893
|
+
},
|
|
29894
|
+
},
|
|
29895
|
+
responses: {
|
|
29896
|
+
200: {
|
|
29897
|
+
content: {
|
|
29898
|
+
'application/json': {
|
|
29899
|
+
schema: {
|
|
29900
|
+
properties: {
|
|
29901
|
+
acs_credentials: {
|
|
29902
|
+
items: { $ref: '#/components/schemas/acs_credential' },
|
|
29903
|
+
type: 'array',
|
|
29904
|
+
},
|
|
29905
|
+
ok: { type: 'boolean' },
|
|
29906
|
+
},
|
|
29907
|
+
required: ['acs_credentials', 'ok'],
|
|
29908
|
+
type: 'object',
|
|
29909
|
+
},
|
|
29910
|
+
},
|
|
29911
|
+
},
|
|
29912
|
+
description: 'OK',
|
|
29913
|
+
},
|
|
29914
|
+
400: { description: 'Bad Request' },
|
|
29915
|
+
401: { description: 'Unauthorized' },
|
|
29916
|
+
},
|
|
29917
|
+
security: [{ client_session: [] }],
|
|
29918
|
+
summary: '/seam/mobile_sdk/v1/acs/credentials/list',
|
|
29919
|
+
tags: ['/acs'],
|
|
29920
|
+
'x-fern-sdk-group-name': [
|
|
29921
|
+
'seam',
|
|
29922
|
+
'mobile_sdk',
|
|
29923
|
+
'v1',
|
|
29924
|
+
'acs',
|
|
29925
|
+
'credentials',
|
|
29926
|
+
],
|
|
29927
|
+
'x-fern-sdk-method-name': 'list',
|
|
29928
|
+
'x-fern-sdk-return-value': 'acs_credentials',
|
|
29929
|
+
'x-response-key': 'acs_credentials',
|
|
29930
|
+
'x-title': 'List Credentials',
|
|
29931
|
+
'x-undocumented': 'Mobile SDK only.',
|
|
29932
|
+
},
|
|
29933
|
+
},
|
|
29839
29934
|
'/thermostats/activate_climate_preset': {
|
|
29840
29935
|
post: {
|
|
29841
29936
|
description:
|