@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.
@@ -95295,6 +95295,7 @@ declare const _default: {
95295
95295
  type: string;
95296
95296
  };
95297
95297
  client: {
95298
+ default: string;
95298
95299
  minLength: number;
95299
95300
  type: string;
95300
95301
  };
@@ -95302,6 +95303,10 @@ declare const _default: {
95302
95303
  minLength: number;
95303
95304
  type: string;
95304
95305
  };
95306
+ enterprise_id: {
95307
+ format: string;
95308
+ type: string;
95309
+ };
95305
95310
  enterprise_ids: {
95306
95311
  items: {
95307
95312
  format: string;
@@ -95310,17 +95315,16 @@ declare const _default: {
95310
95315
  type: string;
95311
95316
  };
95312
95317
  };
95313
- required: string[];
95314
95318
  type: string;
95315
95319
  } | {
95316
95320
  properties: {
95317
95321
  access_token?: never;
95318
95322
  client?: never;
95319
95323
  client_token?: never;
95324
+ enterprise_id?: never;
95320
95325
  enterprise_ids?: never;
95321
95326
  };
95322
95327
  type: string;
95323
- required?: never;
95324
95328
  })[];
95325
95329
  };
95326
95330
  connector_type: {
@@ -95405,9 +95409,181 @@ declare const _default: {
95405
95409
  description: string;
95406
95410
  };
95407
95411
  };
