@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.
package/dist/index.cjs CHANGED
@@ -64306,6 +64306,7 @@ var openapi_default = {
64306
64306
  business_vertical: {
64307
64307
  description: "Business vertical of the customer portal.",
64308
64308
  enum: [
64309
+ "neutral",
64309
64310
  "short_term_rental",
64310
64311
  "hospitality",
64311
64312
  "multi_family",
@@ -64673,6 +64674,7 @@ var openapi_default = {
64673
64674
  business_vertical: {
64674
64675
  description: "Business vertical of the customer portal.",
64675
64676
  enum: [
64677
+ "neutral",
64676
64678
  "short_term_rental",
64677
64679
  "hospitality",
64678
64680
  "multi_family",
@@ -65734,6 +65736,118 @@ var openapi_default = {
65734
65736
  "x-undocumented": "Internal endpoint for customer portals."
65735
65737
  }
65736
65738
  },
65739
+ "/seam/customer/v1/settings/business_verticals/list": {
65740
+ get: {
65741
+ description: "Returns all available business verticals.",
65742
+ operationId: "seamCustomerV1SettingsBusinessVerticalsListGet",
65743
+ parameters: [],
65744
+ responses: {
65745
+ 200: {
65746
+ content: {
65747
+ "application/json": {
65748
+ schema: {
65749
+ properties: {
65750
+ business_verticals: {
65751
+ items: {
65752
+ description: "Business vertical of the customer portal.",
65753
+ enum: [
65754
+ "neutral",
65755
+ "short_term_rental",
65756
+ "hospitality",
65757
+ "multi_family",
65758
+ "gym_management",
65759
+ "property_tours"
65760
+ ],
65761
+ type: "string"
65762
+ },
65763
+ type: "array"
65764
+ },
65765
+ ok: { type: "boolean" }
65766
+ },
65767
+ required: ["business_verticals", "ok"],
65768
+ type: "object"
65769
+ }
65770
+ }
65771
+ },
65772
+ description: "OK"
65773
+ },
65774
+ 400: { description: "Bad Request" },
65775
+ 401: { description: "Unauthorized" }
65776
+ },
65777
+ security: [{ console_session_with_workspace: [] }],
65778
+ summary: "/seam/customer/v1/settings/business_verticals/list",
65779
+ tags: [],
65780
+ "x-fern-sdk-group-name": [
65781
+ "seam",
65782
+ "customer",
65783
+ "v1",
65784
+ "settings",
65785
+ "business_verticals"
65786
+ ],
65787
+ "x-fern-sdk-method-name": "list",
65788
+ "x-fern-sdk-return-value": "business_verticals",
65789
+ "x-response-key": "business_verticals",
65790
+ "x-title": "List Business Verticals",
65791
+ "x-undocumented": "Internal endpoint for customer portals."
65792
+ },
65793
+ post: {
65794
+ description: "Returns all available business verticals.",
65795
+ operationId: "seamCustomerV1SettingsBusinessVerticalsListPost",
65796
+ requestBody: {
65797
+ content: {
65798
+ "application/json": { schema: { properties: {}, type: "object" } }
65799
+ }
65800
+ },
65801
+ responses: {
65802
+ 200: {
65803
+ content: {
65804
+ "application/json": {
65805
+ schema: {
65806
+ properties: {
65807
+ business_verticals: {
65808
+ items: {
65809
+ description: "Business vertical of the customer portal.",
65810
+ enum: [
65811
+ "neutral",
65812
+ "short_term_rental",
65813
+ "hospitality",
65814
+ "multi_family",
65815
+ "gym_management",
65816
+ "property_tours"
65817
+ ],
65818
+ type: "string"
65819
+ },
65820
+ type: "array"
65821
+ },
65822
+ ok: { type: "boolean" }
65823
+ },
65824
+ required: ["business_verticals", "ok"],
65825
+ type: "object"
65826
+ }
65827
+ }
65828
+ },
65829
+ description: "OK"
65830
+ },
65831
+ 400: { description: "Bad Request" },
65832
+ 401: { description: "Unauthorized" }
65833
+ },
65834
+ security: [{ console_session_with_workspace: [] }],
65835
+ summary: "/seam/customer/v1/settings/business_verticals/list",
65836
+ tags: [],
65837
+ "x-fern-sdk-group-name": [
65838
+ "seam",
65839
+ "customer",
65840
+ "v1",
65841
+ "settings",
65842
+ "business_verticals"
65843
+ ],
65844
+ "x-fern-sdk-method-name": "list",
65845
+ "x-fern-sdk-return-value": "business_verticals",
65846
+ "x-response-key": "business_verticals",
65847
+ "x-title": "List Business Verticals",
65848
+ "x-undocumented": "Internal endpoint for customer portals."
65849
+ }
65850
+ },
65737
65851
  "/seam/customer/v1/settings/get": {
65738
65852
  get: {
65739
65853
  description: "Retrieves the settings for a customer portal workspace.",
@@ -65747,6 +65861,7 @@ var openapi_default = {
65747
65861
  business_vertical: {
65748
65862
  description: "Business vertical of the customer portal.",
65749
65863
  enum: [
65864
+ "neutral",
65750
65865
  "short_term_rental",
65751
65866
  "hospitality",
65752
65867
  "multi_family",
@@ -65790,6 +65905,7 @@ var openapi_default = {
65790
65905
  business_vertical: {
65791
65906
  description: "Business vertical of the customer portal.",
65792
65907
  enum: [
65908
+ "neutral",
65793
65909
  "short_term_rental",
65794
65910
  "hospitality",
65795
65911
  "multi_family",
@@ -65834,6 +65950,7 @@ var openapi_default = {
65834
65950
  business_vertical: {
65835
65951
  description: "Business vertical to set on the workspace.",
65836
65952
  enum: [
65953
+ "neutral",
65837
65954
  "short_term_rental",
65838
65955
  "hospitality",
65839
65956
  "multi_family",
@@ -65889,6 +66006,7 @@ var openapi_default = {
65889
66006
  business_vertical: {
65890
66007
  description: "Business vertical to set on the workspace.",
65891
66008
  enum: [
66009
+ "neutral",
65892
66010
  "short_term_rental",
65893
66011
  "hospitality",
65894
66012
  "multi_family",
@@ -65934,6 +66052,346 @@ var openapi_default = {
65934
66052
  "x-undocumented": "Internal endpoint for customer portals."
65935
66053
  }
65936
66054
  },
66055
+ "/seam/customer/v1/settings/vertical_resource_aliases/get": {
66056
+ get: {
66057
+ 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.",
66058
+ operationId: "seamCustomerV1SettingsVerticalResourceAliasesGetGet",
66059
+ parameters: [],
66060
+ responses: {
66061
+ 200: {
66062
+ content: {
66063
+ "application/json": {
66064
+ schema: {
66065
+ properties: {
66066
+ ok: { type: "boolean" },
66067
+ vertical_resource_aliases: {
66068
+ properties: {
66069
+ access_grant: {
66070
+ description: "Primary access grant alias for this vertical.",
66071
+ properties: {
66072
+ collection_key: {
66073
+ description: "The key alias for a collection of resources.",
66074
+ type: "string"
66075
+ },
66076
+ collection_label: {
66077
+ description: "Human-readable label for a collection of resources.",
66078
+ type: "string"
66079
+ },
66080
+ resource_key: {
66081
+ description: "The key alias for a single resource.",
66082
+ type: "string"
66083
+ },
66084
+ resource_label: {
66085
+ description: "Human-readable label for a single resource.",
66086
+ type: "string"
66087
+ }
66088
+ },
66089
+ required: [
66090
+ "resource_key",
66091
+ "resource_label",
66092
+ "collection_key",
66093
+ "collection_label"
66094
+ ],
66095
+ type: "object"
66096
+ },
66097
+ additional_spaces: {
66098
+ description: "Additional space aliases relevant to this vertical.",
66099
+ items: {
66100
+ properties: {
66101
+ collection_key: {
66102
+ description: "The key alias for a collection of resources.",
66103
+ type: "string"
66104
+ },
66105
+ collection_label: {
66106
+ description: "Human-readable label for a collection of resources.",
66107
+ type: "string"
66108
+ },
66109
+ resource_key: {
66110
+ description: "The key alias for a single resource.",
66111
+ type: "string"
66112
+ },
66113
+ resource_label: {
66114
+ description: "Human-readable label for a single resource.",
66115
+ type: "string"
66116
+ }
66117
+ },
66118
+ required: [
66119
+ "resource_key",
66120
+ "resource_label",
66121
+ "collection_key",
66122
+ "collection_label"
66123
+ ],
66124
+ type: "object"
66125
+ },
66126
+ type: "array"
66127
+ },
66128
+ space: {
66129
+ description: "Primary space alias for this vertical.",
66130
+ properties: {
66131
+ collection_key: {
66132
+ description: "The key alias for a collection of resources.",
66133
+ type: "string"
66134
+ },
66135
+ collection_label: {
66136
+ description: "Human-readable label for a collection of resources.",
66137
+ type: "string"
66138
+ },
66139
+ resource_key: {
66140
+ description: "The key alias for a single resource.",
66141
+ type: "string"
66142
+ },
66143
+ resource_label: {
66144
+ description: "Human-readable label for a single resource.",
66145
+ type: "string"
66146
+ }
66147
+ },
66148
+ required: [
66149
+ "resource_key",
66150
+ "resource_label",
66151
+ "collection_key",
66152
+ "collection_label"
66153
+ ],
66154
+ type: "object"
66155
+ },
66156
+ user_identity: {
66157
+ description: "Primary user identity alias for this vertical.",
66158
+ properties: {
66159
+ collection_key: {
66160
+ description: "The key alias for a collection of resources.",
66161
+ type: "string"
66162
+ },
66163
+ collection_label: {
66164
+ description: "Human-readable label for a collection of resources.",
66165
+ type: "string"
66166
+ },
66167
+ resource_key: {
66168
+ description: "The key alias for a single resource.",
66169
+ type: "string"
66170
+ },
66171
+ resource_label: {
66172
+ description: "Human-readable label for a single resource.",
66173
+ type: "string"
66174
+ }
66175
+ },
66176
+ required: [
66177
+ "resource_key",
66178
+ "resource_label",
66179
+ "collection_key",
66180
+ "collection_label"
66181
+ ],
66182
+ type: "object"
66183
+ }
66184
+ },
66185
+ required: [
66186
+ "space",
66187
+ "additional_spaces",
66188
+ "user_identity",
66189
+ "access_grant"
66190
+ ],
66191
+ type: "object"
66192
+ }
66193
+ },
66194
+ required: ["vertical_resource_aliases", "ok"],
66195
+ type: "object"
66196
+ }
66197
+ }
66198
+ },
66199
+ description: "OK"
66200
+ },
66201
+ 400: { description: "Bad Request" },
66202
+ 401: { description: "Unauthorized" }
66203
+ },
66204
+ security: [
66205
+ { console_session_with_workspace: [] },
66206
+ { client_session_with_customer: [] }
66207
+ ],
66208
+ summary: "/seam/customer/v1/settings/vertical_resource_aliases/get",
66209
+ tags: [],
66210
+ "x-fern-sdk-group-name": [
66211
+ "seam",
66212
+ "customer",
66213
+ "v1",
66214
+ "settings",
66215
+ "vertical_resource_aliases"
66216
+ ],
66217
+ "x-fern-sdk-method-name": "get",
66218
+ "x-fern-sdk-return-value": "vertical_resource_aliases",
66219
+ "x-response-key": "vertical_resource_aliases",
66220
+ "x-title": "Get Vertical Resource Aliases",
66221
+ "x-undocumented": "Internal endpoint for customer portals."
66222
+ },
66223
+ post: {
66224
+ 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.",
66225
+ operationId: "seamCustomerV1SettingsVerticalResourceAliasesGetPost",
66226
+ requestBody: {
66227
+ content: {
66228
+ "application/json": { schema: { properties: {}, type: "object" } }
66229
+ }
66230
+ },
66231
+ responses: {
66232
+ 200: {
66233
+ content: {
66234
+ "application/json": {
66235
+ schema: {
66236
+ properties: {
66237
+ ok: { type: "boolean" },
66238
+ vertical_resource_aliases: {
66239
+ properties: {
66240
+ access_grant: {
66241
+ description: "Primary access grant alias for this vertical.",
66242
+ properties: {
66243
+ collection_key: {
66244
+ description: "The key alias for a collection of resources.",
66245
+ type: "string"
66246
+ },
66247
+ collection_label: {
66248
+ description: "Human-readable label for a collection of resources.",
66249
+ type: "string"
66250
+ },
66251
+ resource_key: {
66252
+ description: "The key alias for a single resource.",
66253
+ type: "string"
66254
+ },
66255
+ resource_label: {
66256
+ description: "Human-readable label for a single resource.",
66257
+ type: "string"
66258
+ }
66259
+ },
66260
+ required: [
66261
+ "resource_key",
66262
+ "resource_label",
66263
+ "collection_key",
66264
+ "collection_label"
66265
+ ],
66266
+ type: "object"
66267
+ },
66268
+ additional_spaces: {
66269
+ description: "Additional space aliases relevant to this vertical.",
66270
+ items: {
66271
+ properties: {
66272
+ collection_key: {
66273
+ description: "The key alias for a collection of resources.",
66274
+ type: "string"
66275
+ },
66276
+ collection_label: {
66277
+ description: "Human-readable label for a collection of resources.",
66278
+ type: "string"
66279
+ },
66280
+ resource_key: {
66281
+ description: "The key alias for a single resource.",
66282
+ type: "string"
66283
+ },
66284
+ resource_label: {
66285
+ description: "Human-readable label for a single resource.",
66286
+ type: "string"
66287
+ }
66288
+ },
66289
+ required: [
66290
+ "resource_key",
66291
+ "resource_label",
66292
+ "collection_key",
66293
+ "collection_label"
66294
+ ],
66295
+ type: "object"
66296
+ },
66297
+ type: "array"
66298
+ },
66299
+ space: {
66300
+ description: "Primary space alias for this vertical.",
66301
+ properties: {
66302
+ collection_key: {
66303
+ description: "The key alias for a collection of resources.",
66304
+ type: "string"
66305
+ },
66306
+ collection_label: {
66307
+ description: "Human-readable label for a collection of resources.",
66308
+ type: "string"
66309
+ },
66310
+ resource_key: {
66311
+ description: "The key alias for a single resource.",
66312
+ type: "string"
66313
+ },
66314
+ resource_label: {
66315
+ description: "Human-readable label for a single resource.",
66316
+ type: "string"
66317
+ }
66318
+ },
66319
+ required: [
66320
+ "resource_key",
66321
+ "resource_label",
66322
+ "collection_key",
66323
+ "collection_label"
66324
+ ],
66325
+ type: "object"
66326
+ },
66327
+ user_identity: {
66328
+ description: "Primary user identity alias for this vertical.",
66329
+ properties: {
66330
+ collection_key: {
66331
+ description: "The key alias for a collection of resources.",
66332
+ type: "string"
66333
+ },
66334
+ collection_label: {
66335
+ description: "Human-readable label for a collection of resources.",
66336
+ type: "string"
66337
+ },
66338
+ resource_key: {
66339
+ description: "The key alias for a single resource.",
66340
+ type: "string"
66341
+ },
66342
+ resource_label: {
66343
+ description: "Human-readable label for a single resource.",
66344
+ type: "string"
66345
+ }
66346
+ },
66347
+ required: [
66348
+ "resource_key",
66349
+ "resource_label",
66350
+ "collection_key",
66351
+ "collection_label"
66352
+ ],
66353
+ type: "object"
66354
+ }
66355
+ },
66356
+ required: [
66357
+ "space",
66358
+ "additional_spaces",
66359
+ "user_identity",
66360
+ "access_grant"
66361
+ ],
66362
+ type: "object"
66363
+ }
66364
+ },
66365
+ required: ["vertical_resource_aliases", "ok"],
66366
+ type: "object"
66367
+ }
66368
+ }
66369
+ },
66370
+ description: "OK"
66371
+ },
66372
+ 400: { description: "Bad Request" },
66373
+ 401: { description: "Unauthorized" }
66374
+ },
66375
+ security: [
66376
+ { console_session_with_workspace: [] },
66377
+ { client_session_with_customer: [] }
66378
+ ],
66379
+ summary: "/seam/customer/v1/settings/vertical_resource_aliases/get",
66380
+ tags: [],
66381
+ "x-fern-sdk-group-name": [
66382
+ "seam",
66383
+ "customer",
66384
+ "v1",
66385
+ "settings",
66386
+ "vertical_resource_aliases"
66387
+ ],
66388
+ "x-fern-sdk-method-name": "get",
66389
+ "x-fern-sdk-return-value": "vertical_resource_aliases",
66390
+ "x-response-key": "vertical_resource_aliases",
66391
+ "x-title": "Get Vertical Resource Aliases",
66392
+ "x-undocumented": "Internal endpoint for customer portals."
66393
+ }
66394
+ },
65937
66395
  "/seam/customer/v1/spaces/create": {
65938
66396
  post: {
65939
66397
  description: "Creates a new space with optional parent space support.",