@seamapi/types 1.599.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 +215 -0
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +346 -0
- package/dist/index.cjs +215 -0
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/openapi.d.ts +281 -0
- package/lib/seam/connect/openapi.js +215 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +65 -0
- package/package.json +1 -1
- package/src/lib/seam/connect/openapi.ts +221 -0
- package/src/lib/seam/connect/route-types.ts +69 -0
|
@@ -42101,6 +42101,218 @@ declare const _default: {
|
|
|
42101
42101
|
'x-undocumented': string;
|
|
42102
42102
|
};
|
|
42103
42103
|
};
|
|
42104
|
+
'/seam/customer/v1/connectors/create': {
|
|
42105
|
+
post: {
|
|
42106
|
+
description: string;
|
|
42107
|
+
operationId: string;
|
|
42108
|
+
requestBody: {
|
|
42109
|
+
content: {
|
|
42110
|
+
'application/json': {
|
|
42111
|
+
schema: {
|
|
42112
|
+
properties: {
|
|
42113
|
+
config: {
|
|
42114
|
+
description: string;
|
|
42115
|
+
oneOf: ({
|
|
42116
|
+
properties: {
|
|
42117
|
+
access_token: {
|
|
42118
|
+
minLength: number;
|
|
42119
|
+
type: string;
|
|
42120
|
+
};
|
|
42121
|
+
client: {
|
|
42122
|
+
minLength: number;
|
|
42123
|
+
type: string;
|
|
42124
|
+
};
|
|
42125
|
+
client_token: {
|
|
42126
|
+
minLength: number;
|
|
42127
|
+
type: string;
|
|
42128
|
+
};
|
|
42129
|
+
enterprise_ids: {
|
|
42130
|
+
items: {
|
|
42131
|
+
format: string;
|
|
42132
|
+
type: string;
|
|
42133
|
+
};
|
|
42134
|
+
type: string;
|
|
42135
|
+
};
|
|
42136
|
+
};
|
|
42137
|
+
required: string[];
|
|
42138
|
+
type: string;
|
|
42139
|
+
} | {
|
|
42140
|
+
properties: {
|
|
42141
|
+
access_token?: never;
|
|
42142
|
+
client?: never;
|
|
42143
|
+
client_token?: never;
|
|
42144
|
+
enterprise_ids?: never;
|
|
42145
|
+
};
|
|
42146
|
+
type: string;
|
|
42147
|
+
required?: never;
|
|
42148
|
+
})[];
|
|
42149
|
+
};
|
|
42150
|
+
connector_type: {
|
|
42151
|
+
description: string;
|
|
42152
|
+
enum: string[];
|
|
42153
|
+
type: string;
|
|
42154
|
+
};
|
|
42155
|
+
customer_key: {
|
|
42156
|
+
description: string;
|
|
42157
|
+
minLength: number;
|
|
42158
|
+
type: string;
|
|
42159
|
+
};
|
|
42160
|
+
};
|
|
42161
|
+
required: string[];
|
|
42162
|
+
type: string;
|
|
42163
|
+
};
|
|
42164
|
+
};
|
|
42165
|
+
};
|
|
42166
|
+
};
|
|
42167
|
+
responses: {
|
|
42168
|
+
200: {
|
|
42169
|
+
content: {
|
|
42170
|
+
'application/json': {
|
|
42171
|
+
schema: {
|
|
42172
|
+
properties: {
|
|
42173
|
+
connector: {
|
|
42174
|
+
properties: {
|
|
42175
|
+
connector_id: {
|
|
42176
|
+
type: string;
|
|
42177
|
+
};
|
|
42178
|
+
connector_type: {
|
|
42179
|
+
type: string;
|
|
42180
|
+
};
|
|
42181
|
+
error: {
|
|
42182
|
+
type: string;
|
|
42183
|
+
};
|
|
42184
|
+
status: {
|
|
42185
|
+
enum: string[];
|
|
42186
|
+
type: string;
|
|
42187
|
+
};
|
|
42188
|
+
webhook_subscription: {
|
|
42189
|
+
properties: {
|
|
42190
|
+
events: {
|
|
42191
|
+
items: {
|
|
42192
|
+
type: string;
|
|
42193
|
+
};
|
|
42194
|
+
type: string;
|
|
42195
|
+
};
|
|
42196
|
+
status: {
|
|
42197
|
+
enum: string[];
|
|
42198
|
+
type: string;
|
|
42199
|
+
};
|
|
42200
|
+
subscription_id: {
|
|
42201
|
+
type: string;
|
|
42202
|
+
};
|
|
42203
|
+
webhook_url: {
|
|
42204
|
+
type: string;
|
|
42205
|
+
};
|
|
42206
|
+
};
|
|
42207
|
+
required: string[];
|
|
42208
|
+
type: string;
|
|
42209
|
+
};
|
|
42210
|
+
};
|
|
42211
|
+
required: string[];
|
|
42212
|
+
type: string;
|
|
42213
|
+
};
|
|
42214
|
+
ok: {
|
|
42215
|
+
type: string;
|
|
42216
|
+
};
|
|
42217
|
+
};
|
|
42218
|
+
required: string[];
|
|
42219
|
+
type: string;
|
|
42220
|
+
};
|
|
42221
|
+
};
|
|
42222
|
+
};
|
|
42223
|
+
description: string;
|
|
42224
|
+
};
|
|
42225
|
+
400: {
|
|
42226
|
+
description: string;
|
|
42227
|
+
};
|
|
42228
|
+
401: {
|
|
42229
|
+
description: string;
|
|
42230
|
+
};
|
|
42231
|
+
};
|
|
42232
|
+
security: {
|
|
42233
|
+
api_key: never[];
|
|
42234
|
+
}[];
|
|
42235
|
+
summary: string;
|
|
42236
|
+
tags: never[];
|
|
42237
|
+
'x-fern-sdk-group-name': string[];
|
|
42238
|
+
'x-fern-sdk-method-name': string;
|
|
42239
|
+
'x-fern-sdk-return-value': string;
|
|
42240
|
+
'x-response-key': string;
|
|
42241
|
+
'x-title': string;
|
|
42242
|
+
};
|
|
42243
|
+
};
|
|
42244
|
+
'/seam/customer/v1/connectors/sync': {
|
|
42245
|
+
post: {
|
|
42246
|
+
description: string;
|
|
42247
|
+
operationId: string;
|
|
42248
|
+
requestBody: {
|
|
42249
|
+
content: {
|
|
42250
|
+
'application/json': {
|
|
42251
|
+
schema: {
|
|
42252
|
+
properties: {
|
|
42253
|
+
connector_id: {
|
|
42254
|
+
description: string;
|
|
42255
|
+
format: string;
|
|
42256
|
+
type: string;
|
|
42257
|
+
};
|
|
42258
|
+
};
|
|
42259
|
+
required: string[];
|
|
42260
|
+
type: string;
|
|
42261
|
+
};
|
|
42262
|
+
};
|
|
42263
|
+
};
|
|
42264
|
+
};
|
|
42265
|
+
responses: {
|
|
42266
|
+
200: {
|
|
42267
|
+
content: {
|
|
42268
|
+
'application/json': {
|
|
42269
|
+
schema: {
|
|
42270
|
+
properties: {
|
|
42271
|
+
connector_sync: {
|
|
42272
|
+
properties: {
|
|
42273
|
+
connector_id: {
|
|
42274
|
+
type: string;
|
|
42275
|
+
};
|
|
42276
|
+
message: {
|
|
42277
|
+
type: string;
|
|
42278
|
+
};
|
|
42279
|
+
status: {
|
|
42280
|
+
type: string;
|
|
42281
|
+
};
|
|
42282
|
+
};
|
|
42283
|
+
required: string[];
|
|
42284
|
+
type: string;
|
|
42285
|
+
};
|
|
42286
|
+
ok: {
|
|
42287
|
+
type: string;
|
|
42288
|
+
};
|
|
42289
|
+
};
|
|
42290
|
+
required: string[];
|
|
42291
|
+
type: string;
|
|
42292
|
+
};
|
|
42293
|
+
};
|
|
42294
|
+
};
|
|
42295
|
+
description: string;
|
|
42296
|
+
};
|
|
42297
|
+
400: {
|
|
42298
|
+
description: string;
|
|
42299
|
+
};
|
|
42300
|
+
401: {
|
|
42301
|
+
description: string;
|
|
42302
|
+
};
|
|
42303
|
+
};
|
|
42304
|
+
security: {
|
|
42305
|
+
api_key: never[];
|
|
42306
|
+
}[];
|
|
42307
|
+
summary: string;
|
|
42308
|
+
tags: never[];
|
|
42309
|
+
'x-fern-sdk-group-name': string[];
|
|
42310
|
+
'x-fern-sdk-method-name': string;
|
|
42311
|
+
'x-fern-sdk-return-value': string;
|
|
42312
|
+
'x-response-key': string;
|
|
42313
|
+
'x-title': string;
|
|
42314
|
+
};
|
|
42315
|
+
};
|
|
42104
42316
|
'/seam/customer/v1/events/list': {
|
|
42105
42317
|
get: {
|
|
42106
42318
|
description: string;
|
|
@@ -44162,6 +44374,75 @@ declare const _default: {
|
|
|
44162
44374
|
'x-title': string;
|
|
44163
44375
|
};
|
|
44164
44376
|
};
|
|
44377
|
+
'/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]': {
|
|
44378
|
+
post: {
|
|
44379
|
+
description: string;
|
|
44380
|
+
operationId: string;
|
|
44381
|
+
requestBody: {
|
|
44382
|
+
content: {
|
|
44383
|
+
'application/json': {
|
|
44384
|
+
schema: {
|
|
44385
|
+
properties: {};
|
|
44386
|
+
type: string;
|
|
44387
|
+
};
|
|
44388
|
+
};
|
|
44389
|
+
};
|
|
44390
|
+
};
|
|
44391
|
+
responses: {
|
|
44392
|
+
200: {
|
|
44393
|
+
content: {
|
|
44394
|
+
'application/json': {
|
|
44395
|
+
schema: {
|
|
44396
|
+
properties: {
|
|
44397
|
+
error: {
|
|
44398
|
+
type: string;
|
|
44399
|
+
};
|
|
44400
|
+
ok: {
|
|
44401
|
+
type: string;
|
|
44402
|
+
};
|
|
44403
|
+
processed_events: {
|
|
44404
|
+
format: string;
|
|
44405
|
+
type: string;
|
|
44406
|
+
};
|
|
44407
|
+
success: {
|
|
44408
|
+
type: string;
|
|
44409
|
+
};
|
|
44410
|
+
};
|
|
44411
|
+
required: string[];
|
|
44412
|
+
type: string;
|
|
44413
|
+
};
|
|
44414
|
+
};
|
|
44415
|
+
};
|
|
44416
|
+
description: string;
|
|
44417
|
+
};
|
|
44418
|
+
400: {
|
|
44419
|
+
description: string;
|
|
44420
|
+
};
|
|
44421
|
+
401: {
|
|
44422
|
+
description: string;
|
|
44423
|
+
};
|
|
44424
|
+
};
|
|
44425
|
+
security: ({
|
|
44426
|
+
pat_with_workspace: never[];
|
|
44427
|
+
console_session_with_workspace?: never;
|
|
44428
|
+
api_key?: never;
|
|
44429
|
+
} | {
|
|
44430
|
+
console_session_with_workspace: never[];
|
|
44431
|
+
pat_with_workspace?: never;
|
|
44432
|
+
api_key?: never;
|
|
44433
|
+
} | {
|
|
44434
|
+
api_key: never[];
|
|
44435
|
+
pat_with_workspace?: never;
|
|
44436
|
+
console_session_with_workspace?: never;
|
|
44437
|
+
})[];
|
|
44438
|
+
summary: string;
|
|
44439
|
+
tags: string[];
|
|
44440
|
+
'x-fern-sdk-group-name': string[];
|
|
44441
|
+
'x-fern-sdk-method-name': string;
|
|
44442
|
+
'x-response-key': null;
|
|
44443
|
+
'x-title': string;
|
|
44444
|
+
};
|
|
44445
|
+
};
|
|
44165
44446
|
'/seam/instant_key/v1/client_sessions/exchange_short_code': {
|
|
44166
44447
|
post: {
|
|
44167
44448
|
description: string;
|
|
@@ -47247,6 +47247,171 @@ export default {
|
|
|
47247
47247
|
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
47248
47248
|
},
|
|
47249
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
|
+
},
|
|
47250
47415
|
'/seam/customer/v1/events/list': {
|
|
47251
47416
|
get: {
|
|
47252
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.',
|
|
@@ -49249,6 +49414,56 @@ export default {
|
|
|
49249
49414
|
'x-title': 'List Spaces',
|
|
49250
49415
|
},
|
|
49251
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
|
+
},
|
|
49252
49467
|
'/seam/instant_key/v1/client_sessions/exchange_short_code': {
|
|
49253
49468
|
post: {
|
|
49254
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.',
|