@seamapi/types 1.747.0 → 1.749.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 +185 -20
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +801 -537
  4. package/dist/index.cjs +185 -20
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/access-grants/access-method.d.ts +81 -0
  7. package/lib/seam/connect/models/access-grants/access-method.js +16 -0
  8. package/lib/seam/connect/models/access-grants/access-method.js.map +1 -1
  9. package/lib/seam/connect/models/acs/acs-credential.d.ts +14 -14
  10. package/lib/seam/connect/models/acs/acs-credential.js +3 -1
  11. package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
  12. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +48 -48
  13. package/lib/seam/connect/models/action-attempts/encode-credential.d.ts +20 -20
  14. package/lib/seam/connect/models/action-attempts/scan-credential.d.ts +28 -28
  15. package/lib/seam/connect/models/batch.d.ts +120 -84
  16. package/lib/seam/connect/models/phones/phone-session.d.ts +24 -24
  17. package/lib/seam/connect/openapi.d.ts +140 -10
  18. package/lib/seam/connect/openapi.js +169 -16
  19. package/lib/seam/connect/openapi.js.map +1 -1
  20. package/lib/seam/connect/route-types.d.ts +455 -383
  21. package/package.json +1 -1
  22. package/src/lib/seam/connect/models/access-grants/access-method.ts +21 -0
  23. package/src/lib/seam/connect/models/acs/acs-credential.ts +3 -1
  24. package/src/lib/seam/connect/openapi.ts +194 -16
  25. package/src/lib/seam/connect/route-types.ts +695 -256
package/lib/seam/connect/openapi.js CHANGED
@@ -2318,6 +2318,32 @@ export default {
2318
2318
  required: ['created_at', 'message', 'warning_code'],
2319
2319
  type: 'object',
2320
2320
  },
2321
+ {
2322
+ description: 'Indicates that all attempts to create an access code on this device before the start time failed and a backup access code was used to ensure access was provided in time.',
2323
+ properties: {
2324
+ created_at: {
2325
+ description: 'Date and time at which Seam created the warning.',
2326
+ format: 'date-time',
2327
+ type: 'string',
2328
+ },
2329
+ message: {
2330
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
2331
+ type: 'string',
2332
+ },
2333
+ original_access_method_id: {
2334
+ description: 'ID of the original access method from which this backup access method was split, if applicable.',
2335
+ format: 'uuid',
2336
+ type: 'string',
2337
+ },
2338
+ warning_code: {
2339
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
2340
+ enum: ['pulled_backup_access_code'],
2341
+ type: 'string',
2342
+ },
2343
+ },
2344
+ required: ['created_at', 'message', 'warning_code'],
2345
+ type: 'object',
2346
+ },
2321
2347
  ],
2322
2348
  },
2323
2349
  type: 'array',
