@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.
Files changed (25) hide show
  1. package/dist/connect.cjs +675 -37
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +8483 -423
  4. package/dist/index.cjs +675 -37
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +558 -0
  7. package/lib/seam/connect/models/action-attempts/action-attempt.js +2 -0
  8. package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -1
  9. package/lib/seam/connect/models/action-attempts/scan-to-assign-credential.d.ts +561 -0
  10. package/lib/seam/connect/models/action-attempts/scan-to-assign-credential.js +38 -0
  11. package/lib/seam/connect/models/action-attempts/scan-to-assign-credential.js.map +1 -0
  12. package/lib/seam/connect/models/batch.d.ts +756 -0
  13. package/lib/seam/connect/models/customer/customer-data.d.ts +10 -0
  14. package/lib/seam/connect/models/customer/location-resources.d.ts +6 -0
  15. package/lib/seam/connect/models/customer/location-resources.js +6 -0
  16. package/lib/seam/connect/models/customer/location-resources.js.map +1 -1
  17. package/lib/seam/connect/openapi.js +600 -0
  18. package/lib/seam/connect/openapi.js.map +1 -1
  19. package/lib/seam/connect/route-types.d.ts +7169 -423
  20. package/package.json +1 -1
  21. package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +2 -0
  22. package/src/lib/seam/connect/models/action-attempts/scan-to-assign-credential.ts +69 -0
  23. package/src/lib/seam/connect/models/customer/location-resources.ts +8 -0
  24. package/src/lib/seam/connect/openapi.ts +691 -0
  25. package/src/lib/seam/connect/route-types.ts +8078 -0
@@ -8785,6 +8785,590 @@ const openapi: OpenAPISpec = {
8785
8785
  ],
8786
8786
  type: 'object',
8787
8787
  },
