@seamapi/types 1.748.0 → 1.750.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 (21) hide show
  1. package/dist/connect.cjs +68 -66
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +571 -595
  4. package/dist/index.cjs +68 -66
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/acs/acs-credential.d.ts +14 -14
  7. package/lib/seam/connect/models/acs/acs-credential.js +3 -1
  8. package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
  9. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +48 -48
  10. package/lib/seam/connect/models/action-attempts/encode-credential.d.ts +20 -20
  11. package/lib/seam/connect/models/action-attempts/scan-credential.d.ts +28 -28
  12. package/lib/seam/connect/models/batch.d.ts +84 -84
  13. package/lib/seam/connect/models/phones/phone-session.d.ts +24 -24
  14. package/lib/seam/connect/openapi.d.ts +37 -63
  15. package/lib/seam/connect/openapi.js +64 -64
  16. package/lib/seam/connect/openapi.js.map +1 -1
  17. package/lib/seam/connect/route-types.d.ts +390 -388
  18. package/package.json +1 -1
  19. package/src/lib/seam/connect/models/acs/acs-credential.ts +3 -1
  20. package/src/lib/seam/connect/openapi.ts +67 -64
  21. package/src/lib/seam/connect/route-types.ts +622 -261
package/lib/seam/connect/openapi.js CHANGED
@@ -2858,8 +2858,8 @@ export default {
2858
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.',
2859
2859
  properties: {
2860
2860
  access_method: {
2861
- description: 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
2862
- 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'],
2863
2863
  type: 'string',
2864
2864
  },
2865
2865
  acs_credential_id: {
@@ -2956,6 +2956,7 @@ export default {
2956
2956
  enum: [
2957
2957
  'pti_card',
2958
2958
  'brivo_credential',
2959
+ 'brivo_digital_credential',
2959
2960
  'hid_credential',
2960
2961
  'visionline_card',
2961
2962
  'salto_ks_credential',
@@ -5114,8 +5115,8 @@ export default {
5114
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.',
5115
5116
  properties: {
5116
5117
  access_method: {
5117
- description: 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
5118
- 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'],
5119
5120
  type: 'string',
5120
5121
  },
5121
5122
  acs_credential_id: {
@@ -5215,6 +5216,7 @@ export default {
5215
5216
  enum: [
5216
5217
  'pti_card',
5217
5218
  'brivo_credential',
5219
+ 'brivo_digital_credential',
5218
5220
  'hid_credential',
5219
5221
  'visionline_card',
5220
5222
  'salto_ks_credential',
@@ -5504,8 +5506,8 @@ export default {
5504
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.',
5505
5507
  properties: {
5506
5508
  access_method: {
5507
- description: 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
5508
- 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'],
5509
5511
  type: 'string',
5510
5512
  },
5511
5513
  acs_credential_id: {
@@ -5605,6 +5607,7 @@ export default {
5605
5607
  enum: [
5606
5608
  'pti_card',
5607
5609
  'brivo_credential',
5610
+ 'brivo_digital_credential',
5608
5611
  'hid_credential',
5609
5612
  'visionline_card',
5610
5613
  'salto_ks_credential',
@@ -6088,8 +6091,8 @@ export default {
6088
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.',
6089
6092
  properties: {
6090
6093
  access_method: {
6091
- description: 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
6092
- 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'],
6093
6096
  type: 'string',
6094
6097
  },
6095
6098
  acs_credential_id: {
@@ -6189,6 +6192,7 @@ export default {
6189
6192
  enum: [
6190
6193
  'pti_card',
6191
6194
  'brivo_credential',
6195
+ 'brivo_digital_credential',
6192
6196
  'hid_credential',
6193
6197
  'visionline_card',
6194
6198
  'salto_ks_credential',
@@ -6476,8 +6480,8 @@ export default {
6476
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.',
6477
6481
  properties: {
6478
6482
  access_method: {
6479
- description: 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
6480
- 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'],
6481
6485
  type: 'string',
6482
6486
  },
6483
6487
  acs_credential_id: {
@@ -6577,6 +6581,7 @@ export default {
6577
6581
  enum: [
6578
6582
  'pti_card',
6579
6583
  'brivo_credential',
6584
+ 'brivo_digital_credential',
6580
6585
  'hid_credential',
6581
6586
  'visionline_card',
6582
6587
  'salto_ks_credential',
@@ -21591,8 +21596,8 @@ export default {
21591
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.',
21592
21597
  properties: {
21593
21598
  access_method: {
21594
- description: 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
21595
- 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'],
21596
21601
  type: 'string',
21597
21602
  },
21598
21603
  acs_credential_id: { nullable: true, type: 'string' },
@@ -22014,6 +22019,7 @@ export default {
22014
22019
  enum: [
22015
22020
  'pti_card',
22016
22021
  'brivo_credential',
22022
+ 'brivo_digital_credential',
22017
22023
  'hid_credential',
22018
22024
  'visionline_card',
22019
22025
  'salto_ks_credential',
@@ -24780,8 +24786,8 @@ export default {
24780
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.',
24781
24787
  properties: {
24782
24788
  access_method: {
24783
- description: 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
24784
- 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'],
24785
24791
  type: 'string',
24786
24792
  },
24787
24793
  acs_credential_id: {
@@ -24878,6 +24884,7 @@ export default {
24878
24884
  enum: [
24879
24885
  'pti_card',
24880
24886
  'brivo_credential',
24887
+ 'brivo_digital_credential',
24881
24888
  'hid_credential',
24882
24889
  'visionline_card',
24883
24890
  'salto_ks_credential',
@@ -37519,8 +37526,8 @@ export default {
37519
37526
  schema: {
37520
37527
  properties: {
37521
37528
  access_method: {
37522
- description: 'Access method for the new credential. Supported values: `code`, `card`, `mobile_key`.',
37523
- 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'],
37524
37531
  type: 'string',
37525
37532
  },
37526
37533
  acs_system_id: {
@@ -56110,8 +56117,18 @@ export default {
56110
56117
  },
56111
56118
  '/seam/customer/v1/automations/get': {
56112
56119
  get: {
56113
- description: 'Gets the current automation configuration for a customer portal workspace.\nFor customer client sessions, returns customer-specific config if available,\notherwise falls back to workspace-level config.',
56120
+ description: 'Gets the current automation configuration for a customer portal workspace.\nWhen customer_key is provided, returns customer-specific config if available,\notherwise falls back to workspace-level config.',
56114
56121
  operationId: 'seamCustomerV1AutomationsGetGet',
56122
+ parameters: [
56123
+ {
56124
+ in: 'query',
56125
+ name: 'customer_key',
56126
+ schema: {
56127
+ description: 'Key of the customer to get automation config for.',
56128
+ type: 'string',
56129
+ },
56130
+ },
56131
+ ],
56115
56132
  responses: {
56116
56133
  200: {
56117
56134
  content: {
@@ -56381,11 +56398,7 @@ export default {
56381
56398
  400: { description: 'Bad Request' },
56382
56399
  401: { description: 'Unauthorized' },
56383
56400
  },
56384
- security: [
56385
- { console_session_with_workspace: [] },
56386
- { api_key: [] },
56387
- { client_session_with_customer: [] },
56388
- ],
56401
+ security: [{ console_session_with_workspace: [] }, { api_key: [] }],
56389
56402
  summary: '/seam/customer/v1/automations/get',
56390
56403
  tags: [],
56391
56404
  'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'automations'],
@@ -56395,8 +56408,23 @@ export default {
56395
56408
  'x-undocumented': 'Internal endpoint for customer portals.',
56396
56409
  },
56397
56410
  post: {
56398
- description: 'Gets the current automation configuration for a customer portal workspace.\nFor customer client sessions, returns customer-specific config if available,\notherwise falls back to workspace-level config.',
56411
+ description: 'Gets the current automation configuration for a customer portal workspace.\nWhen customer_key is provided, returns customer-specific config if available,\notherwise falls back to workspace-level config.',
56399
56412
  operationId: 'seamCustomerV1AutomationsGetPost',
56413
+ requestBody: {
56414
+ content: {
56415
+ 'application/json': {
56416
+ schema: {
56417
+ properties: {
56418
+ customer_key: {
56419
+ description: 'Key of the customer to get automation config for.',
56420
+ type: 'string',
56421
+ },
56422
+ },
56423
+ type: 'object',
56424
+ },
56425
+ },
56426
+ },
56427
+ },
56400
56428
  responses: {
56401
56429
  200: {
56402
56430
  content: {
@@ -56666,11 +56694,7 @@ export default {
56666
56694
  400: { description: 'Bad Request' },
56667
56695
  401: { description: 'Unauthorized' },
56668
56696
  },
56669
- security: [
56670
- { console_session_with_workspace: [] },
56671
- { api_key: [] },
56672
- { client_session_with_customer: [] },
56673
- ],
56697
+ security: [{ console_session_with_workspace: [] }, { api_key: [] }],
56674
56698
  summary: '/seam/customer/v1/automations/get',
56675
56699
  tags: [],
56676
56700
  'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'automations'],
@@ -56929,6 +56953,10 @@ export default {
56929
56953
  },
56930
56954
  type: 'object',
56931
56955
  },
56956
+ customer_key: {
56957
+ description: 'Key of the customer to update automation config for.',
56958
+ type: 'string',
56959
+ },
56932
56960
  },
56933
56961
  type: 'object',
56934
56962
  },
@@ -57208,6 +57236,10 @@ export default {
57208
57236
  },
57209
57237
  type: 'object',
57210
57238
  },
57239
+ customer_key: {
57240
+ description: 'Key of the customer to update automation config for.',
57241
+ type: 'string',
57242
+ },
57211
57243
  },
57212
57244
  type: 'object',
57213
57245
  },
@@ -58197,16 +58229,8 @@ export default {
58197
58229
  },
58198
58230
  '/seam/customer/v1/customers/automations/get': {
58199
58231
  get: {
58200
- description: 'Gets the automation configuration for a specific customer.\nReturns the merged configuration (customer overrides on top of workspace defaults).',
58232
+ description: 'Gets the automation configuration for the authenticated customer.\nReturns the merged configuration (customer overrides on top of workspace defaults).',
58201
58233
  operationId: 'seamCustomerV1CustomersAutomationsGetGet',
58202
- parameters: [
58203
- {
58204
- in: 'query',
58205
- name: 'customer_key',
58206
- required: true,
58207
- schema: { description: 'Key of the customer.', type: 'string' },
58208
- },
58209
- ],
58210
58234
  responses: {
58211
58235
  200: {
58212
58236
  content: {
@@ -58485,11 +58509,7 @@ export default {
58485
58509
  400: { description: 'Bad Request' },
58486
58510
  401: { description: 'Unauthorized' },
58487
58511
  },
58488
- security: [
58489
- { pat_with_workspace: [] },
58490
- { console_session_with_workspace: [] },
58491
- { api_key: [] },
58492
- ],
58512
+ security: [{ client_session_with_customer: [] }],
58493
58513
  summary: '/seam/customer/v1/customers/automations/get',
58494
58514
  tags: [],
58495
58515
  'x-fern-sdk-group-name': [
@@ -58505,24 +58525,8 @@ export default {
58505
58525
  'x-title': 'Get Customer Automation Configuration',
58506
58526
  },
58507
58527
  post: {
58508
- description: 'Gets the automation configuration for a specific customer.\nReturns the merged configuration (customer overrides on top of workspace defaults).',
58528
+ description: 'Gets the automation configuration for the authenticated customer.\nReturns the merged configuration (customer overrides on top of workspace defaults).',
58509
58529
  operationId: 'seamCustomerV1CustomersAutomationsGetPost',
58510
- requestBody: {
58511
- content: {
58512
- 'application/json': {
58513
- schema: {
58514
- properties: {
58515
- customer_key: {
58516
- description: 'Key of the customer.',
58517
- type: 'string',
58518
- },
58519
- },
58520
- required: ['customer_key'],
58521
- type: 'object',
58522
- },
58523
- },
58524
- },
58525
- },
58526
58530
  responses: {
58527
58531
  200: {
58528
58532
  content: {
@@ -58801,11 +58805,7 @@ export default {
58801
58805
  400: { description: 'Bad Request' },
58802
58806
  401: { description: 'Unauthorized' },
58803
58807
  },
58804
- security: [
58805
- { pat_with_workspace: [] },
58806
- { console_session_with_workspace: [] },
58807
- { api_key: [] },
58808
- ],
58808
+ security: [{ client_session_with_customer: [] }],
58809
58809
  summary: '/seam/customer/v1/customers/automations/get',
58810
58810
  tags: [],
58811
58811
  'x-fern-sdk-group-name': [