@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.
@@ -57281,13 +57281,14 @@ export type Routes = {
57281
57281
  /** Type of connector to create */
57282
57282
  connector_type: 'mews' | 'mock';
57283
57283
  /** Key identifying the customer */
57284
- customer_key: string;
57284
+ customer_key?: string | undefined;
57285
57285
  /** Instance-specific configuration for the connector */
57286
57286
  config: {
57287
- client_token: string;
57288
- access_token: string;
57289
- client: string;
57287
+ client_token?: string | undefined;
57288
+ access_token?: string | undefined;
57289
+ client?: string;
57290
57290
  enterprise_ids?: string[] | undefined;
57291
+ enterprise_id?: string | undefined;
57291
57292
  } | {};
57292
57293
  };
57293
57294
  commonParams: {};
@@ -57307,6 +57308,26 @@ export type Routes = {
57307
57308
  };
57308
57309
  };
57309
57310
  };
57311
+ '/seam/customer/v1/connectors/list': {
57312
+ route: '/seam/customer/v1/connectors/list';
57313
+ method: 'GET' | 'POST';
57314
+ queryParams: {};
57315
+ jsonBody: {};
57316
+ commonParams: {};
57317
+ formData: {};
57318
+ jsonResponse: {
57319
+ connectors: {
57320
+ connector_id: string;
57321
+ connector_type: string;
57322
+ status: 'active' | 'inactive' | 'error';
57323
+ config: {
57324
+ [x: string]: any;
57325
+ };
57326
+ created_at: string;
57327
+ updated_at: string;
57328
+ }[];
57329
+ };
57330
+ };
57310
57331
  '/seam/customer/v1/connectors/sync': {
57311
57332
  route: '/seam/customer/v1/connectors/sync';
57312
57333
  method: 'POST';
@@ -59593,19 +59614,6 @@ export type Routes = {
59593
59614
  };
59594
59615
  };
59595
59616
  };
