@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.
Files changed (34) hide show
  1. package/dist/connect.cjs +729 -60
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +8858 -470
  4. package/dist/index.cjs +729 -60
  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 +953 -117
  13. package/lib/seam/connect/models/devices/device-metadata.d.ts +28 -0
  14. package/lib/seam/connect/models/devices/device-metadata.js +12 -0
  15. package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
  16. package/lib/seam/connect/models/devices/device-provider.d.ts +1 -0
  17. package/lib/seam/connect/models/devices/device-provider.js +1 -0
  18. package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
  19. package/lib/seam/connect/models/devices/device-type.d.ts +1 -0
  20. package/lib/seam/connect/models/devices/device-type.js +1 -0
  21. package/lib/seam/connect/models/devices/device-type.js.map +1 -1
  22. package/lib/seam/connect/models/devices/device.d.ts +43 -3
  23. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +31 -3
  24. package/lib/seam/connect/openapi.js +621 -0
  25. package/lib/seam/connect/openapi.js.map +1 -1
  26. package/lib/seam/connect/route-types.d.ts +7379 -454
  27. package/package.json +1 -1
  28. package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +2 -0
  29. package/src/lib/seam/connect/models/action-attempts/scan-to-assign-credential.ts +69 -0
  30. package/src/lib/seam/connect/models/devices/device-metadata.ts +15 -0
  31. package/src/lib/seam/connect/models/devices/device-provider.ts +1 -0
  32. package/src/lib/seam/connect/models/devices/device-type.ts +1 -0
  33. package/src/lib/seam/connect/openapi.ts +709 -0
  34. package/src/lib/seam/connect/route-types.ts +8322 -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: {
@@ -11851,6 +12435,7 @@ const openapi: OpenAPISpec = {
11851
12435
  'akiles_lock',
11852
12436
  'ultraloq_lock',
11853
12437
  'korelock_lock',
12438
+ 'omnitec_lock',
11854
12439
  ],
11855
12440
  type: 'string',
11856
12441
  },
@@ -13620,6 +14205,37 @@ const openapi: OpenAPISpec = {
13620
14205
  required: ['device_id', 'device_name'],
13621
14206
  type: 'object',
13622
14207
  },
14208
+ omnitec_metadata: {
14209
+ description: 'Metadata for an Omnitec device.',
14210
+ properties: {
14211
+ has_gateway: {
14212
+ description:
14213
+ 'Whether the Omnitec lock has a connected gateway for remote operations.',
14214
+ type: 'boolean',
14215
+ },
14216
+ lock_id: {
14217
+ description: 'Lock ID for an Omnitec device.',
14218
+ format: 'float',
14219
+ type: 'number',
14220
+ },
14221
+ lock_mac: {
14222
+ description:
14223
+ 'Bluetooth MAC address for an Omnitec device.',
14224
+ type: 'string',
14225
+ },
14226
+ lock_name: {
14227
+ description: 'Lock name for an Omnitec device.',
14228
+ type: 'string',
14229
+ },
14230
+ },
14231
+ required: [
14232
+ 'lock_id',
14233
+ 'lock_name',
14234
+ 'lock_mac',
14235
+ 'has_gateway',
14236
+ ],
14237
+ type: 'object',
14238
+ },
13623
14239
  ring_metadata: {
13624
14240
  description: 'Metadata for a Ring device.',
13625
14241
  properties: {
@@ -15918,6 +16534,7 @@ const openapi: OpenAPISpec = {
15918
16534
  'lodgify',
15919
16535
  'hostaway',
15920
16536
  'acuity_scheduling',
16537
+ 'omnitec',
15921
16538
  ],
15922
16539
  type: 'string',
15923
16540
  },
@@ -30383,6 +31000,7 @@ const openapi: OpenAPISpec = {
30383
31000
  'akiles_lock',
30384
31001
  'ultraloq_lock',
30385
31002
  'korelock_lock',
31003
+ 'omnitec_lock',
30386
31004
  ],
30387
31005
  type: 'string',
30388
31006
  },
@@ -45264,6 +45882,78 @@ const openapi: OpenAPISpec = {
45264
45882
  'x-title': 'Scan a Credential',
45265
45883
  },
45266
45884
  },
