threadByExternalId support (#95)

Author: jesushernandez

.changeset/rotten-crabs-joke.md

@@ -0,0 +1,5 @@
+---
+'@team-plain/typescript-sdk': patch
+---
+
+Adds the ability to get a thread by its external id

src/client.ts

@@ -42,6 +42,7 @@ import {
   ReplyToThreadDocument,
   SendNewEmailDocument,
   SnoozeThreadDocument,
+  ThreadByExternalIdDocument,
   ThreadDocument,
   type ThreadEventPartsFragment,
   type ThreadPartsFragment,
@@ -445,6 +446,21 @@ export class PlainClient {
     return unwrapData(res, (q) => q.thread);
   }
 
+  /**
+   * Get a single thread by external id. A thread's external id is unique per customer,
+   * hence why the customer id is also required.
+   */
+  async getThreadByExternalId(
+    variables: VariablesOf<typeof ThreadByExternalIdDocument>
+  ): SDKResult<ThreadPartsFragment | null> {
+    const res = await request(this.#ctx, {
+      query: ThreadByExternalIdDocument,
+      variables,
+    });
+
+    return unwrapData(res, (q) => q.threadByExternalId);
+  }
+
   /**
    * Create a thread (e.g. when a contact form is submitted)
    */

src/graphql/queries/threadByExternalId.gql

@@ -0,0 +1,5 @@
+query threadByExternalId($customerId: ID!, $externalId: ID!) {
+  threadByExternalId(customerId: $customerId, externalId: $externalId) {
+    ...ThreadParts
+  }
+}