59596
- '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]': {
59597
- route: '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]';
59598
- method: 'POST';
59599
- queryParams: {};
59600
- jsonBody: {};
59601
- commonParams: {};
59602
- formData: {};
59603
- jsonResponse: {
59604
- success: boolean;
59605
- processed_events: number;
59606
- error?: string | undefined;
59607
- };
59608
- };
59609
59617
  '/seam/instant_key/v1/client_sessions/exchange_short_code': {
59610
59618
  route: '/seam/instant_key/v1/client_sessions/exchange_short_code';
59611
59619
  method: 'POST';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.622.0",
3
+ "version": "1.624.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -52463,7 +52463,7 @@ export default {
52463
52463
  '/seam/customer/v1/connectors/create': {
52464
52464
  post: {
52465
52465
  description:
52466
- 'Creates a new connector for a customer in a workspace. The connector will be activated and start syncing data from the external API.',
52466
+ '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.',
52467
52467
  operationId: 'seamCustomerV1ConnectorsCreatePost',
52468
52468
  requestBody: {
52469
52469
  content: {
@@ -52477,14 +52477,18 @@ export default {
52477
52477
  {
52478
52478
  properties: {
52479
52479
  access_token: { minLength: 1, type: 'string' },
52480
- client: { minLength: 1, type: 'string' },
52480
+ client: {
52481
+ default: 'seam',
52482
+ minLength: 1,
52483
+ type: 'string',
52484
+ },
52481
52485
  client_token: { minLength: 1, type: 'string' },
52486
+ enterprise_id: { format: 'uuid', type: 'string' },
52482
52487
  enterprise_ids: {
52483
52488
  items: { format: 'uuid', type: 'string' },
52484
52489
  type: 'array',
52485
52490
  },
52486
52491
  },
52487
- required: ['client_token', 'access_token', 'client'],
52488
52492
  type: 'object',
52489
52493
  },
52490
52494
  { properties: {}, type: 'object' },
@@ -52501,7 +52505,7 @@ export default {
52501
52505
  type: 'string',
52502
52506
  },
52503
52507
  },
52504
- required: ['connector_type', 'customer_key', 'config'],
52508
+ required: ['connector_type', 'config'],
52505
52509
  type: 'object',
52506
52510
  },
52507
52511
  },
@@ -52559,7 +52563,11 @@ export default {
52559
52563
  400: { description: 'Bad Request' },
52560
52564
  401: { description: 'Unauthorized' },
52561
52565
  },
52562
- security: [{ api_key: [] }],
52566
+ security: [
52567
+ { api_key: [] },
52568
+ { client_session_with_customer: [] },
52569
+ { console_session_with_workspace: [] },
52570
+ ],
52563
52571
  summary: '/seam/customer/v1/connectors/create',
52564
52572
  tags: [],
52565
52573
  'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'connectors'],
@@ -52567,6 +52575,141 @@ export default {
52567
52575
  'x-fern-sdk-return-value': 'connector',
52568
52576
  'x-response-key': 'connector',
52569
52577
  'x-title': 'Create Connector',
52578
+ 'x-undocumented': 'Internal endpoint for Console.',
52579
+ },
52580
+ },
52581
+ '/seam/customer/v1/connectors/list': {
52582
+ get: {
52583
+ description:
52584
+ 'Lists connectors for a workspace (API key auth) or for a specific customer (customer client session auth).',
52585
+ operationId: 'seamCustomerV1ConnectorsListGet',
52586
+ responses: {
52587
+ 200: {
52588
+ content: {
52589
+ 'application/json': {
52590
+ schema: {
52591
+ properties: {
52592
+ connectors: {
52593
+ items: {
52594
+ properties: {
52595
+ config: {
52596
+ additionalProperties: {
52597
+ $ref: '#/components/schemas/access_code',
52598
+ },
52599
+ type: 'object',
52600
+ },
52601
+ connector_id: { type: 'string' },
52602
+ connector_type: { type: 'string' },
52603
+ created_at: { type: 'string' },
52604
+ status: {
52605
+ enum: ['active', 'inactive', 'error'],
52606
+ type: 'string',
52607
+ },
52608
+ updated_at: { type: 'string' },
52609
+ },
52610
+ required: [
52611
+ 'connector_id',
52612
+ 'connector_type',
52613
+ 'status',
52614
+ 'config',
52615
+ 'created_at',
52616
+ 'updated_at',
52617
+ ],
52618
+ type: 'object',
52619
+ },
52620
+ type: 'array',
52621
+ },
52622
+ ok: { type: 'boolean' },
52623
+ },
52624
+ required: ['connectors', 'ok'],
52625
+ type: 'object',
52626
+ },
52627
+ },
52628
+ },
52629
+ description: 'OK',
52630
+ },
52631
+ 400: { description: 'Bad Request' },
52632
+ 401: { description: 'Unauthorized' },
52633
+ },
52634
+ security: [
52635
+ { api_key: [] },
52636
+ { client_session_with_customer: [] },
52637
+ { console_session_with_workspace: [] },
52638
+ ],
52639
+ summary: '/seam/customer/v1/connectors/list',
52640
+ tags: [],
52641
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'connectors'],
52642
+ 'x-fern-sdk-method-name': 'list',
52643
+ 'x-fern-sdk-return-value': 'connectors',
52644
+ 'x-response-key': 'connectors',
52645
+ 'x-title': 'List Connectors',
52646
+ 'x-undocumented': 'Internal endpoint for Console.',
52647
+ },
52648
+ post: {
52649
+ description:
52650
+ 'Lists connectors for a workspace (API key auth) or for a specific customer (customer client session auth).',
52651
+ operationId: 'seamCustomerV1ConnectorsListPost',
52652
+ responses: {
52653
+ 200: {
52654
+ content: {
52655
+ 'application/json': {
52656
+ schema: {
52657
+ properties: {
52658
+ connectors: {
52659
+ items: {
52660
+ properties: {
52661
+ config: {
52662
+ additionalProperties: {
52663
+ $ref: '#/components/schemas/access_code',
52664
+ },
52665
+ type: 'object',
52666
+ },
52667
+ connector_id: { type: 'string' },
52668
+ connector_type: { type: 'string' },
52669
+ created_at: { type: 'string' },
52670
+ status: {
52671
+ enum: ['active', 'inactive', 'error'],
52672
+ type: 'string',
52673
+ },
52674
+ updated_at: { type: 'string' },
52675
+ },
52676
+ required: [
52677
+ 'connector_id',
52678
+ 'connector_type',
52679
+ 'status',
52680
+ 'config',
52681
+ 'created_at',
52682
+ 'updated_at',
52683
+ ],
52684
+ type: 'object',
52685
+ },
52686
+ type: 'array',
52687
+ },
52688
+ ok: { type: 'boolean' },
52689
+ },
52690
+ required: ['connectors', 'ok'],
52691
+ type: 'object',
52692
+ },
52693
+ },
52694
+ },
52695
+ description: 'OK',
52696
+ },
52697
+ 400: { description: 'Bad Request' },
52698
+ 401: { description: 'Unauthorized' },
52699
+ },
52700
+ security: [
52701
+ { api_key: [] },
52702
+ { client_session_with_customer: [] },
52703
+ { console_session_with_workspace: [] },
52704
+ ],
52705
+ summary: '/seam/customer/v1/connectors/list',
52706
+ tags: [],
52707
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'connectors'],
52708
+ 'x-fern-sdk-method-name': 'list',
52709
+ 'x-fern-sdk-return-value': 'connectors',
52710
+ 'x-response-key': 'connectors',
52711
+ 'x-title': 'List Connectors',
52712
+ 'x-undocumented': 'Internal endpoint for Console.',
52570
52713
  },
52571
52714
  },
