@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
package/dist/connect.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: {
|
|
@@ -54192,7 +54192,7 @@ var openapi_default = {
|
|
|
54192
54192
|
type: "string"
|
|
54193
54193
|
}
|
|
54194
54194
|
},
|
|
54195
|
-
required: ["connector_type", "
|
|
54195
|
+
required: ["connector_type", "config"],
|
|
54196
54196
|
type: "object"
|
|
54197
54197
|
}
|
|
54198
54198
|
}
|
|
@@ -54250,14 +54250,151 @@ var openapi_default = {
|
|
|
54250
54250
|
400: { description: "Bad Request" },
|
|
54251
54251
|
401: { description: "Unauthorized" }
|
|
54252
54252
|
},
|
|
54253
|
-
security: [
|
|
54253
|
+
security: [
|
|
54254
|
+
{ api_key: [] },
|
|
54255
|
+
{ client_session_with_customer: [] },
|
|
54256
|
+
{ console_session_with_workspace: [] }
|
|
54257
|
+
],
|
|
54254
54258
|
summary: "/seam/customer/v1/connectors/create",
|
|
54255
54259
|
tags: [],
|
|
54256
54260
|
"x-fern-sdk-group-name": ["seam", "customer", "v1", "connectors"],
|
|
54257
54261
|
"x-fern-sdk-method-name": "create",
|
|
54258
54262
|
"x-fern-sdk-return-value": "connector",
|
|
54259
54263
|
"x-response-key": "connector",
|
|
54260
|
-
"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."
|
|
54261
54398
|
}
|
|
54262
54399
|
},
|
|
54263
54400
|
"/seam/customer/v1/connectors/sync": {
|
|
@@ -56348,6 +56485,187 @@ var openapi_default = {
|
|
|
56348
56485
|
"x-title": "List Spaces"
|
|
56349
56486
|
}
|
|
56350
56487
|
},
|
|
56488
|
+
"/seam/customer/v1/staff_members/get": {
|
|
56489
|
+
get: {
|
|
56490
|
+
description: "Returns a staff member for a specific customer.",
|
|
56491
|
+
operationId: "seamCustomerV1StaffMembersGetGet",
|
|
56492
|
+
parameters: [
|
|
56493
|
+
{
|
|
56494
|
+
in: "query",
|
|
56495
|
+
name: "staff_member_key",
|
|
56496
|
+
required: true,
|
|
56497
|
+
schema: {
|
|
56498
|
+
description: "Key of staff member to get.",
|
|
56499
|
+
type: "string"
|
|
56500
|
+
}
|
|
56501
|
+
}
|
|
56502
|
+
],
|
|
56503
|
+
responses: {
|
|
56504
|
+
200: {
|
|
56505
|
+
content: {
|
|
56506
|
+
"application/json": {
|
|
56507
|
+
schema: {
|
|
56508
|
+
properties: {
|
|
56509
|
+
access_grant: { $ref: "#/components/schemas/access_grant" },
|
|
56510
|
+
ok: { type: "boolean" },
|
|
56511
|
+
spaces: {
|
|
56512
|
+
items: {
|
|
56513
|
+
properties: {
|
|
56514
|
+
child_space_keys: {
|
|
56515
|
+
items: { type: "string" },
|
|
56516
|
+
type: "array"
|
|
56517
|
+
},
|
|
56518
|
+
space_key: { type: "string" }
|
|
56519
|
+
},
|
|
56520
|
+
required: ["space_key"],
|
|
56521
|
+
type: "object"
|
|
56522
|
+
},
|
|
56523
|
+
type: "array"
|
|
56524
|
+
},
|
|
56525
|
+
staff_member: {
|
|
56526
|
+
description: "Represents a staff member for a specific customer.",
|
|
56527
|
+
properties: {
|
|
56528
|
+
email_address: {
|
|
56529
|
+
description: "Email address associated with the user identity.",
|
|
56530
|
+
type: "string"
|
|
56531
|
+
},
|
|
56532
|
+
name: {
|
|
56533
|
+
description: "Your display name for this user identity resource.",
|
|
56534
|
+
type: "string"
|
|
56535
|
+
},
|
|
56536
|
+
phone_number: {
|
|
56537
|
+
description: "Phone number associated with the user identity.",
|
|
56538
|
+
type: "string"
|
|
56539
|
+
},
|
|
56540
|
+
space_keys: {
|
|
56541
|
+
description: "List of unique identifiers for the spaces the staff member is associated with.",
|
|
56542
|
+
items: { type: "string" },
|
|
56543
|
+
type: "array"
|
|
56544
|
+
},
|
|
56545
|
+
staff_member_key: {
|
|
56546
|
+
description: "Your unique identifier for the staff.",
|
|
56547
|
+
type: "string"
|
|
56548
|
+
},
|
|
56549
|
+
user_identity_id: { format: "uuid", type: "string" }
|
|
56550
|
+
},
|
|
56551
|
+
required: ["staff_member_key", "name"],
|
|
56552
|
+
type: "object",
|
|
56553
|
+
"x-route-path": "/seam/customer/v1/staff_members"
|
|
56554
|
+
}
|
|
56555
|
+
},
|
|
56556
|
+
required: ["access_grant", "spaces", "staff_member", "ok"],
|
|
56557
|
+
type: "object"
|
|
56558
|
+
}
|
|
56559
|
+
}
|
|
56560
|
+
},
|
|
56561
|
+
description: "OK"
|
|
56562
|
+
},
|
|
56563
|
+
400: { description: "Bad Request" },
|
|
56564
|
+
401: { description: "Unauthorized" }
|
|
56565
|
+
},
|
|
56566
|
+
security: [{ client_session_with_customer: [] }],
|
|
56567
|
+
summary: "/seam/customer/v1/staff_members/get",
|
|
56568
|
+
tags: [],
|
|
56569
|
+
"x-fern-sdk-group-name": ["seam", "customer", "v1", "staff_members"],
|
|
56570
|
+
"x-fern-sdk-method-name": "get",
|
|
56571
|
+
"x-fern-sdk-return-value": "staff_member",
|
|
56572
|
+
"x-response-key": "staff_member",
|
|
56573
|
+
"x-title": "Get Staff Member",
|
|
56574
|
+
"x-undocumented": "Internal endpoint for customer portals."
|
|
56575
|
+
},
|
|
56576
|
+
post: {
|
|
56577
|
+
description: "Returns a staff member for a specific customer.",
|
|
56578
|
+
operationId: "seamCustomerV1StaffMembersGetPost",
|
|
56579
|
+
requestBody: {
|
|
56580
|
+
content: {
|
|
56581
|
+
"application/json": {
|
|
56582
|
+
schema: {
|
|
56583
|
+
properties: {
|
|
56584
|
+
staff_member_key: {
|
|
56585
|
+
description: "Key of staff member to get.",
|
|
56586
|
+
type: "string"
|
|
56587
|
+
}
|
|
56588
|
+
},
|
|
56589
|
+
required: ["staff_member_key"],
|
|
56590
|
+
type: "object"
|
|
56591
|
+
}
|
|
56592
|
+
}
|
|
56593
|
+
}
|
|
56594
|
+
},
|
|
56595
|
+
responses: {
|
|
56596
|
+
200: {
|
|
56597
|
+
content: {
|
|
56598
|
+
"application/json": {
|
|
56599
|
+
schema: {
|
|
56600
|
+
properties: {
|
|
56601
|
+
access_grant: { $ref: "#/components/schemas/access_grant" },
|
|
56602
|
+
ok: { type: "boolean" },
|
|
56603
|
+
spaces: {
|
|
56604
|
+
items: {
|
|
56605
|
+
properties: {
|
|
56606
|
+
child_space_keys: {
|
|
56607
|
+
items: { type: "string" },
|
|
56608
|
+
type: "array"
|
|
56609
|
+
},
|
|
56610
|
+
space_key: { type: "string" }
|
|
56611
|
+
},
|
|
56612
|
+
required: ["space_key"],
|
|
56613
|
+
type: "object"
|
|
56614
|
+
},
|
|
56615
|
+
type: "array"
|
|
56616
|
+
},
|
|
56617
|
+
staff_member: {
|
|
56618
|
+
description: "Represents a staff member for a specific customer.",
|
|
56619
|
+
properties: {
|
|
56620
|
+
email_address: {
|
|
56621
|
+
description: "Email address associated with the user identity.",
|
|
56622
|
+
type: "string"
|
|
56623
|
+
},
|
|
56624
|
+
name: {
|
|
56625
|
+
description: "Your display name for this user identity resource.",
|
|
56626
|
+
type: "string"
|
|
56627
|
+
},
|
|
56628
|
+
phone_number: {
|
|
56629
|
+
description: "Phone number associated with the user identity.",
|
|
56630
|
+
type: "string"
|
|
56631
|
+
},
|
|
56632
|
+
space_keys: {
|
|
56633
|
+
description: "List of unique identifiers for the spaces the staff member is associated with.",
|
|
56634
|
+
items: { type: "string" },
|
|
56635
|
+
type: "array"
|
|
56636
|
+
},
|
|
56637
|
+
staff_member_key: {
|
|
56638
|
+
description: "Your unique identifier for the staff.",
|
|
56639
|
+
type: "string"
|
|
56640
|
+
},
|
|
56641
|
+
user_identity_id: { format: "uuid", type: "string" }
|
|
56642
|
+
},
|
|
56643
|
+
required: ["staff_member_key", "name"],
|
|
56644
|
+
type: "object",
|
|
56645
|
+
"x-route-path": "/seam/customer/v1/staff_members"
|
|
56646
|
+
}
|
|
56647
|
+
},
|
|
56648
|
+
required: ["access_grant", "spaces", "staff_member", "ok"],
|
|
56649
|
+
type: "object"
|
|
56650
|
+
}
|
|
56651
|
+
}
|
|
56652
|
+
},
|
|
56653
|
+
description: "OK"
|
|
56654
|
+
},
|
|
56655
|
+
400: { description: "Bad Request" },
|
|
56656
|
+
401: { description: "Unauthorized" }
|
|
56657
|
+
},
|
|
56658
|
+
security: [{ client_session_with_customer: [] }],
|
|
56659
|
+
summary: "/seam/customer/v1/staff_members/get",
|
|
56660
|
+
tags: [],
|
|
56661
|
+
"x-fern-sdk-group-name": ["seam", "customer", "v1", "staff_members"],
|
|
56662
|
+
"x-fern-sdk-method-name": "get",
|
|
56663
|
+
"x-fern-sdk-return-value": "staff_member",
|
|
56664
|
+
"x-response-key": "staff_member",
|
|
56665
|
+
"x-title": "Get Staff Member",
|
|
56666
|
+
"x-undocumented": "Internal endpoint for customer portals."
|
|
56667
|
+
}
|
|
56668
|
+
},
|
|
56351
56669
|
"/seam/customer/v1/staff_members/list": {
|
|
56352
56670
|
get: {
|
|
56353
56671
|
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.",
|