@seamapi/types 1.725.0 → 1.727.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.
@@ -33038,6 +33038,7 @@ export default {
33038
33038
  'acs_systems',
33039
33039
  'user_identities',
33040
33040
  'acs_access_groups',
33041
+ 'access_methods',
33041
33042
  ],
33042
33043
  type: 'string',
33043
33044
  },
@@ -33057,6 +33058,7 @@ export default {
33057
33058
  'acs_systems',
33058
33059
  'user_identities',
33059
33060
  'acs_access_groups',
33061
+ 'access_methods',
33060
33062
  ],
33061
33063
  type: 'string',
33062
33064
  },
@@ -33073,6 +33075,10 @@ export default {
33073
33075
  batch: {
33074
33076
  description: 'A batch of workspace resources.',
33075
33077
  properties: {
33078
+ access_methods: {
33079
+ items: { $ref: '#/components/schemas/access_method' },
33080
+ type: 'array',
33081
+ },
33076
33082
  acs_access_groups: {
33077
33083
  items: {
33078
33084
  $ref: '#/components/schemas/acs_access_group',
@@ -33136,6 +33142,7 @@ export default {
33136
33142
  'acs_systems',
33137
33143
  'user_identities',
33138
33144
  'acs_access_groups',
33145
+ 'access_methods',
33139
33146
  ],
33140
33147
  'x-draft': 'Early access.',
33141
33148
  'x-fern-sdk-group-name': ['access_grants'],
@@ -33175,6 +33182,7 @@ export default {
33175
33182
  'acs_systems',
33176
33183
  'user_identities',
33177
33184
  'acs_access_groups',
33185
+ 'access_methods',
33178
33186
  ],
33179
33187
  type: 'string',
33180
33188
  },
@@ -33190,6 +33198,7 @@ export default {
33190
33198
  'acs_systems',
33191
33199
  'user_identities',
33192
33200
  'acs_access_groups',
33201
+ 'access_methods',
33193
33202
  ],
33194
33203
  type: 'string',
33195
33204
  },
@@ -33210,6 +33219,10 @@ export default {
33210
33219
  batch: {
33211
33220
  description: 'A batch of workspace resources.',
33212
33221
  properties: {
33222
+ access_methods: {
33223
+ items: { $ref: '#/components/schemas/access_method' },
33224
+ type: 'array',
33225
+ },
33213
33226
  acs_access_groups: {
33214
33227
  items: {
33215
33228
  $ref: '#/components/schemas/acs_access_group',
@@ -33273,6 +33286,7 @@ export default {
33273
33286
  'acs_systems',
33274
33287
  'user_identities',
33275
33288
  'acs_access_groups',
33289
+ 'access_methods',
33276
33290
  ],
33277
33291
  'x-draft': 'Early access.',
33278
33292
  'x-fern-sdk-group-name': ['access_grants'],
@@ -63000,6 +63014,7 @@ export default {
63000
63014
  description:
63001
63015
  'Business vertical of the customer portal.',
63002
63016
  enum: [
63017
+ 'neutral',
63003
63018
  'short_term_rental',
63004
63019
  'hospitality',
63005
63020
  'multi_family',
@@ -63398,6 +63413,7 @@ export default {
63398
63413
  description:
63399
63414
  'Business vertical of the customer portal.',
63400
63415
  enum: [
63416
+ 'neutral',
63401
63417
  'short_term_rental',
63402
63418
  'hospitality',
63403
63419
  'multi_family',
@@ -64499,6 +64515,120 @@ export default {
64499
64515
  'x-undocumented': 'Internal endpoint for customer portals.',
64500
64516
  },
64501
64517
  },
64518
+ '/seam/customer/v1/settings/business_verticals/list': {
64519
+ get: {
64520
+ description: 'Returns all available business verticals.',
64521
+ operationId: 'seamCustomerV1SettingsBusinessVerticalsListGet',
64522
+ parameters: [],
64523
+ responses: {
64524
+ 200: {
64525
+ content: {
64526
+ 'application/json': {
64527
+ schema: {
64528
+ properties: {
64529
+ business_verticals: {
64530
+ items: {
64531
+ description:
64532
+ 'Business vertical of the customer portal.',
64533
+ enum: [
64534
+ 'neutral',
64535
+ 'short_term_rental',
64536
+ 'hospitality',
64537
+ 'multi_family',
64538
+ 'gym_management',
64539
+ 'property_tours',
64540
+ ],
64541
+ type: 'string',
64542
+ },
64543
+ type: 'array',
64544
+ },
64545
+ ok: { type: 'boolean' },
64546
+ },
64547
+ required: ['business_verticals', 'ok'],
64548
+ type: 'object',
64549
+ },
64550
+ },
64551
+ },
64552
+ description: 'OK',
64553
+ },
64554
+ 400: { description: 'Bad Request' },
64555
+ 401: { description: 'Unauthorized' },
64556
+ },
64557
+ security: [{ console_session_with_workspace: [] }],
64558
+ summary: '/seam/customer/v1/settings/business_verticals/list',
64559
+ tags: [],
64560
+ 'x-fern-sdk-group-name': [
64561
+ 'seam',
64562
+ 'customer',
64563
+ 'v1',
64564
+ 'settings',
64565
+ 'business_verticals',
64566
+ ],
64567
+ 'x-fern-sdk-method-name': 'list',
64568
+ 'x-fern-sdk-return-value': 'business_verticals',
64569
+ 'x-response-key': 'business_verticals',
64570
+ 'x-title': 'List Business Verticals',
64571
+ 'x-undocumented': 'Internal endpoint for customer portals.',
64572
+ },
64573
+ post: {
64574
+ description: 'Returns all available business verticals.',
64575
+ operationId: 'seamCustomerV1SettingsBusinessVerticalsListPost',
64576
+ requestBody: {
64577
+ content: {
64578
+ 'application/json': { schema: { properties: {}, type: 'object' } },
64579
+ },
64580
+ },
64581
+ responses: {
64582
+ 200: {
64583
+ content: {
64584
+ 'application/json': {
64585
+ schema: {
64586
+ properties: {
64587
+ business_verticals: {
64588
+ items: {
64589
+ description:
64590
+ 'Business vertical of the customer portal.',
64591
+ enum: [
64592
+ 'neutral',
64593
+ 'short_term_rental',
64594
+ 'hospitality',
64595
+ 'multi_family',
64596
+ 'gym_management',
64597
+ 'property_tours',
64598
+ ],
64599
+ type: 'string',
64600
+ },
64601
+ type: 'array',
64602
+ },
64603
+ ok: { type: 'boolean' },
64604
+ },
64605
+ required: ['business_verticals', 'ok'],
64606
+ type: 'object',
64607
+ },
64608
+ },
64609
+ },
64610
+ description: 'OK',
64611
+ },
64612
+ 400: { description: 'Bad Request' },
64613
+ 401: { description: 'Unauthorized' },
64614
+ },
64615
+ security: [{ console_session_with_workspace: [] }],
64616
+ summary: '/seam/customer/v1/settings/business_verticals/list',
64617
+ tags: [],
64618
+ 'x-fern-sdk-group-name': [
64619
+ 'seam',
64620
+ 'customer',
64621
+ 'v1',
64622
+ 'settings',
64623
+ 'business_verticals',
64624
+ ],
64625
+ 'x-fern-sdk-method-name': 'list',
64626
+ 'x-fern-sdk-return-value': 'business_verticals',
64627
+ 'x-response-key': 'business_verticals',
64628
+ 'x-title': 'List Business Verticals',
64629
+ 'x-undocumented': 'Internal endpoint for customer portals.',
64630
+ },
64631
+ },
64502
64632
  '/seam/customer/v1/settings/get': {
64503
64633
  get: {
64504
64634
  description: 'Retrieves the settings for a customer portal workspace.',
@@ -64512,6 +64642,7 @@ export default {
64512
64642
  business_vertical: {
64513
64643
  description: 'Business vertical of the customer portal.',
64514
64644
  enum: [
64645
+ 'neutral',
64515
64646
  'short_term_rental',
64516
64647
  'hospitality',
64517
64648
  'multi_family',
@@ -64555,6 +64686,7 @@ export default {
64555
64686
  business_vertical: {
64556
64687
  description: 'Business vertical of the customer portal.',
64557
64688
  enum: [
64689
+ 'neutral',
64558
64690
  'short_term_rental',
64559
64691
  'hospitality',
64560
64692
  'multi_family',
@@ -64599,6 +64731,7 @@ export default {
64599
64731
  business_vertical: {
64600
64732
  description: 'Business vertical to set on the workspace.',
64601
64733
  enum: [
64734
+ 'neutral',
64602
64735
  'short_term_rental',
64603
64736
  'hospitality',
64604
64737
  'multi_family',
@@ -64654,6 +64787,7 @@ export default {
64654
64787
  business_vertical: {
64655
64788
  description: 'Business vertical to set on the workspace.',
64656
64789
  enum: [
64790
+ 'neutral',
64657
64791
  'short_term_rental',
64658
64792
  'hospitality',
64659
64793
  'multi_family',
@@ -64699,6 +64833,386 @@ export default {
64699
64833
  'x-undocumented': 'Internal endpoint for customer portals.',
64700
64834
  },
64701
64835
  },
64836
+ '/seam/customer/v1/settings/vertical_resource_aliases/get': {
64837
+ get: {
64838
+ description:
64839
+ "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.",
64840
+ operationId: 'seamCustomerV1SettingsVerticalResourceAliasesGetGet',
64841
+ parameters: [],
64842
+ responses: {
64843
+ 200: {
64844
+ content: {
64845
+ 'application/json': {
64846
+ schema: {
64847
+ properties: {
64848
+ ok: { type: 'boolean' },
64849
+ vertical_resource_aliases: {
64850
+ properties: {
64851
+ access_grant: {
64852
+ description:
64853
+ 'Primary access grant alias for this vertical.',
64854
+ properties: {
64855
+ collection_key: {
64856
+ description:
64857
+ 'The key alias for a collection of resources.',
64858
+ type: 'string',
64859
+ },
64860
+ collection_label: {
64861
+ description:
64862
+ 'Human-readable label for a collection of resources.',
64863
+ type: 'string',
64864
+ },
64865
+ resource_key: {
64866
+ description:
64867
+ 'The key alias for a single resource.',
64868
+ type: 'string',
64869
+ },
64870
+ resource_label: {
64871
+ description:
64872
+ 'Human-readable label for a single resource.',
64873
+ type: 'string',
64874
+ },
64875
+ },
64876
+ required: [
64877
+ 'resource_key',
64878
+ 'resource_label',
64879
+ 'collection_key',
64880
+ 'collection_label',
64881
+ ],
64882
+ type: 'object',
64883
+ },
64884
+ additional_spaces: {
64885
+ description:
64886
+ 'Additional space aliases relevant to this vertical.',
64887
+ items: {
64888
+ properties: {
64889
+ collection_key: {
64890
+ description:
64891
+ 'The key alias for a collection of resources.',
64892
+ type: 'string',
64893
+ },
64894
+ collection_label: {
64895
+ description:
64896
+ 'Human-readable label for a collection of resources.',
64897
+ type: 'string',
64898
+ },
64899
+ resource_key: {
64900
+ description:
64901
+ 'The key alias for a single resource.',
64902
+ type: 'string',
64903
+ },
64904
+ resource_label: {
64905
+ description:
64906
+ 'Human-readable label for a single resource.',
64907
+ type: 'string',
64908
+ },
64909
+ },
64910
+ required: [
64911
+ 'resource_key',
64912
+ 'resource_label',
64913
+ 'collection_key',
64914
+ 'collection_label',
64915
+ ],
64916
+ type: 'object',
64917
+ },
64918
+ type: 'array',
64919
+ },
64920
+ space: {
64921
+ description: 'Primary space alias for this vertical.',
64922
+ properties: {
64923
+ collection_key: {
64924
+ description:
64925
+ 'The key alias for a collection of resources.',
64926
+ type: 'string',
64927
+ },
64928
+ collection_label: {
64929
+ description:
64930
+ 'Human-readable label for a collection of resources.',
64931
+ type: 'string',
64932
+ },
64933
+ resource_key: {
64934
+ description:
64935
+ 'The key alias for a single resource.',
64936
+ type: 'string',
64937
+ },
64938
+ resource_label: {
64939
+ description:
64940
+ 'Human-readable label for a single resource.',
64941
+ type: 'string',
64942
+ },
64943
+ },
64944
+ required: [
64945
+ 'resource_key',
64946
+ 'resource_label',
64947
+ 'collection_key',
64948
+ 'collection_label',
64949
+ ],
64950
+ type: 'object',
64951
+ },
64952
+ user_identity: {
64953
+ description:
64954
+ 'Primary user identity alias for this vertical.',
64955
+ properties: {
64956
+ collection_key: {
64957
+ description:
64958
+ 'The key alias for a collection of resources.',
64959
+ type: 'string',
64960
+ },
64961
+ collection_label: {
64962
+ description:
64963
+ 'Human-readable label for a collection of resources.',
64964
+ type: 'string',
64965
+ },
64966
+ resource_key: {
64967
+ description:
64968
+ 'The key alias for a single resource.',
64969
+ type: 'string',
64970
+ },
64971
+ resource_label: {
64972
+ description:
64973
+ 'Human-readable label for a single resource.',
64974
+ type: 'string',
64975
+ },
64976
+ },
64977
+ required: [
64978
+ 'resource_key',
64979
+ 'resource_label',
64980
+ 'collection_key',
64981
+ 'collection_label',
64982
+ ],
64983
+ type: 'object',
64984
+ },
64985
+ },
64986
+ required: [
64987
+ 'space',
64988
+ 'additional_spaces',
64989
+ 'user_identity',
64990
+ 'access_grant',
64991
+ ],
64992
+ type: 'object',
64993
+ },
64994
+ },
64995
+ required: ['vertical_resource_aliases', 'ok'],
64996
+ type: 'object',
64997
+ },
64998
+ },
64999
+ },
65000
+ description: 'OK',
65001
+ },
65002
+ 400: { description: 'Bad Request' },
65003
+ 401: { description: 'Unauthorized' },
65004
+ },
65005
+ security: [
65006
+ { console_session_with_workspace: [] },
65007
+ { client_session_with_customer: [] },
65008
+ ],
65009
+ summary: '/seam/customer/v1/settings/vertical_resource_aliases/get',
65010
+ tags: [],
65011
+ 'x-fern-sdk-group-name': [
65012
+ 'seam',
65013
+ 'customer',
65014
+ 'v1',
65015
+ 'settings',
65016
+ 'vertical_resource_aliases',
65017
+ ],
65018
+ 'x-fern-sdk-method-name': 'get',
65019
+ 'x-fern-sdk-return-value': 'vertical_resource_aliases',
65020
+ 'x-response-key': 'vertical_resource_aliases',
65021
+ 'x-title': 'Get Vertical Resource Aliases',
65022
+ 'x-undocumented': 'Internal endpoint for customer portals.',
65023
+ },
65024
+ post: {
65025
+ description:
65026
+ "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.",
65027
+ operationId: 'seamCustomerV1SettingsVerticalResourceAliasesGetPost',
65028
+ requestBody: {
65029
+ content: {
65030
+ 'application/json': { schema: { properties: {}, type: 'object' } },
65031
+ },
65032
+ },
65033
+ responses: {
65034
+ 200: {
65035
+ content: {
65036
+ 'application/json': {
65037
+ schema: {
65038
+ properties: {
65039
+ ok: { type: 'boolean' },
65040
+ vertical_resource_aliases: {
65041
+ properties: {
65042
+ access_grant: {
65043
+ description:
65044
+ 'Primary access grant alias for this vertical.',
65045
+ properties: {
65046
+ collection_key: {
65047
+ description:
65048
+ 'The key alias for a collection of resources.',
65049
+ type: 'string',
65050
+ },
65051
+ collection_label: {
65052
+ description:
65053
+ 'Human-readable label for a collection of resources.',
65054
+ type: 'string',
65055
+ },
65056
+ resource_key: {
65057
+ description:
65058
+ 'The key alias for a single resource.',
65059
+ type: 'string',
65060
+ },
65061
+ resource_label: {
65062
+ description:
65063
+ 'Human-readable label for a single resource.',
65064
+ type: 'string',
65065
+ },
65066
+ },
65067
+ required: [
65068
+ 'resource_key',
65069
+ 'resource_label',
65070
+ 'collection_key',
65071
+ 'collection_label',
65072
+ ],
65073
+ type: 'object',
65074
+ },
65075
+ additional_spaces: {
65076
+ description:
65077
+ 'Additional space aliases relevant to this vertical.',
65078
+ items: {
65079
+ properties: {
65080
+ collection_key: {
65081
+ description:
65082
+ 'The key alias for a collection of resources.',
65083
+ type: 'string',
65084
+ },
65085
+ collection_label: {
65086
+ description:
65087
+ 'Human-readable label for a collection of resources.',
65088
+ type: 'string',
65089
+ },
65090
+ resource_key: {
65091
+ description:
65092
+ 'The key alias for a single resource.',
65093
+ type: 'string',
65094
+ },
65095
+ resource_label: {
65096
+ description:
65097
+ 'Human-readable label for a single resource.',
65098
+ type: 'string',
65099
+ },
65100
+ },
65101
+ required: [
65102
+ 'resource_key',
65103
+ 'resource_label',
65104
+ 'collection_key',
65105
+ 'collection_label',
65106
+ ],
65107
+ type: 'object',
65108
+ },
65109
+ type: 'array',
65110
+ },
65111
+ space: {
65112
+ description: 'Primary space alias for this vertical.',
65113
+ properties: {
65114
+ collection_key: {
65115
+ description:
65116
+ 'The key alias for a collection of resources.',
65117
+ type: 'string',
65118
+ },
65119
+ collection_label: {
65120
+ description:
65121
+ 'Human-readable label for a collection of resources.',
65122
+ type: 'string',
65123
+ },
65124
+ resource_key: {
65125
+ description:
65126
+ 'The key alias for a single resource.',
65127
+ type: 'string',
65128
+ },
65129
+ resource_label: {
65130
+ description:
65131
+ 'Human-readable label for a single resource.',
65132
+ type: 'string',
65133
+ },
65134
+ },
65135
+ required: [
65136
+ 'resource_key',
65137
+ 'resource_label',
65138
+ 'collection_key',
65139
+ 'collection_label',
65140
+ ],
65141
+ type: 'object',
65142
+ },
65143
+ user_identity: {
65144
+ description:
65145
+ 'Primary user identity alias for this vertical.',
65146
+ properties: {
65147
+ collection_key: {
65148
+ description:
65149
+ 'The key alias for a collection of resources.',
65150
+ type: 'string',
65151
+ },
65152
+ collection_label: {
65153
+ description:
65154
+ 'Human-readable label for a collection of resources.',
65155
+ type: 'string',
65156
+ },
65157
+ resource_key: {
65158
+ description:
65159
+ 'The key alias for a single resource.',
65160
+ type: 'string',
65161
+ },
65162
+ resource_label: {
65163
+ description:
65164
+ 'Human-readable label for a single resource.',
65165
+ type: 'string',
65166
+ },
65167
+ },
65168
+ required: [
65169
+ 'resource_key',
65170
+ 'resource_label',
65171
+ 'collection_key',
65172
+ 'collection_label',
65173
+ ],
65174
+ type: 'object',
65175
+ },
65176
+ },
65177
+ required: [
65178
+ 'space',
65179
+ 'additional_spaces',
65180
+ 'user_identity',
65181
+ 'access_grant',
65182
+ ],
65183
+ type: 'object',
65184
+ },
65185
+ },
65186
+ required: ['vertical_resource_aliases', 'ok'],
65187
+ type: 'object',
65188
+ },
65189
+ },
65190
+ },
65191
+ description: 'OK',
65192
+ },
65193
+ 400: { description: 'Bad Request' },
65194
+ 401: { description: 'Unauthorized' },
65195
+ },
65196
+ security: [
65197
+ { console_session_with_workspace: [] },
65198
+ { client_session_with_customer: [] },
65199
+ ],
65200
+ summary: '/seam/customer/v1/settings/vertical_resource_aliases/get',
65201
+ tags: [],
65202
+ 'x-fern-sdk-group-name': [
65203
+ 'seam',
65204
+ 'customer',
65205
+ 'v1',
65206
+ 'settings',
65207
+ 'vertical_resource_aliases',
65208
+ ],
65209
+ 'x-fern-sdk-method-name': 'get',
65210
+ 'x-fern-sdk-return-value': 'vertical_resource_aliases',
65211
+ 'x-response-key': 'vertical_resource_aliases',
65212
+ 'x-title': 'Get Vertical Resource Aliases',
65213
+ 'x-undocumented': 'Internal endpoint for customer portals.',
65214
+ },
65215
+ },
64702
65216
  '/seam/customer/v1/spaces/create': {
64703
65217
  post: {
64704
65218
  description: 'Creates a new space with optional parent space support.',