@seamapi/types 1.850.0 → 1.852.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 +675 -37
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +8483 -423
- package/dist/index.cjs +675 -37
- 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 +756 -0
- package/lib/seam/connect/models/customer/customer-data.d.ts +10 -0
- package/lib/seam/connect/models/customer/location-resources.d.ts +6 -0
- package/lib/seam/connect/models/customer/location-resources.js +6 -0
- package/lib/seam/connect/models/customer/location-resources.js.map +1 -1
- package/lib/seam/connect/openapi.js +600 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +7169 -423
- 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/customer/location-resources.ts +8 -0
- package/src/lib/seam/connect/openapi.ts +691 -0
- package/src/lib/seam/connect/route-types.ts +8078 -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: {
|
|
@@ -40860,6 +41362,74 @@ const openapi = {
|
|
|
40860
41362
|
'x-title': 'Scan a Credential',
|
|
40861
41363
|
},
|
|
40862
41364
|
},
|
|
41365
|
+
'/acs/encoders/scan_to_assign_credential': {
|
|
41366
|
+
post: {
|
|
41367
|
+
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`.',
|
|
41368
|
+
operationId: 'acsEncodersScanToAssignCredentialPost',
|
|
41369
|
+
requestBody: {
|
|
41370
|
+
content: {
|
|
41371
|
+
'application/json': {
|
|
41372
|
+
schema: {
|
|
41373
|
+
properties: {
|
|
41374
|
+
acs_encoder_id: {
|
|
41375
|
+
description: 'ID of the `acs_encoder` to use to scan the credential.',
|
|
41376
|
+
format: 'uuid',
|
|
41377
|
+
type: 'string',
|
|
41378
|
+
},
|
|
41379
|
+
acs_user_id: {
|
|
41380
|
+
description: 'ID of the `acs_user` to assign the scanned credential to.',
|
|
41381
|
+
format: 'uuid',
|
|
41382
|
+
type: 'string',
|
|
41383
|
+
},
|
|
41384
|
+
user_identity_id: {
|
|
41385
|
+
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.',
|
|
41386
|
+
format: 'uuid',
|
|
41387
|
+
type: 'string',
|
|
41388
|
+
},
|
|
41389
|
+
},
|
|
41390
|
+
required: ['acs_encoder_id'],
|
|
41391
|
+
type: 'object',
|
|
41392
|
+
},
|
|
41393
|
+
},
|
|
41394
|
+
},
|
|
41395
|
+
},
|
|
41396
|
+
responses: {
|
|
41397
|
+
200: {
|
|
41398
|
+
content: {
|
|
41399
|
+
'application/json': {
|
|
41400
|
+
schema: {
|
|
41401
|
+
properties: {
|
|
41402
|
+
action_attempt: {
|
|
41403
|
+
$ref: '#/components/schemas/action_attempt',
|
|
41404
|
+
},
|
|
41405
|
+
ok: { type: 'boolean' },
|
|
41406
|
+
},
|
|
41407
|
+
required: ['action_attempt', 'ok'],
|
|
41408
|
+
type: 'object',
|
|
41409
|
+
},
|
|
41410
|
+
},
|
|
41411
|
+
},
|
|
41412
|
+
description: 'OK',
|
|
41413
|
+
},
|
|
41414
|
+
400: { description: 'Bad Request' },
|
|
41415
|
+
401: { description: 'Unauthorized' },
|
|
41416
|
+
},
|
|
41417
|
+
security: [
|
|
41418
|
+
{ pat_with_workspace: [] },
|
|
41419
|
+
{ console_session_with_workspace: [] },
|
|
41420
|
+
{ api_key: [] },
|
|
41421
|
+
{ client_session_with_customer: [] },
|
|
41422
|
+
],
|
|
41423
|
+
summary: '/acs/encoders/scan_to_assign_credential',
|
|
41424
|
+
tags: ['/acs'],
|
|
41425
|
+
'x-action-attempt-type': 'SCAN_TO_ASSIGN_CREDENTIAL',
|
|
41426
|
+
'x-fern-sdk-group-name': ['acs', 'encoders'],
|
|
41427
|
+
'x-fern-sdk-method-name': 'scan_to_assign_credential',
|
|
41428
|
+
'x-fern-sdk-return-value': 'action_attempt',
|
|
41429
|
+
'x-response-key': 'action_attempt',
|
|
41430
|
+
'x-title': 'Scan to Assign a Credential',
|
|
41431
|
+
},
|
|
41432
|
+
},
|
|
40863
41433
|
'/acs/encoders/simulate/next_credential_encode_will_fail': {
|
|
40864
41434
|
post: {
|
|
40865
41435
|
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).',
|
|
@@ -47343,6 +47913,12 @@ const openapi = {
|
|
|
47343
47913
|
description: 'List of general spaces or areas.',
|
|
47344
47914
|
items: {
|
|
47345
47915
|
properties: {
|
|
47916
|
+
duration_minutes: {
|
|
47917
|
+
description: 'Default duration of this space in minutes, when the space represents a fixed-length bookable slot (e.g. an appointment type). Used to interpret reservations booked against this space.',
|
|
47918
|
+
exclusiveMinimum: true,
|
|
47919
|
+
minimum: 0,
|
|
47920
|
+
type: 'integer',
|
|
47921
|
+
},
|
|
47346
47922
|
name: {
|
|
47347
47923
|
description: 'Your display name for this location resource.',
|
|
47348
47924
|
type: 'string',
|
|
@@ -48473,6 +49049,12 @@ const openapi = {
|
|
|
48473
49049
|
description: 'List of general spaces or areas.',
|
|
48474
49050
|
items: {
|
|
48475
49051
|
properties: {
|
|
49052
|
+
duration_minutes: {
|
|
49053
|
+
description: 'Default duration of this space in minutes, when the space represents a fixed-length bookable slot (e.g. an appointment type). Used to interpret reservations booked against this space.',
|
|
49054
|
+
exclusiveMinimum: true,
|
|
49055
|
+
minimum: 0,
|
|
49056
|
+
type: 'integer',
|
|
49057
|
+
},
|
|
48476
49058
|
name: {
|
|
48477
49059
|
description: 'Your display name for this location resource.',
|
|
48478
49060
|
type: 'string',
|
|
@@ -73323,6 +73905,12 @@ const openapi = {
|
|
|
73323
73905
|
description: 'Optional list of spaces that you want to include in the new building block magic link.',
|
|
73324
73906
|
items: {
|
|
73325
73907
|
properties: {
|
|
73908
|
+
duration_minutes: {
|
|
73909
|
+
description: 'Default duration of this space in minutes, when the space represents a fixed-length bookable slot (e.g. an appointment type). Used to interpret reservations booked against this space.',
|
|
73910
|
+
exclusiveMinimum: true,
|
|
73911
|
+
minimum: 0,
|
|
73912
|
+
type: 'integer',
|
|
73913
|
+
},
|
|
73326
73914
|
name: {
|
|
73327
73915
|
description: 'Your display name for this location resource.',
|
|
73328
73916
|
type: 'string',
|
|
@@ -73405,6 +73993,12 @@ const openapi = {
|
|
|
73405
73993
|
description: 'Optional list of spaces that you want to include in the new building block magic link.',
|
|
73406
73994
|
items: {
|
|
73407
73995
|
properties: {
|
|
73996
|
+
duration_minutes: {
|
|
73997
|
+
description: 'Default duration of this space in minutes, when the space represents a fixed-length bookable slot (e.g. an appointment type). Used to interpret reservations booked against this space.',
|
|
73998
|
+
exclusiveMinimum: true,
|
|
73999
|
+
minimum: 0,
|
|
74000
|
+
type: 'integer',
|
|
74001
|
+
},
|
|
73408
74002
|
name: {
|
|
73409
74003
|
description: 'Your display name for this location resource.',
|
|
73410
74004
|
type: 'string',
|
|
@@ -73539,6 +74133,12 @@ const openapi = {
|
|
|
73539
74133
|
description: 'Optional list of spaces that you want to include in the new building block magic link.',
|
|
73540
74134
|
items: {
|
|
73541
74135
|
properties: {
|
|
74136
|
+
duration_minutes: {
|
|
74137
|
+
description: 'Default duration of this space in minutes, when the space represents a fixed-length bookable slot (e.g. an appointment type). Used to interpret reservations booked against this space.',
|
|
74138
|
+
exclusiveMinimum: true,
|
|
74139
|
+
minimum: 0,
|
|
74140
|
+
type: 'integer',
|
|
74141
|
+
},
|
|
73542
74142
|
name: {
|
|
73543
74143
|
description: 'Your display name for this location resource.',
|
|
73544
74144
|
type: 'string',
|