@seamapi/types 1.725.0 → 1.726.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.
@@ -57944,6 +57944,7 @@ export default {
57944
57944
  business_vertical: {
57945
57945
  description: 'Business vertical of the customer portal.',
57946
57946
  enum: [
57947
+ 'neutral',
57947
57948
  'short_term_rental',
57948
57949
  'hospitality',
57949
57950
  'multi_family',
@@ -58311,6 +58312,7 @@ export default {
58311
58312
  business_vertical: {
58312
58313
  description: 'Business vertical of the customer portal.',
58313
58314
  enum: [
58315
+ 'neutral',
58314
58316
  'short_term_rental',
58315
58317
  'hospitality',
58316
58318
  'multi_family',
@@ -59372,6 +59374,118 @@ export default {
59372
59374
  'x-undocumented': 'Internal endpoint for customer portals.',
59373
59375
  },
59374
59376
  },
59377
+ '/seam/customer/v1/settings/business_verticals/list': {
59378
+ get: {
59379
+ description: 'Returns all available business verticals.',
59380
+ operationId: 'seamCustomerV1SettingsBusinessVerticalsListGet',
59381
+ parameters: [],
59382
+ responses: {
59383
+ 200: {
59384
+ content: {
59385
+ 'application/json': {
59386
+ schema: {
59387
+ properties: {
59388
+ business_verticals: {
59389
+ items: {
59390
+ description: 'Business vertical of the customer portal.',
59391
+ enum: [
59392
+ 'neutral',
59393
+ 'short_term_rental',
59394
+ 'hospitality',
59395
+ 'multi_family',
59396
+ 'gym_management',
59397
+ 'property_tours',
59398
+ ],
59399
+ type: 'string',
59400
+ },
59401
+ type: 'array',
59402
+ },
59403
+ ok: { type: 'boolean' },
59404
+ },
59405
+ required: ['business_verticals', 'ok'],
59406
+ type: 'object',
59407
+ },
59408
+ },
59409
+ },
59410
+ description: 'OK',
59411
+ },
59412
+ 400: { description: 'Bad Request' },
59413
+ 401: { description: 'Unauthorized' },
59414
+ },
59415
+ security: [{ console_session_with_workspace: [] }],
59416
+ summary: '/seam/customer/v1/settings/business_verticals/list',
59417
+ tags: [],
59418
+ 'x-fern-sdk-group-name': [
59419
+ 'seam',
59420
+ 'customer',
59421
+ 'v1',
59422
+ 'settings',
59423
+ 'business_verticals',
59424
+ ],
59425
+ 'x-fern-sdk-method-name': 'list',
59426
+ 'x-fern-sdk-return-value': 'business_verticals',
59427
+ 'x-response-key': 'business_verticals',
59428
+ 'x-title': 'List Business Verticals',
59429
+ 'x-undocumented': 'Internal endpoint for customer portals.',
59430
+ },
59431
+ post: {
59432
+ description: 'Returns all available business verticals.',
59433
+ operationId: 'seamCustomerV1SettingsBusinessVerticalsListPost',
59434
+ requestBody: {
59435
+ content: {
59436
+ 'application/json': { schema: { properties: {}, type: 'object' } },
59437
+ },
59438
+ },
59439
+ responses: {
59440
+ 200: {
59441
+ content: {
59442
+ 'application/json': {
59443
+ schema: {
59444
+ properties: {
59445
+ business_verticals: {
59446
+ items: {
59447
+ description: 'Business vertical of the customer portal.',
59448
+ enum: [
59449
+ 'neutral',
59450
+ 'short_term_rental',
59451
+ 'hospitality',
59452
+ 'multi_family',
59453
+ 'gym_management',
59454
+ 'property_tours',
59455
+ ],
59456
+ type: 'string',
59457
+ },
59458
+ type: 'array',
59459
+ },
59460
+ ok: { type: 'boolean' },
59461
+ },
59462
+ required: ['business_verticals', 'ok'],
59463
+ type: 'object',
59464
+ },
59465
+ },
59466
+ },
59467
+ description: 'OK',
59468
+ },
59469
+ 400: { description: 'Bad Request' },
59470
+ 401: { description: 'Unauthorized' },
59471
+ },
59472
+ security: [{ console_session_with_workspace: [] }],
59473
+ summary: '/seam/customer/v1/settings/business_verticals/list',
59474
+ tags: [],
59475
+ 'x-fern-sdk-group-name': [
59476
+ 'seam',
59477
+ 'customer',
59478
+ 'v1',
59479
+ 'settings',
59480
+ 'business_verticals',
59481
+ ],
59482
+ 'x-fern-sdk-method-name': 'list',
59483
+ 'x-fern-sdk-return-value': 'business_verticals',
59484
+ 'x-response-key': 'business_verticals',
59485
+ 'x-title': 'List Business Verticals',
59486
+ 'x-undocumented': 'Internal endpoint for customer portals.',
59487
+ },
59488
+ },
59375
59489
  '/seam/customer/v1/settings/get': {
59376
59490
  get: {
59377
59491
  description: 'Retrieves the settings for a customer portal workspace.',
@@ -59385,6 +59499,7 @@ export default {
59385
59499
  business_vertical: {
59386
59500
  description: 'Business vertical of the customer portal.',
59387
59501
  enum: [
59502
+ 'neutral',
59388
59503
  'short_term_rental',
59389
59504
  'hospitality',
59390
59505
  'multi_family',
@@ -59428,6 +59543,7 @@ export default {
59428
59543
  business_vertical: {
59429
59544
  description: 'Business vertical of the customer portal.',
59430
59545
  enum: [
59546
+ 'neutral',
59431
59547
  'short_term_rental',
59432
59548
  'hospitality',
59433
59549
  'multi_family',
@@ -59472,6 +59588,7 @@ export default {
59472
59588
  business_vertical: {
59473
59589
  description: 'Business vertical to set on the workspace.',
59474
59590
  enum: [
59591
+ 'neutral',
59475
59592
  'short_term_rental',
59476
59593
  'hospitality',
59477
59594
  'multi_family',
@@ -59527,6 +59644,7 @@ export default {
59527
59644
  business_vertical: {
59528
59645
  description: 'Business vertical to set on the workspace.',
59529
59646
  enum: [
59647
+ 'neutral',
59530
59648
  'short_term_rental',
59531
59649
  'hospitality',
59532
59650
  'multi_family',
@@ -59572,6 +59690,346 @@ export default {
59572
59690
  'x-undocumented': 'Internal endpoint for customer portals.',
59573
59691
  },
59574
59692
  },
59693
+ '/seam/customer/v1/settings/vertical_resource_aliases/get': {
59694
+ get: {
59695
+ description: "Returns the resource aliases for the workspace's business vertical, mapping\ngeneric resource types (space, user_identity, access_grant) to their\nvertical-specific terminology. Defaults to neutral if no vertical is set.",
59696
+ operationId: 'seamCustomerV1SettingsVerticalResourceAliasesGetGet',
59697
+ parameters: [],
59698
+ responses: {
59699
+ 200: {
59700
+ content: {
59701
+ 'application/json': {
59702
+ schema: {
59703
+ properties: {
59704
+ ok: { type: 'boolean' },
59705
+ vertical_resource_aliases: {
59706
+ properties: {
59707
+ access_grant: {
59708
+ description: 'Primary access grant alias for this vertical.',
59709
+ properties: {
59710
+ collection_key: {
59711
+ description: 'The key alias for a collection of resources.',
59712
+ type: 'string',
59713
+ },
59714
+ collection_label: {
59715
+ description: 'Human-readable label for a collection of resources.',
59716
+ type: 'string',
59717
+ },
59718
+ resource_key: {
59719
+ description: 'The key alias for a single resource.',
59720
+ type: 'string',
59721
+ },
59722
+ resource_label: {
59723
+ description: 'Human-readable label for a single resource.',
59724
+ type: 'string',
59725
+ },
59726
+ },
59727
+ required: [
59728
+ 'resource_key',
59729
+ 'resource_label',
59730
+ 'collection_key',
59731
+ 'collection_label',
59732
+ ],
59733
+ type: 'object',
59734
+ },
59735
+ additional_spaces: {
59736
+ description: 'Additional space aliases relevant to this vertical.',
59737
+ items: {
59738
+ properties: {
59739
+ collection_key: {
59740
+ description: 'The key alias for a collection of resources.',
59741
+ type: 'string',
59742
+ },
59743
+ collection_label: {
59744
+ description: 'Human-readable label for a collection of resources.',
59745
+ type: 'string',
59746
+ },
59747
+ resource_key: {
59748
+ description: 'The key alias for a single resource.',
59749
+ type: 'string',
59750
+ },
59751
+ resource_label: {
59752
+ description: 'Human-readable label for a single resource.',
59753
+ type: 'string',
59754
+ },
59755
+ },
59756
+ required: [
59757
+ 'resource_key',
59758
+ 'resource_label',
59759
+ 'collection_key',
59760
+ 'collection_label',
59761
+ ],
59762
+ type: 'object',
59763
+ },
59764
+ type: 'array',
59765
+ },
59766
+ space: {
59767
+ description: 'Primary space alias for this vertical.',
59768
+ properties: {
59769
+ collection_key: {
59770
+ description: 'The key alias for a collection of resources.',
59771
+ type: 'string',
59772
+ },
59773
+ collection_label: {
59774
+ description: 'Human-readable label for a collection of resources.',
59775
+ type: 'string',
59776
+ },
59777
+ resource_key: {
59778
+ description: 'The key alias for a single resource.',
59779
+ type: 'string',
59780
+ },
59781
+ resource_label: {
59782
+ description: 'Human-readable label for a single resource.',
59783
+ type: 'string',
59784
+ },
59785
+ },
59786
+ required: [
59787
+ 'resource_key',
59788
+ 'resource_label',
59789
+ 'collection_key',
59790
+ 'collection_label',
59791
+ ],
59792
+ type: 'object',
59793
+ },
59794
+ user_identity: {
59795
+ description: 'Primary user identity alias for this vertical.',
59796
+ properties: {
59797
+ collection_key: {
59798
+ description: 'The key alias for a collection of resources.',
59799
+ type: 'string',
59800
+ },
59801
+ collection_label: {
59802
+ description: 'Human-readable label for a collection of resources.',
59803
+ type: 'string',
59804
+ },
59805
+ resource_key: {
59806
+ description: 'The key alias for a single resource.',
59807
+ type: 'string',
59808
+ },
59809
+ resource_label: {
59810
+ description: 'Human-readable label for a single resource.',
59811
+ type: 'string',
59812
+ },
59813
+ },
59814
+ required: [
59815
+ 'resource_key',
59816
+ 'resource_label',
59817
+ 'collection_key',
59818
+ 'collection_label',
59819
+ ],
59820
+ type: 'object',
59821
+ },
59822
+ },
59823
+ required: [
59824
+ 'space',
59825
+ 'additional_spaces',
59826
+ 'user_identity',
59827
+ 'access_grant',
59828
+ ],
59829
+ type: 'object',
59830
+ },
59831
+ },
59832
+ required: ['vertical_resource_aliases', 'ok'],
59833
+ type: 'object',
59834
+ },
59835
+ },
59836
+ },
59837
+ description: 'OK',
59838
+ },
59839
+ 400: { description: 'Bad Request' },
59840
+ 401: { description: 'Unauthorized' },
59841
+ },
59842
+ security: [
59843
+ { console_session_with_workspace: [] },
59844
+ { client_session_with_customer: [] },
59845
+ ],
59846
+ summary: '/seam/customer/v1/settings/vertical_resource_aliases/get',
59847
+ tags: [],
59848
+ 'x-fern-sdk-group-name': [
59849
+ 'seam',
59850
+ 'customer',
59851
+ 'v1',
59852
+ 'settings',
59853
+ 'vertical_resource_aliases',
59854
+ ],
59855
+ 'x-fern-sdk-method-name': 'get',
59856
+ 'x-fern-sdk-return-value': 'vertical_resource_aliases',
59857
+ 'x-response-key': 'vertical_resource_aliases',
59858
+ 'x-title': 'Get Vertical Resource Aliases',
59859
+ 'x-undocumented': 'Internal endpoint for customer portals.',
59860
+ },
59861
+ post: {
59862
+ description: "Returns the resource aliases for the workspace's business vertical, mapping\ngeneric resource types (space, user_identity, access_grant) to their\nvertical-specific terminology. Defaults to neutral if no vertical is set.",
59863
+ operationId: 'seamCustomerV1SettingsVerticalResourceAliasesGetPost',
59864
+ requestBody: {
59865
+ content: {
59866
+ 'application/json': { schema: { properties: {}, type: 'object' } },
59867
+ },
59868
+ },
59869
+ responses: {
59870
+ 200: {
59871
+ content: {
59872
+ 'application/json': {
59873
+ schema: {
59874
+ properties: {
59875
+ ok: { type: 'boolean' },
59876
+ vertical_resource_aliases: {
59877
+ properties: {
59878
+ access_grant: {
59879
+ description: 'Primary access grant alias for this vertical.',
59880
+ properties: {
59881
+ collection_key: {
59882
+ description: 'The key alias for a collection of resources.',
59883
+ type: 'string',
59884
+ },
59885
+ collection_label: {
59886
+ description: 'Human-readable label for a collection of resources.',
59887
+ type: 'string',
59888
+ },
59889
+ resource_key: {
59890
+ description: 'The key alias for a single resource.',
59891
+ type: 'string',
59892
+ },
59893
+ resource_label: {
59894
+ description: 'Human-readable label for a single resource.',
59895
+ type: 'string',
59896
+ },
59897
+ },
59898
+ required: [
59899
+ 'resource_key',
59900
+ 'resource_label',
59901
+ 'collection_key',
59902
+ 'collection_label',
59903
+ ],
59904
+ type: 'object',
59905
+ },
59906
+ additional_spaces: {
59907
+ description: 'Additional space aliases relevant to this vertical.',
59908
+ items: {
59909
+ properties: {
59910
+ collection_key: {
59911
+ description: 'The key alias for a collection of resources.',
59912
+ type: 'string',
59913
+ },
59914
+ collection_label: {
59915
+ description: 'Human-readable label for a collection of resources.',
59916
+ type: 'string',
59917
+ },
59918
+ resource_key: {
59919
+ description: 'The key alias for a single resource.',
59920
+ type: 'string',
59921
+ },
59922
+ resource_label: {
59923
+ description: 'Human-readable label for a single resource.',
59924
+ type: 'string',
59925
+ },
59926
+ },
59927
+ required: [
59928
+ 'resource_key',
59929
+ 'resource_label',
59930
+ 'collection_key',
59931
+ 'collection_label',
59932
+ ],
59933
+ type: 'object',
59934
+ },
59935
+ type: 'array',
59936
+ },
59937
+ space: {
59938
+ description: 'Primary space alias for this vertical.',
59939
+ properties: {
59940
+ collection_key: {
59941
+ description: 'The key alias for a collection of resources.',
59942
+ type: 'string',
59943
+ },
59944
+ collection_label: {
59945
+ description: 'Human-readable label for a collection of resources.',
59946
+ type: 'string',
59947
+ },
59948
+ resource_key: {
59949
+ description: 'The key alias for a single resource.',
59950
+ type: 'string',
59951
+ },
59952
+ resource_label: {
59953
+ description: 'Human-readable label for a single resource.',
59954
+ type: 'string',
59955
+ },
59956
+ },
59957
+ required: [
59958
+ 'resource_key',
59959
+ 'resource_label',
59960
+ 'collection_key',
59961
+ 'collection_label',
59962
+ ],
59963
+ type: 'object',
59964
+ },
59965
+ user_identity: {
59966
+ description: 'Primary user identity alias for this vertical.',
59967
+ properties: {
59968
+ collection_key: {
59969
+ description: 'The key alias for a collection of resources.',
59970
+ type: 'string',
59971
+ },
59972
+ collection_label: {
59973
+ description: 'Human-readable label for a collection of resources.',
59974
+ type: 'string',
59975
+ },
59976
+ resource_key: {
59977
+ description: 'The key alias for a single resource.',
59978
+ type: 'string',
59979
+ },
59980
+ resource_label: {
59981
+ description: 'Human-readable label for a single resource.',
59982
+ type: 'string',
59983
+ },
59984
+ },
59985
+ required: [
59986
+ 'resource_key',
59987
+ 'resource_label',
59988
+ 'collection_key',
59989
+ 'collection_label',
59990
+ ],
59991
+ type: 'object',
59992
+ },
59993
+ },
59994
+ required: [
59995
+ 'space',
59996
+ 'additional_spaces',
59997
+ 'user_identity',
59998
+ 'access_grant',
59999
+ ],
60000
+ type: 'object',
60001
+ },
60002
+ },
60003
+ required: ['vertical_resource_aliases', 'ok'],
60004
+ type: 'object',
60005
+ },
60006
+ },
60007
+ },
60008
+ description: 'OK',
60009
+ },
60010
+ 400: { description: 'Bad Request' },
60011
+ 401: { description: 'Unauthorized' },
60012
+ },
60013
+ security: [
60014
+ { console_session_with_workspace: [] },
60015
+ { client_session_with_customer: [] },
60016
+ ],
60017
+ summary: '/seam/customer/v1/settings/vertical_resource_aliases/get',
60018
+ tags: [],
60019
+ 'x-fern-sdk-group-name': [
60020
+ 'seam',
60021
+ 'customer',
60022
+ 'v1',
60023
+ 'settings',
60024
+ 'vertical_resource_aliases',
60025
+ ],
60026
+ 'x-fern-sdk-method-name': 'get',
60027
+ 'x-fern-sdk-return-value': 'vertical_resource_aliases',
60028
+ 'x-response-key': 'vertical_resource_aliases',
60029
+ 'x-title': 'Get Vertical Resource Aliases',
60030
+ 'x-undocumented': 'Internal endpoint for customer portals.',
60031
+ },
60032
+ },
59575
60033
  '/seam/customer/v1/spaces/create': {
59576
60034
  post: {
59577
60035
  description: 'Creates a new space with optional parent space support.',