52572
52715
  '/seam/customer/v1/connectors/sync': {
@@ -54961,59 +55104,6 @@ export default {
54961
55104
  'x-undocumented': 'Internal endpoint for customer portals.',
54962
55105
  },
54963
55106
  },
54964
- '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]': {
54965
- post: {
54966
- description:
54967
- 'Receives webhook events from external connector APIs and processes them into partner resources.',
54968
- operationId:
54969
- 'seamCustomerV1WebhooksConnectorsByWorkspaceIdByConnectorIdPost',
54970
- requestBody: {
54971
- content: {
54972
- 'application/json': { schema: { properties: {}, type: 'object' } },
54973
- },
54974
- },
54975
- responses: {
54976
- 200: {
54977
- content: {
54978
- 'application/json': {
54979
- schema: {
54980
- properties: {
54981
- error: { type: 'string' },
54982
- ok: { type: 'boolean' },
54983
- processed_events: { format: 'float', type: 'number' },
54984
- success: { type: 'boolean' },
54985
- },
54986
- required: ['success', 'processed_events', 'ok'],
54987
- type: 'object',
54988
- },
54989
- },
54990
- },
54991
- description: 'OK',
54992
- },
54993
- 400: { description: 'Bad Request' },
54994
- 401: { description: 'Unauthorized' },
54995
- },
54996
- security: [
54997
- { pat_with_workspace: [] },
54998
- { console_session_with_workspace: [] },
54999
- { api_key: [] },
55000
- ],
55001
- summary:
55002
- '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]',
55003
- tags: ['/webhooks'],
55004
- 'x-fern-sdk-group-name': [
55005
- 'seam',
55006
- 'customer',
55007
- 'v1',
55008
- 'webhooks',
55009
- 'connectors',
55010
- '[workspace_id]',
55011
- ],
55012
- 'x-fern-sdk-method-name': 'by_connector_id',
55013
- 'x-response-key': null,
55014
- 'x-title': 'Connector Webhook Endpoint',
55015
- },
55016
- },
55017
55107
  '/seam/instant_key/v1/client_sessions/exchange_short_code': {
55018
55108
  post: {
55019
55109
  description:
@@ -68095,14 +68095,15 @@ export type Routes = {
68095
68095
  /** Type of connector to create */
68096
68096
  connector_type: 'mews' | 'mock'
68097
68097
  /** Key identifying the customer */
68098
- customer_key: string
68098
+ customer_key?: string | undefined
68099
68099
  /** Instance-specific configuration for the connector */
68100
68100
  config:
68101
68101
  | {
68102
- client_token: string
68103
- access_token: string
68104
- client: string
68102
+ client_token?: string | undefined
68103
+ access_token?: string | undefined
68104
+ client?: string
68105
68105
  enterprise_ids?: string[] | undefined
68106
+ enterprise_id?: string | undefined
68106
68107
  }
68107
68108
  | {}
68108
68109
  }
@@ -68125,6 +68126,26 @@ export type Routes = {
68125
68126
  }
68126
68127
  }
68127
68128
  }
68129
+ '/seam/customer/v1/connectors/list': {
68130
+ route: '/seam/customer/v1/connectors/list'
68131
+ method: 'GET' | 'POST'
68132
+ queryParams: {}
68133
+ jsonBody: {}
68134
+ commonParams: {}
68135
+ formData: {}
68136
+ jsonResponse: {
68137
+ connectors: {
68138
+ connector_id: string
68139
+ connector_type: string
68140
+ status: 'active' | 'inactive' | 'error'
68141
+ config: {
68142
+ [x: string]: any
68143
+ }
68144
+ created_at: string
68145
+ updated_at: string
68146
+ }[]
68147
+ }
68148
+ }
68128
68149
  '/seam/customer/v1/connectors/sync': {
68129
68150
  route: '/seam/customer/v1/connectors/sync'
68130
68151
  method: 'POST'
@@ -70977,19 +70998,6 @@ export type Routes = {
70977
70998
  }
70978
70999
  }
70979
71000
  }
70980
- '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]': {
70981
- route: '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]'
70982
- method: 'POST'
70983
- queryParams: {}
70984
- jsonBody: {}
70985
- commonParams: {}
70986
- formData: {}
70987
- jsonResponse: {
70988
- success: boolean
70989
- processed_events: number
70990
- error?: string | undefined
70991
- }
70992
- }
70993
71001
  '/seam/instant_key/v1/client_sessions/exchange_short_code': {
70994
71002
  route: '/seam/instant_key/v1/client_sessions/exchange_short_code'
70995
71003
  method: 'POST'