@seamapi/types 1.622.0 → 1.624.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.
@@ -43394,6 +43394,7 @@ declare const _default: {
43394
43394
  type: string;
43395
43395
  };
43396
43396
  client: {
43397
+ default: string;
43397
43398
  minLength: number;
43398
43399
  type: string;
43399
43400
  };
@@ -43401,6 +43402,10 @@ declare const _default: {
43401
43402
  minLength: number;
43402
43403
  type: string;
43403
43404
  };
43405
+ enterprise_id: {
43406
+ format: string;
43407
+ type: string;
43408
+ };
43404
43409
  enterprise_ids: {
43405
43410
  items: {
43406
43411
  format: string;
@@ -43409,17 +43414,16 @@ declare const _default: {
43409
43414
  type: string;
43410
43415
  };
43411
43416
  };
43412
- required: string[];
43413
43417
  type: string;
43414
43418
  } | {
43415
43419
  properties: {
43416
43420
  access_token?: never;
43417
43421
  client?: never;
43418
43422
  client_token?: never;
43423
+ enterprise_id?: never;
43419
43424
  enterprise_ids?: never;
43420
43425
  };
43421
43426
  type: string;
43422
- required?: never;
43423
43427
  })[];
43424
43428
  };
43425
43429
  connector_type: {
@@ -43504,9 +43508,19 @@ declare const _default: {
43504
43508
  description: string;
43505
43509
  };
43506
43510
  };
43507
- security: {
43511
+ security: ({
43508
43512
  api_key: never[];
43509
- }[];
43513
+ client_session_with_customer?: never;
43514
+ console_session_with_workspace?: never;
43515
+ } | {
43516
+ client_session_with_customer: never[];
43517
+ api_key?: never;
43518
+ console_session_with_workspace?: never;
43519
+ } | {
43520
+ console_session_with_workspace: never[];
43521
+ api_key?: never;
43522
+ client_session_with_customer?: never;
43523
+ })[];
43510
43524
  summary: string;
43511
43525
  tags: never[];
43512
43526
  'x-fern-sdk-group-name': string[];
