@seamapi/types 1.624.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 +181 -0
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +306 -0
- package/dist/index.cjs +181 -0
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/openapi.d.ts +217 -0
- package/lib/seam/connect/openapi.js +181 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +89 -0
- package/package.json +1 -1
- package/src/lib/seam/connect/openapi.ts +191 -0
- package/src/lib/seam/connect/route-types.ts +89 -0
package/dist/connect.cjs
CHANGED
|
@@ -56485,6 +56485,187 @@ var openapi_default = {
|
|
|
56485
56485
|
"x-title": "List Spaces"
|
|
56486
56486
|
}
|
|
56487
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
|
+
},
|
|
56488
56669
|
"/seam/customer/v1/staff_members/list": {
|
|
56489
56670
|
get: {
|
|
56490
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.",
|