add threadByRef support in typescript SDK (#194)

* add threadByRef support in typescript SDK

* remove wrong example

* typecheck

* revert changes to pnpm lock

Author: presmihaylov

src/client.ts

@@ -71,6 +71,7 @@ import {
   type TenantTierMembershipPartsFragment,
   TenantsDocument,
   ThreadByExternalIdDocument,
+  ThreadByRefDocument,
   ThreadDocument,
   type ThreadEventPartsFragment,
   type ThreadFieldPartsFragment,
@@ -576,6 +577,20 @@ export class PlainClient {
     return unwrapData(res, (q) => q.thread);
   }
 
+  /**
+   * Get a single thread by its ref (eg T-12345)
+   */
+  async getThreadByRef(
+    variables: VariablesOf<typeof ThreadByRefDocument>
+  ): SDKResult<ThreadPartsFragment | null> {
+    const res = await request(this.#ctx, {
+      query: ThreadByRefDocument,
+      variables,
+    });
+
+    return unwrapData(res, (q) => q.threadByRef);
+  }
+
   /**
    * Get a single thread by external id. A thread's external id is unique per customer,
    * hence why the customer id is also required.

src/examples/getThreadByRef.ts

@@ -0,0 +1,17 @@
+import { PlainClient } from '../index';
+
+export async function getThreadByRef() {
+  const client = new PlainClient({ apiKey: process.env.API_KEY || '' });
+
+  const ref = 'T-12345';
+  const res = await client.getThreadByRef({
+    ref,
+  });
+  if (res.error) {
+    console.error(res.error);
+  } else if (res.data === null) {
+    console.log(`Thread with ref=${ref} not found`);
+  } else {
+    console.log(`Thread with id=${res.data.id} and ref=${res.data.ref} found`);
+  }
+}

src/examples/threadFields.ts

@@ -25,7 +25,10 @@ export async function upsertThreadField() {
 
 export async function deleteThreadField() {
   const res = await client.deleteThreadField({
-    threadFieldId: 'tf_01HVTN2VTNYP91P5XGDQ57M2ZX',
+    identifier: {
+      key: 'product_area',
+      threadId: 'th_01HVNWFJS395XVPPBJNE6A8BHP',
+    },
   });
 
   if (res.error) {

src/graphql/fragments/threadParts.gql

@@ -1,6 +1,7 @@
 fragment ThreadParts on Thread {
   __typename
   id
+  ref
   externalId
   customer {
     id

src/graphql/queries/threadByRef.gql

@@ -0,0 +1,5 @@
+query threadByRef($ref: String!) {
+  threadByRef(ref: $ref) {
+    ...ThreadParts
+  }
+}