@@ -43514,6 +43528,169 @@ declare const _default: {
43514
43528
  'x-fern-sdk-return-value': string;
43515
43529
  'x-response-key': string;
43516
43530
  'x-title': string;
43531
+ 'x-undocumented': string;
43532
+ };
43533
+ };
43534
+ '/seam/customer/v1/connectors/list': {
43535
+ get: {
43536
+ description: string;
43537
+ operationId: string;
43538
+ responses: {
43539
+ 200: {
43540
+ content: {
43541
+ 'application/json': {
43542
+ schema: {
43543
+ properties: {
43544
+ connectors: {
43545
+ items: {
43546
+ properties: {
43547
+ config: {
43548
+ additionalProperties: {
43549
+ $ref: string;
43550
+ };
43551
+ type: string;
43552
+ };
43553
+ connector_id: {
43554
+ type: string;
43555
+ };
43556
+ connector_type: {
43557
+ type: string;
43558
+ };
43559
+ created_at: {
43560
+ type: string;
43561
+ };
43562
+ status: {
43563
+ enum: string[];
43564
+ type: string;
43565
+ };
43566
+ updated_at: {
43567
+ type: string;
43568
+ };
43569
+ };
43570
+ required: string[];
43571
+ type: string;
43572
+ };
43573
+ type: string;
43574
+ };
43575
+ ok: {
43576
+ type: string;
43577
+ };
43578
+ };
43579
+ required: string[];
43580
+ type: string;
43581
+ };
43582
+ };
43583
+ };
43584
+ description: string;
43585
+ };
43586
+ 400: {
43587
+ description: string;
43588
+ };
43589
+ 401: {
43590
+ description: string;
43591
+ };
43592
+ };
43593
+ security: ({
43594
+ api_key: never[];
43595
+ client_session_with_customer?: never;
43596
+ console_session_with_workspace?: never;
43597
+ } | {
43598
+ client_session_with_customer: never[];
43599
+ api_key?: never;
43600
+ console_session_with_workspace?: never;
43601
+ } | {
43602
+ console_session_with_workspace: never[];
43603
+ api_key?: never;
43604
+ client_session_with_customer?: never;
43605
+ })[];
43606
+ summary: string;
43607
+ tags: never[];
43608
+ 'x-fern-sdk-group-name': string[];
43609
+ 'x-fern-sdk-method-name': string;
43610
+ 'x-fern-sdk-return-value': string;
43611
+ 'x-response-key': string;
43612
+ 'x-title': string;
43613
+ 'x-undocumented': string;
43614
+ };
43615
+ post: {
43616
+ description: string;
43617
+ operationId: string;
43618
+ responses: {
43619
+ 200: {
43620
+ content: {
43621
+ 'application/json': {
43622
+ schema: {
43623
+ properties: {
43624
+ connectors: {
43625
+ items: {
43626
+ properties: {
43627
+ config: {
43628
+ additionalProperties: {
43629
+ $ref: string;
43630
+ };
43631
+ type: string;
43632
+ };
43633
+ connector_id: {
43634
+ type: string;
43635
+ };
43636
+ connector_type: {
43637
+ type: string;
43638
+ };
43639
+ created_at: {
43640
+ type: string;
43641
+ };
43642
+ status: {
43643
+ enum: string[];
43644
+ type: string;
43645
+ };
43646
+ updated_at: {
43647
+ type: string;
43648
+ };
43649
+ };
43650
+ required: string[];
43651
+ type: string;
43652
+ };
43653
+ type: string;
43654
+ };
43655
+ ok: {
43656
+ type: string;
43657
+ };
43658
+ };
43659
+ required: string[];
43660
+ type: string;
43661
+ };
43662
+ };
43663
+ };
43664
+ description: string;
43665
+ };
43666
+ 400: {
43667
+ description: string;
43668
+ };
43669
+ 401: {
43670
+ description: string;
43671
+ };
43672
+ };
43673
+ security: ({
43674
+ api_key: never[];
43675
+ client_session_with_customer?: never;
43676
+ console_session_with_workspace?: never;
43677
+ } | {
43678
+ client_session_with_customer: never[];
43679
+ api_key?: never;
43680
+ console_session_with_workspace?: never;
43681
+ } | {
43682
+ console_session_with_workspace: never[];
43683
+ api_key?: never;
43684
+ client_session_with_customer?: never;
43685
+ })[];
43686
+ summary: string;
43687
+ tags: never[];
43688
+ 'x-fern-sdk-group-name': string[];
43689
+ 'x-fern-sdk-method-name': string;
43690
+ 'x-fern-sdk-return-value': string;
43691
+ 'x-response-key': string;
43692
+ 'x-title': string;
43693
+ 'x-undocumented': string;
43517
43694
  };
43518
43695
  };
43519
43696
  '/seam/customer/v1/connectors/sync': {
@@ -45929,75 +46106,6 @@ declare const _default: {
45929
46106
  'x-undocumented': string;
45930
46107
  };
45931
46108
  };
