From 5a8df00420d0ee086156b73f74b90c2f8f5ad851 Mon Sep 17 00:00:00 2001 From: Mathias Vagni Date: Mon, 20 Nov 2023 12:22:55 +0100 Subject: [PATCH] Further clean-up --- .../graphql/customers/delete.mdx | 6 ++--- .../graphql/messaging/reply-email.mdx | 9 +++----- .../graphql/messaging/reply-to-thread.mdx | 2 +- .../graphql/messaging/send-email.mdx | 22 ++++++++----------- docs/api-reference/graphql/pagination.mdx | 5 ++++- docs/api-reference/graphql/threads.mdx | 3 ++- .../graphql/threads/assignment.mdx | 6 ++--- docs/api-reference/graphql/threads/create.mdx | 5 +++-- .../graphql/threads/status-changes.mdx | 4 ++-- docs/email-setup/receiving-emails.mdx | 4 +++- 10 files changed, 33 insertions(+), 33 deletions(-) diff --git a/docs/api-reference/graphql/customers/delete.mdx b/docs/api-reference/graphql/customers/delete.mdx index 18437bc..96a7c66 100644 --- a/docs/api-reference/graphql/customers/delete.mdx +++ b/docs/api-reference/graphql/customers/delete.mdx @@ -1,6 +1,6 @@ -import DeleteCustomerTypescriptSDK from '../../../snippets/typescript-sdk/delete-customer.mdx'; -import DeleteCustomerGraphQL from '../../../snippets/graphql/delete-customer.mdx'; -import { Tab, Tabs } from 'nextra-theme-docs'; +--- +title: 'Delete customers' +--- You can delete customers with the `deleteCustomer` API, you will find this name in both our API and our SDKs. diff --git a/docs/api-reference/graphql/messaging/reply-email.mdx b/docs/api-reference/graphql/messaging/reply-email.mdx index 8810dca..250da67 100644 --- a/docs/api-reference/graphql/messaging/reply-email.mdx +++ b/docs/api-reference/graphql/messaging/reply-email.mdx @@ -1,9 +1,6 @@ -import { Tab, Tabs } from 'nextra-theme-docs'; - -import ReplyEmailTypescriptSDK from '../../../snippets/typescript-sdk/reply-email.mdx'; -import ReplyEmailGraphQL from '../../../snippets/graphql/reply-email.mdx'; - -# Reply to emails +--- +title: 'Reply to emails' +--- You can reply to an inbound email with the `replyToEmail` API. diff --git a/docs/api-reference/graphql/messaging/reply-to-thread.mdx b/docs/api-reference/graphql/messaging/reply-to-thread.mdx index 94c39c5..d181fd9 100644 --- a/docs/api-reference/graphql/messaging/reply-to-thread.mdx +++ b/docs/api-reference/graphql/messaging/reply-to-thread.mdx @@ -1,5 +1,5 @@ --- -title: 'Reply to thread' +title: 'Reply to threads' --- You can reply to a thread using the `replyToThread` mutation. The call to this mutation will be successful if: diff --git a/docs/api-reference/graphql/messaging/send-email.mdx b/docs/api-reference/graphql/messaging/send-email.mdx index bf167ed..dc6d973 100644 --- a/docs/api-reference/graphql/messaging/send-email.mdx +++ b/docs/api-reference/graphql/messaging/send-email.mdx @@ -1,18 +1,14 @@ --- -title: 'Send emails' -description: 'You can send new outbound emails to customers with the `sendNewEmail` API. This is useful for proactively reaching out about issues.' +title: 'Send new emails' --- - - - - - - - - - - - +You can send new outbound emails to customers with the `sendNewEmail` API. This is useful for proactively reaching out about issues. + + + + + + + diff --git a/docs/api-reference/graphql/pagination.mdx b/docs/api-reference/graphql/pagination.mdx index 7773d59..7c9055c 100644 --- a/docs/api-reference/graphql/pagination.mdx +++ b/docs/api-reference/graphql/pagination.mdx @@ -1,8 +1,11 @@ --- title: 'Pagination' -description: 'When fetching collections from our API you can use pagination to control how much data is returned. We will return 25 records per request by default and the maximum page size is 100 records.' --- +Our GraphQL API follos the [Relay pagination spec](https://relay.dev/graphql/connections.htm). + +When fetching collections from our API you can control how much data is returned. We will return 25 records per request by default and the maximum page size is 100 records. + We support two forms of page control arguments: 1. Forward pagination with `after` (cursor) & `first` (numeric count) diff --git a/docs/api-reference/graphql/threads.mdx b/docs/api-reference/graphql/threads.mdx index b96141a..fa9df20 100644 --- a/docs/api-reference/graphql/threads.mdx +++ b/docs/api-reference/graphql/threads.mdx @@ -1,9 +1,10 @@ --- title: 'Threads' sidebarTitle: Overview -description: "Threads are the core of Plain's data model and equivalent to tickets or conversations in other support platforms. When you use Plain to help a customer you assign yourself to a thread and then mark the thread as done once you're done helping." --- +Threads are the core of Plain's data model and equivalent to tickets or conversations in other support platforms. When you use Plain to help a customer you assign yourself to a thread and then mark the thread as done once you're done helping. + Threads are automatically created when a new email is received but can also be created via the API (when a customer submits a contact form for example). Threads have a status which can be in either **Todo**, **Snoozed** or **Done** and can only be assigned to one person. diff --git a/docs/api-reference/graphql/threads/assignment.mdx b/docs/api-reference/graphql/threads/assignment.mdx index 7be4745..dfec742 100644 --- a/docs/api-reference/graphql/threads/assignment.mdx +++ b/docs/api-reference/graphql/threads/assignment.mdx @@ -1,6 +1,6 @@ -import { Tabs, Tab } from 'nextra-theme-docs'; - -# Assign threads +--- +title: 'Assignment' +--- Threads can be assigned to users or machine users. The latter is useful if you want a bot to handle or are building a complex automation of some kind. diff --git a/docs/api-reference/graphql/threads/create.mdx b/docs/api-reference/graphql/threads/create.mdx index 70691a3..4f21d3f 100644 --- a/docs/api-reference/graphql/threads/create.mdx +++ b/docs/api-reference/graphql/threads/create.mdx @@ -1,8 +1,9 @@ --- -title: 'Create Threads' -description: Creating a thread is useful in scenarios where you want to programatically start a support interaction." +title: 'Create threads' --- +Creating a thread is useful in scenarios where you want to programatically start a support interaction. + You can do this in many different scenarios but the most common use-cases are when a contact form is submitted or when you want to provide proactive support off the back of some event or error happening in your product. A thread is created with an initial 'message' composed out of [UI components](/docs/ui-components). You have full control over the structure and appearance of the message in Plain. diff --git a/docs/api-reference/graphql/threads/status-changes.mdx b/docs/api-reference/graphql/threads/status-changes.mdx index 29107b0..7f6436d 100644 --- a/docs/api-reference/graphql/threads/status-changes.mdx +++ b/docs/api-reference/graphql/threads/status-changes.mdx @@ -1,5 +1,5 @@ --- -title: 'Changing thread status' +title: 'Changing status' --- Threads can be in one of 3 statuses: @@ -10,7 +10,7 @@ Threads can be in one of 3 statuses: When you log into Plain you can filter threads by these statuses. -When threads are created they default to Todo. +When threads are created they default to `Todo`. To change a threads status you need an API key with the following permissions: diff --git a/docs/email-setup/receiving-emails.mdx b/docs/email-setup/receiving-emails.mdx index abdbc4c..b168f8a 100644 --- a/docs/email-setup/receiving-emails.mdx +++ b/docs/email-setup/receiving-emails.mdx @@ -1,4 +1,6 @@ -import { Callout, Steps } from 'nextra-theme-docs'; +--- +title: 'Receiving emails' +--- # Receiving emails in Plain