@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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.748.0",
3
+ "version": "1.750.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -9,6 +9,7 @@ import {
9
9
  export const acs_credential_external_type = z.enum([
10
10
  'pti_card',
11
11
  'brivo_credential',
12
+ 'brivo_digital_credential',
12
13
  'hid_credential',
13
14
  'visionline_card',
14
15
  'salto_ks_credential',
@@ -23,6 +24,7 @@ export const acs_credential_access_method_type = z.enum([
23
24
  'code',
24
25
  'card',
25
26
  'mobile_key',
27
+ 'cloud_key',
26
28
  ])
27
29
 
28
30
  export type AcsCredentialExternalType = z.infer<
@@ -214,7 +216,7 @@ const common_acs_credential = z.object({
214
216
  'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card.',
215
217
  ),
216
218
  access_method: acs_credential_access_method_type.describe(
217
- 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
219
+ 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
218
220
  ),
219
221
  external_type: acs_credential_external_type
220
222
  .optional()
@@ -3246,8 +3246,8 @@ export default {
3246
3246
  properties: {
3247
3247
  access_method: {
3248
3248
  description:
3249
- 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
3250
- enum: ['code', 'card', 'mobile_key'],
3249
+ 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
3250
+ enum: ['code', 'card', 'mobile_key', 'cloud_key'],
3251
3251
  type: 'string',
3252
3252
  },
3253
3253
  acs_credential_id: {
@@ -3360,6 +3360,7 @@ export default {
3360
3360
  enum: [
3361
3361
  'pti_card',
3362
3362
  'brivo_credential',
3363
+ 'brivo_digital_credential',
3363
3364
  'hid_credential',
3364
3365
  'visionline_card',
3365
3366
  'salto_ks_credential',
@@ -5807,8 +5808,8 @@ export default {
5807
5808
  properties: {
5808
5809
  access_method: {
5809
5810
  description:
5810
- 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
5811
- enum: ['code', 'card', 'mobile_key'],
5811
+ 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
5812
+ enum: ['code', 'card', 'mobile_key', 'cloud_key'],
5812
5813
  type: 'string',
5813
5814
  },
5814
5815
  acs_credential_id: {
@@ -5926,6 +5927,7 @@ export default {
5926
5927
  enum: [
5927
5928
  'pti_card',
5928
5929
  'brivo_credential',
5930
+ 'brivo_digital_credential',
5929
5931
  'hid_credential',
5930
5932
  'visionline_card',
5931
5933
  'salto_ks_credential',
@@ -6263,8 +6265,8 @@ export default {
6263
6265
  properties: {
6264
6266
  access_method: {
6265
6267
  description:
6266
- 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
6267
- enum: ['code', 'card', 'mobile_key'],
6268
+ 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
6269
+ enum: ['code', 'card', 'mobile_key', 'cloud_key'],
6268
6270
  type: 'string',
6269
6271
  },
6270
6272
  acs_credential_id: {
@@ -6382,6 +6384,7 @@ export default {
6382
6384
  enum: [
6383
6385
  'pti_card',
6384
6386
  'brivo_credential',
6387
+ 'brivo_digital_credential',
6385
6388
  'hid_credential',
6386
6389
  'visionline_card',
6387
6390
  'salto_ks_credential',
@@ -6938,8 +6941,8 @@ export default {
6938
6941
  properties: {
6939
6942
  access_method: {
6940
6943
  description:
6941
- 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
6942
- enum: ['code', 'card', 'mobile_key'],
6944
+ 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
6945
+ enum: ['code', 'card', 'mobile_key', 'cloud_key'],
6943
6946
  type: 'string',
6944
6947
  },
6945
6948
  acs_credential_id: {
@@ -7056,6 +7059,7 @@ export default {
7056
7059
  enum: [
7057
7060
  'pti_card',
7058
7061
  'brivo_credential',
7062
+ 'brivo_digital_credential',
7059
7063
  'hid_credential',
7060
7064
  'visionline_card',
7061
7065
  'salto_ks_credential',
@@ -7391,8 +7395,8 @@ export default {
7391
7395
  properties: {
7392
7396
  access_method: {
7393
7397
  description:
7394
- 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
7395
- enum: ['code', 'card', 'mobile_key'],
7398
+ 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
7399
+ enum: ['code', 'card', 'mobile_key', 'cloud_key'],
7396
7400
  type: 'string',
7397
7401
  },
7398
7402
  acs_credential_id: {
@@ -7509,6 +7513,7 @@ export default {
7509
7513
  enum: [
7510
7514
  'pti_card',
7511
7515
  'brivo_credential',
7516
+ 'brivo_digital_credential',
7512
7517
  'hid_credential',
7513
7518
  'visionline_card',
7514
7519
  'salto_ks_credential',
@@ -23985,8 +23990,8 @@ export default {
23985
23990
  properties: {
23986
23991
  access_method: {
23987
23992
  description:
23988
- 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
23989
- enum: ['code', 'card', 'mobile_key'],
23993
+ 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
23994
+ enum: ['code', 'card', 'mobile_key', 'cloud_key'],
23990
23995
  type: 'string',
23991
23996
  },
23992
23997
  acs_credential_id: { nullable: true, type: 'string' },
@@ -24480,6 +24485,7 @@ export default {
24480
24485
  enum: [
24481
24486
  'pti_card',
24482
24487
  'brivo_credential',
24488
+ 'brivo_digital_credential',
24483
24489
  'hid_credential',
24484
24490
  'visionline_card',
24485
24491
  'salto_ks_credential',
@@ -27629,8 +27635,8 @@ export default {
27629
27635
  properties: {
27630
27636
  access_method: {
27631
27637
  description:
27632
- 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
27633
- enum: ['code', 'card', 'mobile_key'],
27638
+ 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
27639
+ enum: ['code', 'card', 'mobile_key', 'cloud_key'],
27634
27640
  type: 'string',
27635
27641
  },
27636
27642
  acs_credential_id: {
@@ -27743,6 +27749,7 @@ export default {
27743
27749
  enum: [
27744
27750
  'pti_card',
27745
27751
  'brivo_credential',
27752
+ 'brivo_digital_credential',
27746
27753
  'hid_credential',
27747
27754
  'visionline_card',
27748
27755
  'salto_ks_credential',
@@ -41591,8 +41598,8 @@ export default {
41591
41598
  properties: {
41592
41599
  access_method: {
41593
41600
  description:
41594
- 'Access method for the new credential. Supported values: `code`, `card`, `mobile_key`.',
41595
- enum: ['code', 'card', 'mobile_key'],
41601
+ 'Access method for the new credential. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
41602
+ enum: ['code', 'card', 'mobile_key', 'cloud_key'],
41596
41603
  type: 'string',
41597
41604
  },
41598
41605
  acs_system_id: {
@@ -61246,8 +61253,18 @@ export default {
61246
61253
  '/seam/customer/v1/automations/get': {
61247
61254
  get: {
61248
61255
  description:
61249
- '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.',
61256
+ '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.',
61250
61257
  operationId: 'seamCustomerV1AutomationsGetGet',
61258
+ parameters: [
61259
+ {
61260
+ in: 'query',
61261
+ name: 'customer_key',
61262
+ schema: {
61263
+ description: 'Key of the customer to get automation config for.',
61264
+ type: 'string',
61265
+ },
61266
+ },
61267
+ ],
61251
61268
  responses: {
61252
61269
  200: {
61253
61270
  content: {
@@ -61517,11 +61534,7 @@ export default {
61517
61534
  400: { description: 'Bad Request' },
61518
61535
  401: { description: 'Unauthorized' },
61519
61536
  },
61520
- security: [
61521
- { console_session_with_workspace: [] },
61522
- { api_key: [] },
61523
- { client_session_with_customer: [] },
61524
- ],
61537
+ security: [{ console_session_with_workspace: [] }, { api_key: [] }],
61525
61538
  summary: '/seam/customer/v1/automations/get',
61526
61539
  tags: [],
61527
61540
  'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'automations'],
@@ -61532,8 +61545,24 @@ export default {
61532
61545
  },
61533
61546
  post: {
61534
61547
  description:
61535
- '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.',
61548
+ '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.',
61536
61549
  operationId: 'seamCustomerV1AutomationsGetPost',
61550
+ requestBody: {
61551
+ content: {
61552
+ 'application/json': {
61553
+ schema: {
61554
+ properties: {
61555
+ customer_key: {
61556
+ description:
61557
+ 'Key of the customer to get automation config for.',
61558
+ type: 'string',
61559
+ },
61560
+ },
61561
+ type: 'object',
61562
+ },
61563
+ },
61564
+ },
61565
+ },
61537
61566
  responses: {
61538
61567
  200: {
61539
61568
  content: {
@@ -61803,11 +61832,7 @@ export default {
61803
61832
  400: { description: 'Bad Request' },
61804
61833
  401: { description: 'Unauthorized' },
61805
61834
  },
61806
- security: [
61807
- { console_session_with_workspace: [] },
61808
- { api_key: [] },
61809
- { client_session_with_customer: [] },
61810
- ],
61835
+ security: [{ console_session_with_workspace: [] }, { api_key: [] }],
61811
61836
  summary: '/seam/customer/v1/automations/get',
61812
61837
  tags: [],
61813
61838
  'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'automations'],
@@ -62067,6 +62092,11 @@ export default {
62067
62092
  },
62068
62093
  type: 'object',
62069
62094
  },
62095
+ customer_key: {
62096
+ description:
62097
+ 'Key of the customer to update automation config for.',
62098
+ type: 'string',
62099
+ },
62070
62100
  },
62071
62101
  type: 'object',
62072
62102
  },
@@ -62347,6 +62377,11 @@ export default {
62347
62377
  },
62348
62378
  type: 'object',
62349
62379
  },
62380
+ customer_key: {
62381
+ description:
62382
+ 'Key of the customer to update automation config for.',
62383
+ type: 'string',
62384
+ },
62350
62385
  },
62351
62386
  type: 'object',
62352
62387
  },
@@ -63353,16 +63388,8 @@ export default {
63353
63388
  '/seam/customer/v1/customers/automations/get': {
63354
63389
  get: {
63355
63390
  description:
63356
- 'Gets the automation configuration for a specific customer.\nReturns the merged configuration (customer overrides on top of workspace defaults).',
63391
+ 'Gets the automation configuration for the authenticated customer.\nReturns the merged configuration (customer overrides on top of workspace defaults).',
63357
63392
  operationId: 'seamCustomerV1CustomersAutomationsGetGet',
63358
- parameters: [
63359
- {
63360
- in: 'query',
63361
- name: 'customer_key',
63362
- required: true,
63363
- schema: { description: 'Key of the customer.', type: 'string' },
63364
- },
63365
- ],
63366
63393
  responses: {
63367
63394
  200: {
63368
63395
  content: {
@@ -63641,11 +63668,7 @@ export default {
63641
63668
  400: { description: 'Bad Request' },
63642
63669
  401: { description: 'Unauthorized' },
63643
63670
  },
63644
- security: [
63645
- { pat_with_workspace: [] },
63646
- { console_session_with_workspace: [] },
63647
- { api_key: [] },
63648
- ],
63671
+ security: [{ client_session_with_customer: [] }],
63649
63672
  summary: '/seam/customer/v1/customers/automations/get',
63650
63673
  tags: [],
63651
63674
  'x-fern-sdk-group-name': [
@@ -63662,24 +63685,8 @@ export default {
63662
63685
  },
63663
63686
  post: {
63664
63687
  description:
63665
- 'Gets the automation configuration for a specific customer.\nReturns the merged configuration (customer overrides on top of workspace defaults).',
63688
+ 'Gets the automation configuration for the authenticated customer.\nReturns the merged configuration (customer overrides on top of workspace defaults).',
63666
63689
  operationId: 'seamCustomerV1CustomersAutomationsGetPost',
63667
- requestBody: {
63668
- content: {
63669
- 'application/json': {
63670
- schema: {
63671
- properties: {
63672
- customer_key: {
63673
- description: 'Key of the customer.',
63674
- type: 'string',
63675
- },
63676
- },
63677
- required: ['customer_key'],
63678
- type: 'object',
63679
- },
63680
- },
63681
- },
63682
- },
63683
63690
  responses: {
63684
63691
  200: {
63685
63692
  content: {
@@ -63958,11 +63965,7 @@ export default {
63958
63965
  400: { description: 'Bad Request' },
63959
63966
  401: { description: 'Unauthorized' },
63960
63967
  },
63961
- security: [
63962
- { pat_with_workspace: [] },
63963
- { console_session_with_workspace: [] },
63964
- { api_key: [] },
63965
- ],
63968
+ security: [{ client_session_with_customer: [] }],
63966
63969
  summary: '/seam/customer/v1/customers/automations/get',
63967
63970
  tags: [],
63968
63971
  'x-fern-sdk-group-name': [