@@ -2832,8 +2858,8 @@ export default {
2832
2858
  description: 'Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nAn access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.\n\nFor each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.',
2833
2859
  properties: {
2834
2860
  access_method: {
2835
- description: 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
2836
- enum: ['code', 'card', 'mobile_key'],
2861
+ 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`.',
2862
+ enum: ['code', 'card', 'mobile_key', 'cloud_key'],
2837
2863
  type: 'string',
2838
2864
  },
2839
2865
  acs_credential_id: {
@@ -2930,6 +2956,7 @@ export default {
2930
2956
  enum: [
2931
2957
  'pti_card',
2932
2958
  'brivo_credential',
2959
+ 'brivo_digital_credential',
2933
2960
  'hid_credential',
2934
2961
  'visionline_card',
2935
2962
  'salto_ks_credential',
@@ -5088,8 +5115,8 @@ export default {
5088
5115
  description: 'Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nAn access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.\n\nFor each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.',
5089
5116
  properties: {
5090
5117
  access_method: {
5091
- description: 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
5092
- enum: ['code', 'card', 'mobile_key'],
5118
+ 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`.',
5119
+ enum: ['code', 'card', 'mobile_key', 'cloud_key'],
5093
5120
  type: 'string',
5094
5121
  },
5095
5122
  acs_credential_id: {
@@ -5189,6 +5216,7 @@ export default {
5189
5216
  enum: [
5190
5217
  'pti_card',
5191
5218
  'brivo_credential',
5219
+ 'brivo_digital_credential',
5192
5220
  'hid_credential',
5193
5221
  'visionline_card',
5194
5222
  'salto_ks_credential',
@@ -5478,8 +5506,8 @@ export default {
5478
5506
  description: 'Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `unmanaged_acs_credential` object, which is not managed by Seam, represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code.',
5479
5507
  properties: {
5480
5508
  access_method: {
5481
- description: 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
5482
- enum: ['code', 'card', 'mobile_key'],
5509
+ 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`.',
5510
+ enum: ['code', 'card', 'mobile_key', 'cloud_key'],
5483
5511
  type: 'string',
5484
5512
  },
5485
5513
  acs_credential_id: {
@@ -5579,6 +5607,7 @@ export default {
5579
5607
  enum: [
5580
5608
  'pti_card',
5581
5609
  'brivo_credential',
5610
+ 'brivo_digital_credential',
5582
5611
  'hid_credential',
5583
5612
  'visionline_card',
5584
5613
  'salto_ks_credential',
@@ -6062,8 +6091,8 @@ export default {
6062
6091
  description: 'Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nAn access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.\n\nFor each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.',
6063
6092
  properties: {
6064
6093
  access_method: {
6065
- description: 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
6066
- enum: ['code', 'card', 'mobile_key'],
6094
+ 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`.',
6095
+ enum: ['code', 'card', 'mobile_key', 'cloud_key'],
6067
6096
  type: 'string',
6068
6097
  },
6069
6098
  acs_credential_id: {
@@ -6163,6 +6192,7 @@ export default {
6163
6192
  enum: [
6164
6193
  'pti_card',
6165
6194
  'brivo_credential',
6195
+ 'brivo_digital_credential',
6166
6196
  'hid_credential',
6167
6197
  'visionline_card',
6168
6198
  'salto_ks_credential',
@@ -6450,8 +6480,8 @@ export default {
6450
6480
  description: 'Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `unmanaged_acs_credential` object, which is not managed by Seam, represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code.',
6451
6481
  properties: {
6452
6482
  access_method: {
6453
- description: 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
6454
- enum: ['code', 'card', 'mobile_key'],
6483
+ 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`.',
6484
+ enum: ['code', 'card', 'mobile_key', 'cloud_key'],
6455
6485
  type: 'string',
6456
6486
  },
6457
6487
  acs_credential_id: {
@@ -6551,6 +6581,7 @@ export default {
6551
6581
  enum: [
6552
6582
  'pti_card',
6553
6583
  'brivo_credential',
6584
+ 'brivo_digital_credential',
6554
6585
  'hid_credential',
6555
6586
  'visionline_card',
6556
6587
  'salto_ks_credential',
@@ -21565,8 +21596,8 @@ export default {
21565
21596
  description: 'Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nAn access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.\n\nFor each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.',
21566
21597
  properties: {
21567
21598
  access_method: {
21568
- description: 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
21569
- enum: ['code', 'card', 'mobile_key'],
21599
+ 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`.',
21600
+ enum: ['code', 'card', 'mobile_key', 'cloud_key'],
21570
21601
  type: 'string',
21571
21602
  },
21572
21603
  acs_credential_id: { nullable: true, type: 'string' },
@@ -21988,6 +22019,7 @@ export default {
21988
22019
  enum: [
21989
22020
  'pti_card',
21990
22021
  'brivo_credential',
22022
+ 'brivo_digital_credential',
21991
22023
  'hid_credential',
21992
22024
  'visionline_card',
21993
22025
  'salto_ks_credential',
@@ -24754,8 +24786,8 @@ export default {
24754
24786
  description: 'Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `unmanaged_acs_credential` object, which is not managed by Seam, represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code.',
24755
24787
  properties: {
24756
24788
  access_method: {
24757
- description: 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
24758
- enum: ['code', 'card', 'mobile_key'],
24789
+ 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`.',
24790
+ enum: ['code', 'card', 'mobile_key', 'cloud_key'],
24759
24791
  type: 'string',
24760
24792
  },
24761
24793
  acs_credential_id: {
@@ -24852,6 +24884,7 @@ export default {
24852
24884
  enum: [
24853
24885
  'pti_card',
24854
24886
  'brivo_credential',
24887
+ 'brivo_digital_credential',
24855
24888
  'hid_credential',
24856
24889
  'visionline_card',
24857
24890
  'salto_ks_credential',
@@ -34806,6 +34839,36 @@ export default {
34806
34839
  ],
34807
34840
  type: 'object',
34808
34841
  },
34842
+ {
34843
+ description: 'Indicates that all attempts to create an access code on this device before the start time failed and a backup access code was used to ensure access was provided in time.',
34844
+ properties: {
34845
+ created_at: {
34846
+ description: 'Date and time at which Seam created the warning.',
34847
+ format: 'date-time',
34848
+ type: 'string',
34849
+ },
34850
+ message: {
34851
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
34852
+ type: 'string',
34853
+ },
34854
+ original_access_method_id: {
34855
+ description: 'ID of the original access method from which this backup access method was split, if applicable.',
34856
+ format: 'uuid',
34857
+ type: 'string',
34858
+ },
34859
+ warning_code: {
34860
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
34861
+ enum: ['pulled_backup_access_code'],
34862
+ type: 'string',
34863
+ },
34864
+ },
34865
+ required: [
34866
+ 'created_at',
34867
+ 'message',
34868
+ 'warning_code',
34869
+ ],
34870
+ type: 'object',
34871
+ },
34809
34872
  ],
34810
34873
  },
34811
34874
  type: 'array',
@@ -35168,6 +35231,36 @@ export default {
35168
35231
  ],
35169
35232
  type: 'object',
35170
35233
  },
35234
+ {
35235
+ description: 'Indicates that all attempts to create an access code on this device before the start time failed and a backup access code was used to ensure access was provided in time.',
35236
+ properties: {
35237
+ created_at: {
35238
+ description: 'Date and time at which Seam created the warning.',
35239
+ format: 'date-time',
35240
+ type: 'string',
35241
+ },
35242
+ message: {
35243
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
35244
+ type: 'string',
35245
+ },
35246
+ original_access_method_id: {
35247
+ description: 'ID of the original access method from which this backup access method was split, if applicable.',
35248
+ format: 'uuid',
35249
+ type: 'string',
35250
+ },
35251
+ warning_code: {
35252
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
35253
+ enum: ['pulled_backup_access_code'],
35254
+ type: 'string',
35255
+ },
35256
+ },
35257
+ required: [
35258
+ 'created_at',
35259
+ 'message',
35260
+ 'warning_code',
35261
+ ],
35262
+ type: 'object',
35263
+ },
35171
35264
  ],
35172
35265
  },
35173
35266
  type: 'array',
@@ -35558,6 +35651,36 @@ export default {
35558
35651
  ],
35559
35652
  type: 'object',
35560
35653
  },
35654
+ {
35655
+ description: 'Indicates that all attempts to create an access code on this device before the start time failed and a backup access code was used to ensure access was provided in time.',
35656
+ properties: {
35657
+ created_at: {
35658
+ description: 'Date and time at which Seam created the warning.',
35659
+ format: 'date-time',
35660
+ type: 'string',
35661
+ },
35662
+ message: {
35663
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
35664
+ type: 'string',
35665
+ },
35666
+ original_access_method_id: {
35667
+ description: 'ID of the original access method from which this backup access method was split, if applicable.',
35668
+ format: 'uuid',
35669
+ type: 'string',
35670
+ },
35671
+ warning_code: {
35672
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
35673
+ enum: ['pulled_backup_access_code'],
35674
+ type: 'string',
35675
+ },
35676
+ },
35677
+ required: [
35678
+ 'created_at',
35679
+ 'message',
35680
+ 'warning_code',
35681
+ ],
35682
+ type: 'object',
35683
+ },
35561
35684
  ],
35562
35685
  },
35563
35686
  type: 'array',
@@ -35938,6 +36061,36 @@ export default {
35938
36061
  ],
35939
36062
  type: 'object',
35940
36063
  },
36064
+ {
36065
+ description: 'Indicates that all attempts to create an access code on this device before the start time failed and a backup access code was used to ensure access was provided in time.',
36066
+ properties: {
36067
+ created_at: {
36068
+ description: 'Date and time at which Seam created the warning.',
36069
+ format: 'date-time',
36070
+ type: 'string',
36071
+ },
36072
+ message: {
36073
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
36074
+ type: 'string',
36075
+ },
36076
+ original_access_method_id: {
36077
+ description: 'ID of the original access method from which this backup access method was split, if applicable.',
36078
+ format: 'uuid',
36079
+ type: 'string',
36080
+ },
36081
+ warning_code: {
36082
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
36083
+ enum: ['pulled_backup_access_code'],
36084
+ type: 'string',
36085
+ },
36086
+ },
36087
+ required: [
36088
+ 'created_at',
36089
+ 'message',
36090
+ 'warning_code',
36091
+ ],
36092
+ type: 'object',
36093
+ },
35941
36094
  ],
35942
36095
  },
35943
36096
  type: 'array',
@@ -37373,8 +37526,8 @@ export default {
37373
37526
  schema: {
37374
37527
  properties: {
37375
37528
  access_method: {
37376
- description: 'Access method for the new credential. Supported values: `code`, `card`, `mobile_key`.',
37377
- enum: ['code', 'card', 'mobile_key'],
37529
+ description: 'Access method for the new credential. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
37530
+ enum: ['code', 'card', 'mobile_key', 'cloud_key'],
37378
37531
  type: 'string',
37379
37532
  },
37380
37533
  acs_system_id: {