8788
+ {
8789
+ description:
8790
+ 'Scanning a physical card and assigning the credential is pending.',
8791
+ properties: {
8792
+ action_attempt_id: {
8793
+ description: 'ID of the action attempt.',
8794
+ format: 'uuid',
8795
+ type: 'string',
8796
+ },
8797
+ action_type: {
8798
+ description:
8799
+ 'Action attempt to track the status of scanning a physical card and assigning the credential to an ACS user.',
8800
+ enum: ['SCAN_TO_ASSIGN_CREDENTIAL'],
8801
+ type: 'string',
8802
+ },
8803
+ error: {
8804
+ description:
8805
+ 'Errors associated with the action attempt. Null for pending action attempts.',
8806
+ nullable: true,
8807
+ },
8808
+ result: {
8809
+ description:
8810
+ 'Result of the action attempt. Null for pending action attempts.',
8811
+ nullable: true,
8812
+ },
8813
+ status: { enum: ['pending'], type: 'string' },
8814
+ },
8815
+ required: [
8816
+ 'action_attempt_id',
8817
+ 'status',
8818
+ 'result',
8819
+ 'error',
8820
+ 'action_type',
8821
+ ],
8822
+ type: 'object',
8823
+ },
8824
+ {
8825
+ description:
8826
+ 'Scanning a physical card and assigning the credential succeeded.',
8827
+ properties: {
8828
+ action_attempt_id: {
8829
+ description: 'ID of the action attempt.',
8830
+ format: 'uuid',
8831
+ type: 'string',
8832
+ },
8833
+ action_type: {
8834
+ description:
8835
+ 'Action attempt to track the status of scanning a physical card and assigning the credential to an ACS user.',
8836
+ enum: ['SCAN_TO_ASSIGN_CREDENTIAL'],
8837
+ type: 'string',
8838
+ },
8839
+ error: {
8840
+ description:
8841
+ 'Errors associated with the action attempt. Null for successful action attempts.',
8842
+ nullable: true,
8843
+ },
8844
+ result: {
8845
+ description:
8846
+ 'Result of a scan to assign attempt. If the attempt was successful, includes the credential data that was scanned and assigned.',
8847
+ properties: {
8848
+ access_method: {
8849
+ description:
8850
+ 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
8851
+ enum: ['code', 'card', 'mobile_key', 'cloud_key'],
8852
+ type: 'string',
8853
+ },
8854
+ acs_credential_id: {
8855
+ description:
8856
+ 'ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
8857
+ format: 'uuid',
8858
+ type: 'string',
8859
+ },
8860
+ acs_credential_pool_id: { format: 'uuid', type: 'string' },
8861
+ acs_system_id: {
8862
+ description:
8863
+ '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).',
8864
+ format: 'uuid',
8865
+ type: 'string',
8866
+ },
8867
+ acs_user_id: {
8868
+ description:
8869
+ '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.',
8870
+ format: 'uuid',
8871
+ type: 'string',
8872
+ },
8873
+ assa_abloy_vostio_metadata: {
8874
+ description:
8875
+ 'Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
8876
+ properties: {
8877
+ auto_join: {
8878
+ description:
8879
+ '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.',
8880
+ type: 'boolean',
8881
+ },
8882
+ door_names: {
8883
+ description:
8884
+ 'Names of the doors to which to grant access in the Vostio access system.',
8885
+ items: { type: 'string' },
8886
+ type: 'array',
8887
+ },
8888
+ endpoint_id: {
8889
+ description: 'Endpoint ID in the Vostio access system.',
8890
+ type: 'string',
8891
+ },
8892
+ key_id: {
8893
+ description: 'Key ID in the Vostio access system.',
8894
+ type: 'string',
8895
+ },
8896
+ key_issuing_request_id: {
8897
+ description:
8898
+ 'Key issuing request ID in the Vostio access system.',
8899
+ type: 'string',
8900
+ },
8901
+ override_guest_acs_entrance_ids: {
8902
+ description:
8903
+ 'IDs of the guest entrances to override in the Vostio access system.',
8904
+ items: { type: 'string' },
8905
+ type: 'array',
8906
+ },
8907
+ },
8908
+ type: 'object',
8909
+ },
8910
+ card_number: {
8911
+ description:
8912
+ 'Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
8913
+ nullable: true,
8914
+ type: 'string',
8915
+ },
8916
+ code: {
8917
+ description:
8918
+ 'Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
8919
+ nullable: true,
8920
+ type: 'string',
8921
+ },
8922
+ connected_account_id: {
8923
+ description:
8924
+ '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.',
8925
+ format: 'uuid',
8926
+ type: 'string',
8927
+ },
8928
+ created_at: {
8929
+ description:
8930
+ 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.',
8931
+ format: 'date-time',
8932
+ type: 'string',
8933
+ },
8934
+ display_name: {
8935
+ description:
8936
+ 'Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.',
8937
+ minLength: 1,
8938
+ type: 'string',
8939
+ },
8940
+ ends_at: {
8941
+ description:
8942
+ '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`.',
8943
+ type: 'string',
8944
+ },
8945
+ errors: {
8946
+ description:
8947
+ 'Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
8948
+ items: {
8949
+ properties: {
8950
+ error_code: { type: 'string' },
8951
+ message: { type: 'string' },
8952
+ },
8953
+ required: ['error_code', 'message'],
8954
+ type: 'object',
8955
+ },
8956
+ type: 'array',
8957
+ },
8958
+ external_type: {
8959
+ description:
8960
+ '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`.',
8961
+ enum: [
8962
+ 'pti_card',
8963
+ 'brivo_credential',
8964
+ 'hid_credential',
8965
+ 'visionline_card',
8966
+ 'salto_ks_credential',
8967
+ 'assa_abloy_vostio_key',
8968
+ 'salto_space_key',
8969
+ 'latch_access',
8970
+ 'dormakaba_ambiance_credential',
8971
+ 'hotek_card',
8972
+ 'salto_ks_tag',
8973
+ 'avigilon_alta_credential',
8974
+ ],
8975
+ type: 'string',
8976
+ },
8977
+ external_type_display_name: {
8978
+ description:
8979
+ 'Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.',
8980
+ type: 'string',
8981
+ },
8982
+ is_issued: {
8983
+ description:
8984
+ 'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card.',
8985
+ type: 'boolean',
8986
+ },
8987
+ is_latest_desired_state_synced_with_provider: {
8988
+ description:
8989
+ '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.',
8990
+ nullable: true,
8991
+ type: 'boolean',
8992
+ },
8993
+ is_managed: { enum: [true], type: 'boolean' },
8994
+ is_multi_phone_sync_credential: {
8995
+ description:
8996
+ '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).',
8997
+ type: 'boolean',
8998
+ },
8999
+ is_one_time_use: {
9000
+ description:
9001
+ '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.',
9002
+ type: 'boolean',
9003
+ },
9004
+ issued_at: {
9005
+ description:
9006
+ 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card.',
9007
+ format: 'date-time',
9008
+ nullable: true,
9009
+ type: 'string',
9010
+ },
9011
+ latest_desired_state_synced_with_provider_at: {
9012
+ description:
9013
+ '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.',
9014
+ format: 'date-time',
9015
+ nullable: true,
9016
+ type: 'string',
9017
+ },
9018
+ parent_acs_credential_id: {
9019
+ description:
9020
+ 'ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
9021
+ format: 'uuid',
9022
+ type: 'string',
9023
+ },
9024
+ starts_at: {
9025
+ description:
9026
+ '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.',
9027
+ type: 'string',
9028
+ },
9029
+ user_identity_id: {
9030
+ description:
9031
+ '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.',
9032
+ format: 'uuid',
9033
+ type: 'string',
9034
+ },
9035
+ visionline_metadata: {
9036
+ description:
9037
+ 'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
9038
+ properties: {
9039
+ auto_join: {
9040
+ description:
9041
+ '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.',
9042
+ type: 'boolean',
9043
+ },
9044
+ card_function_type: {
9045
+ description:
9046
+ 'Card function type in the Visionline access system.',
9047
+ enum: ['guest', 'staff'],
9048
+ type: 'string',
9049
+ },
9050
+ card_id: {
9051
+ description:
9052
+ 'ID of the card in the Visionline access system.',
9053
+ type: 'string',
9054
+ },
9055
+ common_acs_entrance_ids: {
9056
+ description:
9057
+ 'Common entrance IDs in the Visionline access system.',
9058
+ items: { format: 'uuid', type: 'string' },
9059
+ type: 'array',
9060
+ },
9061
+ credential_id: {
9062
+ description:
9063
+ 'ID of the credential in the Visionline access system.',
9064
+ type: 'string',
9065
+ },
9066
+ guest_acs_entrance_ids: {
9067
+ description:
9068
+ 'Guest entrance IDs in the Visionline access system.',
9069
+ items: { format: 'uuid', type: 'string' },
9070
+ type: 'array',
9071
+ },
9072
+ is_valid: {
9073
+ description:
9074
+ 'Indicates whether the credential is valid.',
9075
+ type: 'boolean',
9076
+ },
9077
+ joiner_acs_credential_ids: {
9078
+ description:
9079
+ 'IDs of the credentials to which you want to join.',
9080
+ items: { format: 'uuid', type: 'string' },
9081
+ type: 'array',
9082
+ },
9083
+ },
9084
+ required: ['card_function_type'],
9085
+ type: 'object',
9086
+ },
9087
+ warnings: {
9088
+ description:
9089
+ 'Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
9090
+ items: {
9091
+ description:
9092
+ 'Warning associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
9093
+ discriminator: { propertyName: 'warning_code' },
9094
+ oneOf: [
9095
+ {
9096
+ description:
9097
+ 'Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is waiting to be issued.',
9098
+ properties: {
9099
+ created_at: {
9100
+ description:
9101
+ 'Date and time at which Seam created the warning.',
9102
+ format: 'date-time',
9103
+ type: 'string',
9104
+ },
9105
+ message: {
9106
+ description:
9107
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
9108
+ type: 'string',
9109
+ },
9110
+ warning_code: {
9111
+ description:
9112
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
9113
+ enum: ['waiting_to_be_issued'],
9114
+ type: 'string',
9115
+ },
9116
+ },
9117
+ required: ['created_at', 'message', 'warning_code'],
9118
+ type: 'object',
9119
+ },
9120
+ {
9121
+ description:
9122
+ "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.",
9123
+ properties: {
9124
+ created_at: {
9125
+ description:
9126
+ 'Date and time at which Seam created the warning.',
9127
+ format: 'date-time',
9128
+ type: 'string',
9129
+ },
9130
+ message: {
9131
+ description:
9132
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
9133
+ type: 'string',
9134
+ },
9135
+ warning_code: {
9136
+ description:
9137
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
9138
+ enum: ['schedule_externally_modified'],
9139
+ type: 'string',
9140
+ },
9141
+ },
9142
+ required: ['created_at', 'message', 'warning_code'],
9143
+ type: 'object',
9144
+ },
9145
+ {
9146
+ description:
9147
+ '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.',
9148
+ properties: {
9149
+ created_at: {
9150
+ description:
9151
+ 'Date and time at which Seam created the warning.',
9152
+ format: 'date-time',
9153
+ type: 'string',
9154
+ },
9155
+ message: {
9156
+ description:
9157
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
9158
+ type: 'string',
9159
+ },
9160
+ warning_code: {
9161
+ description:
9162
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
9163
+ enum: ['schedule_modified'],
9164
+ type: 'string',
9165
+ },
9166
+ },
9167
+ required: ['created_at', 'message', 'warning_code'],
9168
+ type: 'object',
9169
+ },
9170
+ {
9171
+ description:
9172
+ 'Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted.',
9173
+ properties: {
9174
+ created_at: {
9175
+ description:
9176
+ 'Date and time at which Seam created the warning.',
9177
+ format: 'date-time',
9178
+ type: 'string',
9179
+ },
9180
+ message: {
9181
+ description:
9182
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
9183
+ type: 'string',
9184
+ },
9185
+ warning_code: {
9186
+ description:
9187
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
9188
+ enum: ['being_deleted'],
9189
+ type: 'string',
9190
+ },
9191
+ },
9192
+ required: ['created_at', 'message', 'warning_code'],
9193
+ type: 'object',
9194
+ },
9195
+ {
9196
+ description:
9197
+ '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.',
9198
+ properties: {
9199
+ created_at: {
9200
+ description:
9201
+ 'Date and time at which Seam created the warning.',
9202
+ format: 'date-time',
9203
+ type: 'string',
9204
+ },
9205
+ message: {
9206
+ description:
9207
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
9208
+ type: 'string',
9209
+ },
9210
+ warning_code: {
9211
+ description:
9212
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
9213
+ enum: ['unknown_issue_with_acs_credential'],
9214
+ type: 'string',
9215
+ },
9216
+ },
9217
+ required: ['created_at', 'message', 'warning_code'],
9218
+ type: 'object',
9219
+ },
9220
+ {
9221
+ description:
9222
+ '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.',
9223
+ properties: {
9224
+ created_at: {
9225
+ description:
9226
+ 'Date and time at which Seam created the warning.',
9227
+ format: 'date-time',
9228
+ type: 'string',
9229
+ },
9230
+ message: {
9231
+ description:
9232
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
9233
+ type: 'string',
9234
+ },
9235
+ warning_code: {
9236
+ description:
9237
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
9238
+ enum: ['needs_to_be_reissued'],
9239
+ type: 'string',
9240
+ },
9241
+ },
9242
+ required: ['created_at', 'message', 'warning_code'],
9243
+ type: 'object',
9244
+ },
9245
+ ],
9246
+ },
9247
+ type: 'array',
9248
+ },
9249
+ workspace_id: {
9250
+ description:
9251
+ '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).',
9252
+ format: 'uuid',
9253
+ type: 'string',
9254
+ },
9255
+ },
9256
+ required: [
9257
+ 'acs_credential_id',
9258
+ 'connected_account_id',
9259
+ 'acs_system_id',
9260
+ 'display_name',
9261
+ 'access_method',
9262
+ 'created_at',
9263
+ 'workspace_id',
9264
+ 'errors',
9265
+ 'warnings',
9266
+ 'is_managed',
9267
+ ],
9268
+ type: 'object',
9269
+ },
9270
+ status: { enum: ['success'], type: 'string' },
9271
+ },
9272
+ required: [
9273
+ 'action_attempt_id',
9274
+ 'status',
9275
+ 'error',
9276
+ 'action_type',
9277
+ 'result',
9278
+ ],
9279
+ type: 'object',
9280
+ },
9281
+ {
9282
+ description:
9283
+ 'Scanning a physical card and assigning the credential failed.',
9284
+ properties: {
9285
+ action_attempt_id: {
9286
+ description: 'ID of the action attempt.',
9287
+ format: 'uuid',
9288
+ type: 'string',
9289
+ },
9290
+ action_type: {
9291
+ description:
9292
+ 'Action attempt to track the status of scanning a physical card and assigning the credential to an ACS user.',
9293
+ enum: ['SCAN_TO_ASSIGN_CREDENTIAL'],
9294
+ type: 'string',
9295
+ },
9296
+ error: {
9297
+ oneOf: [
9298
+ {
9299
+ description:
9300
+ "Error that doesn't fit into other specific error categories.",
9301
+ properties: {
9302
+ message: {
9303
+ description:
9304
+ 'Message for the error associated with the action attempt.',
9305
+ type: 'string',
9306
+ },
9307
+ type: {
9308
+ description:
9309
+ 'Type of the error associated with the action attempt.',
9310
+ enum: ['uncategorized_error'],
9311
+ type: 'string',
9312
+ },
9313
+ },
9314
+ required: ['type', 'message'],
9315
+ type: 'object',
9316
+ },
9317
+ {
9318
+ description: 'Error to indicate an expired action attempt.',
9319
+ properties: {
9320
+ message: {
9321
+ description:
9322
+ 'Message for the error associated with the action attempt.',
9323
+ type: 'string',
9324
+ },
9325
+ type: {
9326
+ description:
9327
+ 'Type of the error associated with the action attempt.',
9328
+ enum: ['action_attempt_expired'],
9329
+ type: 'string',
9330
+ },
9331
+ },
9332
+ required: ['type', 'message'],
9333
+ type: 'object',
9334
+ },
9335
+ {
9336
+ description:
9337
+ 'Error to indicate that there is no credential on the encoder.',
9338
+ properties: {
9339
+ message: {
9340
+ description:
9341
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
9342
+ type: 'string',
9343
+ },
9344
+ type: {
9345
+ description:
9346
+ 'Error type to indicate that there is no credential on the encoder.',
9347
+ enum: ['no_credential_on_encoder'],
9348
+ type: 'string',
9349
+ },
9350
+ },
9351
+ required: ['type', 'message'],
9352
+ type: 'object',
9353
+ },
9354
+ ],
9355
+ },
9356
+ result: {
9357
+ description:
9358
+ 'Result of the action attempt. Null for failed action attempts.',
9359
+ nullable: true,
9360
+ },
9361
+ status: { enum: ['error'], type: 'string' },
9362
+ },
9363
+ required: [
9364
+ 'action_attempt_id',
9365
+ 'status',
9366
+ 'result',
9367
+ 'action_type',
9368
+ 'error',
9369
+ ],
9370
+ type: 'object',
9371
+ },
8788
9372
  {
8789
9373
  description: 'Resetting a sandbox workspace is pending.',
8790
9374
  properties: {
@@ -45264,6 +45848,78 @@ const openapi: OpenAPISpec = {
45264
45848
  'x-title': 'Scan a Credential',
45265
45849
  },
45266
45850
  },
45851
+ '/acs/encoders/scan_to_assign_credential': {
45852
+ post: {
45853
+ description:
45854
+ '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`.',
45855
+ operationId: 'acsEncodersScanToAssignCredentialPost',
45856
+ requestBody: {
45857
+ content: {
45858
+ 'application/json': {
45859
+ schema: {
45860
+ properties: {
45861
+ acs_encoder_id: {
45862
+ description:
45863
+ 'ID of the `acs_encoder` to use to scan the credential.',
45864
+ format: 'uuid',
45865
+ type: 'string',
45866
+ },
45867
+ acs_user_id: {
45868
+ description:
45869
+ 'ID of the `acs_user` to assign the scanned credential to.',
45870
+ format: 'uuid',
45871
+ type: 'string',
45872
+ },
45873
+ user_identity_id: {
45874
+ description:
45875
+ '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.',
45876
+ format: 'uuid',
45877
+ type: 'string',
45878
+ },
45879
+ },
45880
+ required: ['acs_encoder_id'],
45881
+ type: 'object',
45882
+ },
45883
+ },
45884
+ },
45885
+ },
45886
+ responses: {
45887
+ 200: {
45888
+ content: {
45889
+ 'application/json': {
45890
+ schema: {
45891
+ properties: {
45892
+ action_attempt: {
45893
+ $ref: '#/components/schemas/action_attempt',
45894
+ },
45895
+ ok: { type: 'boolean' },
45896
+ },
45897
+ required: ['action_attempt', 'ok'],
45898
+ type: 'object',
45899
+ },
45900
+ },
45901
+ },
45902
+ description: 'OK',
45903
+ },
45904
+ 400: { description: 'Bad Request' },
45905
+ 401: { description: 'Unauthorized' },
45906
+ },
45907
+ security: [
45908
+ { pat_with_workspace: [] },
45909
+ { console_session_with_workspace: [] },
45910
+ { api_key: [] },
45911
+ { client_session_with_customer: [] },
45912
+ ],
45913
+ summary: '/acs/encoders/scan_to_assign_credential',
45914
+ tags: ['/acs'],
45915
+ 'x-action-attempt-type': 'SCAN_TO_ASSIGN_CREDENTIAL',
45916
+ 'x-fern-sdk-group-name': ['acs', 'encoders'],
45917
+ 'x-fern-sdk-method-name': 'scan_to_assign_credential',
45918
+ 'x-fern-sdk-return-value': 'action_attempt',
45919
+ 'x-response-key': 'action_attempt',
45920
+ 'x-title': 'Scan to Assign a Credential',
45921
+ },
45922
+ },
45267
45923
  '/acs/encoders/simulate/next_credential_encode_will_fail': {
45268
45924
  post: {
45269
45925
  description:
@@ -52205,6 +52861,13 @@ const openapi: OpenAPISpec = {
52205
52861
  description: 'List of general spaces or areas.',
52206
52862
  items: {
52207
52863
  properties: {
52864
+ duration_minutes: {
52865
+ description:
52866
+ '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.',
52867
+ exclusiveMinimum: true,
52868
+ minimum: 0,
52869
+ type: 'integer',
52870
+ },
52208
52871
  name: {
52209
52872
  description:
52210
52873
  'Your display name for this location resource.',
@@ -53451,6 +54114,13 @@ const openapi: OpenAPISpec = {
53451
54114
  description: 'List of general spaces or areas.',
53452
54115
  items: {
53453
54116
  properties: {
54117
+ duration_minutes: {
54118
+ description:
54119
+ '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.',
54120
+ exclusiveMinimum: true,
54121
+ minimum: 0,
54122
+ type: 'integer',
54123
+ },
53454
54124
  name: {
53455
54125
  description:
53456
54126
  'Your display name for this location resource.',
@@ -79368,6 +80038,13 @@ const openapi: OpenAPISpec = {
79368
80038
  'Optional list of spaces that you want to include in the new building block magic link.',
79369
80039
  items: {
79370
80040
  properties: {
80041
+ duration_minutes: {
80042
+ description:
80043
+ '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.',
80044
+ exclusiveMinimum: true,
80045
+ minimum: 0,
80046
+ type: 'integer',
80047
+ },
79371
80048
  name: {
79372
80049
  description:
79373
80050
  'Your display name for this location resource.',
@@ -79454,6 +80131,13 @@ const openapi: OpenAPISpec = {
79454
80131
  'Optional list of spaces that you want to include in the new building block magic link.',
79455
80132
  items: {
79456
80133
  properties: {
80134
+ duration_minutes: {
80135
+ description:
80136
+ '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.',
80137
+ exclusiveMinimum: true,
80138
+ minimum: 0,
80139
+ type: 'integer',
80140
+ },
79457
80141
  name: {
79458
80142
  description:
79459
80143
  'Your display name for this location resource.',
@@ -79594,6 +80278,13 @@ const openapi: OpenAPISpec = {
79594
80278
  'Optional list of spaces that you want to include in the new building block magic link.',
79595
80279
  items: {
79596
80280
  properties: {
80281
+ duration_minutes: {
80282
+ description:
80283
+ '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.',
80284
+ exclusiveMinimum: true,
80285
+ minimum: 0,
80286
+ type: 'integer',
80287
+ },
79597
80288
  name: {
79598
80289
  description:
79599
80290
  'Your display name for this location resource.',