@seamapi/types 1.467.0 → 1.468.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.467.0",
3
+ "version": "1.468.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -47349,6 +47349,574 @@ export default {
47349
47349
  'x-undocumented': 'Internal endpoint for customer portals.',
47350
47350
  },
47351
47351
  },
47352
+ '/seam/customer/v1/events/list': {
47353
+ get: {
47354
+ description:
47355
+ 'Returns a list of events for devices in a specific space. This endpoint is designed for customer portals and only supports filtering by space_id.',
47356
+ operationId: 'seamCustomerV1EventsListGet',
47357
+ parameters: [
47358
+ {
47359
+ in: 'query',
47360
+ name: 'space_id',
47361
+ required: true,
47362
+ schema: {
47363
+ description: 'ID of the space for which you want to list events.',
47364
+ format: 'uuid',
47365
+ type: 'string',
47366
+ },
47367
+ },
47368
+ {
47369
+ in: 'query',
47370
+ name: 'since',
47371
+ required: false,
47372
+ schema: {
47373
+ description:
47374
+ 'Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`.',
47375
+ type: 'string',
47376
+ },
47377
+ },
47378
+ {
47379
+ in: 'query',
47380
+ name: 'between',
47381
+ required: false,
47382
+ schema: {
47383
+ description:
47384
+ 'Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`.',
47385
+ items: {
47386
+ oneOf: [
47387
+ { type: 'string' },
47388
+ { format: 'date-time', type: 'string' },
47389
+ ],
47390
+ },
47391
+ maxItems: 2,
47392
+ minItems: 2,
47393
+ type: 'array',
47394
+ },
47395
+ },
47396
+ {
47397
+ in: 'query',
47398
+ name: 'event_type',
47399
+ required: false,
47400
+ schema: {
47401
+ description: 'Type of the events that you want to list.',
47402
+ enum: [
47403
+ 'access_code.created',
47404
+ 'access_code.changed',
47405
+ 'access_code.scheduled_on_device',
47406
+ 'access_code.set_on_device',
47407
+ 'access_code.removed_from_device',
47408
+ 'access_code.delay_in_setting_on_device',
47409
+ 'access_code.failed_to_set_on_device',
47410
+ 'access_code.deleted',
47411
+ 'access_code.delay_in_removing_from_device',
47412
+ 'access_code.failed_to_remove_from_device',
47413
+ 'access_code.modified_external_to_seam',
47414
+ 'access_code.deleted_external_to_seam',
47415
+ 'access_code.backup_access_code_pulled',
47416
+ 'access_code.unmanaged.converted_to_managed',
47417
+ 'access_code.unmanaged.failed_to_convert_to_managed',
47418
+ 'access_code.unmanaged.created',
47419
+ 'access_code.unmanaged.removed',
47420
+ 'access_grant.created',
47421
+ 'access_grant.deleted',
47422
+ 'access_grant.access_granted_to_all_doors',
47423
+ 'access_grant.access_granted_to_door',
47424
+ 'access_grant.access_to_door_lost',
47425
+ 'access_method.issued',
47426
+ 'access_method.revoked',
47427
+ 'access_method.card_encoding_required',
47428
+ 'access_method.deleted',
47429
+ 'access_method.reissued',
47430
+ 'acs_system.connected',
47431
+ 'acs_system.added',
47432
+ 'acs_system.disconnected',
47433
+ 'acs_credential.deleted',
47434
+ 'acs_credential.issued',
47435
+ 'acs_credential.reissued',
47436
+ 'acs_credential.invalidated',
47437
+ 'acs_user.created',
47438
+ 'acs_user.deleted',
47439
+ 'acs_encoder.added',
47440
+ 'acs_encoder.removed',
47441
+ 'acs_access_group.deleted',
47442
+ 'acs_entrance.added',
47443
+ 'acs_entrance.removed',
47444
+ 'client_session.deleted',
47445
+ 'connected_account.connected',
47446
+ 'connected_account.created',
47447
+ 'connected_account.successful_login',
47448
+ 'connected_account.disconnected',
47449
+ 'connected_account.completed_first_sync',
47450
+ 'connected_account.deleted',
47451
+ 'connected_account.completed_first_sync_after_reconnection',
47452
+ 'action_attempt.lock_door.succeeded',
47453
+ 'action_attempt.lock_door.failed',
47454
+ 'action_attempt.unlock_door.succeeded',
47455
+ 'action_attempt.unlock_door.failed',
47456
+ 'connect_webview.login_succeeded',
47457
+ 'connect_webview.login_failed',
47458
+ 'device.connected',
47459
+ 'device.added',
47460
+ 'device.converted_to_unmanaged',
47461
+ 'device.unmanaged.converted_to_managed',
47462
+ 'device.unmanaged.connected',
47463
+ 'device.disconnected',
47464
+ 'device.unmanaged.disconnected',
47465
+ 'device.tampered',
47466
+ 'device.low_battery',
47467
+ 'device.battery_status_changed',
47468
+ 'device.removed',
47469
+ 'device.deleted',
47470
+ 'device.third_party_integration_detected',
47471
+ 'device.third_party_integration_no_longer_detected',
47472
+ 'device.salto.privacy_mode_activated',
47473
+ 'device.salto.privacy_mode_deactivated',
47474
+ 'device.connection_became_flaky',
47475
+ 'device.connection_stabilized',
47476
+ 'device.error.subscription_required',
47477
+ 'device.error.subscription_required.resolved',
47478
+ 'device.accessory_keypad_connected',
47479
+ 'device.accessory_keypad_disconnected',
47480
+ 'noise_sensor.noise_threshold_triggered',
47481
+ 'lock.locked',
47482
+ 'lock.unlocked',
47483
+ 'lock.access_denied',
47484
+ 'thermostat.climate_preset_activated',
47485
+ 'thermostat.manually_adjusted',
47486
+ 'thermostat.temperature_threshold_exceeded',
47487
+ 'thermostat.temperature_threshold_no_longer_exceeded',
47488
+ 'thermostat.temperature_reached_set_point',
47489
+ 'thermostat.temperature_changed',
47490
+ 'device.name_changed',
47491
+ 'enrollment_automation.deleted',
47492
+ 'phone.deactivated',
47493
+ ],
47494
+ type: 'string',
47495
+ },
47496
+ },
47497
+ {
47498
+ in: 'query',
47499
+ name: 'event_types',
47500
+ required: false,
47501
+ schema: {
47502
+ description: 'Types of the events that you want to list.',
47503
+ items: {
47504
+ enum: [
47505
+ 'access_code.created',
47506
+ 'access_code.changed',
47507
+ 'access_code.scheduled_on_device',
47508
+ 'access_code.set_on_device',
47509
+ 'access_code.removed_from_device',
47510
+ 'access_code.delay_in_setting_on_device',
47511
+ 'access_code.failed_to_set_on_device',
47512
+ 'access_code.deleted',
47513
+ 'access_code.delay_in_removing_from_device',
47514
+ 'access_code.failed_to_remove_from_device',
47515
+ 'access_code.modified_external_to_seam',
47516
+ 'access_code.deleted_external_to_seam',
47517
+ 'access_code.backup_access_code_pulled',
47518
+ 'access_code.unmanaged.converted_to_managed',
47519
+ 'access_code.unmanaged.failed_to_convert_to_managed',
47520
+ 'access_code.unmanaged.created',
47521
+ 'access_code.unmanaged.removed',
47522
+ 'access_grant.created',
47523
+ 'access_grant.deleted',
47524
+ 'access_grant.access_granted_to_all_doors',
47525
+ 'access_grant.access_granted_to_door',
47526
+ 'access_grant.access_to_door_lost',
47527
+ 'access_method.issued',
47528
+ 'access_method.revoked',
47529
+ 'access_method.card_encoding_required',
47530
+ 'access_method.deleted',
47531
+ 'access_method.reissued',
47532
+ 'acs_system.connected',
47533
+ 'acs_system.added',
47534
+ 'acs_system.disconnected',
47535
+ 'acs_credential.deleted',
47536
+ 'acs_credential.issued',
47537
+ 'acs_credential.reissued',
47538
+ 'acs_credential.invalidated',
47539
+ 'acs_user.created',
47540
+ 'acs_user.deleted',
47541
+ 'acs_encoder.added',
47542
+ 'acs_encoder.removed',
47543
+ 'acs_access_group.deleted',
47544
+ 'acs_entrance.added',
47545
+ 'acs_entrance.removed',
47546
+ 'client_session.deleted',
47547
+ 'connected_account.connected',
47548
+ 'connected_account.created',
47549
+ 'connected_account.successful_login',
47550
+ 'connected_account.disconnected',
47551
+ 'connected_account.completed_first_sync',
47552
+ 'connected_account.deleted',
47553
+ 'connected_account.completed_first_sync_after_reconnection',
47554
+ 'action_attempt.lock_door.succeeded',
47555
+ 'action_attempt.lock_door.failed',
47556
+ 'action_attempt.unlock_door.succeeded',
47557
+ 'action_attempt.unlock_door.failed',
47558
+ 'connect_webview.login_succeeded',
47559
+ 'connect_webview.login_failed',
47560
+ 'device.connected',
47561
+ 'device.added',
47562
+ 'device.converted_to_unmanaged',
47563
+ 'device.unmanaged.converted_to_managed',
47564
+ 'device.unmanaged.connected',
47565
+ 'device.disconnected',
47566
+ 'device.unmanaged.disconnected',
47567
+ 'device.tampered',
47568
+ 'device.low_battery',
47569
+ 'device.battery_status_changed',
47570
+ 'device.removed',
47571
+ 'device.deleted',
47572
+ 'device.third_party_integration_detected',
47573
+ 'device.third_party_integration_no_longer_detected',
47574
+ 'device.salto.privacy_mode_activated',
47575
+ 'device.salto.privacy_mode_deactivated',
47576
+ 'device.connection_became_flaky',
47577
+ 'device.connection_stabilized',
47578
+ 'device.error.subscription_required',
47579
+ 'device.error.subscription_required.resolved',
47580
+ 'device.accessory_keypad_connected',
47581
+ 'device.accessory_keypad_disconnected',
47582
+ 'noise_sensor.noise_threshold_triggered',
47583
+ 'lock.locked',
47584
+ 'lock.unlocked',
47585
+ 'lock.access_denied',
47586
+ 'thermostat.climate_preset_activated',
47587
+ 'thermostat.manually_adjusted',
47588
+ 'thermostat.temperature_threshold_exceeded',
47589
+ 'thermostat.temperature_threshold_no_longer_exceeded',
47590
+ 'thermostat.temperature_reached_set_point',
47591
+ 'thermostat.temperature_changed',
47592
+ 'device.name_changed',
47593
+ 'enrollment_automation.deleted',
47594
+ 'phone.deactivated',
47595
+ ],
47596
+ type: 'string',
47597
+ },
47598
+ type: 'array',
47599
+ },
47600
+ },
47601
+ {
47602
+ in: 'query',
47603
+ name: 'limit',
47604
+ required: false,
47605
+ schema: {
47606
+ default: 500,
47607
+ description: 'Numerical limit on the number of events to return.',
47608
+ format: 'float',
47609
+ type: 'number',
47610
+ },
47611
+ },
47612
+ ],
47613
+ responses: {
47614
+ 200: {
47615
+ content: {
47616
+ 'application/json': {
47617
+ schema: {
47618
+ properties: {
47619
+ events: {
47620
+ items: { $ref: '#/components/schemas/event' },
47621
+ type: 'array',
47622
+ },
47623
+ ok: { type: 'boolean' },
47624
+ },
47625
+ required: ['events', 'ok'],
47626
+ type: 'object',
47627
+ },
47628
+ },
47629
+ },
47630
+ description: 'OK',
47631
+ },
47632
+ 400: { description: 'Bad Request' },
47633
+ 401: { description: 'Unauthorized' },
47634
+ },
47635
+ security: [{ client_session_with_customer: [] }],
47636
+ summary: '/seam/customer/v1/events/list',
47637
+ tags: ['/events'],
47638
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'events'],
47639
+ 'x-fern-sdk-method-name': 'list',
47640
+ 'x-fern-sdk-return-value': 'events',
47641
+ 'x-response-key': 'events',
47642
+ 'x-title': 'List Events for Customer Space',
47643
+ 'x-undocumented': 'Internal endpoint for customer portals.',
47644
+ },
47645
+ post: {
47646
+ description:
47647
+ 'Returns a list of events for devices in a specific space. This endpoint is designed for customer portals and only supports filtering by space_id.',
47648
+ operationId: 'seamCustomerV1EventsListPost',
47649
+ requestBody: {
47650
+ content: {
47651
+ 'application/json': {
47652
+ schema: {
47653
+ properties: {
47654
+ between: {
47655
+ description:
47656
+ 'Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`.',
47657
+ items: {
47658
+ oneOf: [
47659
+ { type: 'string' },
47660
+ { format: 'date-time', type: 'string' },
47661
+ ],
47662
+ },
47663
+ maxItems: 2,
47664
+ minItems: 2,
47665
+ type: 'array',
47666
+ },
47667
+ event_type: {
47668
+ description: 'Type of the events that you want to list.',
47669
+ enum: [
47670
+ 'access_code.created',
47671
+ 'access_code.changed',
47672
+ 'access_code.scheduled_on_device',
47673
+ 'access_code.set_on_device',
47674
+ 'access_code.removed_from_device',
47675
+ 'access_code.delay_in_setting_on_device',
47676
+ 'access_code.failed_to_set_on_device',
47677
+ 'access_code.deleted',
47678
+ 'access_code.delay_in_removing_from_device',
47679
+ 'access_code.failed_to_remove_from_device',
47680
+ 'access_code.modified_external_to_seam',
47681
+ 'access_code.deleted_external_to_seam',
47682
+ 'access_code.backup_access_code_pulled',
47683
+ 'access_code.unmanaged.converted_to_managed',
47684
+ 'access_code.unmanaged.failed_to_convert_to_managed',
47685
+ 'access_code.unmanaged.created',
47686
+ 'access_code.unmanaged.removed',
47687
+ 'access_grant.created',
47688
+ 'access_grant.deleted',
47689
+ 'access_grant.access_granted_to_all_doors',
47690
+ 'access_grant.access_granted_to_door',
47691
+ 'access_grant.access_to_door_lost',
47692
+ 'access_method.issued',
47693
+ 'access_method.revoked',
47694
+ 'access_method.card_encoding_required',
47695
+ 'access_method.deleted',
47696
+ 'access_method.reissued',
47697
+ 'acs_system.connected',
47698
+ 'acs_system.added',
47699
+ 'acs_system.disconnected',
47700
+ 'acs_credential.deleted',
47701
+ 'acs_credential.issued',
47702
+ 'acs_credential.reissued',
47703
+ 'acs_credential.invalidated',
47704
+ 'acs_user.created',
47705
+ 'acs_user.deleted',
47706
+ 'acs_encoder.added',
47707
+ 'acs_encoder.removed',
47708
+ 'acs_access_group.deleted',
47709
+ 'acs_entrance.added',
47710
+ 'acs_entrance.removed',
47711
+ 'client_session.deleted',
47712
+ 'connected_account.connected',
47713
+ 'connected_account.created',
47714
+ 'connected_account.successful_login',
47715
+ 'connected_account.disconnected',
47716
+ 'connected_account.completed_first_sync',
47717
+ 'connected_account.deleted',
47718
+ 'connected_account.completed_first_sync_after_reconnection',
47719
+ 'action_attempt.lock_door.succeeded',
47720
+ 'action_attempt.lock_door.failed',
47721
+ 'action_attempt.unlock_door.succeeded',
47722
+ 'action_attempt.unlock_door.failed',
47723
+ 'connect_webview.login_succeeded',
47724
+ 'connect_webview.login_failed',
47725
+ 'device.connected',
47726
+ 'device.added',
47727
+ 'device.converted_to_unmanaged',
47728
+ 'device.unmanaged.converted_to_managed',
47729
+ 'device.unmanaged.connected',
47730
+ 'device.disconnected',
47731
+ 'device.unmanaged.disconnected',
47732
+ 'device.tampered',
47733
+ 'device.low_battery',
47734
+ 'device.battery_status_changed',
47735
+ 'device.removed',
47736
+ 'device.deleted',
47737
+ 'device.third_party_integration_detected',
47738
+ 'device.third_party_integration_no_longer_detected',
47739
+ 'device.salto.privacy_mode_activated',
47740
+ 'device.salto.privacy_mode_deactivated',
47741
+ 'device.connection_became_flaky',
47742
+ 'device.connection_stabilized',
47743
+ 'device.error.subscription_required',
47744
+ 'device.error.subscription_required.resolved',
47745
+ 'device.accessory_keypad_connected',
47746
+ 'device.accessory_keypad_disconnected',
47747
+ 'noise_sensor.noise_threshold_triggered',
47748
+ 'lock.locked',
47749
+ 'lock.unlocked',
47750
+ 'lock.access_denied',
47751
+ 'thermostat.climate_preset_activated',
47752
+ 'thermostat.manually_adjusted',
47753
+ 'thermostat.temperature_threshold_exceeded',
47754
+ 'thermostat.temperature_threshold_no_longer_exceeded',
47755
+ 'thermostat.temperature_reached_set_point',
47756
+ 'thermostat.temperature_changed',
47757
+ 'device.name_changed',
47758
+ 'enrollment_automation.deleted',
47759
+ 'phone.deactivated',
47760
+ ],
47761
+ type: 'string',
47762
+ },
47763
+ event_types: {
47764
+ description: 'Types of the events that you want to list.',
47765
+ items: {
47766
+ enum: [
47767
+ 'access_code.created',
47768
+ 'access_code.changed',
47769
+ 'access_code.scheduled_on_device',
47770
+ 'access_code.set_on_device',
47771
+ 'access_code.removed_from_device',
47772
+ 'access_code.delay_in_setting_on_device',
47773
+ 'access_code.failed_to_set_on_device',
47774
+ 'access_code.deleted',
47775
+ 'access_code.delay_in_removing_from_device',
47776
+ 'access_code.failed_to_remove_from_device',
47777
+ 'access_code.modified_external_to_seam',
47778
+ 'access_code.deleted_external_to_seam',
47779
+ 'access_code.backup_access_code_pulled',
47780
+ 'access_code.unmanaged.converted_to_managed',
47781
+ 'access_code.unmanaged.failed_to_convert_to_managed',
47782
+ 'access_code.unmanaged.created',
47783
+ 'access_code.unmanaged.removed',
47784
+ 'access_grant.created',
47785
+ 'access_grant.deleted',
47786
+ 'access_grant.access_granted_to_all_doors',
47787
+ 'access_grant.access_granted_to_door',
47788
+ 'access_grant.access_to_door_lost',
47789
+ 'access_method.issued',
47790
+ 'access_method.revoked',
47791
+ 'access_method.card_encoding_required',
47792
+ 'access_method.deleted',
47793
+ 'access_method.reissued',
47794
+ 'acs_system.connected',
47795
+ 'acs_system.added',
47796
+ 'acs_system.disconnected',
47797
+ 'acs_credential.deleted',
47798
+ 'acs_credential.issued',
47799
+ 'acs_credential.reissued',
47800
+ 'acs_credential.invalidated',
47801
+ 'acs_user.created',
47802
+ 'acs_user.deleted',
47803
+ 'acs_encoder.added',
47804
+ 'acs_encoder.removed',
47805
+ 'acs_access_group.deleted',
47806
+ 'acs_entrance.added',
47807
+ 'acs_entrance.removed',
47808
+ 'client_session.deleted',
47809
+ 'connected_account.connected',
47810
+ 'connected_account.created',
47811
+ 'connected_account.successful_login',
47812
+ 'connected_account.disconnected',
47813
+ 'connected_account.completed_first_sync',
47814
+ 'connected_account.deleted',
47815
+ 'connected_account.completed_first_sync_after_reconnection',
47816
+ 'action_attempt.lock_door.succeeded',
47817
+ 'action_attempt.lock_door.failed',
47818
+ 'action_attempt.unlock_door.succeeded',
47819
+ 'action_attempt.unlock_door.failed',
47820
+ 'connect_webview.login_succeeded',
47821
+ 'connect_webview.login_failed',
47822
+ 'device.connected',
47823
+ 'device.added',
47824
+ 'device.converted_to_unmanaged',
47825
+ 'device.unmanaged.converted_to_managed',
47826
+ 'device.unmanaged.connected',
47827
+ 'device.disconnected',
47828
+ 'device.unmanaged.disconnected',
47829
+ 'device.tampered',
47830
+ 'device.low_battery',
47831
+ 'device.battery_status_changed',
47832
+ 'device.removed',
47833
+ 'device.deleted',
47834
+ 'device.third_party_integration_detected',
47835
+ 'device.third_party_integration_no_longer_detected',
47836
+ 'device.salto.privacy_mode_activated',
47837
+ 'device.salto.privacy_mode_deactivated',
47838
+ 'device.connection_became_flaky',
47839
+ 'device.connection_stabilized',
47840
+ 'device.error.subscription_required',
47841
+ 'device.error.subscription_required.resolved',
47842
+ 'device.accessory_keypad_connected',
47843
+ 'device.accessory_keypad_disconnected',
47844
+ 'noise_sensor.noise_threshold_triggered',
47845
+ 'lock.locked',
47846
+ 'lock.unlocked',
47847
+ 'lock.access_denied',
47848
+ 'thermostat.climate_preset_activated',
47849
+ 'thermostat.manually_adjusted',
47850
+ 'thermostat.temperature_threshold_exceeded',
47851
+ 'thermostat.temperature_threshold_no_longer_exceeded',
47852
+ 'thermostat.temperature_reached_set_point',
47853
+ 'thermostat.temperature_changed',
47854
+ 'device.name_changed',
47855
+ 'enrollment_automation.deleted',
47856
+ 'phone.deactivated',
47857
+ ],
47858
+ type: 'string',
47859
+ },
47860
+ type: 'array',
47861
+ },
47862
+ limit: {
47863
+ default: 500,
47864
+ description:
47865
+ 'Numerical limit on the number of events to return.',
47866
+ format: 'float',
47867
+ type: 'number',
47868
+ },
47869
+ since: {
47870
+ description:
47871
+ 'Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`.',
47872
+ type: 'string',
47873
+ },
47874
+ space_id: {
47875
+ description:
47876
+ 'ID of the space for which you want to list events.',
47877
+ format: 'uuid',
47878
+ type: 'string',
47879
+ },
47880
+ },
47881
+ required: ['space_id'],
47882
+ type: 'object',
47883
+ },
47884
+ },
47885
+ },
47886
+ },
47887
+ responses: {
47888
+ 200: {
47889
+ content: {
47890
+ 'application/json': {
47891
+ schema: {
47892
+ properties: {
47893
+ events: {
47894
+ items: { $ref: '#/components/schemas/event' },
47895
+ type: 'array',
47896
+ },
47897
+ ok: { type: 'boolean' },
47898
+ },
47899
+ required: ['events', 'ok'],
47900
+ type: 'object',
47901
+ },
47902
+ },
47903
+ },
47904
+ description: 'OK',
47905
+ },
47906
+ 400: { description: 'Bad Request' },
47907
+ 401: { description: 'Unauthorized' },
47908
+ },
47909
+ security: [{ client_session_with_customer: [] }],
47910
+ summary: '/seam/customer/v1/events/list',
47911
+ tags: ['/events'],
47912
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'events'],
47913
+ 'x-fern-sdk-method-name': 'list',
47914
+ 'x-fern-sdk-return-value': 'events',
47915
+ 'x-response-key': 'events',
47916
+ 'x-title': 'List Events for Customer Space',
47917
+ 'x-undocumented': 'Internal endpoint for customer portals.',
47918
+ },
47919
+ },
47352
47920
  '/seam/customer/v1/portals/get': {
47353
47921
  get: {
47354
47922
  description:
@@ -47533,6 +48101,92 @@ export default {
47533
48101
  'x-undocumented': 'Internal endpoint for customer portals.',
47534
48102
  },
47535
48103
  },
48104
+ '/seam/customer/v1/settings/get': {
48105
+ get: {
48106
+ description: 'Retrieves the settings for a customer portal workspace.',
48107
+ operationId: 'seamCustomerV1SettingsGetGet',
48108
+ responses: {
48109
+ 200: {
48110
+ content: {
48111
+ 'application/json': {
48112
+ schema: {
48113
+ properties: {
48114
+ business_vertical: {
48115
+ description: 'Business vertical of the customer portal.',
48116
+ enum: [
48117
+ 'short_term_rental',
48118
+ 'hospitality',
48119
+ 'multi_family',
48120
+ 'gym_management',
48121
+ 'property_tours',
48122
+ ],
48123
+ type: 'string',
48124
+ },
48125
+ ok: { type: 'boolean' },
48126
+ },
48127
+ required: ['ok'],
48128
+ type: 'object',
48129
+ },
48130
+ },
48131
+ },
48132
+ description: 'OK',
48133
+ },
48134
+ 400: { description: 'Bad Request' },
48135
+ 401: { description: 'Unauthorized' },
48136
+ },
48137
+ security: [{ console_session_with_workspace: [] }, { api_key: [] }],
48138
+ summary: '/seam/customer/v1/settings/get',
48139
+ tags: [],
48140
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'settings'],
48141
+ 'x-fern-sdk-method-name': 'get',
48142
+ 'x-fern-sdk-return-value': 'business_vertical',
48143
+ 'x-response-key': 'business_vertical',
48144
+ 'x-title': 'Get Customer Portal Settings',
48145
+ 'x-undocumented': 'Internal endpoint for customer portals.',
48146
+ },
48147
+ post: {
48148
+ description: 'Retrieves the settings for a customer portal workspace.',
48149
+ operationId: 'seamCustomerV1SettingsGetPost',
48150
+ responses: {
48151
+ 200: {
48152
+ content: {
48153
+ 'application/json': {
48154
+ schema: {
48155
+ properties: {
48156
+ business_vertical: {
48157
+ description: 'Business vertical of the customer portal.',
48158
+ enum: [
48159
+ 'short_term_rental',
48160
+ 'hospitality',
48161
+ 'multi_family',
48162
+ 'gym_management',
48163
+ 'property_tours',
48164
+ ],
48165
+ type: 'string',
48166
+ },
48167
+ ok: { type: 'boolean' },
48168
+ },
48169
+ required: ['ok'],
48170
+ type: 'object',
48171
+ },
48172
+ },
48173
+ },
48174
+ description: 'OK',
48175
+ },
48176
+ 400: { description: 'Bad Request' },
48177
+ 401: { description: 'Unauthorized' },
48178
+ },
48179
+ security: [{ console_session_with_workspace: [] }, { api_key: [] }],
48180
+ summary: '/seam/customer/v1/settings/get',
48181
+ tags: [],
48182
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'settings'],
48183
+ 'x-fern-sdk-method-name': 'get',
48184
+ 'x-fern-sdk-return-value': 'business_vertical',
48185
+ 'x-response-key': 'business_vertical',
48186
+ 'x-title': 'Get Customer Portal Settings',
48187
+ 'x-undocumented': 'Internal endpoint for customer portals.',
48188
+ },
48189
+ },
47536
48190
  '/seam/customer/v1/settings/update': {
47537
48191
  patch: {
47538
48192
  description: 'Updates the settings for a customer portal workspace.',