45885
+ '/acs/encoders/scan_to_assign_credential': {
45886
+ post: {
45887
+ description:
45888
+ '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`.',
45889
+ operationId: 'acsEncodersScanToAssignCredentialPost',
45890
+ requestBody: {
45891
+ content: {
45892
+ 'application/json': {
45893
+ schema: {
45894
+ properties: {
45895
+ acs_encoder_id: {
45896
+ description:
45897
+ 'ID of the `acs_encoder` to use to scan the credential.',
45898
+ format: 'uuid',
45899
+ type: 'string',
45900
+ },
45901
+ acs_user_id: {
45902
+ description:
45903
+ 'ID of the `acs_user` to assign the scanned credential to.',
45904
+ format: 'uuid',
45905
+ type: 'string',
45906
+ },
45907
+ user_identity_id: {
45908
+ description:
45909
+ '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.',
45910
+ format: 'uuid',
45911
+ type: 'string',
45912
+ },
45913
+ },
45914
+ required: ['acs_encoder_id'],
45915
+ type: 'object',
45916
+ },
45917
+ },
45918
+ },
45919
+ },
45920
+ responses: {
45921
+ 200: {
45922
+ content: {
45923
+ 'application/json': {
45924
+ schema: {
45925
+ properties: {
45926
+ action_attempt: {
45927
+ $ref: '#/components/schemas/action_attempt',
45928
+ },
45929
+ ok: { type: 'boolean' },
45930
+ },
45931
+ required: ['action_attempt', 'ok'],
45932
+ type: 'object',
45933
+ },
45934
+ },
45935
+ },
45936
+ description: 'OK',
45937
+ },
45938
+ 400: { description: 'Bad Request' },
45939
+ 401: { description: 'Unauthorized' },
45940
+ },
45941
+ security: [
45942
+ { pat_with_workspace: [] },
45943
+ { console_session_with_workspace: [] },
45944
+ { api_key: [] },
45945
+ { client_session_with_customer: [] },
45946
+ ],
45947
+ summary: '/acs/encoders/scan_to_assign_credential',
45948
+ tags: ['/acs'],
45949
+ 'x-action-attempt-type': 'SCAN_TO_ASSIGN_CREDENTIAL',
45950
+ 'x-fern-sdk-group-name': ['acs', 'encoders'],
45951
+ 'x-fern-sdk-method-name': 'scan_to_assign_credential',
45952
+ 'x-fern-sdk-return-value': 'action_attempt',
45953
+ 'x-response-key': 'action_attempt',
45954
+ 'x-title': 'Scan to Assign a Credential',
45955
+ },
45956
+ },
45267
45957
  '/acs/encoders/simulate/next_credential_encode_will_fail': {
45268
45958
  post: {
45269
45959
  description:
@@ -49956,6 +50646,7 @@ const openapi: OpenAPISpec = {
49956
50646
  'lodgify',
49957
50647
  'hostaway',
49958
50648
  'acuity_scheduling',
50649
+ 'omnitec',
49959
50650
  'yale_access',
49960
50651
  'hid_cm',
49961
50652
  'google_nest',
@@ -54114,6 +54805,7 @@ const openapi: OpenAPISpec = {
54114
54805
  'akiles_lock',
54115
54806
  'ultraloq_lock',
54116
54807
  'korelock_lock',
54808
+ 'omnitec_lock',
54117
54809
  ],
54118
54810
  type: 'string',
54119
54811
  },
@@ -54190,6 +54882,7 @@ const openapi: OpenAPISpec = {
54190
54882
  'akiles_lock',
54191
54883
  'ultraloq_lock',
54192
54884
  'korelock_lock',
54885
+ 'omnitec_lock',
54193
54886
  ],
54194
54887
  type: 'string',
54195
54888
  },
@@ -54282,6 +54975,7 @@ const openapi: OpenAPISpec = {
54282
54975
  'lodgify',
54283
54976
  'hostaway',
54284
54977
  'acuity_scheduling',
54978
+ 'omnitec',
54285
54979
  ],
54286
54980
  type: 'string',
54287
54981
  },
@@ -54570,6 +55264,7 @@ const openapi: OpenAPISpec = {
54570
55264
  'akiles_lock',
54571
55265
  'ultraloq_lock',
54572
55266
  'korelock_lock',
55267
+ 'omnitec_lock',
54573
55268
  ],
54574
55269
  type: 'string',
54575
55270
  },
@@ -54644,6 +55339,7 @@ const openapi: OpenAPISpec = {
54644
55339
  'akiles_lock',
54645
55340
  'ultraloq_lock',
54646
55341
  'korelock_lock',
55342
+ 'omnitec_lock',
54647
55343
  ],
