Add docs for thread fields (#40)

* add docs for thread fields * fix formatting * make formatting consistent * fix import * lint * Update thread-fields.mdx Co-authored-by: Preslav Mihaylov <[email protected]> * Update thread-fields.mdx Co-authored-by: Preslav Mihaylov <[email protected]> * review feedback --------- Co-authored-by: Preslav Mihaylov <[email protected]>
team-plain · Apr 23, 2024 · c76af82 · c76af82
1 parent 7f3a5f8
commit c76af82
Show file tree

Hide file tree

Showing 53 changed files with 288 additions and 101 deletions.
diff --git a/_snippets/graphql/delete-thread-field.mdx b/_snippets/graphql/delete-thread-field.mdx
@@ -0,0 +1,24 @@
+```graphql Mutation
+mutation deleteThreadField($input: DeleteThreadFieldInput!) {
+  deleteThreadField(input: $input) {
+    error {
+      message
+      type
+      code
+      fields {
+        field
+        message
+        type
+      }
+    }
+  }
+}
+```
+
+```json Variables
+{
+  "input": {
+    "threadFieldId": "tf_01HVTN2VTNYP91P5XGDQ57M2ZX"
+  }
+}
+```
diff --git a/_snippets/graphql/upsert-thread-field.mdx b/_snippets/graphql/upsert-thread-field.mdx
@@ -0,0 +1,45 @@
+```graphql Mutation
+mutation upsertThreadField($input: UpsertThreadFieldInput!) {
+  upsertThreadField(input: $input) {
+    result
+    threadField {
+      id
+      key
+      type
+      threadId
+      stringValue
+      booleanValue
+      isAiGenerated
+      createdAt {
+        iso8601
+      }
+      updatedAt {
+        iso8601
+      }
+    }
+    error {
+      message
+      type
+      code
+      fields {
+        field
+        message
+        type
+      }
+    }
+  }
+}
+```
+
+```json Variables
+{
+  "input": {
+    "identifier": {
+      "threadId": "th_01HVNWFJS395XVPPBJNE6A8BHP",
+      "key": "product_area"
+    },
+    "type": "STRING",
+    "stringValue": "security"
+  }
+}
+```
diff --git a/_snippets/typescript-sdk/add-customer-to-group.mdx b/_snippets/typescript-sdk/add-customer-to-group.mdx
@@ -1,4 +1,4 @@
-```tsx
+```ts
 import { PlainClient } from '@team-plain/typescript-sdk';
 
 const client = new PlainClient({ apiKey: 'plainApiKey_xxx' });

diff --git a/_snippets/typescript-sdk/add-customer-to-tenants.mdx b/_snippets/typescript-sdk/add-customer-to-tenants.mdx
@@ -1,4 +1,8 @@
-```tsx
+```ts
+import { PlainClient } from '@team-plain/typescript-sdk';
+
+const client = new PlainClient({ apiKey: 'plainApiKey_xxx' });
+
 const res = await client.addCustomerToTenants({
   customerIdentifier: {
     // You can use the customer email

diff --git a/_snippets/typescript-sdk/add-labels.mdx b/_snippets/typescript-sdk/add-labels.mdx
@@ -1,4 +1,4 @@
-```tsx
+```ts
 import { PlainClient } from '@team-plain/typescript-sdk';
 
 const client = new PlainClient({ apiKey: 'plainApiKey_xxx' });

diff --git a/_snippets/typescript-sdk/add-members-to-tier.mdx b/_snippets/typescript-sdk/add-members-to-tier.mdx
@@ -1,4 +1,8 @@
-```tsx
+```ts
+import { PlainClient } from '@team-plain/typescript-sdk';
+
+const client = new PlainClient({ apiKey: 'plainApiKey_xxx' });
+
 const res = await client.addMembersToTier({
   memberIdentifiers: [
     {

diff --git a/_snippets/typescript-sdk/assign-thread.mdx b/_snippets/typescript-sdk/assign-thread.mdx
@@ -1,9 +1,7 @@
-```tsx
+```ts
 import { PlainClient } from '@team-plain/typescript-sdk';
 
-const client = new PlainClient({
-  apiKey: 'XXX',
-});
+const client = new PlainClient({ apiKey: 'plainApiKey_xxx' });
 
 const res = await client.assignThread({
   threadId: 'th_01H8H46YPB2S4MAJM382FG9423',

diff --git a/_snippets/typescript-sdk/create-attachment-url.mdx b/_snippets/typescript-sdk/create-attachment-url.mdx
@@ -1,7 +1,7 @@
-```tsx
+```ts
 import { AttachmentType, PlainClient } from '@team-plain/typescript-sdk';
 
-const client = new PlainClient({ apiKey: 'XXX' });
+const client = new PlainClient({ apiKey: 'plainApiKey_xxx' });
 
 const res = await client.createAttachmentUploadUrl({
   customerId: 'c_XXXXXXXXXXXXXXXXXXXXXXXXXX',

diff --git a/_snippets/typescript-sdk/create-customer-event.mdx b/_snippets/typescript-sdk/create-customer-event.mdx
@@ -1,10 +1,7 @@
-```tsx
+```ts
 import { PlainClient, uiComponent } from '@team-plain/typescript-sdk';
 
-const client = new PlainClient({
-  apiKey: 'XXX',
-  debug: true,
-});
+const client = new PlainClient({ apiKey: 'plainApiKey_xxx' });
 
 const res = await client.createCustomerEvent({
   title: 'API key generated',

diff --git a/_snippets/typescript-sdk/create-thread-event.mdx b/_snippets/typescript-sdk/create-thread-event.mdx
@@ -1,10 +1,7 @@
-```tsx
+```ts
 import { PlainClient, uiComponent } from '@team-plain/typescript-sdk';
 
-const client = new PlainClient({
-  apiKey: 'XXX',
-  debug: true,
-});
+const client = new PlainClient({ apiKey: 'plainApiKey_xxx' });
 
 const res = await client.createThreadEvent({
   title: 'API key generated',

diff --git a/_snippets/typescript-sdk/create-thread.mdx b/_snippets/typescript-sdk/create-thread.mdx
@@ -1,9 +1,7 @@
-```tsx
+```ts
 import { PlainClient } from '@team-plain/typescript-sdk';
 
-const client = new PlainClient({
-  apiKey: 'XXX',
-});
+const client = new PlainClient({ apiKey: 'plainApiKey_xxx' });
 
 const res = await client.createThread({
   title: 'Bug Report',

diff --git a/_snippets/typescript-sdk/delete-customer.mdx b/_snippets/typescript-sdk/delete-customer.mdx
@@ -1,9 +1,7 @@
-```tsx
+```ts
 import { PlainClient } from '@team-plain/typescript-sdk';
 
-const client = new PlainClient({
-  apiKey: 'XXX',
-});
+const client = new PlainClient({ apiKey: 'plainApiKey_xxx' });
 
 const res = await client.deleteCustomer({
   customerId: 'c_01H1P4TE62AS5KZ4CZFC0578ED',

diff --git a/_snippets/typescript-sdk/delete-thread-field.mdx b/_snippets/typescript-sdk/delete-thread-field.mdx
@@ -0,0 +1,15 @@
+```ts
+import { PlainClient } from '@team-plain/typescript-sdk';
+
+const client = new PlainClient({ apiKey: 'plainApiKey_xxx' });
+
+const res = await client.deleteThreadField({
+  threadFieldId: 'tf_01HVTN2VTNYP91P5XGDQ57M2ZX',
+});
+
+if (res.error) {
+  console.error(res.error);
+} else {
+  console.log(res.data);
+}
+```
diff --git a/_snippets/typescript-sdk/error-handling.mdx b/_snippets/typescript-sdk/error-handling.mdx
@@ -1,4 +1,4 @@
-```tsx {21}
+```ts {21}
 import { PlainClient } from '@team-plain/typescript-sdk';
 
 export async function createCustomer() {

diff --git a/_snippets/typescript-sdk/first-api-call.mdx b/_snippets/typescript-sdk/first-api-call.mdx
@@ -5,7 +5,7 @@ const apiKey = 'XXX';
 const email = 'XXX';
 
 const client = new PlainClient({
-  apiKey: apiKey,
+  apiKey,
 });
 
 client.getCustomerByEmail({ email: email }).then((result) => {

diff --git a/_snippets/typescript-sdk/get-companies.mdx b/_snippets/typescript-sdk/get-companies.mdx
@@ -1,4 +1,8 @@
-```tsx
+```ts
+import { PlainClient } from '@team-plain/typescript-sdk';
+
+const client = new PlainClient({ apiKey: 'plainApiKey_xxx' });
+
 const res = await client.getCompanies({
   first: 25,
 });

diff --git a/_snippets/typescript-sdk/get-customer-by-email.mdx b/_snippets/typescript-sdk/get-customer-by-email.mdx
@@ -1,7 +1,7 @@
-```tsx
-const client = new PlainClient({
-  apiKey: 'XXX',
-});
+```ts
+import { PlainClient } from '@team-plain/typescript-sdk';
+
+const client = new PlainClient({ apiKey: 'plainApiKey_xxx' });
 
 const res = await client.getCustomerByEmail({ email: '[email protected]' });
 

diff --git a/_snippets/typescript-sdk/get-customer-by-id.mdx b/_snippets/typescript-sdk/get-customer-by-id.mdx
@@ -1,7 +1,7 @@
-```tsx
-const client = new PlainClient({
-  apiKey: 'XXX',
-});
+```ts
+import { PlainClient } from '@team-plain/typescript-sdk';
+
+const client = new PlainClient({ apiKey: 'plainApiKey_xxx' });
 
 const res = await client.getCustomerById({
   customerId: 'c_01H14DFQ4PDYBH398J1E99TWSS',

diff --git a/_snippets/typescript-sdk/get-customers.mdx b/_snippets/typescript-sdk/get-customers.mdx
@@ -1,7 +1,7 @@
-```tsx
-const client = new PlainClient({
-  apiKey: 'XXX',
-});
+```ts
+import { PlainClient } from '@team-plain/typescript-sdk';
+
+const client = new PlainClient({ apiKey: 'plainApiKey_xxx' });
 
 const res = await client.getCustomers({
   first: 50,

diff --git a/_snippets/typescript-sdk/get-tenant-by-id.mdx b/_snippets/typescript-sdk/get-tenant-by-id.mdx
@@ -1,4 +1,8 @@
-```tsx
+```ts
+import { PlainClient } from '@team-plain/typescript-sdk';
+
+const client = new PlainClient({ apiKey: 'plainApiKey_xxx' });
+
 const res = await client.getTenantById({
   tenantId: 'te_123',
 });

diff --git a/_snippets/typescript-sdk/get-tenants.mdx b/_snippets/typescript-sdk/get-tenants.mdx
@@ -1,4 +1,8 @@
-```tsx
+```ts
+import { PlainClient } from '@team-plain/typescript-sdk';
+
+const client = new PlainClient({ apiKey: 'plainApiKey_xxx' });
+
 const res = await client.getTenants({
   first: 25,
 });

diff --git a/_snippets/typescript-sdk/get-tier-by-id.mdx b/_snippets/typescript-sdk/get-tier-by-id.mdx
@@ -1,4 +1,8 @@
-```tsx
+```ts
+import { PlainClient } from '@team-plain/typescript-sdk';
+
+const client = new PlainClient({ apiKey: 'plainApiKey_xxx' });
+
 const res = await client.getTierById({
   tierId: 'tier_123',
 });

diff --git a/_snippets/typescript-sdk/get-tiers.mdx b/_snippets/typescript-sdk/get-tiers.mdx
@@ -1,4 +1,8 @@
-```tsx
+```ts
+import { PlainClient } from '@team-plain/typescript-sdk';
+
+const client = new PlainClient({ apiKey: 'plainApiKey_xxx' });
+
 const res = await client.getTiers({
   first: 25,
 });

diff --git a/_snippets/typescript-sdk/mark-thread-as-done.mdx b/_snippets/typescript-sdk/mark-thread-as-done.mdx
@@ -1,9 +1,7 @@
-```tsx
+```ts
 import { PlainClient } from '@team-plain/typescript-sdk';
 
-const client = new PlainClient({
-  apiKey: 'XXX',
-});
+const client = new PlainClient({ apiKey: 'plainApiKey_xxx' });
 
 const res = await client.markThreadAsDone({
   threadId: 'th_01HB924RWAW8H3Q8KZDFWYBJHZ',

diff --git a/_snippets/typescript-sdk/mark-thread-as-todo.mdx b/_snippets/typescript-sdk/mark-thread-as-todo.mdx
@@ -1,9 +1,7 @@
-```tsx
+```ts
 import { PlainClient } from '@team-plain/typescript-sdk';
 
-const client = new PlainClient({
-  apiKey: 'XXX',
-});
+const client = new PlainClient({ apiKey: 'plainApiKey_xxx' });
 
 const res = await client.markThreadAsTodo({
   threadId: 'th_01HB924RWAW8H3Q8KZDFWYBJHZ',

diff --git a/_snippets/typescript-sdk/page-info-after.mdx b/_snippets/typescript-sdk/page-info-after.mdx
@@ -1,9 +1,7 @@
-```tsx
+```ts
 import { PlainClient } from '@team-plain/typescript-sdk';
 
-const client = new PlainClient({
-  apiKey: 'XXX',
-});
+const client = new PlainClient({ apiKey: 'plainApiKey_xxx' });
 
 const firstPage = client.getCustomers({});
 

diff --git a/_snippets/typescript-sdk/remove-customer-from-groups.mdx b/_snippets/typescript-sdk/remove-customer-from-groups.mdx
@@ -1,9 +1,7 @@
-```tsx
+```ts
 import { PlainClient } from '@team-plain/typescript-sdk';
 
-const client = new PlainClient({
-  apiKey: 'plainApiKey_rO6tIKWU2w0gD_ek9HwjsHMiq1MHsgAn7mhVrcC7MGw',
-});
+const client = new PlainClient({ apiKey: 'plainApiKey_xxx' });
 
 const res = await client.removeCustomerFromCustomerGroups({
   customerId: 'c_01H1P4TE62AS5KZ4CZFC0578ED',

diff --git a/_snippets/typescript-sdk/remove-customer-from-tenants.mdx b/_snippets/typescript-sdk/remove-customer-from-tenants.mdx
@@ -1,4 +1,4 @@
-```tsx
+```ts
 const res = await client.removeCustomerFromTenants({
   customerIdentifier: {
     // You can use the customer email

diff --git a/_snippets/typescript-sdk/remove-labels.mdx b/_snippets/typescript-sdk/remove-labels.mdx
@@ -1,4 +1,4 @@
-```tsx
+```ts
 import { PlainClient } from '@team-plain/typescript-sdk';
 
 const client = new PlainClient({ apiKey: 'plainApiKey_xxx' });

diff --git a/_snippets/typescript-sdk/remove-members-from-tier.mdx b/_snippets/typescript-sdk/remove-members-from-tier.mdx
@@ -1,4 +1,8 @@
-```tsx
+```ts
+import { PlainClient } from '@team-plain/typescript-sdk';
+
+const client = new PlainClient({ apiKey: 'plainApiKey_xxx' });
+
 const res = await client.removeMembersFromTier({
   memberIdentifiers: [
     {

diff --git a/_snippets/typescript-sdk/reply-email.mdx b/_snippets/typescript-sdk/reply-email.mdx
@@ -1,4 +1,4 @@
-```tsx
+```ts
 import { PlainClient } from '@team-plain/typescript-sdk';
 
 const client = new PlainClient({ apiKey: 'plainApiKey_xxx' });

diff --git a/_snippets/typescript-sdk/reply-to-response.mdx b/_snippets/typescript-sdk/reply-to-response.mdx
@@ -1,4 +1,4 @@
-```tsx
+```ts
 import { PlainClient } from '@team-plain/typescript-sdk';
 
 const client = new PlainClient({ apiKey: 'plainApiKey_xxx' });

diff --git a/_snippets/typescript-sdk/reply-to-thread.mdx b/_snippets/typescript-sdk/reply-to-thread.mdx
@@ -1,4 +1,4 @@
-```tsx
+```ts
 import { PlainClient } from '@team-plain/typescript-sdk';
 
 const client = new PlainClient({ apiKey: 'plainApiKey_xxx' });

diff --git a/_snippets/typescript-sdk/send-email.mdx b/_snippets/typescript-sdk/send-email.mdx
@@ -1,4 +1,4 @@
-```tsx
+```ts
 import { PlainClient } from '@team-plain/typescript-sdk';
 
 const client = new PlainClient({ apiKey: 'plainApiKey_xxx' });

diff --git a/_snippets/typescript-sdk/set-customer-tenants.mdx b/_snippets/typescript-sdk/set-customer-tenants.mdx
@@ -1,4 +1,8 @@
-```tsx
+```ts
+import { PlainClient } from '@team-plain/typescript-sdk';
+
+const client = new PlainClient({ apiKey: 'plainApiKey_xxx' });
+
 const res = await client.setCustomerTenants({
   customerIdentifier: {
     // You can use the customer email