95408
- security: {
95412
+ security: ({
95409
95413
  api_key: never[];
95410
- }[];
95414
+ client_session_with_customer?: never;
95415
+ console_session_with_workspace?: never;
95416
+ } | {
95417
+ client_session_with_customer: never[];
95418
+ api_key?: never;
95419
+ console_session_with_workspace?: never;
95420
+ } | {
95421
+ console_session_with_workspace: never[];
95422
+ api_key?: never;
95423
+ client_session_with_customer?: never;
95424
+ })[];
95425
+ summary: string;
95426
+ tags: never[];
95427
+ 'x-fern-sdk-group-name': string[];
95428
+ 'x-fern-sdk-method-name': string;
95429
+ 'x-fern-sdk-return-value': string;
95430
+ 'x-response-key': string;
95431
+ 'x-title': string;
95432
+ 'x-undocumented': string;
95433
+ };
95434
+ };
95435
+ '/seam/customer/v1/connectors/list': {
95436
+ get: {
95437
+ description: string;
95438
+ operationId: string;
95439
+ responses: {
95440
+ 200: {
95441
+ content: {
95442
+ 'application/json': {
95443
+ schema: {
95444
+ properties: {
95445
+ connectors: {
95446
+ items: {
95447
+ properties: {
95448
+ config: {
95449
+ additionalProperties: {
95450
+ $ref: string;
95451
+ };
95452
+ type: string;
95453
+ };
95454
+ connector_id: {
95455
+ type: string;
95456
+ };
95457
+ connector_type: {
95458
+ type: string;
95459
+ };
95460
+ created_at: {
95461
+ type: string;
95462
+ };
95463
+ status: {
95464
+ enum: string[];
95465
+ type: string;
95466
+ };
95467
+ updated_at: {
95468
+ type: string;
95469
+ };
95470
+ };
95471
+ required: string[];
95472
+ type: string;
95473
+ };
95474
+ type: string;
95475
+ };
95476
+ ok: {
95477
+ type: string;
95478
+ };
95479
+ };
95480
+ required: string[];
95481
+ type: string;
95482
+ };
95483
+ };
95484
+ };
95485
+ description: string;
95486
+ };
95487
+ 400: {
95488
+ description: string;
95489
+ };
95490
+ 401: {
95491
+ description: string;
95492
+ };
95493
+ };
95494
+ security: ({
95495
+ api_key: never[];
95496
+ client_session_with_customer?: never;
95497
+ console_session_with_workspace?: never;
95498
+ } | {
95499
+ client_session_with_customer: never[];
95500
+ api_key?: never;
95501
+ console_session_with_workspace?: never;
95502
+ } | {
95503
+ console_session_with_workspace: never[];
95504
+ api_key?: never;
95505
+ client_session_with_customer?: never;
95506
+ })[];
95507
+ summary: string;
95508
+ tags: never[];
95509
+ 'x-fern-sdk-group-name': string[];
95510
+ 'x-fern-sdk-method-name': string;
95511
+ 'x-fern-sdk-return-value': string;
95512
+ 'x-response-key': string;
95513
+ 'x-title': string;
95514
+ 'x-undocumented': string;
95515
+ };
95516
+ post: {
95517
+ description: string;
95518
+ operationId: string;
95519
+ responses: {
95520
+ 200: {
95521
+ content: {
95522
+ 'application/json': {
95523
+ schema: {
95524
+ properties: {
95525
+ connectors: {
95526
+ items: {
95527
+ properties: {
95528
+ config: {
95529
+ additionalProperties: {
95530
+ $ref: string;
95531
+ };
95532
+ type: string;
95533
+ };
95534
+ connector_id: {
95535
+ type: string;
95536
+ };
95537
+ connector_type: {
95538
+ type: string;
95539
+ };
95540
+ created_at: {
95541
+ type: string;
95542
+ };
95543
+ status: {
95544
+ enum: string[];
95545
+ type: string;
95546
+ };
95547
+ updated_at: {
95548
+ type: string;
95549
+ };
95550
+ };
95551
+ required: string[];
95552
+ type: string;
95553
+ };
95554
+ type: string;
95555
+ };
95556
+ ok: {
95557
+ type: string;
95558
+ };
95559
+ };
95560
+ required: string[];
95561
+ type: string;
95562
+ };
95563
+ };
95564
+ };
95565
+ description: string;
95566
+ };
95567
+ 400: {
95568
+ description: string;
95569
+ };
95570
+ 401: {
95571
+ description: string;
95572
+ };
95573
+ };
95574
+ security: ({
95575
+ api_key: never[];
95576
+ client_session_with_customer?: never;
95577
+ console_session_with_workspace?: never;
95578
+ } | {
95579
+ client_session_with_customer: never[];
95580
+ api_key?: never;
95581
+ console_session_with_workspace?: never;
95582
+ } | {
95583
+ console_session_with_workspace: never[];
95584
+ api_key?: never;
95585
+ client_session_with_customer?: never;
95586
+ })[];
95411
95587
  summary: string;
95412
95588
  tags: never[];
95413
95589
  'x-fern-sdk-group-name': string[];
@@ -95415,6 +95591,7 @@ declare const _default: {
95415
95591
  'x-fern-sdk-return-value': string;
95416
95592
  'x-response-key': string;
95417
95593
  'x-title': string;
95594
+ 'x-undocumented': string;
95418
95595
  };
95419
95596
  };
95420
95597
  '/seam/customer/v1/connectors/sync': {
@@ -97830,75 +98007,6 @@ declare const _default: {
97830
98007
  'x-undocumented': string;
97831
98008
  };
97832
98009
  };
97833
- '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]': {
97834
- post: {
97835
- description: string;
97836
- operationId: string;
97837
- requestBody: {
97838
- content: {
97839
- 'application/json': {
97840
- schema: {
97841
- properties: {};
97842
- type: string;
97843
- };
97844
- };
97845
- };
97846
- };
97847
- responses: {
97848
- 200: {
97849
- content: {
97850
- 'application/json': {
97851
- schema: {
97852
- properties: {
97853
- error: {
97854
- type: string;
97855
- };
97856
- ok: {
97857
- type: string;
97858
- };
97859
- processed_events: {
97860
- format: string;
97861
- type: string;
97862
- };
97863
- success: {
97864
- type: string;
97865
- };
97866
- };
97867
- required: string[];
97868
- type: string;
97869
- };
97870
- };
97871
- };
97872
- description: string;
97873
- };
97874
- 400: {
97875
- description: string;
97876
- };
97877
- 401: {
97878
- description: string;
97879
- };
97880
- };
97881
- security: ({
97882
- pat_with_workspace: never[];
97883
- console_session_with_workspace?: never;
97884
- api_key?: never;
97885
- } | {
97886
- console_session_with_workspace: never[];
97887
- pat_with_workspace?: never;
97888
- api_key?: never;
97889
- } | {
97890
- api_key: never[];
97891
- pat_with_workspace?: never;
97892
- console_session_with_workspace?: never;
97893
- })[];
97894
- summary: string;
97895
- tags: string[];
97896
- 'x-fern-sdk-group-name': string[];
97897
- 'x-fern-sdk-method-name': string;
97898
- 'x-response-key': null;
97899
- 'x-title': string;
97900
- };
97901
- };
97902
98010
  '/seam/instant_key/v1/client_sessions/exchange_short_code': {
97903
98011
  post: {
97904
98012
  description: string;
@@ -167593,13 +167701,14 @@ type Routes = {
167593
167701
  /** Type of connector to create */
167594
167702
  connector_type: 'mews' | 'mock';
167595
167703
  /** Key identifying the customer */
167596
- customer_key: string;
167704
+ customer_key?: string | undefined;
167597
167705
  /** Instance-specific configuration for the connector */
167598
167706
  config: {
167599
- client_token: string;
167600
- access_token: string;
167601
- client: string;
167707
+ client_token?: string | undefined;
167708
+ access_token?: string | undefined;
167709
+ client?: string;
167602
167710
  enterprise_ids?: string[] | undefined;
167711
+ enterprise_id?: string | undefined;
167603
167712
  } | {};
167604
167713
  };
167605
167714
  commonParams: {};
@@ -167619,6 +167728,26 @@ type Routes = {
167619
167728
  };
167620
167729
  };
167621
167730
  };
167731
+ '/seam/customer/v1/connectors/list': {
167732
+ route: '/seam/customer/v1/connectors/list';
167733
+ method: 'GET' | 'POST';
167734
+ queryParams: {};
167735
+ jsonBody: {};
167736
+ commonParams: {};
167737
+ formData: {};
167738
+ jsonResponse: {
167739
+ connectors: {
167740
+ connector_id: string;
167741
+ connector_type: string;
167742
+ status: 'active' | 'inactive' | 'error';
167743
+ config: {
167744
+ [x: string]: any;
167745
+ };
167746
+ created_at: string;
167747
+ updated_at: string;
167748
+ }[];
167749
+ };
167750
+ };
167622
167751
  '/seam/customer/v1/connectors/sync': {
167623
167752
  route: '/seam/customer/v1/connectors/sync';
167624
167753
  method: 'POST';
@@ -169905,19 +170034,6 @@ type Routes = {
169905
170034
  };
169906
170035
  };
169907
170036
  };