54648
55344
  type: 'string',
54649
55345
  },
@@ -54800,6 +55496,7 @@ const openapi: OpenAPISpec = {
54800
55496
  'lodgify',
54801
55497
  'hostaway',
54802
55498
  'acuity_scheduling',
55499
+ 'omnitec',
54803
55500
  ],
54804
55501
  type: 'string',
54805
55502
  },
@@ -56465,6 +57162,7 @@ const openapi: OpenAPISpec = {
56465
57162
  'akiles_lock',
56466
57163
  'ultraloq_lock',
56467
57164
  'korelock_lock',
57165
+ 'omnitec_lock',
56468
57166
  ],
56469
57167
  type: 'string',
56470
57168
  },
@@ -56541,6 +57239,7 @@ const openapi: OpenAPISpec = {
56541
57239
  'akiles_lock',
56542
57240
  'ultraloq_lock',
56543
57241
  'korelock_lock',
57242
+ 'omnitec_lock',
56544
57243
  ],
56545
57244
  type: 'string',
56546
57245
  },
@@ -56633,6 +57332,7 @@ const openapi: OpenAPISpec = {
56633
57332
  'lodgify',
56634
57333
  'hostaway',
56635
57334
  'acuity_scheduling',
57335
+ 'omnitec',
56636
57336
  ],
56637
57337
  type: 'string',
56638
57338
  },
@@ -56920,6 +57620,7 @@ const openapi: OpenAPISpec = {
56920
57620
  'akiles_lock',
56921
57621
  'ultraloq_lock',
56922
57622
  'korelock_lock',
57623
+ 'omnitec_lock',
56923
57624
  ],
56924
57625
  type: 'string',
56925
57626
  },
@@ -56994,6 +57695,7 @@ const openapi: OpenAPISpec = {
56994
57695
  'akiles_lock',
56995
57696
  'ultraloq_lock',
56996
57697
  'korelock_lock',
57698
+ 'omnitec_lock',
56997
57699
  ],
56998
57700
  type: 'string',
56999
57701
  },
@@ -57150,6 +57852,7 @@ const openapi: OpenAPISpec = {
57150
57852
  'lodgify',
57151
57853
  'hostaway',
57152
57854
  'acuity_scheduling',
57855
+ 'omnitec',
57153
57856
  ],
57154
57857
  type: 'string',
57155
57858
  },
@@ -59234,6 +59937,7 @@ const openapi: OpenAPISpec = {
59234
59937
  'akiles_lock',
59235
59938
  'ultraloq_lock',
59236
59939
  'korelock_lock',
59940
+ 'omnitec_lock',
59237
59941
  ],
59238
59942
  type: 'string',
59239
59943
  },
@@ -59273,6 +59977,7 @@ const openapi: OpenAPISpec = {
59273
59977
  'akiles_lock',
59274
59978
  'ultraloq_lock',
59275
59979
  'korelock_lock',
59980
+ 'omnitec_lock',
59276
59981
  ],
59277
59982
  type: 'string',
59278
59983
  },
@@ -59314,6 +60019,7 @@ const openapi: OpenAPISpec = {
59314
60019
  'korelock',
59315
60020
  'smartthings',
59316
60021
  'ultraloq',
60022
+ 'omnitec',
59317
60023
  ],
59318
60024
  type: 'string',
59319
60025
  },
@@ -59601,6 +60307,7 @@ const openapi: OpenAPISpec = {
59601
60307
  'akiles_lock',
59602
60308
  'ultraloq_lock',
59603
60309
  'korelock_lock',
60310
+ 'omnitec_lock',
59604
60311
  ],
59605
60312
  type: 'string',
59606
60313
  },
@@ -59637,6 +60344,7 @@ const openapi: OpenAPISpec = {
59637
60344
  'akiles_lock',
59638
60345
  'ultraloq_lock',
59639
60346
  'korelock_lock',
60347
+ 'omnitec_lock',
59640
60348
  ],
59641
60349
  type: 'string',
59642
60350
  },
@@ -59740,6 +60448,7 @@ const openapi: OpenAPISpec = {
59740
60448
  'korelock',
59741
60449
  'smartthings',
59742
60450
  'ultraloq',
60451
+ 'omnitec',
59743
60452
  ],
59744
60453
  type: 'string',
59745
60454
  },