@seamapi/types 1.598.0 → 1.600.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/connect.cjs +243 -76
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +377 -107
- package/dist/index.cjs +243 -76
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/customer/customer-portal.d.ts +26 -92
- package/lib/seam/connect/models/customer/customer-portal.js +15 -16
- package/lib/seam/connect/models/customer/customer-portal.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +296 -83
- package/lib/seam/connect/openapi.js +243 -76
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +81 -24
- package/package.json +1 -1
- package/src/lib/seam/connect/models/customer/customer-portal.ts +19 -18
- package/src/lib/seam/connect/openapi.ts +249 -85
- package/src/lib/seam/connect/route-types.ts +85 -24
|
@@ -37089,8 +37089,11 @@ export default {
|
|
|
37089
37089
|
exclude: false,
|
|
37090
37090
|
},
|
|
37091
37091
|
connect: { exclude: false },
|
|
37092
|
+
manage: {
|
|
37093
|
+
exclude: false,
|
|
37094
|
+
exclude_reservation_management: false,
|
|
37095
|
+
},
|
|
37092
37096
|
manage_devices: { exclude: false },
|
|
37093
|
-
manage_reservations: { exclude: false },
|
|
37094
37097
|
organize: { exclude: false },
|
|
37095
37098
|
},
|
|
37096
37099
|
is_embedded: false,
|
|
@@ -37144,49 +37147,32 @@ export default {
|
|
|
37144
37147
|
},
|
|
37145
37148
|
type: 'object',
|
|
37146
37149
|
},
|
|
37147
|
-
|
|
37150
|
+
manage: {
|
|
37148
37151
|
default: {},
|
|
37149
|
-
description: 'Configuration for the manage
|
|
37152
|
+
description: 'Configuration for the manage feature.',
|
|
37150
37153
|
properties: {
|
|
37151
|
-
accepted_providers: {
|
|
37152
|
-
description: 'List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account.',
|
|
37153
|
-
items: { type: 'string' },
|
|
37154
|
-
type: 'array',
|
|
37155
|
-
},
|
|
37156
37154
|
exclude: {
|
|
37157
37155
|
default: false,
|
|
37158
37156
|
description: 'Whether to exclude this feature from the portal.',
|
|
37159
37157
|
type: 'boolean',
|
|
37160
37158
|
},
|
|
37161
|
-
|
|
37162
|
-
|
|
37163
|
-
|
|
37164
|
-
type: '
|
|
37159
|
+
exclude_reservation_management: {
|
|
37160
|
+
default: false,
|
|
37161
|
+
description: 'Indicates whether the customer can manage reservations for their properties.',
|
|
37162
|
+
type: 'boolean',
|
|
37165
37163
|
},
|
|
37166
37164
|
},
|
|
37167
37165
|
type: 'object',
|
|
37168
37166
|
},
|
|
37169
|
-
|
|
37167
|
+
manage_devices: {
|
|
37170
37168
|
default: {},
|
|
37171
|
-
description: 'Configuration for the manage
|
|
37169
|
+
description: 'Configuration for the manage devices feature.\n---\ndeprecated: Use `manage` instead.\n---',
|
|
37172
37170
|
properties: {
|
|
37173
37171
|
exclude: {
|
|
37174
37172
|
default: false,
|
|
37175
37173
|
description: 'Whether to exclude this feature from the portal.',
|
|
37176
37174
|
type: 'boolean',
|
|
37177
37175
|
},
|
|
37178
|
-
reservations: {
|
|
37179
|
-
default: { exclude: false },
|
|
37180
|
-
description: 'Configuration for the reservations feature.',
|
|
37181
|
-
properties: {
|
|
37182
|
-
exclude: {
|
|
37183
|
-
default: false,
|
|
37184
|
-
description: 'Indicates whether the customer can view reservations for their properties.',
|
|
37185
|
-
type: 'boolean',
|
|
37186
|
-
},
|
|
37187
|
-
},
|
|
37188
|
-
type: 'object',
|
|
37189
|
-
},
|
|
37190
37176
|
},
|
|
37191
37177
|
type: 'object',
|
|
37192
37178
|
},
|
|
@@ -47261,6 +47247,171 @@ export default {
|
|
|
47261
47247
|
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
47262
47248
|
},
|
|
47263
47249
|
},
|
|
47250
|
+
'/seam/customer/v1/connectors/create': {
|
|
47251
|
+
post: {
|
|
47252
|
+
description: 'Creates a new connector for a customer in a workspace. The connector will be activated and start syncing data from the external API.',
|
|
47253
|
+
operationId: 'seamCustomerV1ConnectorsCreatePost',
|
|
47254
|
+
requestBody: {
|
|
47255
|
+
content: {
|
|
47256
|
+
'application/json': {
|
|
47257
|
+
schema: {
|
|
47258
|
+
properties: {
|
|
47259
|
+
config: {
|
|
47260
|
+
description: 'Instance-specific configuration for the connector',
|
|
47261
|
+
oneOf: [
|
|
47262
|
+
{
|
|
47263
|
+
properties: {
|
|
47264
|
+
access_token: { minLength: 1, type: 'string' },
|
|
47265
|
+
client: { minLength: 1, type: 'string' },
|
|
47266
|
+
client_token: { minLength: 1, type: 'string' },
|
|
47267
|
+
enterprise_ids: {
|
|
47268
|
+
items: { format: 'uuid', type: 'string' },
|
|
47269
|
+
type: 'array',
|
|
47270
|
+
},
|
|
47271
|
+
},
|
|
47272
|
+
required: ['client_token', 'access_token', 'client'],
|
|
47273
|
+
type: 'object',
|
|
47274
|
+
},
|
|
47275
|
+
{ properties: {}, type: 'object' },
|
|
47276
|
+
],
|
|
47277
|
+
},
|
|
47278
|
+
connector_type: {
|
|
47279
|
+
description: 'Type of connector to create',
|
|
47280
|
+
enum: ['mews', 'mock'],
|
|
47281
|
+
type: 'string',
|
|
47282
|
+
},
|
|
47283
|
+
customer_key: {
|
|
47284
|
+
description: 'Key identifying the customer',
|
|
47285
|
+
minLength: 1,
|
|
47286
|
+
type: 'string',
|
|
47287
|
+
},
|
|
47288
|
+
},
|
|
47289
|
+
required: ['connector_type', 'customer_key', 'config'],
|
|
47290
|
+
type: 'object',
|
|
47291
|
+
},
|
|
47292
|
+
},
|
|
47293
|
+
},
|
|
47294
|
+
},
|
|
47295
|
+
responses: {
|
|
47296
|
+
200: {
|
|
47297
|
+
content: {
|
|
47298
|
+
'application/json': {
|
|
47299
|
+
schema: {
|
|
47300
|
+
properties: {
|
|
47301
|
+
connector: {
|
|
47302
|
+
properties: {
|
|
47303
|
+
connector_id: { type: 'string' },
|
|
47304
|
+
connector_type: { type: 'string' },
|
|
47305
|
+
error: { type: 'string' },
|
|
47306
|
+
status: {
|
|
47307
|
+
enum: ['active', 'inactive', 'error'],
|
|
47308
|
+
type: 'string',
|
|
47309
|
+
},
|
|
47310
|
+
webhook_subscription: {
|
|
47311
|
+
properties: {
|
|
47312
|
+
events: {
|
|
47313
|
+
items: { type: 'string' },
|
|
47314
|
+
type: 'array',
|
|
47315
|
+
},
|
|
47316
|
+
status: {
|
|
47317
|
+
enum: ['active', 'inactive', 'error'],
|
|
47318
|
+
type: 'string',
|
|
47319
|
+
},
|
|
47320
|
+
subscription_id: { type: 'string' },
|
|
47321
|
+
webhook_url: { type: 'string' },
|
|
47322
|
+
},
|
|
47323
|
+
required: [
|
|
47324
|
+
'subscription_id',
|
|
47325
|
+
'webhook_url',
|
|
47326
|
+
'events',
|
|
47327
|
+
'status',
|
|
47328
|
+
],
|
|
47329
|
+
type: 'object',
|
|
47330
|
+
},
|
|
47331
|
+
},
|
|
47332
|
+
required: ['connector_id', 'connector_type', 'status'],
|
|
47333
|
+
type: 'object',
|
|
47334
|
+
},
|
|
47335
|
+
ok: { type: 'boolean' },
|
|
47336
|
+
},
|
|
47337
|
+
required: ['connector', 'ok'],
|
|
47338
|
+
type: 'object',
|
|
47339
|
+
},
|
|
47340
|
+
},
|
|
47341
|
+
},
|
|
47342
|
+
description: 'OK',
|
|
47343
|
+
},
|
|
47344
|
+
400: { description: 'Bad Request' },
|
|
47345
|
+
401: { description: 'Unauthorized' },
|
|
47346
|
+
},
|
|
47347
|
+
security: [{ api_key: [] }],
|
|
47348
|
+
summary: '/seam/customer/v1/connectors/create',
|
|
47349
|
+
tags: [],
|
|
47350
|
+
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'connectors'],
|
|
47351
|
+
'x-fern-sdk-method-name': 'create',
|
|
47352
|
+
'x-fern-sdk-return-value': 'connector',
|
|
47353
|
+
'x-response-key': 'connector',
|
|
47354
|
+
'x-title': 'Create Connector',
|
|
47355
|
+
},
|
|
47356
|
+
},
|
|
47357
|
+
'/seam/customer/v1/connectors/sync': {
|
|
47358
|
+
post: {
|
|
47359
|
+
description: 'Triggers an immediate data sync for a connector by scheduling a polling task.',
|
|
47360
|
+
operationId: 'seamCustomerV1ConnectorsSyncPost',
|
|
47361
|
+
requestBody: {
|
|
47362
|
+
content: {
|
|
47363
|
+
'application/json': {
|
|
47364
|
+
schema: {
|
|
47365
|
+
properties: {
|
|
47366
|
+
connector_id: {
|
|
47367
|
+
description: 'ID of the connector to sync',
|
|
47368
|
+
format: 'uuid',
|
|
47369
|
+
type: 'string',
|
|
47370
|
+
},
|
|
47371
|
+
},
|
|
47372
|
+
required: ['connector_id'],
|
|
47373
|
+
type: 'object',
|
|
47374
|
+
},
|
|
47375
|
+
},
|
|
47376
|
+
},
|
|
47377
|
+
},
|
|
47378
|
+
responses: {
|
|
47379
|
+
200: {
|
|
47380
|
+
content: {
|
|
47381
|
+
'application/json': {
|
|
47382
|
+
schema: {
|
|
47383
|
+
properties: {
|
|
47384
|
+
connector_sync: {
|
|
47385
|
+
properties: {
|
|
47386
|
+
connector_id: { type: 'string' },
|
|
47387
|
+
message: { type: 'string' },
|
|
47388
|
+
status: { type: 'string' },
|
|
47389
|
+
},
|
|
47390
|
+
required: ['connector_id', 'status', 'message'],
|
|
47391
|
+
type: 'object',
|
|
47392
|
+
},
|
|
47393
|
+
ok: { type: 'boolean' },
|
|
47394
|
+
},
|
|
47395
|
+
required: ['connector_sync', 'ok'],
|
|
47396
|
+
type: 'object',
|
|
47397
|
+
},
|
|
47398
|
+
},
|
|
47399
|
+
},
|
|
47400
|
+
description: 'OK',
|
|
47401
|
+
},
|
|
47402
|
+
400: { description: 'Bad Request' },
|
|
47403
|
+
401: { description: 'Unauthorized' },
|
|
47404
|
+
},
|
|
47405
|
+
security: [{ api_key: [] }],
|
|
47406
|
+
summary: '/seam/customer/v1/connectors/sync',
|
|
47407
|
+
tags: [],
|
|
47408
|
+
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'connectors'],
|
|
47409
|
+
'x-fern-sdk-method-name': 'sync',
|
|
47410
|
+
'x-fern-sdk-return-value': 'connector_sync',
|
|
47411
|
+
'x-response-key': 'connector_sync',
|
|
47412
|
+
'x-title': 'Sync Connector Data',
|
|
47413
|
+
},
|
|
47414
|
+
},
|
|
47264
47415
|
'/seam/customer/v1/events/list': {
|
|
47265
47416
|
get: {
|
|
47266
47417
|
description: '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.',
|
|
@@ -47915,53 +48066,36 @@ export default {
|
|
|
47915
48066
|
},
|
|
47916
48067
|
type: 'object',
|
|
47917
48068
|
},
|
|
47918
|
-
|
|
48069
|
+
manage: {
|
|
47919
48070
|
default: {
|
|
47920
48071
|
$ref: '#/components/schemas/access_code',
|
|
47921
48072
|
},
|
|
47922
|
-
description: 'Configuration for the manage
|
|
48073
|
+
description: 'Configuration for the manage feature.',
|
|
47923
48074
|
properties: {
|
|
47924
|
-
accepted_providers: {
|
|
47925
|
-
description: 'List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account.',
|
|
47926
|
-
items: { type: 'string' },
|
|
47927
|
-
type: 'array',
|
|
47928
|
-
},
|
|
47929
48075
|
exclude: {
|
|
47930
48076
|
default: false,
|
|
47931
48077
|
description: 'Whether to exclude this feature from the portal.',
|
|
47932
48078
|
type: 'boolean',
|
|
47933
48079
|
},
|
|
47934
|
-
|
|
47935
|
-
|
|
47936
|
-
|
|
47937
|
-
type: '
|
|
48080
|
+
exclude_reservation_management: {
|
|
48081
|
+
default: false,
|
|
48082
|
+
description: 'Indicates whether the customer can manage reservations for their properties.',
|
|
48083
|
+
type: 'boolean',
|
|
47938
48084
|
},
|
|
47939
48085
|
},
|
|
47940
48086
|
type: 'object',
|
|
47941
48087
|
},
|
|
47942
|
-
|
|
48088
|
+
manage_devices: {
|
|
47943
48089
|
default: {
|
|
47944
48090
|
$ref: '#/components/schemas/access_code',
|
|
47945
48091
|
},
|
|
47946
|
-
description: 'Configuration for the manage
|
|
48092
|
+
description: 'Configuration for the manage devices feature.\n---\ndeprecated: Use `manage` instead.\n---',
|
|
47947
48093
|
properties: {
|
|
47948
48094
|
exclude: {
|
|
47949
48095
|
default: false,
|
|
47950
48096
|
description: 'Whether to exclude this feature from the portal.',
|
|
47951
48097
|
type: 'boolean',
|
|
47952
48098
|
},
|
|
47953
|
-
reservations: {
|
|
47954
|
-
default: { exclude: false },
|
|
47955
|
-
description: 'Configuration for the reservations feature.',
|
|
47956
|
-
properties: {
|
|
47957
|
-
exclude: {
|
|
47958
|
-
default: false,
|
|
47959
|
-
description: 'Indicates whether the customer can view reservations for their properties.',
|
|
47960
|
-
type: 'boolean',
|
|
47961
|
-
},
|
|
47962
|
-
},
|
|
47963
|
-
type: 'object',
|
|
47964
|
-
},
|
|
47965
48099
|
},
|
|
47966
48100
|
type: 'object',
|
|
47967
48101
|
},
|
|
@@ -48213,53 +48347,36 @@ export default {
|
|
|
48213
48347
|
},
|
|
48214
48348
|
type: 'object',
|
|
48215
48349
|
},
|
|
48216
|
-
|
|
48350
|
+
manage: {
|
|
48217
48351
|
default: {
|
|
48218
48352
|
$ref: '#/components/schemas/access_code',
|
|
48219
48353
|
},
|
|
48220
|
-
description: 'Configuration for the manage
|
|
48354
|
+
description: 'Configuration for the manage feature.',
|
|
48221
48355
|
properties: {
|
|
48222
|
-
accepted_providers: {
|
|
48223
|
-
description: 'List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account.',
|
|
48224
|
-
items: { type: 'string' },
|
|
48225
|
-
type: 'array',
|
|
48226
|
-
},
|
|
48227
48356
|
exclude: {
|
|
48228
48357
|
default: false,
|
|
48229
48358
|
description: 'Whether to exclude this feature from the portal.',
|
|
48230
48359
|
type: 'boolean',
|
|
48231
48360
|
},
|
|
48232
|
-
|
|
48233
|
-
|
|
48234
|
-
|
|
48235
|
-
type: '
|
|
48361
|
+
exclude_reservation_management: {
|
|
48362
|
+
default: false,
|
|
48363
|
+
description: 'Indicates whether the customer can manage reservations for their properties.',
|
|
48364
|
+
type: 'boolean',
|
|
48236
48365
|
},
|
|
48237
48366
|
},
|
|
48238
48367
|
type: 'object',
|
|
48239
48368
|
},
|
|
48240
|
-
|
|
48369
|
+
manage_devices: {
|
|
48241
48370
|
default: {
|
|
48242
48371
|
$ref: '#/components/schemas/access_code',
|
|
48243
48372
|
},
|
|
48244
|
-
description: 'Configuration for the manage
|
|
48373
|
+
description: 'Configuration for the manage devices feature.\n---\ndeprecated: Use `manage` instead.\n---',
|
|
48245
48374
|
properties: {
|
|
48246
48375
|
exclude: {
|
|
48247
48376
|
default: false,
|
|
48248
48377
|
description: 'Whether to exclude this feature from the portal.',
|
|
48249
48378
|
type: 'boolean',
|
|
48250
48379
|
},
|
|
48251
|
-
reservations: {
|
|
48252
|
-
default: { exclude: false },
|
|
48253
|
-
description: 'Configuration for the reservations feature.',
|
|
48254
|
-
properties: {
|
|
48255
|
-
exclude: {
|
|
48256
|
-
default: false,
|
|
48257
|
-
description: 'Indicates whether the customer can view reservations for their properties.',
|
|
48258
|
-
type: 'boolean',
|
|
48259
|
-
},
|
|
48260
|
-
},
|
|
48261
|
-
type: 'object',
|
|
48262
|
-
},
|
|
48263
48380
|
},
|
|
48264
48381
|
type: 'object',
|
|
48265
48382
|
},
|
|
@@ -49297,6 +49414,56 @@ export default {
|
|
|
49297
49414
|
'x-title': 'List Spaces',
|
|
49298
49415
|
},
|
|
49299
49416
|
},
|
|
49417
|
+
'/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]': {
|
|
49418
|
+
post: {
|
|
49419
|
+
description: 'Receives webhook events from external connector APIs and processes them into partner resources.',
|
|
49420
|
+
operationId: 'seamCustomerV1WebhooksConnectorsByWorkspaceIdByConnectorIdPost',
|
|
49421
|
+
requestBody: {
|
|
49422
|
+
content: {
|
|
49423
|
+
'application/json': { schema: { properties: {}, type: 'object' } },
|
|
49424
|
+
},
|
|
49425
|
+
},
|
|
49426
|
+
responses: {
|
|
49427
|
+
200: {
|
|
49428
|
+
content: {
|
|
49429
|
+
'application/json': {
|
|
49430
|
+
schema: {
|
|
49431
|
+
properties: {
|
|
49432
|
+
error: { type: 'string' },
|
|
49433
|
+
ok: { type: 'boolean' },
|
|
49434
|
+
processed_events: { format: 'float', type: 'number' },
|
|
49435
|
+
success: { type: 'boolean' },
|
|
49436
|
+
},
|
|
49437
|
+
required: ['success', 'processed_events', 'ok'],
|
|
49438
|
+
type: 'object',
|
|
49439
|
+
},
|
|
49440
|
+
},
|
|
49441
|
+
},
|
|
49442
|
+
description: 'OK',
|
|
49443
|
+
},
|
|
49444
|
+
400: { description: 'Bad Request' },
|
|
49445
|
+
401: { description: 'Unauthorized' },
|
|
49446
|
+
},
|
|
49447
|
+
security: [
|
|
49448
|
+
{ pat_with_workspace: [] },
|
|
49449
|
+
{ console_session_with_workspace: [] },
|
|
49450
|
+
{ api_key: [] },
|
|
49451
|
+
],
|
|
49452
|
+
summary: '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]',
|
|
49453
|
+
tags: ['/webhooks'],
|
|
49454
|
+
'x-fern-sdk-group-name': [
|
|
49455
|
+
'seam',
|
|
49456
|
+
'customer',
|
|
49457
|
+
'v1',
|
|
49458
|
+
'webhooks',
|
|
49459
|
+
'connectors',
|
|
49460
|
+
'[workspace_id]',
|
|
49461
|
+
],
|
|
49462
|
+
'x-fern-sdk-method-name': 'by_connector_id',
|
|
49463
|
+
'x-response-key': null,
|
|
49464
|
+
'x-title': 'Connector Webhook Endpoint',
|
|
49465
|
+
},
|
|
49466
|
+
},
|
|
49300
49467
|
'/seam/instant_key/v1/client_sessions/exchange_short_code': {
|
|
49301
49468
|
post: {
|
|
49302
49469
|
description: 'Exchanges a short code for a client session token. Mobile apps use this endpoint to retrieve a client session token securely using a short code obtained from an Instant Key URL.',
|