@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
|
@@ -56660,6 +56660,58 @@ export type Routes = {
|
|
|
56660
56660
|
formData: {};
|
|
56661
56661
|
jsonResponse: {};
|
|
56662
56662
|
};
|
|
56663
|
+
'/seam/customer/v1/connectors/create': {
|
|
56664
|
+
route: '/seam/customer/v1/connectors/create';
|
|
56665
|
+
method: 'POST';
|
|
56666
|
+
queryParams: {};
|
|
56667
|
+
jsonBody: {
|
|
56668
|
+
/** Type of connector to create */
|
|
56669
|
+
connector_type: 'mews' | 'mock';
|
|
56670
|
+
/** Key identifying the customer */
|
|
56671
|
+
customer_key: string;
|
|
56672
|
+
/** Instance-specific configuration for the connector */
|
|
56673
|
+
config: {
|
|
56674
|
+
client_token: string;
|
|
56675
|
+
access_token: string;
|
|
56676
|
+
client: string;
|
|
56677
|
+
enterprise_ids?: string[] | undefined;
|
|
56678
|
+
} | {};
|
|
56679
|
+
};
|
|
56680
|
+
commonParams: {};
|
|
56681
|
+
formData: {};
|
|
56682
|
+
jsonResponse: {
|
|
56683
|
+
connector: {
|
|
56684
|
+
connector_id: string;
|
|
56685
|
+
connector_type: string;
|
|
56686
|
+
status: 'active' | 'inactive' | 'error';
|
|
56687
|
+
webhook_subscription?: {
|
|
56688
|
+
subscription_id: string;
|
|
56689
|
+
webhook_url: string;
|
|
56690
|
+
events: string[];
|
|
56691
|
+
status: 'active' | 'inactive' | 'error';
|
|
56692
|
+
} | undefined;
|
|
56693
|
+
error?: string | undefined;
|
|
56694
|
+
};
|
|
56695
|
+
};
|
|
56696
|
+
};
|
|
56697
|
+
'/seam/customer/v1/connectors/sync': {
|
|
56698
|
+
route: '/seam/customer/v1/connectors/sync';
|
|
56699
|
+
method: 'POST';
|
|
56700
|
+
queryParams: {};
|
|
56701
|
+
jsonBody: {};
|
|
56702
|
+
commonParams: {
|
|
56703
|
+
/** ID of the connector to sync */
|
|
56704
|
+
connector_id: string;
|
|
56705
|
+
};
|
|
56706
|
+
formData: {};
|
|
56707
|
+
jsonResponse: {
|
|
56708
|
+
connector_sync: {
|
|
56709
|
+
connector_id: string;
|
|
56710
|
+
status: string;
|
|
56711
|
+
message: string;
|
|
56712
|
+
};
|
|
56713
|
+
};
|
|
56714
|
+
};
|
|
56663
56715
|
'/seam/customer/v1/events/list': {
|
|
56664
56716
|
route: '/seam/customer/v1/events/list';
|
|
56665
56717
|
method: 'GET' | 'POST';
|
|
@@ -58862,6 +58914,19 @@ export type Routes = {
|
|
|
58862
58914
|
}[];
|
|
58863
58915
|
};
|
|
58864
58916
|
};
|
|
58917
|
+
'/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]': {
|
|
58918
|
+
route: '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]';
|
|
58919
|
+
method: 'POST';
|
|
58920
|
+
queryParams: {};
|
|
58921
|
+
jsonBody: {};
|
|
58922
|
+
commonParams: {};
|
|
58923
|
+
formData: {};
|
|
58924
|
+
jsonResponse: {
|
|
58925
|
+
success: boolean;
|
|
58926
|
+
processed_events: number;
|
|
58927
|
+
error?: string | undefined;
|
|
58928
|
+
};
|
|
58929
|
+
};
|
|
58865
58930
|
'/seam/instant_key/v1/client_sessions/exchange_short_code': {
|
|
58866
58931
|
route: '/seam/instant_key/v1/client_sessions/exchange_short_code';
|
|
58867
58932
|
method: 'POST';
|
package/package.json
CHANGED
|
@@ -51362,6 +51362,174 @@ export default {
|
|
|
51362
51362
|
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
51363
51363
|
},
|
|
51364
51364
|
},
|
|
51365
|
+
'/seam/customer/v1/connectors/create': {
|
|
51366
|
+
post: {
|
|
51367
|
+
description:
|
|
51368
|
+
'Creates a new connector for a customer in a workspace. The connector will be activated and start syncing data from the external API.',
|
|
51369
|
+
operationId: 'seamCustomerV1ConnectorsCreatePost',
|
|
51370
|
+
requestBody: {
|
|
51371
|
+
content: {
|
|
51372
|
+
'application/json': {
|
|
51373
|
+
schema: {
|
|
51374
|
+
properties: {
|
|
51375
|
+
config: {
|
|
51376
|
+
description:
|
|
51377
|
+
'Instance-specific configuration for the connector',
|
|
51378
|
+
oneOf: [
|
|
51379
|
+
{
|
|
51380
|
+
properties: {
|
|
51381
|
+
access_token: { minLength: 1, type: 'string' },
|
|
51382
|
+
client: { minLength: 1, type: 'string' },
|
|
51383
|
+
client_token: { minLength: 1, type: 'string' },
|
|
51384
|
+
enterprise_ids: {
|
|
51385
|
+
items: { format: 'uuid', type: 'string' },
|
|
51386
|
+
type: 'array',
|
|
51387
|
+
},
|
|
51388
|
+
},
|
|
51389
|
+
required: ['client_token', 'access_token', 'client'],
|
|
51390
|
+
type: 'object',
|
|
51391
|
+
},
|
|
51392
|
+
{ properties: {}, type: 'object' },
|
|
51393
|
+
],
|
|
51394
|
+
},
|
|
51395
|
+
connector_type: {
|
|
51396
|
+
description: 'Type of connector to create',
|
|
51397
|
+
enum: ['mews', 'mock'],
|
|
51398
|
+
type: 'string',
|
|
51399
|
+
},
|
|
51400
|
+
customer_key: {
|
|
51401
|
+
description: 'Key identifying the customer',
|
|
51402
|
+
minLength: 1,
|
|
51403
|
+
type: 'string',
|
|
51404
|
+
},
|
|
51405
|
+
},
|
|
51406
|
+
required: ['connector_type', 'customer_key', 'config'],
|
|
51407
|
+
type: 'object',
|
|
51408
|
+
},
|
|
51409
|
+
},
|
|
51410
|
+
},
|
|
51411
|
+
},
|
|
51412
|
+
responses: {
|
|
51413
|
+
200: {
|
|
51414
|
+
content: {
|
|
51415
|
+
'application/json': {
|
|
51416
|
+
schema: {
|
|
51417
|
+
properties: {
|
|
51418
|
+
connector: {
|
|
51419
|
+
properties: {
|
|
51420
|
+
connector_id: { type: 'string' },
|
|
51421
|
+
connector_type: { type: 'string' },
|
|
51422
|
+
error: { type: 'string' },
|
|
51423
|
+
status: {
|
|
51424
|
+
enum: ['active', 'inactive', 'error'],
|
|
51425
|
+
type: 'string',
|
|
51426
|
+
},
|
|
51427
|
+
webhook_subscription: {
|
|
51428
|
+
properties: {
|
|
51429
|
+
events: {
|
|
51430
|
+
items: { type: 'string' },
|
|
51431
|
+
type: 'array',
|
|
51432
|
+
},
|
|
51433
|
+
status: {
|
|
51434
|
+
enum: ['active', 'inactive', 'error'],
|
|
51435
|
+
type: 'string',
|
|
51436
|
+
},
|
|
51437
|
+
subscription_id: { type: 'string' },
|
|
51438
|
+
webhook_url: { type: 'string' },
|
|
51439
|
+
},
|
|
51440
|
+
required: [
|
|
51441
|
+
'subscription_id',
|
|
51442
|
+
'webhook_url',
|
|
51443
|
+
'events',
|
|
51444
|
+
'status',
|
|
51445
|
+
],
|
|
51446
|
+
type: 'object',
|
|
51447
|
+
},
|
|
51448
|
+
},
|
|
51449
|
+
required: ['connector_id', 'connector_type', 'status'],
|
|
51450
|
+
type: 'object',
|
|
51451
|
+
},
|
|
51452
|
+
ok: { type: 'boolean' },
|
|
51453
|
+
},
|
|
51454
|
+
required: ['connector', 'ok'],
|
|
51455
|
+
type: 'object',
|
|
51456
|
+
},
|
|
51457
|
+
},
|
|
51458
|
+
},
|
|
51459
|
+
description: 'OK',
|
|
51460
|
+
},
|
|
51461
|
+
400: { description: 'Bad Request' },
|
|
51462
|
+
401: { description: 'Unauthorized' },
|
|
51463
|
+
},
|
|
51464
|
+
security: [{ api_key: [] }],
|
|
51465
|
+
summary: '/seam/customer/v1/connectors/create',
|
|
51466
|
+
tags: [],
|
|
51467
|
+
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'connectors'],
|
|
51468
|
+
'x-fern-sdk-method-name': 'create',
|
|
51469
|
+
'x-fern-sdk-return-value': 'connector',
|
|
51470
|
+
'x-response-key': 'connector',
|
|
51471
|
+
'x-title': 'Create Connector',
|
|
51472
|
+
},
|
|
51473
|
+
},
|
|
51474
|
+
'/seam/customer/v1/connectors/sync': {
|
|
51475
|
+
post: {
|
|
51476
|
+
description:
|
|
51477
|
+
'Triggers an immediate data sync for a connector by scheduling a polling task.',
|
|
51478
|
+
operationId: 'seamCustomerV1ConnectorsSyncPost',
|
|
51479
|
+
requestBody: {
|
|
51480
|
+
content: {
|
|
51481
|
+
'application/json': {
|
|
51482
|
+
schema: {
|
|
51483
|
+
properties: {
|
|
51484
|
+
connector_id: {
|
|
51485
|
+
description: 'ID of the connector to sync',
|
|
51486
|
+
format: 'uuid',
|
|
51487
|
+
type: 'string',
|
|
51488
|
+
},
|
|
51489
|
+
},
|
|
51490
|
+
required: ['connector_id'],
|
|
51491
|
+
type: 'object',
|
|
51492
|
+
},
|
|
51493
|
+
},
|
|
51494
|
+
},
|
|
51495
|
+
},
|
|
51496
|
+
responses: {
|
|
51497
|
+
200: {
|
|
51498
|
+
content: {
|
|
51499
|
+
'application/json': {
|
|
51500
|
+
schema: {
|
|
51501
|
+
properties: {
|
|
51502
|
+
connector_sync: {
|
|
51503
|
+
properties: {
|
|
51504
|
+
connector_id: { type: 'string' },
|
|
51505
|
+
message: { type: 'string' },
|
|
51506
|
+
status: { type: 'string' },
|
|
51507
|
+
},
|
|
51508
|
+
required: ['connector_id', 'status', 'message'],
|
|
51509
|
+
type: 'object',
|
|
51510
|
+
},
|
|
51511
|
+
ok: { type: 'boolean' },
|
|
51512
|
+
},
|
|
51513
|
+
required: ['connector_sync', 'ok'],
|
|
51514
|
+
type: 'object',
|
|
51515
|
+
},
|
|
51516
|
+
},
|
|
51517
|
+
},
|
|
51518
|
+
description: 'OK',
|
|
51519
|
+
},
|
|
51520
|
+
400: { description: 'Bad Request' },
|
|
51521
|
+
401: { description: 'Unauthorized' },
|
|
51522
|
+
},
|
|
51523
|
+
security: [{ api_key: [] }],
|
|
51524
|
+
summary: '/seam/customer/v1/connectors/sync',
|
|
51525
|
+
tags: [],
|
|
51526
|
+
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'connectors'],
|
|
51527
|
+
'x-fern-sdk-method-name': 'sync',
|
|
51528
|
+
'x-fern-sdk-return-value': 'connector_sync',
|
|
51529
|
+
'x-response-key': 'connector_sync',
|
|
51530
|
+
'x-title': 'Sync Connector Data',
|
|
51531
|
+
},
|
|
51532
|
+
},
|
|
51365
51533
|
'/seam/customer/v1/events/list': {
|
|
51366
51534
|
get: {
|
|
51367
51535
|
description:
|
|
@@ -53427,6 +53595,59 @@ export default {
|
|
|
53427
53595
|
'x-title': 'List Spaces',
|
|
53428
53596
|
},
|
|
53429
53597
|
},
|
|
53598
|
+
'/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]': {
|
|
53599
|
+
post: {
|
|
53600
|
+
description:
|
|
53601
|
+
'Receives webhook events from external connector APIs and processes them into partner resources.',
|
|
53602
|
+
operationId:
|
|
53603
|
+
'seamCustomerV1WebhooksConnectorsByWorkspaceIdByConnectorIdPost',
|
|
53604
|
+
requestBody: {
|
|
53605
|
+
content: {
|
|
53606
|
+
'application/json': { schema: { properties: {}, type: 'object' } },
|
|
53607
|
+
},
|
|
53608
|
+
},
|
|
53609
|
+
responses: {
|
|
53610
|
+
200: {
|
|
53611
|
+
content: {
|
|
53612
|
+
'application/json': {
|
|
53613
|
+
schema: {
|
|
53614
|
+
properties: {
|
|
53615
|
+
error: { type: 'string' },
|
|
53616
|
+
ok: { type: 'boolean' },
|
|
53617
|
+
processed_events: { format: 'float', type: 'number' },
|
|
53618
|
+
success: { type: 'boolean' },
|
|
53619
|
+
},
|
|
53620
|
+
required: ['success', 'processed_events', 'ok'],
|
|
53621
|
+
type: 'object',
|
|
53622
|
+
},
|
|
53623
|
+
},
|
|
53624
|
+
},
|
|
53625
|
+
description: 'OK',
|
|
53626
|
+
},
|
|
53627
|
+
400: { description: 'Bad Request' },
|
|
53628
|
+
401: { description: 'Unauthorized' },
|
|
53629
|
+
},
|
|
53630
|
+
security: [
|
|
53631
|
+
{ pat_with_workspace: [] },
|
|
53632
|
+
{ console_session_with_workspace: [] },
|
|
53633
|
+
{ api_key: [] },
|
|
53634
|
+
],
|
|
53635
|
+
summary:
|
|
53636
|
+
'/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]',
|
|
53637
|
+
tags: ['/webhooks'],
|
|
53638
|
+
'x-fern-sdk-group-name': [
|
|
53639
|
+
'seam',
|
|
53640
|
+
'customer',
|
|
53641
|
+
'v1',
|
|
53642
|
+
'webhooks',
|
|
53643
|
+
'connectors',
|
|
53644
|
+
'[workspace_id]',
|
|
53645
|
+
],
|
|
53646
|
+
'x-fern-sdk-method-name': 'by_connector_id',
|
|
53647
|
+
'x-response-key': null,
|
|
53648
|
+
'x-title': 'Connector Webhook Endpoint',
|
|
53649
|
+
},
|
|
53650
|
+
},
|
|
53430
53651
|
'/seam/instant_key/v1/client_sessions/exchange_short_code': {
|
|
53431
53652
|
post: {
|
|
53432
53653
|
description:
|
|
@@ -67359,6 +67359,62 @@ export type Routes = {
|
|
|
67359
67359
|
formData: {}
|
|
67360
67360
|
jsonResponse: {}
|
|
67361
67361
|
}
|
|
67362
|
+
'/seam/customer/v1/connectors/create': {
|
|
67363
|
+
route: '/seam/customer/v1/connectors/create'
|
|
67364
|
+
method: 'POST'
|
|
67365
|
+
queryParams: {}
|
|
67366
|
+
jsonBody: {
|
|
67367
|
+
/** Type of connector to create */
|
|
67368
|
+
connector_type: 'mews' | 'mock'
|
|
67369
|
+
/** Key identifying the customer */
|
|
67370
|
+
customer_key: string
|
|
67371
|
+
/** Instance-specific configuration for the connector */
|
|
67372
|
+
config:
|
|
67373
|
+
| {
|
|
67374
|
+
client_token: string
|
|
67375
|
+
access_token: string
|
|
67376
|
+
client: string
|
|
67377
|
+
enterprise_ids?: string[] | undefined
|
|
67378
|
+
}
|
|
67379
|
+
| {}
|
|
67380
|
+
}
|
|
67381
|
+
commonParams: {}
|
|
67382
|
+
formData: {}
|
|
67383
|
+
jsonResponse: {
|
|
67384
|
+
connector: {
|
|
67385
|
+
connector_id: string
|
|
67386
|
+
connector_type: string
|
|
67387
|
+
status: 'active' | 'inactive' | 'error'
|
|
67388
|
+
webhook_subscription?:
|
|
67389
|
+
| {
|
|
67390
|
+
subscription_id: string
|
|
67391
|
+
webhook_url: string
|
|
67392
|
+
events: string[]
|
|
67393
|
+
status: 'active' | 'inactive' | 'error'
|
|
67394
|
+
}
|
|
67395
|
+
| undefined
|
|
67396
|
+
error?: string | undefined
|
|
67397
|
+
}
|
|
67398
|
+
}
|
|
67399
|
+
}
|
|
67400
|
+
'/seam/customer/v1/connectors/sync': {
|
|
67401
|
+
route: '/seam/customer/v1/connectors/sync'
|
|
67402
|
+
method: 'POST'
|
|
67403
|
+
queryParams: {}
|
|
67404
|
+
jsonBody: {}
|
|
67405
|
+
commonParams: {
|
|
67406
|
+
/** ID of the connector to sync */
|
|
67407
|
+
connector_id: string
|
|
67408
|
+
}
|
|
67409
|
+
formData: {}
|
|
67410
|
+
jsonResponse: {
|
|
67411
|
+
connector_sync: {
|
|
67412
|
+
connector_id: string
|
|
67413
|
+
status: string
|
|
67414
|
+
message: string
|
|
67415
|
+
}
|
|
67416
|
+
}
|
|
67417
|
+
}
|
|
67362
67418
|
'/seam/customer/v1/events/list': {
|
|
67363
67419
|
route: '/seam/customer/v1/events/list'
|
|
67364
67420
|
method: 'GET' | 'POST'
|
|
@@ -70124,6 +70180,19 @@ export type Routes = {
|
|
|
70124
70180
|
}[]
|
|
70125
70181
|
}
|
|
70126
70182
|
}
|
|
70183
|
+
'/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]': {
|
|
70184
|
+
route: '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]'
|
|
70185
|
+
method: 'POST'
|
|
70186
|
+
queryParams: {}
|
|
70187
|
+
jsonBody: {}
|
|
70188
|
+
commonParams: {}
|
|
70189
|
+
formData: {}
|
|
70190
|
+
jsonResponse: {
|
|
70191
|
+
success: boolean
|
|
70192
|
+
processed_events: number
|
|
70193
|
+
error?: string | undefined
|
|
70194
|
+
}
|
|
70195
|
+
}
|
|
70127
70196
|
'/seam/instant_key/v1/client_sessions/exchange_short_code': {
|
|
70128
70197
|
route: '/seam/instant_key/v1/client_sessions/exchange_short_code'
|
|
70129
70198
|
method: 'POST'
|