@platform/sdk-comms
Typed TypeScript client for services/comms. The page is generated from the SDK package source plus its generated OpenAPI types.
Installation
npm install @platform/sdk-commsYou’ll also need the shared auth/client helpers:
npm install @platform/hosts @platform/sdkQuick start
import { LoopClient } from "@platform/sdk";
import { platformHost, SERVICE_NAMES } from "@platform/hosts";
import { createCommsClient } from "@platform/sdk-comms";
const loop = new LoopClient({
clientId: process.env.LOOP_CLIENT_ID!,
clientSecret: process.env.LOOP_CLIENT_SECRET!,
redirectUri: "https://your-app.example.com/auth/loop/callback",
});
const comms = createCommsClient({
baseUrl: platformHost({ service: SERVICE_NAMES.COMMS }),
accessToken: tokens.access_token,
});Use the convenience helpers below when the SDK exposes them, or call the typed endpoint methods directly with GET / POST / PATCH / DELETE.
Convenience helpers
archive
Underlying REST endpoint: POST /v1/inbox/\{user_id\}/bulk-archive
Parameters
input: BulkActionInput
Return type
Promise<Result<{ updated: number }>>Example
const result = await comms.archive({
/* BulkActionInput */
});captureLead
Underlying REST endpoint: POST /v1/public/leads
Parameters
input: CaptureLeadBody
Return type
Promise<Result<CaptureLeadResponse>>Example
const result = await comms.captureLead({
/* CaptureLeadBody */
});countUnread
Underlying REST endpoint: GET /v1/inbox/\{user_id\}/unread-count
Parameters
userId: string
Return type
Promise<Result<{ count: number }>>Example
const result = await comms.countUnread("<userId>");createAskThread
Underlying REST endpoint: POST /v1/ask/threads
Parameters
input: CreateAskThreadInput
Return type
Promise<Result<AskThreadDetail>>Example
const result = await comms.createAskThread({
/* CreateAskThreadInput */
});createSupportTicket
Underlying REST endpoint: POST /v1/support/tickets
Parameters
input: SupportTicketInput
Return type
Promise<Result<SupportTicketResponse>>Example
const result = await comms.createSupportTicket({
/* SupportTicketInput */
});createThread
Underlying REST endpoint: POST /v1/threads
Parameters
body: CreateThreadBody
Return type
Promise<Result<ThreadResponse>>Example
const result = await comms.createThread({
/* CreateThreadBody */
});findThreadByParticipant
Underlying REST endpoint: GET /v1/threads
Parameters
participantId: string
Return type
Promise<Result<ThreadResponse>>Example
const result = await comms.findThreadByParticipant("<participantId>");getAskThread
Underlying REST endpoint: GET /v1/ask/threads/\{thread_id\}
Parameters
threadId: string
Return type
Promise<Result<AskThreadDetail>>Example
const result = await comms.getAskThread("<threadId>");getConsents
Underlying REST endpoint: GET /v1/consents/\{person_id\}
Parameters
personId: stringbrandId: string
Return type
Promise<Result<ConsentItem[]>>Example
const result = await comms.getConsents("<personId>", "<brandId>");getLeadByEmail
Underlying REST endpoint: GET /v1/leads
Parameters
email: string
Return type
Promise<Result<LeadResponse>>Example
const result = await comms.getLeadByEmail("<email>");getPreferences
Underlying REST endpoint: GET /v1/preferences/\{person_id\}
Parameters
personId: stringbrandId: string
Return type
Promise<Result<PreferenceItem[]>>Example
const result = await comms.getPreferences("<personId>", "<brandId>");getStreamChatToken
Underlying REST endpoint: GET /v1/stream/chat-token
Parameters
channelId?: string
Return type
Promise<Result<ChatTokenResponse>>Example
const result = await comms.getStreamChatToken("<channelId>");getStreamFeedsToken
Underlying REST endpoint: POST /v1/stream/feeds-token
Parameters
_feedSlug?: string
Return type
Promise<Result<FeedsTokenResponse>>Example
const result = await comms.getStreamFeedsToken("<_feedSlug>");getThread
Underlying REST endpoint: GET /v1/threads/\{id\}
Parameters
id: string
Return type
Promise<Result<ThreadResponse>>Example
const result = await comms.getThread("<id>");getVapidKey
Underlying REST endpoint: GET /v1/push/vapid-key
Parameters
None
Return type
Promise<Result<VapidKeyResponse>>Example
const result = await comms.getVapidKey();listAskThreads
Underlying REST endpoint: GET /v1/ask/threads
Parameters
opts?: ListAskThreadsOpts
Return type
Promise<Result<AskThreadSummary[]>>Example
const result = await comms.listAskThreads({
/* ListAskThreadsOpts */
});listNotifications
Underlying REST endpoint: GET /v1/inbox/\{person_id\}
Parameters
opts: ListNotificationsOpts
Return type
Promise<Result<InboxItem[]>>Example
const result = await comms.listNotifications({
/* ListNotificationsOpts */
});markRead
Underlying REST endpoint: POST /v1/inbox/\{user_id\}/bulk-read
Parameters
input: BulkActionInput
Return type
Promise<Result<{ updated: number }>>Example
const result = await comms.markRead({
/* BulkActionInput */
});sendAskReply
Underlying REST endpoint: POST /v1/ask/threads/\{thread_id\}/replies
Parameters
input: SendAskReplyInput
Return type
Promise<Result<AskMessage>>Example
const result = await comms.sendAskReply({
/* SendAskReplyInput */
});subscribePush
Underlying REST endpoint: POST /v1/push/subscriptions
Parameters
subscription: PushSubscribeBody
Return type
Promise<Result<PushSubscription>>Example
const result = await comms.subscribePush({
/* PushSubscribeBody */
});unsubscribePush
Underlying REST endpoint: DELETE /v1/push/subscriptions/by-endpoint/\{endpoint\}
Parameters
endpoint: string
Return type
Promise<Result<PushSubscription>>Example
const result = await comms.unsubscribePush("<endpoint>");updateConsent
Underlying REST endpoint: PUT /v1/consents
Parameters
input: ConsentUpdateBody
Return type
Promise<Result<ConsentResult>>Example
const result = await comms.updateConsent({
/* ConsentUpdateBody */
});updatePreferences
Underlying REST endpoint: PUT /v1/preferences
Parameters
input: PreferenceUpdateBody
Return type
Promise<Result<PreferenceResult>>Example
const result = await comms.updatePreferences({
/* PreferenceUpdateBody */
});Endpoint calls
GET /readyz
Underlying REST endpoint: GET /readyz
Parameters
None
Return type
Promise<{
data?: paths["/readyz"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.GET("/readyz");GET /u/unsub
Underlying REST endpoint: GET /u/unsub
Parameters
query: paths["/u/unsub"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/u/unsub"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.GET("/u/unsub", {
params: {
query: {
/* paths["/u/unsub"]["get"]["parameters"]["query"] */
},
},
});POST /u/unsub
Underlying REST endpoint: POST /u/unsub
Parameters
query: paths["/u/unsub"]["post"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/u/unsub"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/u/unsub", {
params: {
query: {
/* paths["/u/unsub"]["post"]["parameters"]["query"] */
},
},
});POST /v1/account-export-link
Underlying REST endpoint: POST /v1/account-export-link
Parameters
body: paths["/v1/account-export-link"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/account-export-link"]["post"]["responses"]["201"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/account-export-link", {
body: {
/* paths["/v1/account-export-link"]["post"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/admin/ask/coach-sla-overdue
Underlying REST endpoint: GET /v1/admin/ask/coach-sla-overdue
Parameters
query?: paths["/v1/admin/ask/coach-sla-overdue"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/admin/ask/coach-sla-overdue"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.GET("/v1/admin/ask/coach-sla-overdue", {
params: {
query: {
/* paths["/v1/admin/ask/coach-sla-overdue"]["get"]["parameters"]["query"] */
},
},
});GET /v1/admin/campaigns
Underlying REST endpoint: GET /v1/admin/campaigns
Parameters
query: paths["/v1/admin/campaigns"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/admin/campaigns"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.GET("/v1/admin/campaigns", {
params: {
query: {
/* paths["/v1/admin/campaigns"]["get"]["parameters"]["query"] */
},
},
});POST /v1/admin/campaigns
Underlying REST endpoint: POST /v1/admin/campaigns
Parameters
body?: paths["/v1/admin/campaigns"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/admin/campaigns"]["post"]["responses"]["201"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/admin/campaigns", {
body: {
/* paths["/v1/admin/campaigns"]["post"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/admin/campaigns/{id}
Underlying REST endpoint: GET /v1/admin/campaigns/\{id\}
Parameters
path: paths["/v1/admin/campaigns/{id}"]["get"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/admin/campaigns/{id}"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.GET("/v1/admin/campaigns/{id}", {
params: {
path: {
id: "<id>",
},
},
});PATCH /v1/admin/campaigns/{id}
Underlying REST endpoint: PATCH /v1/admin/campaigns/\{id\}
Parameters
path: paths["/v1/admin/campaigns/{id}"]["patch"]["parameters"]["path"]body?: paths["/v1/admin/campaigns/{id}"]["patch"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/admin/campaigns/{id}"]["patch"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.PATCH("/v1/admin/campaigns/{id}", {
params: {
path: {
id: "<id>",
},
},
body: {
/* paths["/v1/admin/campaigns/{id}"]["patch"]["requestBody"]["content"]["application/json"] */
},
});POST /v1/admin/campaigns/{id}/cancel
Underlying REST endpoint: POST /v1/admin/campaigns/\{id\}/cancel
Parameters
path: paths["/v1/admin/campaigns/{id}/cancel"]["post"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/admin/campaigns/{id}/cancel"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/admin/campaigns/{id}/cancel", {
params: {
path: {
id: "<id>",
},
},
});GET /v1/admin/campaigns/{id}/history
Underlying REST endpoint: GET /v1/admin/campaigns/\{id\}/history
Parameters
path: paths["/v1/admin/campaigns/{id}/history"]["get"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/admin/campaigns/{id}/history"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.GET("/v1/admin/campaigns/{id}/history", {
params: {
path: {
id: "<id>",
},
},
});POST /v1/admin/campaigns/{id}/schedule
Underlying REST endpoint: POST /v1/admin/campaigns/\{id\}/schedule
Parameters
path: paths["/v1/admin/campaigns/{id}/schedule"]["post"]["parameters"]["path"]body?: paths["/v1/admin/campaigns/{id}/schedule"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/admin/campaigns/{id}/schedule"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/admin/campaigns/{id}/schedule", {
params: {
path: {
id: "<id>",
},
},
body: {
/* paths["/v1/admin/campaigns/{id}/schedule"]["post"]["requestBody"]["content"]["application/json"] */
},
});POST /v1/admin/campaigns/{id}/send
Underlying REST endpoint: POST /v1/admin/campaigns/\{id\}/send
Parameters
path: paths["/v1/admin/campaigns/{id}/send"]["post"]["parameters"]["path"]body?: paths["/v1/admin/campaigns/{id}/send"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/admin/campaigns/{id}/send"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/admin/campaigns/{id}/send", {
params: {
path: {
id: "<id>",
},
},
body: {
/* paths["/v1/admin/campaigns/{id}/send"]["post"]["requestBody"]["content"]["application/json"] */
},
});POST /v1/admin/campaigns/process-batch
Underlying REST endpoint: POST /v1/admin/campaigns/process-batch
Parameters
None
Return type
Promise<{
data?: paths["/v1/admin/campaigns/process-batch"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/admin/campaigns/process-batch");POST /v1/admin/digests/send-nightly
Underlying REST endpoint: POST /v1/admin/digests/send-nightly
Parameters
None
Return type
Promise<{
data?: paths["/v1/admin/digests/send-nightly"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/admin/digests/send-nightly");POST /v1/admin/dunning/send-reminders
Underlying REST endpoint: POST /v1/admin/dunning/send-reminders
Parameters
None
Return type
Promise<{
data?: paths["/v1/admin/dunning/send-reminders"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/admin/dunning/send-reminders");POST /v1/admin/emails/send-stuck-checkout
Underlying REST endpoint: POST /v1/admin/emails/send-stuck-checkout
Parameters
None
Return type
Promise<{
data?: paths["/v1/admin/emails/send-stuck-checkout"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/admin/emails/send-stuck-checkout");POST /v1/admin/erasure
Underlying REST endpoint: POST /v1/admin/erasure
Parameters
body: paths["/v1/admin/erasure"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/admin/erasure"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/admin/erasure", {
body: {
/* paths["/v1/admin/erasure"]["post"]["requestBody"]["content"]["application/json"] */
},
});POST /v1/admin/inbox/screening-status
Underlying REST endpoint: POST /v1/admin/inbox/screening-status
Parameters
body: paths["/v1/admin/inbox/screening-status"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/admin/inbox/screening-status"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/admin/inbox/screening-status", {
body: {
/* paths["/v1/admin/inbox/screening-status"]["post"]["requestBody"]["content"]["application/json"] */
},
});POST /v1/admin/notifications
Underlying REST endpoint: POST /v1/admin/notifications
Parameters
body: paths["/v1/admin/notifications"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/admin/notifications"]["post"]["responses"]["201"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/admin/notifications", {
body: {
/* paths["/v1/admin/notifications"]["post"]["requestBody"]["content"]["application/json"] */
},
});POST /v1/admin/notifications/send-payout
Underlying REST endpoint: POST /v1/admin/notifications/send-payout
Parameters
None
Return type
Promise<{
data?: paths["/v1/admin/notifications/send-payout"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/admin/notifications/send-payout");POST /v1/admin/notifications/send-sale
Underlying REST endpoint: POST /v1/admin/notifications/send-sale
Parameters
None
Return type
Promise<{
data?: paths["/v1/admin/notifications/send-sale"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/admin/notifications/send-sale");POST /v1/admin/nudges/send-signup
Underlying REST endpoint: POST /v1/admin/nudges/send-signup
Parameters
None
Return type
Promise<{
data?: paths["/v1/admin/nudges/send-signup"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/admin/nudges/send-signup");POST /v1/admin/reminders/send-dose
Underlying REST endpoint: POST /v1/admin/reminders/send-dose
Parameters
None
Return type
Promise<{
data?: paths["/v1/admin/reminders/send-dose"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/admin/reminders/send-dose");POST /v1/admin/sla/sms-ping
Underlying REST endpoint: POST /v1/admin/sla/sms-ping
Parameters
None
Return type
Promise<{
data?: paths["/v1/admin/sla/sms-ping"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/admin/sla/sms-ping");POST /v1/admin/sync/affiliate-phones-klaviyo
Underlying REST endpoint: POST /v1/admin/sync/affiliate-phones-klaviyo
Parameters
None
Return type
Promise<{
data?: paths["/v1/admin/sync/affiliate-phones-klaviyo"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/admin/sync/affiliate-phones-klaviyo");POST /v1/admin/sync/klaviyo-cross-account
Underlying REST endpoint: POST /v1/admin/sync/klaviyo-cross-account
Parameters
None
Return type
Promise<{
data?: paths["/v1/admin/sync/klaviyo-cross-account"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/admin/sync/klaviyo-cross-account");POST /v1/admin/sync/profiles-to-klaviyo
Underlying REST endpoint: POST /v1/admin/sync/profiles-to-klaviyo
Parameters
None
Return type
Promise<{
data?: paths["/v1/admin/sync/profiles-to-klaviyo"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/admin/sync/profiles-to-klaviyo");GET /v1/ask/threads
Underlying REST endpoint: GET /v1/ask/threads
Parameters
query?: paths["/v1/ask/threads"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/ask/threads"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.GET("/v1/ask/threads", {
params: {
query: {
/* paths["/v1/ask/threads"]["get"]["parameters"]["query"] */
},
},
});POST /v1/ask/threads
Underlying REST endpoint: POST /v1/ask/threads
Parameters
body: paths["/v1/ask/threads"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/ask/threads"]["post"]["responses"]["201"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/ask/threads", {
body: {
/* paths["/v1/ask/threads"]["post"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/ask/threads/{thread_id}
Underlying REST endpoint: GET /v1/ask/threads/\{thread_id\}
Parameters
path: paths["/v1/ask/threads/{thread_id}"]["get"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/ask/threads/{thread_id}"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.GET("/v1/ask/threads/{thread_id}", {
params: {
path: {
thread_id: "<thread_id>",
},
},
});POST /v1/ask/threads/{thread_id}/replies
Underlying REST endpoint: POST /v1/ask/threads/\{thread_id\}/replies
Parameters
path: paths["/v1/ask/threads/{thread_id}/replies"]["post"]["parameters"]["path"]body: paths["/v1/ask/threads/{thread_id}/replies"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/ask/threads/{thread_id}/replies"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/ask/threads/{thread_id}/replies", {
params: {
path: {
thread_id: "<thread_id>",
},
},
body: {
/* paths["/v1/ask/threads/{thread_id}/replies"]["post"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/attachments/{id}/download-url
Underlying REST endpoint: GET /v1/attachments/\{id\}/download-url
Parameters
path: paths["/v1/attachments/{id}/download-url"]["get"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/attachments/{id}/download-url"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.GET("/v1/attachments/{id}/download-url", {
params: {
path: {
id: "<id>",
},
},
});PUT /v1/consents
Underlying REST endpoint: PUT /v1/consents
Parameters
body: paths["/v1/consents"]["put"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/consents"]["put"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.PUT("/v1/consents", {
body: {
/* paths["/v1/consents"]["put"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/consents/{person_id}
Underlying REST endpoint: GET /v1/consents/\{person_id\}
Parameters
path: paths["/v1/consents/{person_id}"]["get"]["parameters"]["path"]query: paths["/v1/consents/{person_id}"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/consents/{person_id}"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.GET("/v1/consents/{person_id}", {
params: {
path: {
person_id: "<person_id>",
},
query: {
/* paths["/v1/consents/{person_id}"]["get"]["parameters"]["query"] */
},
},
});PATCH /v1/inbox/{id}/read
Underlying REST endpoint: PATCH /v1/inbox/\{id\}/read
Parameters
path: paths["/v1/inbox/{id}/read"]["patch"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/inbox/{id}/read"]["patch"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.PATCH("/v1/inbox/{id}/read", {
params: {
path: {
id: "<id>",
},
},
});GET /v1/inbox/{person_id}
Underlying REST endpoint: GET /v1/inbox/\{person_id\}
Parameters
path: paths["/v1/inbox/{person_id}"]["get"]["parameters"]["path"]query?: paths["/v1/inbox/{person_id}"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/inbox/{person_id}"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.GET("/v1/inbox/{person_id}", {
params: {
path: {
person_id: "<person_id>",
},
query: {
/* paths["/v1/inbox/{person_id}"]["get"]["parameters"]["query"] */
},
},
});POST /v1/inbox/{user_id}/bulk-archive
Underlying REST endpoint: POST /v1/inbox/\{user_id\}/bulk-archive
Parameters
path: paths["/v1/inbox/{user_id}/bulk-archive"]["post"]["parameters"]["path"]body: paths["/v1/inbox/{user_id}/bulk-archive"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/inbox/{user_id}/bulk-archive"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/inbox/{user_id}/bulk-archive", {
params: {
path: {
user_id: "<user_id>",
},
},
body: {
/* paths["/v1/inbox/{user_id}/bulk-archive"]["post"]["requestBody"]["content"]["application/json"] */
},
});POST /v1/inbox/{user_id}/bulk-read
Underlying REST endpoint: POST /v1/inbox/\{user_id\}/bulk-read
Parameters
path: paths["/v1/inbox/{user_id}/bulk-read"]["post"]["parameters"]["path"]body: paths["/v1/inbox/{user_id}/bulk-read"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/inbox/{user_id}/bulk-read"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/inbox/{user_id}/bulk-read", {
params: {
path: {
user_id: "<user_id>",
},
},
body: {
/* paths["/v1/inbox/{user_id}/bulk-read"]["post"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/inbox/{user_id}/unread-count
Underlying REST endpoint: GET /v1/inbox/\{user_id\}/unread-count
Parameters
path: paths["/v1/inbox/{user_id}/unread-count"]["get"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/inbox/{user_id}/unread-count"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.GET("/v1/inbox/{user_id}/unread-count", {
params: {
path: {
user_id: "<user_id>",
},
},
});GET /v1/leads
Underlying REST endpoint: GET /v1/leads
Parameters
query: paths["/v1/leads"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/leads"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.GET("/v1/leads", {
params: {
query: {
/* paths["/v1/leads"]["get"]["parameters"]["query"] */
},
},
});POST /v1/leads/bloodwork-token/uploads
Underlying REST endpoint: POST /v1/leads/bloodwork-token/uploads
Parameters
body: paths["/v1/leads/bloodwork-token/uploads"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/leads/bloodwork-token/uploads"]["post"]["responses"]["201"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/leads/bloodwork-token/uploads", {
body: {
/* paths["/v1/leads/bloodwork-token/uploads"]["post"]["requestBody"]["content"]["application/json"] */
},
});POST /v1/leads/bloodwork-token/validate
Underlying REST endpoint: POST /v1/leads/bloodwork-token/validate
Parameters
body: paths["/v1/leads/bloodwork-token/validate"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/leads/bloodwork-token/validate"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/leads/bloodwork-token/validate", {
body: {
/* paths["/v1/leads/bloodwork-token/validate"]["post"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/messages/{id}
Underlying REST endpoint: GET /v1/messages/\{id\}
Parameters
path: paths["/v1/messages/{id}"]["get"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/messages/{id}"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.GET("/v1/messages/{id}", {
params: {
path: {
id: "<id>",
},
},
});GET /v1/messages/recent
Underlying REST endpoint: GET /v1/messages/recent
Parameters
query?: paths["/v1/messages/recent"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/messages/recent"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.GET("/v1/messages/recent", {
params: {
query: {
/* paths["/v1/messages/recent"]["get"]["parameters"]["query"] */
},
},
});POST /v1/messages/schedule
Underlying REST endpoint: POST /v1/messages/schedule
Parameters
body: paths["/v1/messages/schedule"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/messages/schedule"]["post"]["responses"]["201"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/messages/schedule", {
body: {
/* paths["/v1/messages/schedule"]["post"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/messages/scheduled
Underlying REST endpoint: GET /v1/messages/scheduled
Parameters
query: paths["/v1/messages/scheduled"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/messages/scheduled"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.GET("/v1/messages/scheduled", {
params: {
query: {
/* paths["/v1/messages/scheduled"]["get"]["parameters"]["query"] */
},
},
});GET /v1/messages/scheduled/{id}
Underlying REST endpoint: GET /v1/messages/scheduled/\{id\}
Parameters
path: paths["/v1/messages/scheduled/{id}"]["get"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/messages/scheduled/{id}"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.GET("/v1/messages/scheduled/{id}", {
params: {
path: {
id: "<id>",
},
},
});POST /v1/messages/scheduled/{id}/cancel
Underlying REST endpoint: POST /v1/messages/scheduled/\{id\}/cancel
Parameters
path: paths["/v1/messages/scheduled/{id}/cancel"]["post"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/messages/scheduled/{id}/cancel"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/messages/scheduled/{id}/cancel", {
params: {
path: {
id: "<id>",
},
},
});POST /v1/messages/send
Underlying REST endpoint: POST /v1/messages/send
Parameters
body: paths["/v1/messages/send"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/messages/send"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/messages/send", {
body: {
/* paths["/v1/messages/send"]["post"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/notifications
Underlying REST endpoint: GET /v1/notifications
Parameters
query?: paths["/v1/notifications"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/notifications"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.GET("/v1/notifications", {
params: {
query: {
/* paths["/v1/notifications"]["get"]["parameters"]["query"] */
},
},
});POST /v1/notifications/{id}/read
Underlying REST endpoint: POST /v1/notifications/\{id\}/read
Parameters
path: paths["/v1/notifications/{id}/read"]["post"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/notifications/{id}/read"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/notifications/{id}/read", {
params: {
path: {
id: "<id>",
},
},
});POST /v1/notifications/read-all
Underlying REST endpoint: POST /v1/notifications/read-all
Parameters
None
Return type
Promise<{
data?: paths["/v1/notifications/read-all"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/notifications/read-all");GET /v1/notifications/unread-count
Underlying REST endpoint: GET /v1/notifications/unread-count
Parameters
None
Return type
Promise<{
data?: paths["/v1/notifications/unread-count"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.GET("/v1/notifications/unread-count");PUT /v1/preferences
Underlying REST endpoint: PUT /v1/preferences
Parameters
body: paths["/v1/preferences"]["put"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/preferences"]["put"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.PUT("/v1/preferences", {
body: {
/* paths["/v1/preferences"]["put"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/preferences/{person_id}
Underlying REST endpoint: GET /v1/preferences/\{person_id\}
Parameters
path: paths["/v1/preferences/{person_id}"]["get"]["parameters"]["path"]query?: paths["/v1/preferences/{person_id}"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/preferences/{person_id}"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.GET("/v1/preferences/{person_id}", {
params: {
path: {
person_id: "<person_id>",
},
query: {
/* paths["/v1/preferences/{person_id}"]["get"]["parameters"]["query"] */
},
},
});POST /v1/public/leads
Underlying REST endpoint: POST /v1/public/leads
Parameters
body: paths["/v1/public/leads"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/public/leads"]["post"]["responses"]["201"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/public/leads", {
body: {
/* paths["/v1/public/leads"]["post"]["requestBody"]["content"]["application/json"] */
},
});POST /v1/push/send
Underlying REST endpoint: POST /v1/push/send
Parameters
body: paths["/v1/push/send"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/push/send"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/push/send", {
body: {
/* paths["/v1/push/send"]["post"]["requestBody"]["content"]["application/json"] */
},
});POST /v1/push/subscriptions
Underlying REST endpoint: POST /v1/push/subscriptions
Parameters
body: paths["/v1/push/subscriptions"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/push/subscriptions"]["post"]["responses"]["201"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/push/subscriptions", {
body: {
/* paths["/v1/push/subscriptions"]["post"]["requestBody"]["content"]["application/json"] */
},
});DELETE /v1/push/subscriptions/{id}
Underlying REST endpoint: DELETE /v1/push/subscriptions/\{id\}
Parameters
path: paths["/v1/push/subscriptions/{id}"]["delete"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/push/subscriptions/{id}"]["delete"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.DELETE("/v1/push/subscriptions/{id}", {
params: {
path: {
id: "<id>",
},
},
});GET /v1/push/subscriptions/{person_id}
Underlying REST endpoint: GET /v1/push/subscriptions/\{person_id\}
Parameters
path: paths["/v1/push/subscriptions/{person_id}"]["get"]["parameters"]["path"]query: paths["/v1/push/subscriptions/{person_id}"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/push/subscriptions/{person_id}"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.GET("/v1/push/subscriptions/{person_id}", {
params: {
path: {
person_id: "<person_id>",
},
query: {
/* paths["/v1/push/subscriptions/{person_id}"]["get"]["parameters"]["query"] */
},
},
});DELETE /v1/push/subscriptions/by-endpoint/{endpoint}
Underlying REST endpoint: DELETE /v1/push/subscriptions/by-endpoint/\{endpoint\}
Parameters
path: paths["/v1/push/subscriptions/by-endpoint/{endpoint}"]["delete"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/push/subscriptions/by-endpoint/{endpoint}"]["delete"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.DELETE("/v1/push/subscriptions/by-endpoint/{endpoint}", {
params: {
path: {
endpoint: "<endpoint>",
},
},
});GET /v1/push/vapid-key
Underlying REST endpoint: GET /v1/push/vapid-key
Parameters
None
Return type
Promise<{
data?: paths["/v1/push/vapid-key"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.GET("/v1/push/vapid-key");POST /v1/resubscribe
Underlying REST endpoint: POST /v1/resubscribe
Parameters
body: paths["/v1/resubscribe"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/resubscribe"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/resubscribe", {
body: {
/* paths["/v1/resubscribe"]["post"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/sequences
Underlying REST endpoint: GET /v1/sequences
Parameters
query: paths["/v1/sequences"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/sequences"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.GET("/v1/sequences", {
params: {
query: {
/* paths["/v1/sequences"]["get"]["parameters"]["query"] */
},
},
});POST /v1/sequences
Underlying REST endpoint: POST /v1/sequences
Parameters
body: paths["/v1/sequences"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/sequences"]["post"]["responses"]["201"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/sequences", {
body: {
/* paths["/v1/sequences"]["post"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/sequences/{id}
Underlying REST endpoint: GET /v1/sequences/\{id\}
Parameters
path: paths["/v1/sequences/{id}"]["get"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/sequences/{id}"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.GET("/v1/sequences/{id}", {
params: {
path: {
id: "<id>",
},
},
});POST /v1/sequences/{id}/enroll
Underlying REST endpoint: POST /v1/sequences/\{id\}/enroll
Parameters
path: paths["/v1/sequences/{id}/enroll"]["post"]["parameters"]["path"]body: paths["/v1/sequences/{id}/enroll"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/sequences/{id}/enroll"]["post"]["responses"]["201"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/sequences/{id}/enroll", {
params: {
path: {
id: "<id>",
},
},
body: {
/* paths["/v1/sequences/{id}/enroll"]["post"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/sequences/{id}/enrollments
Underlying REST endpoint: GET /v1/sequences/\{id\}/enrollments
Parameters
path: paths["/v1/sequences/{id}/enrollments"]["get"]["parameters"]["path"]query?: paths["/v1/sequences/{id}/enrollments"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/sequences/{id}/enrollments"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.GET("/v1/sequences/{id}/enrollments", {
params: {
path: {
id: "<id>",
},
query: {
/* paths["/v1/sequences/{id}/enrollments"]["get"]["parameters"]["query"] */
},
},
});POST /v1/sequences/{id}/pause
Underlying REST endpoint: POST /v1/sequences/\{id\}/pause
Parameters
path: paths["/v1/sequences/{id}/pause"]["post"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/sequences/{id}/pause"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/sequences/{id}/pause", {
params: {
path: {
id: "<id>",
},
},
});POST /v1/sequences/{id}/resume
Underlying REST endpoint: POST /v1/sequences/\{id\}/resume
Parameters
path: paths["/v1/sequences/{id}/resume"]["post"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/sequences/{id}/resume"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/sequences/{id}/resume", {
params: {
path: {
id: "<id>",
},
},
});POST /v1/sequences/enrollments/{id}/cancel
Underlying REST endpoint: POST /v1/sequences/enrollments/\{id\}/cancel
Parameters
path: paths["/v1/sequences/enrollments/{id}/cancel"]["post"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/sequences/enrollments/{id}/cancel"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/sequences/enrollments/{id}/cancel", {
params: {
path: {
id: "<id>",
},
},
});POST /v1/slack/commands/sms
Underlying REST endpoint: POST /v1/slack/commands/sms
Parameters
body: paths["/v1/slack/commands/sms"]["post"]["requestBody"]["content"]["application/x-www-form-urlencoded"]
Return type
Promise<{
data?: paths["/v1/slack/commands/sms"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/slack/commands/sms", {
body: {
/* paths["/v1/slack/commands/sms"]["post"]["requestBody"]["content"]["application/x-www-form-urlencoded"] */
},
});POST /v1/slack/events
Underlying REST endpoint: POST /v1/slack/events
Parameters
body: paths["/v1/slack/events"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/slack/events"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/slack/events", {
body: {
/* paths["/v1/slack/events"]["post"]["requestBody"]["content"]["application/json"] */
},
});POST /v1/slack/interact
Underlying REST endpoint: POST /v1/slack/interact
Parameters
body: paths["/v1/slack/interact"]["post"]["requestBody"]["content"]["application/x-www-form-urlencoded"]
Return type
Promise<{
data?: paths["/v1/slack/interact"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/slack/interact", {
body: {
/* paths["/v1/slack/interact"]["post"]["requestBody"]["content"]["application/x-www-form-urlencoded"] */
},
});GET /v1/stream/chat-token
Underlying REST endpoint: GET /v1/stream/chat-token
Parameters
query?: paths["/v1/stream/chat-token"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/stream/chat-token"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.GET("/v1/stream/chat-token", {
params: {
query: {
/* paths["/v1/stream/chat-token"]["get"]["parameters"]["query"] */
},
},
});POST /v1/stream/feeds-token
Underlying REST endpoint: POST /v1/stream/feeds-token
Parameters
None
Return type
Promise<{
data?: paths["/v1/stream/feeds-token"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/stream/feeds-token");POST /v1/support/tickets
Underlying REST endpoint: POST /v1/support/tickets
Parameters
body: paths["/v1/support/tickets"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/support/tickets"]["post"]["responses"]["201"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/support/tickets", {
body: {
/* paths["/v1/support/tickets"]["post"]["requestBody"]["content"]["application/json"] */
},
});POST /v1/suppressions
Underlying REST endpoint: POST /v1/suppressions
Parameters
body: paths["/v1/suppressions"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/suppressions"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/suppressions", {
body: {
/* paths["/v1/suppressions"]["post"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/suppressions/{email}
Underlying REST endpoint: GET /v1/suppressions/\{email\}
Parameters
path: paths["/v1/suppressions/{email}"]["get"]["parameters"]["path"]query: paths["/v1/suppressions/{email}"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/suppressions/{email}"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.GET("/v1/suppressions/{email}", {
params: {
path: {
email: "<email>",
},
query: {
/* paths["/v1/suppressions/{email}"]["get"]["parameters"]["query"] */
},
},
});DELETE /v1/suppressions/{id}
Underlying REST endpoint: DELETE /v1/suppressions/\{id\}
Parameters
path: paths["/v1/suppressions/{id}"]["delete"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/suppressions/{id}"]["delete"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.DELETE("/v1/suppressions/{id}", {
params: {
path: {
id: "<id>",
},
},
});GET /v1/threads
Underlying REST endpoint: GET /v1/threads
Parameters
query: paths["/v1/threads"]["get"]["parameters"]["query"]
Return type
Promise<{
data?: paths["/v1/threads"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.GET("/v1/threads", {
params: {
query: {
/* paths["/v1/threads"]["get"]["parameters"]["query"] */
},
},
});POST /v1/threads
Underlying REST endpoint: POST /v1/threads
Parameters
body?: paths["/v1/threads"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/threads"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/threads", {
body: {
/* paths["/v1/threads"]["post"]["requestBody"]["content"]["application/json"] */
},
});GET /v1/threads/{id}
Underlying REST endpoint: GET /v1/threads/\{id\}
Parameters
path: paths["/v1/threads/{id}"]["get"]["parameters"]["path"]
Return type
Promise<{
data?: paths["/v1/threads/{id}"]["get"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.GET("/v1/threads/{id}", {
params: {
path: {
id: "<id>",
},
},
});POST /v1/threads/{threadId}/attachments
Underlying REST endpoint: POST /v1/threads/\{threadId\}/attachments
Parameters
path: paths["/v1/threads/{threadId}/attachments"]["post"]["parameters"]["path"]body?: paths["/v1/threads/{threadId}/attachments"]["post"]["requestBody"]["content"]["multipart/form-data"]
Return type
Promise<{
data?: paths["/v1/threads/{threadId}/attachments"]["post"]["responses"]["201"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/threads/{threadId}/attachments", {
params: {
path: {
threadId: "<threadId>",
},
},
body: {
/* paths["/v1/threads/{threadId}/attachments"]["post"]["requestBody"]["content"]["multipart/form-data"] */
},
});POST /v1/unsubscribe
Underlying REST endpoint: POST /v1/unsubscribe
Parameters
body: paths["/v1/unsubscribe"]["post"]["requestBody"]["content"]["application/json"]
Return type
Promise<{
data?: paths["/v1/unsubscribe"]["post"]["responses"]["200"]["content"]["application/json"];
error?: unknown;
response: Response;
}>Example
const result = await comms.POST("/v1/unsubscribe", {
body: {
/* paths["/v1/unsubscribe"]["post"]["requestBody"]["content"]["application/json"] */
},
});