169908
- '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]': {
169909
- route: '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]';
169910
- method: 'POST';
169911
- queryParams: {};
169912
- jsonBody: {};
169913
- commonParams: {};
169914
- formData: {};
169915
- jsonResponse: {
169916
- success: boolean;
169917
- processed_events: number;
169918
- error?: string | undefined;
169919
- };
169920
- };
169921
170037
  '/seam/instant_key/v1/client_sessions/exchange_short_code': {
169922
170038
  route: '/seam/instant_key/v1/client_sessions/exchange_short_code';
169923
170039
  method: 'POST';
package/dist/index.cjs CHANGED
@@ -54151,7 +54151,7 @@ var openapi_default = {
54151
54151
  },
54152
54152
  "/seam/customer/v1/connectors/create": {
54153
54153
  post: {
54154
- description: "Creates a new connector for a customer in a workspace. The connector will be activated and start syncing data from the external API.",
54154
+ 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.",
54155
54155
  operationId: "seamCustomerV1ConnectorsCreatePost",
54156
54156
  requestBody: {
54157
54157
  content: {
@@ -54164,14 +54164,18 @@ var openapi_default = {
54164
54164
  {
54165
54165
  properties: {
54166
54166
  access_token: { minLength: 1, type: "string" },
54167
- client: { minLength: 1, type: "string" },
54167
+ client: {
54168
+ default: "seam",
54169
+ minLength: 1,
54170
+ type: "string"
54171
+ },
54168
54172
  client_token: { minLength: 1, type: "string" },
54173
+ enterprise_id: { format: "uuid", type: "string" },
54169
54174
  enterprise_ids: {
54170
54175
  items: { format: "uuid", type: "string" },
54171
54176
  type: "array"
54172
54177
  }
54173
54178
  },
54174
- required: ["client_token", "access_token", "client"],
54175
54179
  type: "object"
54176
54180
  },
54177
54181
  { properties: {}, type: "object" }
@@ -54188,7 +54192,7 @@ var openapi_default = {
54188
54192
  type: "string"
54189
54193
  }
54190
54194
  },
54191
- required: ["connector_type", "customer_key", "config"],
54195
+ required: ["connector_type", "config"],
54192
54196
  type: "object"
54193
54197
  }
54194
54198
  }
@@ -54246,14 +54250,151 @@ var openapi_default = {
54246
54250
  400: { description: "Bad Request" },
54247
54251
  401: { description: "Unauthorized" }
54248
54252
  },
54249
- security: [{ api_key: [] }],
54253
+ security: [
54254
+ { api_key: [] },
54255
+ { client_session_with_customer: [] },
54256
+ { console_session_with_workspace: [] }
54257
+ ],
54250
54258
  summary: "/seam/customer/v1/connectors/create",
54251
54259
  tags: [],
54252
54260
  "x-fern-sdk-group-name": ["seam", "customer", "v1", "connectors"],
54253
54261
  "x-fern-sdk-method-name": "create",
54254
54262
  "x-fern-sdk-return-value": "connector",
54255
54263
  "x-response-key": "connector",
54256
- "x-title": "Create Connector"
54264
+ "x-title": "Create Connector",
54265
+ "x-undocumented": "Internal endpoint for Console."
54266
+ }
54267
+ },
54268
+ "/seam/customer/v1/connectors/list": {
54269
+ get: {
54270
+ description: "Lists connectors for a workspace (API key auth) or for a specific customer (customer client session auth).",
54271
+ operationId: "seamCustomerV1ConnectorsListGet",
54272
+ responses: {
54273
+ 200: {
54274
+ content: {
54275
+ "application/json": {
54276
+ schema: {
54277
+ properties: {
54278
+ connectors: {
54279
+ items: {
54280
+ properties: {
54281
+ config: {
54282
+ additionalProperties: {
54283
+ $ref: "#/components/schemas/access_code"
54284
+ },
54285
+ type: "object"
54286
+ },
54287
+ connector_id: { type: "string" },
54288
+ connector_type: { type: "string" },
54289
+ created_at: { type: "string" },
54290
+ status: {
54291
+ enum: ["active", "inactive", "error"],
54292
+ type: "string"
54293
+ },
54294
+ updated_at: { type: "string" }
54295
+ },
54296
+ required: [
54297
+ "connector_id",
54298
+ "connector_type",
54299
+ "status",
54300
+ "config",
54301
+ "created_at",
54302
+ "updated_at"
54303
+ ],
54304
+ type: "object"
54305
+ },
54306
+ type: "array"
54307
+ },
54308
+ ok: { type: "boolean" }
54309
+ },
54310
+ required: ["connectors", "ok"],
54311
+ type: "object"
54312
+ }
54313
+ }
54314
+ },
54315
+ description: "OK"
54316
+ },
54317
+ 400: { description: "Bad Request" },
54318
+ 401: { description: "Unauthorized" }
54319
+ },
54320
+ security: [
54321
+ { api_key: [] },
54322
+ { client_session_with_customer: [] },
54323
+ { console_session_with_workspace: [] }
54324
+ ],
54325
+ summary: "/seam/customer/v1/connectors/list",
54326
+ tags: [],
54327
+ "x-fern-sdk-group-name": ["seam", "customer", "v1", "connectors"],
54328
+ "x-fern-sdk-method-name": "list",
54329
+ "x-fern-sdk-return-value": "connectors",
54330
+ "x-response-key": "connectors",
54331
+ "x-title": "List Connectors",
54332
+ "x-undocumented": "Internal endpoint for Console."
54333
+ },
54334
+ post: {
54335
+ description: "Lists connectors for a workspace (API key auth) or for a specific customer (customer client session auth).",
54336
+ operationId: "seamCustomerV1ConnectorsListPost",
54337
+ responses: {
54338
+ 200: {
54339
+ content: {
54340
+ "application/json": {
54341
+ schema: {
54342
+ properties: {
54343
+ connectors: {
54344
+ items: {
54345
+ properties: {
54346
+ config: {
54347
+ additionalProperties: {
54348
+ $ref: "#/components/schemas/access_code"
54349
+ },
54350
+ type: "object"
54351
+ },
54352
+ connector_id: { type: "string" },
54353
+ connector_type: { type: "string" },
54354
+ created_at: { type: "string" },
54355
+ status: {
54356
+ enum: ["active", "inactive", "error"],
54357
+ type: "string"
54358
+ },
54359
+ updated_at: { type: "string" }
54360
+ },
54361
+ required: [
54362
+ "connector_id",
54363
+ "connector_type",
54364
+ "status",
54365
+ "config",
54366
+ "created_at",
54367
+ "updated_at"
54368
+ ],
54369
+ type: "object"
54370
+ },
54371
+ type: "array"
54372
+ },
54373
+ ok: { type: "boolean" }
54374
+ },
54375
+ required: ["connectors", "ok"],
54376
+ type: "object"
54377
+ }
54378
+ }
54379
+ },
54380
+ description: "OK"
54381
+ },
54382
+ 400: { description: "Bad Request" },
54383
+ 401: { description: "Unauthorized" }
54384
+ },
54385
+ security: [
54386
+ { api_key: [] },
54387
+ { client_session_with_customer: [] },
54388
+ { console_session_with_workspace: [] }
54389
+ ],
54390
+ summary: "/seam/customer/v1/connectors/list",
54391
+ tags: [],
54392
+ "x-fern-sdk-group-name": ["seam", "customer", "v1", "connectors"],
54393
+ "x-fern-sdk-method-name": "list",
54394
+ "x-fern-sdk-return-value": "connectors",
54395
+ "x-response-key": "connectors",
54396
+ "x-title": "List Connectors",
54397
+ "x-undocumented": "Internal endpoint for Console."
54257
54398
  }
54258
54399
  },
54259
54400
  "/seam/customer/v1/connectors/sync": {
@@ -56561,56 +56702,6 @@ var openapi_default = {
56561
56702
  "x-undocumented": "Internal endpoint for customer portals."
56562
56703
  }
56563
56704
  },
56564
- "/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]": {
56565
- post: {
56566
- description: "Receives webhook events from external connector APIs and processes them into partner resources.",
56567
- operationId: "seamCustomerV1WebhooksConnectorsByWorkspaceIdByConnectorIdPost",
56568
- requestBody: {
56569
- content: {
56570
- "application/json": { schema: { properties: {}, type: "object" } }
56571
- }
56572
- },
56573
- responses: {
56574
- 200: {
56575
- content: {
56576
- "application/json": {
56577
- schema: {
56578
- properties: {
56579
- error: { type: "string" },
56580
- ok: { type: "boolean" },
56581
- processed_events: { format: "float", type: "number" },
56582
- success: { type: "boolean" }
56583
- },
56584
- required: ["success", "processed_events", "ok"],
56585
- type: "object"
56586
- }
56587
- }
56588
- },
56589
- description: "OK"
56590
- },
56591
- 400: { description: "Bad Request" },
56592
- 401: { description: "Unauthorized" }
56593
- },
56594
- security: [
56595
- { pat_with_workspace: [] },
56596
- { console_session_with_workspace: [] },
56597
- { api_key: [] }
56598
- ],
56599
- summary: "/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]",
56600
- tags: ["/webhooks"],
56601
- "x-fern-sdk-group-name": [
56602
- "seam",
56603
- "customer",
56604
- "v1",
56605
- "webhooks",
56606
- "connectors",
56607
- "[workspace_id]"
56608
- ],
56609
- "x-fern-sdk-method-name": "by_connector_id",
56610
- "x-response-key": null,
56611
- "x-title": "Connector Webhook Endpoint"
56612
- }
56613
- },
56614
56705
  "/seam/instant_key/v1/client_sessions/exchange_short_code": {
56615
56706
  post: {
56616
56707
  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.",