@seamapi/types 1.623.0 → 1.625.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 +322 -4
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +502 -3
- package/dist/index.cjs +322 -4
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/openapi.d.ts +392 -2
- package/lib/seam/connect/openapi.js +321 -3
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +110 -1
- package/package.json +1 -1
- package/src/lib/seam/connect/openapi.ts +333 -3
- package/src/lib/seam/connect/route-types.ts +110 -1
|
@@ -48274,7 +48274,7 @@ export default {
|
|
|
48274
48274
|
},
|
|
48275
48275
|
'/seam/customer/v1/connectors/create': {
|
|
48276
48276
|
post: {
|
|
48277
|
-
description: 'Creates a new connector for a customer in a workspace. The connector will be activated and start syncing data from the external API.',
|
|
48277
|
+
description: 'Creates a new connector for a customer in a workspace. The connector will be activated and start syncing data from the external API.\nIf a connector already exists with the same unique_provider_resource_key, it will be updated instead of creating a new one.',
|
|
48278
48278
|
operationId: 'seamCustomerV1ConnectorsCreatePost',
|
|
48279
48279
|
requestBody: {
|
|
48280
48280
|
content: {
|
|
@@ -48315,7 +48315,7 @@ export default {
|
|
|
48315
48315
|
type: 'string',
|
|
48316
48316
|
},
|
|
48317
48317
|
},
|
|
48318
|
-
required: ['connector_type', '
|
|
48318
|
+
required: ['connector_type', 'config'],
|
|
48319
48319
|
type: 'object',
|
|
48320
48320
|
},
|
|
48321
48321
|
},
|
|
@@ -48373,7 +48373,11 @@ export default {
|
|
|
48373
48373
|
400: { description: 'Bad Request' },
|
|
48374
48374
|
401: { description: 'Unauthorized' },
|
|
48375
48375
|
},
|
|
48376
|
-
security: [
|
|
48376
|
+
security: [
|
|
48377
|
+
{ api_key: [] },
|
|
48378
|
+
{ client_session_with_customer: [] },
|
|
48379
|
+
{ console_session_with_workspace: [] },
|
|
48380
|
+
],
|
|
48377
48381
|
summary: '/seam/customer/v1/connectors/create',
|
|
48378
48382
|
tags: [],
|
|
48379
48383
|
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'connectors'],
|
|
@@ -48381,6 +48385,139 @@ export default {
|
|
|
48381
48385
|
'x-fern-sdk-return-value': 'connector',
|
|
48382
48386
|
'x-response-key': 'connector',
|
|
48383
48387
|
'x-title': 'Create Connector',
|
|
48388
|
+
'x-undocumented': 'Internal endpoint for Console.',
|
|
48389
|
+
},
|
|
48390
|
+
},
|
|
48391
|
+
'/seam/customer/v1/connectors/list': {
|
|
48392
|
+
get: {
|
|
48393
|
+
description: 'Lists connectors for a workspace (API key auth) or for a specific customer (customer client session auth).',
|
|
48394
|
+
operationId: 'seamCustomerV1ConnectorsListGet',
|
|
48395
|
+
responses: {
|
|
48396
|
+
200: {
|
|
48397
|
+
content: {
|
|
48398
|
+
'application/json': {
|
|
48399
|
+
schema: {
|
|
48400
|
+
properties: {
|
|
48401
|
+
connectors: {
|
|
48402
|
+
items: {
|
|
48403
|
+
properties: {
|
|
48404
|
+
config: {
|
|
48405
|
+
additionalProperties: {
|
|
48406
|
+
$ref: '#/components/schemas/access_code',
|
|
48407
|
+
},
|
|
48408
|
+
type: 'object',
|
|
48409
|
+
},
|
|
48410
|
+
connector_id: { type: 'string' },
|
|
48411
|
+
connector_type: { type: 'string' },
|
|
48412
|
+
created_at: { type: 'string' },
|
|
48413
|
+
status: {
|
|
48414
|
+
enum: ['active', 'inactive', 'error'],
|
|
48415
|
+
type: 'string',
|
|
48416
|
+
},
|
|
48417
|
+
updated_at: { type: 'string' },
|
|
48418
|
+
},
|
|
48419
|
+
required: [
|
|
48420
|
+
'connector_id',
|
|
48421
|
+
'connector_type',
|
|
48422
|
+
'status',
|
|
48423
|
+
'config',
|
|
48424
|
+
'created_at',
|
|
48425
|
+
'updated_at',
|
|
48426
|
+
],
|
|
48427
|
+
type: 'object',
|
|
48428
|
+
},
|
|
48429
|
+
type: 'array',
|
|
48430
|
+
},
|
|
48431
|
+
ok: { type: 'boolean' },
|
|
48432
|
+
},
|
|
48433
|
+
required: ['connectors', 'ok'],
|
|
48434
|
+
type: 'object',
|
|
48435
|
+
},
|
|
48436
|
+
},
|
|
48437
|
+
},
|
|
48438
|
+
description: 'OK',
|
|
48439
|
+
},
|
|
48440
|
+
400: { description: 'Bad Request' },
|
|
48441
|
+
401: { description: 'Unauthorized' },
|
|
48442
|
+
},
|
|
48443
|
+
security: [
|
|
48444
|
+
{ api_key: [] },
|
|
48445
|
+
{ client_session_with_customer: [] },
|
|
48446
|
+
{ console_session_with_workspace: [] },
|
|
48447
|
+
],
|
|
48448
|
+
summary: '/seam/customer/v1/connectors/list',
|
|
48449
|
+
tags: [],
|
|
48450
|
+
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'connectors'],
|
|
48451
|
+
'x-fern-sdk-method-name': 'list',
|
|
48452
|
+
'x-fern-sdk-return-value': 'connectors',
|
|
48453
|
+
'x-response-key': 'connectors',
|
|
48454
|
+
'x-title': 'List Connectors',
|
|
48455
|
+
'x-undocumented': 'Internal endpoint for Console.',
|
|
48456
|
+
},
|
|
48457
|
+
post: {
|
|
48458
|
+
description: 'Lists connectors for a workspace (API key auth) or for a specific customer (customer client session auth).',
|
|
48459
|
+
operationId: 'seamCustomerV1ConnectorsListPost',
|
|
48460
|
+
responses: {
|
|
48461
|
+
200: {
|
|
48462
|
+
content: {
|
|
48463
|
+
'application/json': {
|
|
48464
|
+
schema: {
|
|
48465
|
+
properties: {
|
|
48466
|
+
connectors: {
|
|
48467
|
+
items: {
|
|
48468
|
+
properties: {
|
|
48469
|
+
config: {
|
|
48470
|
+
additionalProperties: {
|
|
48471
|
+
$ref: '#/components/schemas/access_code',
|
|
48472
|
+
},
|
|
48473
|
+
type: 'object',
|
|
48474
|
+
},
|
|
48475
|
+
connector_id: { type: 'string' },
|
|
48476
|
+
connector_type: { type: 'string' },
|
|
48477
|
+
created_at: { type: 'string' },
|
|
48478
|
+
status: {
|
|
48479
|
+
enum: ['active', 'inactive', 'error'],
|
|
48480
|
+
type: 'string',
|
|
48481
|
+
},
|
|
48482
|
+
updated_at: { type: 'string' },
|
|
48483
|
+
},
|
|
48484
|
+
required: [
|
|
48485
|
+
'connector_id',
|
|
48486
|
+
'connector_type',
|
|
48487
|
+
'status',
|
|
48488
|
+
'config',
|
|
48489
|
+
'created_at',
|
|
48490
|
+
'updated_at',
|
|
48491
|
+
],
|
|
48492
|
+
type: 'object',
|
|
48493
|
+
},
|
|
48494
|
+
type: 'array',
|
|
48495
|
+
},
|
|
48496
|
+
ok: { type: 'boolean' },
|
|
48497
|
+
},
|
|
48498
|
+
required: ['connectors', 'ok'],
|
|
48499
|
+
type: 'object',
|
|
48500
|
+
},
|
|
48501
|
+
},
|
|
48502
|
+
},
|
|
48503
|
+
description: 'OK',
|
|
48504
|
+
},
|
|
48505
|
+
400: { description: 'Bad Request' },
|
|
48506
|
+
401: { description: 'Unauthorized' },
|
|
48507
|
+
},
|
|
48508
|
+
security: [
|
|
48509
|
+
{ api_key: [] },
|
|
48510
|
+
{ client_session_with_customer: [] },
|
|
48511
|
+
{ console_session_with_workspace: [] },
|
|
48512
|
+
],
|
|
48513
|
+
summary: '/seam/customer/v1/connectors/list',
|
|
48514
|
+
tags: [],
|
|
48515
|
+
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'connectors'],
|
|
48516
|
+
'x-fern-sdk-method-name': 'list',
|
|
48517
|
+
'x-fern-sdk-return-value': 'connectors',
|
|
48518
|
+
'x-response-key': 'connectors',
|
|
48519
|
+
'x-title': 'List Connectors',
|
|
48520
|
+
'x-undocumented': 'Internal endpoint for Console.',
|
|
48384
48521
|
},
|
|
48385
48522
|
},
|
|
48386
48523
|
'/seam/customer/v1/connectors/sync': {
|
|
@@ -50471,6 +50608,187 @@ export default {
|
|
|
50471
50608
|
'x-title': 'List Spaces',
|
|
50472
50609
|
},
|
|
50473
50610
|
},
|
|
50611
|
+
'/seam/customer/v1/staff_members/get': {
|
|
50612
|
+
get: {
|
|
50613
|
+
description: 'Returns a staff member for a specific customer.',
|
|
50614
|
+
operationId: 'seamCustomerV1StaffMembersGetGet',
|
|
50615
|
+
parameters: [
|
|
50616
|
+
{
|
|
50617
|
+
in: 'query',
|
|
50618
|
+
name: 'staff_member_key',
|
|
50619
|
+
required: true,
|
|
50620
|
+
schema: {
|
|
50621
|
+
description: 'Key of staff member to get.',
|
|
50622
|
+
type: 'string',
|
|
50623
|
+
},
|
|
50624
|
+
},
|
|
50625
|
+
],
|
|
50626
|
+
responses: {
|
|
50627
|
+
200: {
|
|
50628
|
+
content: {
|
|
50629
|
+
'application/json': {
|
|
50630
|
+
schema: {
|
|
50631
|
+
properties: {
|
|
50632
|
+
access_grant: { $ref: '#/components/schemas/access_grant' },
|
|
50633
|
+
ok: { type: 'boolean' },
|
|
50634
|
+
spaces: {
|
|
50635
|
+
items: {
|
|
50636
|
+
properties: {
|
|
50637
|
+
child_space_keys: {
|
|
50638
|
+
items: { type: 'string' },
|
|
50639
|
+
type: 'array',
|
|
50640
|
+
},
|
|
50641
|
+
space_key: { type: 'string' },
|
|
50642
|
+
},
|
|
50643
|
+
required: ['space_key'],
|
|
50644
|
+
type: 'object',
|
|
50645
|
+
},
|
|
50646
|
+
type: 'array',
|
|
50647
|
+
},
|
|
50648
|
+
staff_member: {
|
|
50649
|
+
description: 'Represents a staff member for a specific customer.',
|
|
50650
|
+
properties: {
|
|
50651
|
+
email_address: {
|
|
50652
|
+
description: 'Email address associated with the user identity.',
|
|
50653
|
+
type: 'string',
|
|
50654
|
+
},
|
|
50655
|
+
name: {
|
|
50656
|
+
description: 'Your display name for this user identity resource.',
|
|
50657
|
+
type: 'string',
|
|
50658
|
+
},
|
|
50659
|
+
phone_number: {
|
|
50660
|
+
description: 'Phone number associated with the user identity.',
|
|
50661
|
+
type: 'string',
|
|
50662
|
+
},
|
|
50663
|
+
space_keys: {
|
|
50664
|
+
description: 'List of unique identifiers for the spaces the staff member is associated with.',
|
|
50665
|
+
items: { type: 'string' },
|
|
50666
|
+
type: 'array',
|
|
50667
|
+
},
|
|
50668
|
+
staff_member_key: {
|
|
50669
|
+
description: 'Your unique identifier for the staff.',
|
|
50670
|
+
type: 'string',
|
|
50671
|
+
},
|
|
50672
|
+
user_identity_id: { format: 'uuid', type: 'string' },
|
|
50673
|
+
},
|
|
50674
|
+
required: ['staff_member_key', 'name'],
|
|
50675
|
+
type: 'object',
|
|
50676
|
+
'x-route-path': '/seam/customer/v1/staff_members',
|
|
50677
|
+
},
|
|
50678
|
+
},
|
|
50679
|
+
required: ['access_grant', 'spaces', 'staff_member', 'ok'],
|
|
50680
|
+
type: 'object',
|
|
50681
|
+
},
|
|
50682
|
+
},
|
|
50683
|
+
},
|
|
50684
|
+
description: 'OK',
|
|
50685
|
+
},
|
|
50686
|
+
400: { description: 'Bad Request' },
|
|
50687
|
+
401: { description: 'Unauthorized' },
|
|
50688
|
+
},
|
|
50689
|
+
security: [{ client_session_with_customer: [] }],
|
|
50690
|
+
summary: '/seam/customer/v1/staff_members/get',
|
|
50691
|
+
tags: [],
|
|
50692
|
+
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'staff_members'],
|
|
50693
|
+
'x-fern-sdk-method-name': 'get',
|
|
50694
|
+
'x-fern-sdk-return-value': 'staff_member',
|
|
50695
|
+
'x-response-key': 'staff_member',
|
|
50696
|
+
'x-title': 'Get Staff Member',
|
|
50697
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
50698
|
+
},
|
|
50699
|
+
post: {
|
|
50700
|
+
description: 'Returns a staff member for a specific customer.',
|
|
50701
|
+
operationId: 'seamCustomerV1StaffMembersGetPost',
|
|
50702
|
+
requestBody: {
|
|
50703
|
+
content: {
|
|
50704
|
+
'application/json': {
|
|
50705
|
+
schema: {
|
|
50706
|
+
properties: {
|
|
50707
|
+
staff_member_key: {
|
|
50708
|
+
description: 'Key of staff member to get.',
|
|
50709
|
+
type: 'string',
|
|
50710
|
+
},
|
|
50711
|
+
},
|
|
50712
|
+
required: ['staff_member_key'],
|
|
50713
|
+
type: 'object',
|
|
50714
|
+
},
|
|
50715
|
+
},
|
|
50716
|
+
},
|
|
50717
|
+
},
|
|
50718
|
+
responses: {
|
|
50719
|
+
200: {
|
|
50720
|
+
content: {
|
|
50721
|
+
'application/json': {
|
|
50722
|
+
schema: {
|
|
50723
|
+
properties: {
|
|
50724
|
+
access_grant: { $ref: '#/components/schemas/access_grant' },
|
|
50725
|
+
ok: { type: 'boolean' },
|
|
50726
|
+
spaces: {
|
|
50727
|
+
items: {
|
|
50728
|
+
properties: {
|
|
50729
|
+
child_space_keys: {
|
|
50730
|
+
items: { type: 'string' },
|
|
50731
|
+
type: 'array',
|
|
50732
|
+
},
|
|
50733
|
+
space_key: { type: 'string' },
|
|
50734
|
+
},
|
|
50735
|
+
required: ['space_key'],
|
|
50736
|
+
type: 'object',
|
|
50737
|
+
},
|
|
50738
|
+
type: 'array',
|
|
50739
|
+
},
|
|
50740
|
+
staff_member: {
|
|
50741
|
+
description: 'Represents a staff member for a specific customer.',
|
|
50742
|
+
properties: {
|
|
50743
|
+
email_address: {
|
|
50744
|
+
description: 'Email address associated with the user identity.',
|
|
50745
|
+
type: 'string',
|
|
50746
|
+
},
|
|
50747
|
+
name: {
|
|
50748
|
+
description: 'Your display name for this user identity resource.',
|
|
50749
|
+
type: 'string',
|
|
50750
|
+
},
|
|
50751
|
+
phone_number: {
|
|
50752
|
+
description: 'Phone number associated with the user identity.',
|
|
50753
|
+
type: 'string',
|
|
50754
|
+
},
|
|
50755
|
+
space_keys: {
|
|
50756
|
+
description: 'List of unique identifiers for the spaces the staff member is associated with.',
|
|
50757
|
+
items: { type: 'string' },
|
|
50758
|
+
type: 'array',
|
|
50759
|
+
},
|
|
50760
|
+
staff_member_key: {
|
|
50761
|
+
description: 'Your unique identifier for the staff.',
|
|
50762
|
+
type: 'string',
|
|
50763
|
+
},
|
|
50764
|
+
user_identity_id: { format: 'uuid', type: 'string' },
|
|
50765
|
+
},
|
|
50766
|
+
required: ['staff_member_key', 'name'],
|
|
50767
|
+
type: 'object',
|
|
50768
|
+
'x-route-path': '/seam/customer/v1/staff_members',
|
|
50769
|
+
},
|
|
50770
|
+
},
|
|
50771
|
+
required: ['access_grant', 'spaces', 'staff_member', 'ok'],
|
|
50772
|
+
type: 'object',
|
|
50773
|
+
},
|
|
50774
|
+
},
|
|
50775
|
+
},
|
|
50776
|
+
description: 'OK',
|
|
50777
|
+
},
|
|
50778
|
+
400: { description: 'Bad Request' },
|
|
50779
|
+
401: { description: 'Unauthorized' },
|
|
50780
|
+
},
|
|
50781
|
+
security: [{ client_session_with_customer: [] }],
|
|
50782
|
+
summary: '/seam/customer/v1/staff_members/get',
|
|
50783
|
+
tags: [],
|
|
50784
|
+
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'staff_members'],
|
|
50785
|
+
'x-fern-sdk-method-name': 'get',
|
|
50786
|
+
'x-fern-sdk-return-value': 'staff_member',
|
|
50787
|
+
'x-response-key': 'staff_member',
|
|
50788
|
+
'x-title': 'Get Staff Member',
|
|
50789
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
50790
|
+
},
|
|
50791
|
+
},
|
|
50474
50792
|
'/seam/customer/v1/staff_members/list': {
|
|
50475
50793
|
get: {
|
|
50476
50794
|
description: 'Returns a list of staff members for a specific customer. This endpoint is designed for customer portals and supports filtering by space_key.\nProvided space_key or space_id can be a child space, in which case the staff members for the parent space will be returned.',
|