45932
- '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]': {
45933
- post: {
45934
- description: string;
45935
- operationId: string;
45936
- requestBody: {
45937
- content: {
45938
- 'application/json': {
45939
- schema: {
45940
- properties: {};
45941
- type: string;
45942
- };
45943
- };
45944
- };
45945
- };
45946
- responses: {
45947
- 200: {
45948
- content: {
45949
- 'application/json': {
45950
- schema: {
45951
- properties: {
45952
- error: {
45953
- type: string;
45954
- };
45955
- ok: {
45956
- type: string;
45957
- };
45958
- processed_events: {
45959
- format: string;
45960
- type: string;
45961
- };
45962
- success: {
45963
- type: string;
45964
- };
45965
- };
45966
- required: string[];
45967
- type: string;
45968
- };
45969
- };
45970
- };
45971
- description: string;
45972
- };
45973
- 400: {
45974
- description: string;
45975
- };
45976
- 401: {
45977
- description: string;
45978
- };
45979
- };
45980
- security: ({
45981
- pat_with_workspace: never[];
45982
- console_session_with_workspace?: never;
45983
- api_key?: never;
45984
- } | {
45985
- console_session_with_workspace: never[];
45986
- pat_with_workspace?: never;
45987
- api_key?: never;
45988
- } | {
45989
- api_key: never[];
45990
- pat_with_workspace?: never;
45991
- console_session_with_workspace?: never;
45992
- })[];
45993
- summary: string;
45994
- tags: string[];
45995
- 'x-fern-sdk-group-name': string[];
45996
- 'x-fern-sdk-method-name': string;
45997
- 'x-response-key': null;
45998
- 'x-title': string;
45999
- };
46000
- };
46001
46109
  '/seam/instant_key/v1/client_sessions/exchange_short_code': {
46002
46110
  post: {
46003
46111
  description: string;
@@ -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: {
@@ -48287,14 +48287,18 @@ export default {
48287
48287
  {
48288
48288
  properties: {
48289
48289
  access_token: { minLength: 1, type: 'string' },
48290
- client: { minLength: 1, type: 'string' },
48290
+ client: {
48291
+ default: 'seam',
48292
+ minLength: 1,
48293
+ type: 'string',
48294
+ },
48291
48295
  client_token: { minLength: 1, type: 'string' },
48296
+ enterprise_id: { format: 'uuid', type: 'string' },
48292
48297
  enterprise_ids: {
48293
48298
  items: { format: 'uuid', type: 'string' },
48294
48299
  type: 'array',
48295
48300
  },
48296
48301
  },
48297
- required: ['client_token', 'access_token', 'client'],
48298
48302
  type: 'object',
48299
48303
  },
48300
48304
  { properties: {}, type: 'object' },
@@ -48311,7 +48315,7 @@ export default {
48311
48315
  type: 'string',
48312
48316
  },
48313
48317
  },
48314
- required: ['connector_type', 'customer_key', 'config'],
48318
+ required: ['connector_type', 'config'],
48315
48319
  type: 'object',
48316
48320
  },
48317
48321
  },
@@ -48369,7 +48373,11 @@ export default {
48369
48373
  400: { description: 'Bad Request' },
48370
48374
  401: { description: 'Unauthorized' },
48371
48375
  },
48372
- security: [{ api_key: [] }],
48376
+ security: [
48377
+ { api_key: [] },
48378
+ { client_session_with_customer: [] },
48379
+ { console_session_with_workspace: [] },
48380
+ ],
48373
48381
  summary: '/seam/customer/v1/connectors/create',
48374
48382
  tags: [],
48375
48383
  'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'connectors'],
@@ -48377,6 +48385,139 @@ export default {
48377
48385
  'x-fern-sdk-return-value': 'connector',
48378
48386
  'x-response-key': 'connector',
48379
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.',
48380
48521
  },
48381
48522
  },
48382
48523
  '/seam/customer/v1/connectors/sync': {
@@ -50684,56 +50825,6 @@ export default {
50684
50825
  'x-undocumented': 'Internal endpoint for customer portals.',
50685
50826
  },
50686
50827
  },
50687
- '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]': {
50688
- post: {
50689
- description: 'Receives webhook events from external connector APIs and processes them into partner resources.',
50690
- operationId: 'seamCustomerV1WebhooksConnectorsByWorkspaceIdByConnectorIdPost',
50691
- requestBody: {
50692
- content: {
50693
- 'application/json': { schema: { properties: {}, type: 'object' } },
50694
- },
50695
- },
50696
- responses: {
50697
- 200: {
50698
- content: {
50699
- 'application/json': {
50700
- schema: {
50701
- properties: {
50702
- error: { type: 'string' },
50703
- ok: { type: 'boolean' },
50704
- processed_events: { format: 'float', type: 'number' },
50705
- success: { type: 'boolean' },
50706
- },
50707
- required: ['success', 'processed_events', 'ok'],
50708
- type: 'object',
50709
- },
50710
- },
50711
- },
50712
- description: 'OK',
50713
- },
50714
- 400: { description: 'Bad Request' },
50715
- 401: { description: 'Unauthorized' },
50716
- },
50717
- security: [
50718
- { pat_with_workspace: [] },
50719
- { console_session_with_workspace: [] },
50720
- { api_key: [] },
50721
- ],
50722
- summary: '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]',
50723
- tags: ['/webhooks'],
50724
- 'x-fern-sdk-group-name': [
50725
- 'seam',
50726
- 'customer',
50727
- 'v1',
50728
- 'webhooks',
50729
- 'connectors',
50730
- '[workspace_id]',
50731
- ],
50732
- 'x-fern-sdk-method-name': 'by_connector_id',
50733
- 'x-response-key': null,
50734
- 'x-title': 'Connector Webhook Endpoint',
50735
- },
50736
- },
50737
50828
  '/seam/instant_key/v1/client_sessions/exchange_short_code': {
50738
50829
  post: {
50739
50830
  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.',