@seamapi/types 1.851.0 → 1.853.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 +729 -60
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +8858 -470
- package/dist/index.cjs +729 -60
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +558 -0
- package/lib/seam/connect/models/action-attempts/action-attempt.js +2 -0
- package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/scan-to-assign-credential.d.ts +561 -0
- package/lib/seam/connect/models/action-attempts/scan-to-assign-credential.js +38 -0
- package/lib/seam/connect/models/action-attempts/scan-to-assign-credential.js.map +1 -0
- package/lib/seam/connect/models/batch.d.ts +953 -117
- package/lib/seam/connect/models/devices/device-metadata.d.ts +28 -0
- package/lib/seam/connect/models/devices/device-metadata.js +12 -0
- package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
- package/lib/seam/connect/models/devices/device-provider.d.ts +1 -0
- package/lib/seam/connect/models/devices/device-provider.js +1 -0
- package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
- package/lib/seam/connect/models/devices/device-type.d.ts +1 -0
- package/lib/seam/connect/models/devices/device-type.js +1 -0
- package/lib/seam/connect/models/devices/device-type.js.map +1 -1
- package/lib/seam/connect/models/devices/device.d.ts +43 -3
- package/lib/seam/connect/models/devices/unmanaged-device.d.ts +31 -3
- package/lib/seam/connect/openapi.js +621 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +7379 -454
- package/package.json +1 -1
- package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +2 -0
- package/src/lib/seam/connect/models/action-attempts/scan-to-assign-credential.ts +69 -0
- package/src/lib/seam/connect/models/devices/device-metadata.ts +15 -0
- package/src/lib/seam/connect/models/devices/device-provider.ts +1 -0
- package/src/lib/seam/connect/models/devices/device-type.ts +1 -0
- package/src/lib/seam/connect/openapi.ts +709 -0
- package/src/lib/seam/connect/route-types.ts +8322 -0
|
@@ -7695,6 +7695,508 @@ const openapi = {
|
|
|
7695
7695
|
],
|
|
7696
7696
|
type: 'object',
|
|
7697
7697
|
},
|
|
7698
|
+
{
|
|
7699
|
+
description: 'Scanning a physical card and assigning the credential is pending.',
|
|
7700
|
+
properties: {
|
|
7701
|
+
action_attempt_id: {
|
|
7702
|
+
description: 'ID of the action attempt.',
|
|
7703
|
+
format: 'uuid',
|
|
7704
|
+
type: 'string',
|
|
7705
|
+
},
|
|
7706
|
+
action_type: {
|
|
7707
|
+
description: 'Action attempt to track the status of scanning a physical card and assigning the credential to an ACS user.',
|
|
7708
|
+
enum: ['SCAN_TO_ASSIGN_CREDENTIAL'],
|
|
7709
|
+
type: 'string',
|
|
7710
|
+
},
|
|
7711
|
+
error: {
|
|
7712
|
+
description: 'Errors associated with the action attempt. Null for pending action attempts.',
|
|
7713
|
+
nullable: true,
|
|
7714
|
+
},
|
|
7715
|
+
result: {
|
|
7716
|
+
description: 'Result of the action attempt. Null for pending action attempts.',
|
|
7717
|
+
nullable: true,
|
|
7718
|
+
},
|
|
7719
|
+
status: { enum: ['pending'], type: 'string' },
|
|
7720
|
+
},
|
|
7721
|
+
required: [
|
|
7722
|
+
'action_attempt_id',
|
|
7723
|
+
'status',
|
|
7724
|
+
'result',
|
|
7725
|
+
'error',
|
|
7726
|
+
'action_type',
|
|
7727
|
+
],
|
|
7728
|
+
type: 'object',
|
|
7729
|
+
},
|
|
7730
|
+
{
|
|
7731
|
+
description: 'Scanning a physical card and assigning the credential succeeded.',
|
|
7732
|
+
properties: {
|
|
7733
|
+
action_attempt_id: {
|
|
7734
|
+
description: 'ID of the action attempt.',
|
|
7735
|
+
format: 'uuid',
|
|
7736
|
+
type: 'string',
|
|
7737
|
+
},
|
|
7738
|
+
action_type: {
|
|
7739
|
+
description: 'Action attempt to track the status of scanning a physical card and assigning the credential to an ACS user.',
|
|
7740
|
+
enum: ['SCAN_TO_ASSIGN_CREDENTIAL'],
|
|
7741
|
+
type: 'string',
|
|
7742
|
+
},
|
|
7743
|
+
error: {
|
|
7744
|
+
description: 'Errors associated with the action attempt. Null for successful action attempts.',
|
|
7745
|
+
nullable: true,
|
|
7746
|
+
},
|
|
7747
|
+
result: {
|
|
7748
|
+
description: 'Result of a scan to assign attempt. If the attempt was successful, includes the credential data that was scanned and assigned.',
|
|
7749
|
+
properties: {
|
|
7750
|
+
access_method: {
|
|
7751
|
+
description: 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
|
|
7752
|
+
enum: ['code', 'card', 'mobile_key', 'cloud_key'],
|
|
7753
|
+
type: 'string',
|
|
7754
|
+
},
|
|
7755
|
+
acs_credential_id: {
|
|
7756
|
+
description: 'ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
7757
|
+
format: 'uuid',
|
|
7758
|
+
type: 'string',
|
|
7759
|
+
},
|
|
7760
|
+
acs_credential_pool_id: { format: 'uuid', type: 'string' },
|
|
7761
|
+
acs_system_id: {
|
|
7762
|
+
description: '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).',
|
|
7763
|
+
format: 'uuid',
|
|
7764
|
+
type: 'string',
|
|
7765
|
+
},
|
|
7766
|
+
acs_user_id: {
|
|
7767
|
+
description: '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.',
|
|
7768
|
+
format: 'uuid',
|
|
7769
|
+
type: 'string',
|
|
7770
|
+
},
|
|
7771
|
+
assa_abloy_vostio_metadata: {
|
|
7772
|
+
description: 'Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
7773
|
+
properties: {
|
|
7774
|
+
auto_join: {
|
|
7775
|
+
description: '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.',
|
|
7776
|
+
type: 'boolean',
|
|
7777
|
+
},
|
|
7778
|
+
door_names: {
|
|
7779
|
+
description: 'Names of the doors to which to grant access in the Vostio access system.',
|
|
7780
|
+
items: { type: 'string' },
|
|
7781
|
+
type: 'array',
|
|
7782
|
+
},
|
|
7783
|
+
endpoint_id: {
|
|
7784
|
+
description: 'Endpoint ID in the Vostio access system.',
|
|
7785
|
+
type: 'string',
|
|
7786
|
+
},
|
|
7787
|
+
key_id: {
|
|
7788
|
+
description: 'Key ID in the Vostio access system.',
|
|
7789
|
+
type: 'string',
|
|
7790
|
+
},
|
|
7791
|
+
key_issuing_request_id: {
|
|
7792
|
+
description: 'Key issuing request ID in the Vostio access system.',
|
|
7793
|
+
type: 'string',
|
|
7794
|
+
},
|
|
7795
|
+
override_guest_acs_entrance_ids: {
|
|
7796
|
+
description: 'IDs of the guest entrances to override in the Vostio access system.',
|
|
7797
|
+
items: { type: 'string' },
|
|
7798
|
+
type: 'array',
|
|
7799
|
+
},
|
|
7800
|
+
},
|
|
7801
|
+
type: 'object',
|
|
7802
|
+
},
|
|
7803
|
+
card_number: {
|
|
7804
|
+
description: 'Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
7805
|
+
nullable: true,
|
|
7806
|
+
type: 'string',
|
|
7807
|
+
},
|
|
7808
|
+
code: {
|
|
7809
|
+
description: 'Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
7810
|
+
nullable: true,
|
|
7811
|
+
type: 'string',
|
|
7812
|
+
},
|
|
7813
|
+
connected_account_id: {
|
|
7814
|
+
description: '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.',
|
|
7815
|
+
format: 'uuid',
|
|
7816
|
+
type: 'string',
|
|
7817
|
+
},
|
|
7818
|
+
created_at: {
|
|
7819
|
+
description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.',
|
|
7820
|
+
format: 'date-time',
|
|
7821
|
+
type: 'string',
|
|
7822
|
+
},
|
|
7823
|
+
display_name: {
|
|
7824
|
+
description: 'Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.',
|
|
7825
|
+
minLength: 1,
|
|
7826
|
+
type: 'string',
|
|
7827
|
+
},
|
|
7828
|
+
ends_at: {
|
|
7829
|
+
description: '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`.',
|
|
7830
|
+
type: 'string',
|
|
7831
|
+
},
|
|
7832
|
+
errors: {
|
|
7833
|
+
description: 'Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
7834
|
+
items: {
|
|
7835
|
+
properties: {
|
|
7836
|
+
error_code: { type: 'string' },
|
|
7837
|
+
message: { type: 'string' },
|
|
7838
|
+
},
|
|
7839
|
+
required: ['error_code', 'message'],
|
|
7840
|
+
type: 'object',
|
|
7841
|
+
},
|
|
7842
|
+
type: 'array',
|
|
7843
|
+
},
|
|
7844
|
+
external_type: {
|
|
7845
|
+
description: '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`.',
|
|
7846
|
+
enum: [
|
|
7847
|
+
'pti_card',
|
|
7848
|
+
'brivo_credential',
|
|
7849
|
+
'hid_credential',
|
|
7850
|
+
'visionline_card',
|
|
7851
|
+
'salto_ks_credential',
|
|
7852
|
+
'assa_abloy_vostio_key',
|
|
7853
|
+
'salto_space_key',
|
|
7854
|
+
'latch_access',
|
|
7855
|
+
'dormakaba_ambiance_credential',
|
|
7856
|
+
'hotek_card',
|
|
7857
|
+
'salto_ks_tag',
|
|
7858
|
+
'avigilon_alta_credential',
|
|
7859
|
+
],
|
|
7860
|
+
type: 'string',
|
|
7861
|
+
},
|
|
7862
|
+
external_type_display_name: {
|
|
7863
|
+
description: 'Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.',
|
|
7864
|
+
type: 'string',
|
|
7865
|
+
},
|
|
7866
|
+
is_issued: {
|
|
7867
|
+
description: 'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card.',
|
|
7868
|
+
type: 'boolean',
|
|
7869
|
+
},
|
|
7870
|
+
is_latest_desired_state_synced_with_provider: {
|
|
7871
|
+
description: '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.',
|
|
7872
|
+
nullable: true,
|
|
7873
|
+
type: 'boolean',
|
|
7874
|
+
},
|
|
7875
|
+
is_managed: { enum: [true], type: 'boolean' },
|
|
7876
|
+
is_multi_phone_sync_credential: {
|
|
7877
|
+
description: '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).',
|
|
7878
|
+
type: 'boolean',
|
|
7879
|
+
},
|
|
7880
|
+
is_one_time_use: {
|
|
7881
|
+
description: '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.',
|
|
7882
|
+
type: 'boolean',
|
|
7883
|
+
},
|
|
7884
|
+
issued_at: {
|
|
7885
|
+
description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card.',
|
|
7886
|
+
format: 'date-time',
|
|
7887
|
+
nullable: true,
|
|
7888
|
+
type: 'string',
|
|
7889
|
+
},
|
|
7890
|
+
latest_desired_state_synced_with_provider_at: {
|
|
7891
|
+
description: '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.',
|
|
7892
|
+
format: 'date-time',
|
|
7893
|
+
nullable: true,
|
|
7894
|
+
type: 'string',
|
|
7895
|
+
},
|
|
7896
|
+
parent_acs_credential_id: {
|
|
7897
|
+
description: 'ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
7898
|
+
format: 'uuid',
|
|
7899
|
+
type: 'string',
|
|
7900
|
+
},
|
|
7901
|
+
starts_at: {
|
|
7902
|
+
description: '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.',
|
|
7903
|
+
type: 'string',
|
|
7904
|
+
},
|
|
7905
|
+
user_identity_id: {
|
|
7906
|
+
description: '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.',
|
|
7907
|
+
format: 'uuid',
|
|
7908
|
+
type: 'string',
|
|
7909
|
+
},
|
|
7910
|
+
visionline_metadata: {
|
|
7911
|
+
description: 'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
7912
|
+
properties: {
|
|
7913
|
+
auto_join: {
|
|
7914
|
+
description: '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.',
|
|
7915
|
+
type: 'boolean',
|
|
7916
|
+
},
|
|
7917
|
+
card_function_type: {
|
|
7918
|
+
description: 'Card function type in the Visionline access system.',
|
|
7919
|
+
enum: ['guest', 'staff'],
|
|
7920
|
+
type: 'string',
|
|
7921
|
+
},
|
|
7922
|
+
card_id: {
|
|
7923
|
+
description: 'ID of the card in the Visionline access system.',
|
|
7924
|
+
type: 'string',
|
|
7925
|
+
},
|
|
7926
|
+
common_acs_entrance_ids: {
|
|
7927
|
+
description: 'Common entrance IDs in the Visionline access system.',
|
|
7928
|
+
items: { format: 'uuid', type: 'string' },
|
|
7929
|
+
type: 'array',
|
|
7930
|
+
},
|
|
7931
|
+
credential_id: {
|
|
7932
|
+
description: 'ID of the credential in the Visionline access system.',
|
|
7933
|
+
type: 'string',
|
|
7934
|
+
},
|
|
7935
|
+
guest_acs_entrance_ids: {
|
|
7936
|
+
description: 'Guest entrance IDs in the Visionline access system.',
|
|
7937
|
+
items: { format: 'uuid', type: 'string' },
|
|
7938
|
+
type: 'array',
|
|
7939
|
+
},
|
|
7940
|
+
is_valid: {
|
|
7941
|
+
description: 'Indicates whether the credential is valid.',
|
|
7942
|
+
type: 'boolean',
|
|
7943
|
+
},
|
|
7944
|
+
joiner_acs_credential_ids: {
|
|
7945
|
+
description: 'IDs of the credentials to which you want to join.',
|
|
7946
|
+
items: { format: 'uuid', type: 'string' },
|
|
7947
|
+
type: 'array',
|
|
7948
|
+
},
|
|
7949
|
+
},
|
|
7950
|
+
required: ['card_function_type'],
|
|
7951
|
+
type: 'object',
|
|
7952
|
+
},
|
|
7953
|
+
warnings: {
|
|
7954
|
+
description: 'Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
7955
|
+
items: {
|
|
7956
|
+
description: 'Warning associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
7957
|
+
discriminator: { propertyName: 'warning_code' },
|
|
7958
|
+
oneOf: [
|
|
7959
|
+
{
|
|
7960
|
+
description: 'Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is waiting to be issued.',
|
|
7961
|
+
properties: {
|
|
7962
|
+
created_at: {
|
|
7963
|
+
description: 'Date and time at which Seam created the warning.',
|
|
7964
|
+
format: 'date-time',
|
|
7965
|
+
type: 'string',
|
|
7966
|
+
},
|
|
7967
|
+
message: {
|
|
7968
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
7969
|
+
type: 'string',
|
|
7970
|
+
},
|
|
7971
|
+
warning_code: {
|
|
7972
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
7973
|
+
enum: ['waiting_to_be_issued'],
|
|
7974
|
+
type: 'string',
|
|
7975
|
+
},
|
|
7976
|
+
},
|
|
7977
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
7978
|
+
type: 'object',
|
|
7979
|
+
},
|
|
7980
|
+
{
|
|
7981
|
+
description: "Indicates that the schedule of one of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)'s children was modified externally.",
|
|
7982
|
+
properties: {
|
|
7983
|
+
created_at: {
|
|
7984
|
+
description: 'Date and time at which Seam created the warning.',
|
|
7985
|
+
format: 'date-time',
|
|
7986
|
+
type: 'string',
|
|
7987
|
+
},
|
|
7988
|
+
message: {
|
|
7989
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
7990
|
+
type: 'string',
|
|
7991
|
+
},
|
|
7992
|
+
warning_code: {
|
|
7993
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
7994
|
+
enum: ['schedule_externally_modified'],
|
|
7995
|
+
type: 'string',
|
|
7996
|
+
},
|
|
7997
|
+
},
|
|
7998
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
7999
|
+
type: 'object',
|
|
8000
|
+
},
|
|
8001
|
+
{
|
|
8002
|
+
description: 'Indicates that the schedule of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past.',
|
|
8003
|
+
properties: {
|
|
8004
|
+
created_at: {
|
|
8005
|
+
description: 'Date and time at which Seam created the warning.',
|
|
8006
|
+
format: 'date-time',
|
|
8007
|
+
type: 'string',
|
|
8008
|
+
},
|
|
8009
|
+
message: {
|
|
8010
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
8011
|
+
type: 'string',
|
|
8012
|
+
},
|
|
8013
|
+
warning_code: {
|
|
8014
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
8015
|
+
enum: ['schedule_modified'],
|
|
8016
|
+
type: 'string',
|
|
8017
|
+
},
|
|
8018
|
+
},
|
|
8019
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
8020
|
+
type: 'object',
|
|
8021
|
+
},
|
|
8022
|
+
{
|
|
8023
|
+
description: 'Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted.',
|
|
8024
|
+
properties: {
|
|
8025
|
+
created_at: {
|
|
8026
|
+
description: 'Date and time at which Seam created the warning.',
|
|
8027
|
+
format: 'date-time',
|
|
8028
|
+
type: 'string',
|
|
8029
|
+
},
|
|
8030
|
+
message: {
|
|
8031
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
8032
|
+
type: 'string',
|
|
8033
|
+
},
|
|
8034
|
+
warning_code: {
|
|
8035
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
8036
|
+
enum: ['being_deleted'],
|
|
8037
|
+
type: 'string',
|
|
8038
|
+
},
|
|
8039
|
+
},
|
|
8040
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
8041
|
+
type: 'object',
|
|
8042
|
+
},
|
|
8043
|
+
{
|
|
8044
|
+
description: 'An unknown issue occurred while syncing the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential.',
|
|
8045
|
+
properties: {
|
|
8046
|
+
created_at: {
|
|
8047
|
+
description: 'Date and time at which Seam created the warning.',
|
|
8048
|
+
format: 'date-time',
|
|
8049
|
+
type: 'string',
|
|
8050
|
+
},
|
|
8051
|
+
message: {
|
|
8052
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
8053
|
+
type: 'string',
|
|
8054
|
+
},
|
|
8055
|
+
warning_code: {
|
|
8056
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
8057
|
+
enum: ['unknown_issue_with_acs_credential'],
|
|
8058
|
+
type: 'string',
|
|
8059
|
+
},
|
|
8060
|
+
},
|
|
8061
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
8062
|
+
type: 'object',
|
|
8063
|
+
},
|
|
8064
|
+
{
|
|
8065
|
+
description: 'Access permissions for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential.',
|
|
8066
|
+
properties: {
|
|
8067
|
+
created_at: {
|
|
8068
|
+
description: 'Date and time at which Seam created the warning.',
|
|
8069
|
+
format: 'date-time',
|
|
8070
|
+
type: 'string',
|
|
8071
|
+
},
|
|
8072
|
+
message: {
|
|
8073
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
8074
|
+
type: 'string',
|
|
8075
|
+
},
|
|
8076
|
+
warning_code: {
|
|
8077
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
8078
|
+
enum: ['needs_to_be_reissued'],
|
|
8079
|
+
type: 'string',
|
|
8080
|
+
},
|
|
8081
|
+
},
|
|
8082
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
8083
|
+
type: 'object',
|
|
8084
|
+
},
|
|
8085
|
+
],
|
|
8086
|
+
},
|
|
8087
|
+
type: 'array',
|
|
8088
|
+
},
|
|
8089
|
+
workspace_id: {
|
|
8090
|
+
description: '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).',
|
|
8091
|
+
format: 'uuid',
|
|
8092
|
+
type: 'string',
|
|
8093
|
+
},
|
|
8094
|
+
},
|
|
8095
|
+
required: [
|
|
8096
|
+
'acs_credential_id',
|
|
8097
|
+
'connected_account_id',
|
|
8098
|
+
'acs_system_id',
|
|
8099
|
+
'display_name',
|
|
8100
|
+
'access_method',
|
|
8101
|
+
'created_at',
|
|
8102
|
+
'workspace_id',
|
|
8103
|
+
'errors',
|
|
8104
|
+
'warnings',
|
|
8105
|
+
'is_managed',
|
|
8106
|
+
],
|
|
8107
|
+
type: 'object',
|
|
8108
|
+
},
|
|
8109
|
+
status: { enum: ['success'], type: 'string' },
|
|
8110
|
+
},
|
|
8111
|
+
required: [
|
|
8112
|
+
'action_attempt_id',
|
|
8113
|
+
'status',
|
|
8114
|
+
'error',
|
|
8115
|
+
'action_type',
|
|
8116
|
+
'result',
|
|
8117
|
+
],
|
|
8118
|
+
type: 'object',
|
|
8119
|
+
},
|
|
8120
|
+
{
|
|
8121
|
+
description: 'Scanning a physical card and assigning the credential failed.',
|
|
8122
|
+
properties: {
|
|
8123
|
+
action_attempt_id: {
|
|
8124
|
+
description: 'ID of the action attempt.',
|
|
8125
|
+
format: 'uuid',
|
|
8126
|
+
type: 'string',
|
|
8127
|
+
},
|
|
8128
|
+
action_type: {
|
|
8129
|
+
description: 'Action attempt to track the status of scanning a physical card and assigning the credential to an ACS user.',
|
|
8130
|
+
enum: ['SCAN_TO_ASSIGN_CREDENTIAL'],
|
|
8131
|
+
type: 'string',
|
|
8132
|
+
},
|
|
8133
|
+
error: {
|
|
8134
|
+
oneOf: [
|
|
8135
|
+
{
|
|
8136
|
+
description: "Error that doesn't fit into other specific error categories.",
|
|
8137
|
+
properties: {
|
|
8138
|
+
message: {
|
|
8139
|
+
description: 'Message for the error associated with the action attempt.',
|
|
8140
|
+
type: 'string',
|
|
8141
|
+
},
|
|
8142
|
+
type: {
|
|
8143
|
+
description: 'Type of the error associated with the action attempt.',
|
|
8144
|
+
enum: ['uncategorized_error'],
|
|
8145
|
+
type: 'string',
|
|
8146
|
+
},
|
|
8147
|
+
},
|
|
8148
|
+
required: ['type', 'message'],
|
|
8149
|
+
type: 'object',
|
|
8150
|
+
},
|
|
8151
|
+
{
|
|
8152
|
+
description: 'Error to indicate an expired action attempt.',
|
|
8153
|
+
properties: {
|
|
8154
|
+
message: {
|
|
8155
|
+
description: 'Message for the error associated with the action attempt.',
|
|
8156
|
+
type: 'string',
|
|
8157
|
+
},
|
|
8158
|
+
type: {
|
|
8159
|
+
description: 'Type of the error associated with the action attempt.',
|
|
8160
|
+
enum: ['action_attempt_expired'],
|
|
8161
|
+
type: 'string',
|
|
8162
|
+
},
|
|
8163
|
+
},
|
|
8164
|
+
required: ['type', 'message'],
|
|
8165
|
+
type: 'object',
|
|
8166
|
+
},
|
|
8167
|
+
{
|
|
8168
|
+
description: 'Error to indicate that there is no credential on the encoder.',
|
|
8169
|
+
properties: {
|
|
8170
|
+
message: {
|
|
8171
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
8172
|
+
type: 'string',
|
|
8173
|
+
},
|
|
8174
|
+
type: {
|
|
8175
|
+
description: 'Error type to indicate that there is no credential on the encoder.',
|
|
8176
|
+
enum: ['no_credential_on_encoder'],
|
|
8177
|
+
type: 'string',
|
|
8178
|
+
},
|
|
8179
|
+
},
|
|
8180
|
+
required: ['type', 'message'],
|
|
8181
|
+
type: 'object',
|
|
8182
|
+
},
|
|
8183
|
+
],
|
|
8184
|
+
},
|
|
8185
|
+
result: {
|
|
8186
|
+
description: 'Result of the action attempt. Null for failed action attempts.',
|
|
8187
|
+
nullable: true,
|
|
8188
|
+
},
|
|
8189
|
+
status: { enum: ['error'], type: 'string' },
|
|
8190
|
+
},
|
|
8191
|
+
required: [
|
|
8192
|
+
'action_attempt_id',
|
|
8193
|
+
'status',
|
|
8194
|
+
'result',
|
|
8195
|
+
'action_type',
|
|
8196
|
+
'error',
|
|
8197
|
+
],
|
|
8198
|
+
type: 'object',
|
|
8199
|
+
},
|
|
7698
8200
|
{
|
|
7699
8201
|
description: 'Resetting a sandbox workspace is pending.',
|
|
7700
8202
|
properties: {
|
|
@@ -10511,6 +11013,7 @@ const openapi = {
|
|
|
10511
11013
|
'akiles_lock',
|
|
10512
11014
|
'ultraloq_lock',
|
|
10513
11015
|
'korelock_lock',
|
|
11016
|
+
'omnitec_lock',
|
|
10514
11017
|
],
|
|
10515
11018
|
type: 'string',
|
|
10516
11019
|
},
|
|
@@ -12093,6 +12596,35 @@ const openapi = {
|
|
|
12093
12596
|
required: ['device_id', 'device_name'],
|
|
12094
12597
|
type: 'object',
|
|
12095
12598
|
},
|
|
12599
|
+
omnitec_metadata: {
|
|
12600
|
+
description: 'Metadata for an Omnitec device.',
|
|
12601
|
+
properties: {
|
|
12602
|
+
has_gateway: {
|
|
12603
|
+
description: 'Whether the Omnitec lock has a connected gateway for remote operations.',
|
|
12604
|
+
type: 'boolean',
|
|
12605
|
+
},
|
|
12606
|
+
lock_id: {
|
|
12607
|
+
description: 'Lock ID for an Omnitec device.',
|
|
12608
|
+
format: 'float',
|
|
12609
|
+
type: 'number',
|
|
12610
|
+
},
|
|
12611
|
+
lock_mac: {
|
|
12612
|
+
description: 'Bluetooth MAC address for an Omnitec device.',
|
|
12613
|
+
type: 'string',
|
|
12614
|
+
},
|
|
12615
|
+
lock_name: {
|
|
12616
|
+
description: 'Lock name for an Omnitec device.',
|
|
12617
|
+
type: 'string',
|
|
12618
|
+
},
|
|
12619
|
+
},
|
|
12620
|
+
required: [
|
|
12621
|
+
'lock_id',
|
|
12622
|
+
'lock_name',
|
|
12623
|
+
'lock_mac',
|
|
12624
|
+
'has_gateway',
|
|
12625
|
+
],
|
|
12626
|
+
type: 'object',
|
|
12627
|
+
},
|
|
12096
12628
|
ring_metadata: {
|
|
12097
12629
|
description: 'Metadata for a Ring device.',
|
|
12098
12630
|
properties: {
|
|
@@ -14128,6 +14660,7 @@ const openapi = {
|
|
|
14128
14660
|
'lodgify',
|
|
14129
14661
|
'hostaway',
|
|
14130
14662
|
'acuity_scheduling',
|
|
14663
|
+
'omnitec',
|
|
14131
14664
|
],
|
|
14132
14665
|
type: 'string',
|
|
14133
14666
|
},
|
|
@@ -27210,6 +27743,7 @@ const openapi = {
|
|
|
27210
27743
|
'akiles_lock',
|
|
27211
27744
|
'ultraloq_lock',
|
|
27212
27745
|
'korelock_lock',
|
|
27746
|
+
'omnitec_lock',
|
|
27213
27747
|
],
|
|
27214
27748
|
type: 'string',
|
|
27215
27749
|
},
|
|
@@ -40860,6 +41394,74 @@ const openapi = {
|
|
|
40860
41394
|
'x-title': 'Scan a Credential',
|
|
40861
41395
|
},
|
|
40862
41396
|
},
|
|
41397
|
+
'/acs/encoders/scan_to_assign_credential': {
|
|
41398
|
+
post: {
|
|
41399
|
+
description: 'Scans a physical card placed on the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) and assigns the scanned credential to an ACS user. Provide either an `acs_user_id` or a `user_identity_id`.',
|
|
41400
|
+
operationId: 'acsEncodersScanToAssignCredentialPost',
|
|
41401
|
+
requestBody: {
|
|
41402
|
+
content: {
|
|
41403
|
+
'application/json': {
|
|
41404
|
+
schema: {
|
|
41405
|
+
properties: {
|
|
41406
|
+
acs_encoder_id: {
|
|
41407
|
+
description: 'ID of the `acs_encoder` to use to scan the credential.',
|
|
41408
|
+
format: 'uuid',
|
|
41409
|
+
type: 'string',
|
|
41410
|
+
},
|
|
41411
|
+
acs_user_id: {
|
|
41412
|
+
description: 'ID of the `acs_user` to assign the scanned credential to.',
|
|
41413
|
+
format: 'uuid',
|
|
41414
|
+
type: 'string',
|
|
41415
|
+
},
|
|
41416
|
+
user_identity_id: {
|
|
41417
|
+
description: 'ID of the `user_identity` to assign the scanned credential to. If the ACS system contains an ACS user linked to this user identity, it is used. Otherwise, one is created.',
|
|
41418
|
+
format: 'uuid',
|
|
41419
|
+
type: 'string',
|
|
41420
|
+
},
|
|
41421
|
+
},
|
|
41422
|
+
required: ['acs_encoder_id'],
|
|
41423
|
+
type: 'object',
|
|
41424
|
+
},
|
|
41425
|
+
},
|
|
41426
|
+
},
|
|
41427
|
+
},
|
|
41428
|
+
responses: {
|
|
41429
|
+
200: {
|
|
41430
|
+
content: {
|
|
41431
|
+
'application/json': {
|
|
41432
|
+
schema: {
|
|
41433
|
+
properties: {
|
|
41434
|
+
action_attempt: {
|
|
41435
|
+
$ref: '#/components/schemas/action_attempt',
|
|
41436
|
+
},
|
|
41437
|
+
ok: { type: 'boolean' },
|
|
41438
|
+
},
|
|
41439
|
+
required: ['action_attempt', 'ok'],
|
|
41440
|
+
type: 'object',
|
|
41441
|
+
},
|
|
41442
|
+
},
|
|
41443
|
+
},
|
|
41444
|
+
description: 'OK',
|
|
41445
|
+
},
|
|
41446
|
+
400: { description: 'Bad Request' },
|
|
41447
|
+
401: { description: 'Unauthorized' },
|
|
41448
|
+
},
|
|
41449
|
+
security: [
|
|
41450
|
+
{ pat_with_workspace: [] },
|
|
41451
|
+
{ console_session_with_workspace: [] },
|
|
41452
|
+
{ api_key: [] },
|
|
41453
|
+
{ client_session_with_customer: [] },
|
|
41454
|
+
],
|
|
41455
|
+
summary: '/acs/encoders/scan_to_assign_credential',
|
|
41456
|
+
tags: ['/acs'],
|
|
41457
|
+
'x-action-attempt-type': 'SCAN_TO_ASSIGN_CREDENTIAL',
|
|
41458
|
+
'x-fern-sdk-group-name': ['acs', 'encoders'],
|
|
41459
|
+
'x-fern-sdk-method-name': 'scan_to_assign_credential',
|
|
41460
|
+
'x-fern-sdk-return-value': 'action_attempt',
|
|
41461
|
+
'x-response-key': 'action_attempt',
|
|
41462
|
+
'x-title': 'Scan to Assign a Credential',
|
|
41463
|
+
},
|
|
41464
|
+
},
|
|
40863
41465
|
'/acs/encoders/simulate/next_credential_encode_will_fail': {
|
|
40864
41466
|
post: {
|
|
40865
41467
|
description: 'Simulates that the next attempt to encode a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).',
|
|
@@ -45280,6 +45882,7 @@ const openapi = {
|
|
|
45280
45882
|
'lodgify',
|
|
45281
45883
|
'hostaway',
|
|
45282
45884
|
'acuity_scheduling',
|
|
45885
|
+
'omnitec',
|
|
45283
45886
|
'yale_access',
|
|
45284
45887
|
'hid_cm',
|
|
45285
45888
|
'google_nest',
|
|
@@ -49091,6 +49694,7 @@ const openapi = {
|
|
|
49091
49694
|
'akiles_lock',
|
|
49092
49695
|
'ultraloq_lock',
|
|
49093
49696
|
'korelock_lock',
|
|
49697
|
+
'omnitec_lock',
|
|
49094
49698
|
],
|
|
49095
49699
|
type: 'string',
|
|
49096
49700
|
},
|
|
@@ -49166,6 +49770,7 @@ const openapi = {
|
|
|
49166
49770
|
'akiles_lock',
|
|
49167
49771
|
'ultraloq_lock',
|
|
49168
49772
|
'korelock_lock',
|
|
49773
|
+
'omnitec_lock',
|
|
49169
49774
|
],
|
|
49170
49775
|
type: 'string',
|
|
49171
49776
|
},
|
|
@@ -49258,6 +49863,7 @@ const openapi = {
|
|
|
49258
49863
|
'lodgify',
|
|
49259
49864
|
'hostaway',
|
|
49260
49865
|
'acuity_scheduling',
|
|
49866
|
+
'omnitec',
|
|
49261
49867
|
],
|
|
49262
49868
|
type: 'string',
|
|
49263
49869
|
},
|
|
@@ -49529,6 +50135,7 @@ const openapi = {
|
|
|
49529
50135
|
'akiles_lock',
|
|
49530
50136
|
'ultraloq_lock',
|
|
49531
50137
|
'korelock_lock',
|
|
50138
|
+
'omnitec_lock',
|
|
49532
50139
|
],
|
|
49533
50140
|
type: 'string',
|
|
49534
50141
|
},
|
|
@@ -49600,6 +50207,7 @@ const openapi = {
|
|
|
49600
50207
|
'akiles_lock',
|
|
49601
50208
|
'ultraloq_lock',
|
|
49602
50209
|
'korelock_lock',
|
|
50210
|
+
'omnitec_lock',
|
|
49603
50211
|
],
|
|
49604
50212
|
type: 'string',
|
|
49605
50213
|
},
|
|
@@ -49752,6 +50360,7 @@ const openapi = {
|
|
|
49752
50360
|
'lodgify',
|
|
49753
50361
|
'hostaway',
|
|
49754
50362
|
'acuity_scheduling',
|
|
50363
|
+
'omnitec',
|
|
49755
50364
|
],
|
|
49756
50365
|
type: 'string',
|
|
49757
50366
|
},
|
|
@@ -51388,6 +51997,7 @@ const openapi = {
|
|
|
51388
51997
|
'akiles_lock',
|
|
51389
51998
|
'ultraloq_lock',
|
|
51390
51999
|
'korelock_lock',
|
|
52000
|
+
'omnitec_lock',
|
|
51391
52001
|
],
|
|
51392
52002
|
type: 'string',
|
|
51393
52003
|
},
|
|
@@ -51463,6 +52073,7 @@ const openapi = {
|
|
|
51463
52073
|
'akiles_lock',
|
|
51464
52074
|
'ultraloq_lock',
|
|
51465
52075
|
'korelock_lock',
|
|
52076
|
+
'omnitec_lock',
|
|
51466
52077
|
],
|
|
51467
52078
|
type: 'string',
|
|
51468
52079
|
},
|
|
@@ -51555,6 +52166,7 @@ const openapi = {
|
|
|
51555
52166
|
'lodgify',
|
|
51556
52167
|
'hostaway',
|
|
51557
52168
|
'acuity_scheduling',
|
|
52169
|
+
'omnitec',
|
|
51558
52170
|
],
|
|
51559
52171
|
type: 'string',
|
|
51560
52172
|
},
|
|
@@ -51825,6 +52437,7 @@ const openapi = {
|
|
|
51825
52437
|
'akiles_lock',
|
|
51826
52438
|
'ultraloq_lock',
|
|
51827
52439
|
'korelock_lock',
|
|
52440
|
+
'omnitec_lock',
|
|
51828
52441
|
],
|
|
51829
52442
|
type: 'string',
|
|
51830
52443
|
},
|
|
@@ -51896,6 +52509,7 @@ const openapi = {
|
|
|
51896
52509
|
'akiles_lock',
|
|
51897
52510
|
'ultraloq_lock',
|
|
51898
52511
|
'korelock_lock',
|
|
52512
|
+
'omnitec_lock',
|
|
51899
52513
|
],
|
|
51900
52514
|
type: 'string',
|
|
51901
52515
|
},
|
|
@@ -52048,6 +52662,7 @@ const openapi = {
|
|
|
52048
52662
|
'lodgify',
|
|
52049
52663
|
'hostaway',
|
|
52050
52664
|
'acuity_scheduling',
|
|
52665
|
+
'omnitec',
|
|
52051
52666
|
],
|
|
52052
52667
|
type: 'string',
|
|
52053
52668
|
},
|
|
@@ -54043,6 +54658,7 @@ const openapi = {
|
|
|
54043
54658
|
'akiles_lock',
|
|
54044
54659
|
'ultraloq_lock',
|
|
54045
54660
|
'korelock_lock',
|
|
54661
|
+
'omnitec_lock',
|
|
54046
54662
|
],
|
|
54047
54663
|
type: 'string',
|
|
54048
54664
|
},
|
|
@@ -54082,6 +54698,7 @@ const openapi = {
|
|
|
54082
54698
|
'akiles_lock',
|
|
54083
54699
|
'ultraloq_lock',
|
|
54084
54700
|
'korelock_lock',
|
|
54701
|
+
'omnitec_lock',
|
|
54085
54702
|
],
|
|
54086
54703
|
type: 'string',
|
|
54087
54704
|
},
|
|
@@ -54123,6 +54740,7 @@ const openapi = {
|
|
|
54123
54740
|
'korelock',
|
|
54124
54741
|
'smartthings',
|
|
54125
54742
|
'ultraloq',
|
|
54743
|
+
'omnitec',
|
|
54126
54744
|
],
|
|
54127
54745
|
type: 'string',
|
|
54128
54746
|
},
|
|
@@ -54393,6 +55011,7 @@ const openapi = {
|
|
|
54393
55011
|
'akiles_lock',
|
|
54394
55012
|
'ultraloq_lock',
|
|
54395
55013
|
'korelock_lock',
|
|
55014
|
+
'omnitec_lock',
|
|
54396
55015
|
],
|
|
54397
55016
|
type: 'string',
|
|
54398
55017
|
},
|
|
@@ -54428,6 +55047,7 @@ const openapi = {
|
|
|
54428
55047
|
'akiles_lock',
|
|
54429
55048
|
'ultraloq_lock',
|
|
54430
55049
|
'korelock_lock',
|
|
55050
|
+
'omnitec_lock',
|
|
54431
55051
|
],
|
|
54432
55052
|
type: 'string',
|
|
54433
55053
|
},
|
|
@@ -54529,6 +55149,7 @@ const openapi = {
|
|
|
54529
55149
|
'korelock',
|
|
54530
55150
|
'smartthings',
|
|
54531
55151
|
'ultraloq',
|
|
55152
|
+
'omnitec',
|
|
54532
55153
|
],
|
|
54533
55154
|
type: 'string',
|
|
54534
55155
|
},
|