Add support for creating and updating customer card configs (#48)

* Add support for creating and updating customer card configs

* copy change

* add update method

Author: mattvagni

.changeset/eight-grapes-decide.md

@@ -0,0 +1,5 @@
+---
+'@team-plain/typescript-sdk': minor
+---
+
+Add support for creating and updating Customer Card configurations. Useful if you want to programatically set up Customer Cards.

src/client.ts

@@ -6,9 +6,11 @@ import {
   AddCustomerToCustomerGroupsDocument,
   type AttachmentUploadUrlPartsFragment,
   CreateAttachmentUploadUrlDocument,
+  CreateCustomerCardConfigDocument,
   CreateIssueDocument,
   CustomerByEmailDocument,
   CustomerByIdDocument,
+  type CustomerCardConfigPartsFragment,
   CustomerGroupByIdDocument,
   type CustomerGroupMembershipPartsFragment,
   type CustomerGroupPartsFragment,
@@ -23,10 +25,11 @@ import {
   ReplyToEmailDocument,
   SendNewEmailDocument,
   type TimelineEntryPartsFragment,
+  UpdateCustomerCardConfigDocument,
   UpsertCustomerDocument,
   UpsertCustomTimelineEntryDocument,
   type UpsertResult,
-  type WorkspacePartsFragment
+  type WorkspacePartsFragment,
 } from './graphql/types';
 import { request } from './request';
 import type { Result } from './result';
@@ -84,7 +87,7 @@ export class PlainClient {
    */
   async getCustomers(
     variables: VariablesOf<typeof CustomersDocument>
-  ): SDKResult<{ customers: CustomerPartsFragment[], pageInfo: PageInfo, totalCount: number }> {
+  ): SDKResult<{ customers: CustomerPartsFragment[]; pageInfo: PageInfo; totalCount: number }> {
     const res = await request(this.#ctx, {
       query: CustomersDocument,
       variables,
@@ -97,7 +100,6 @@ export class PlainClient {
     }));
   }
 
-
   /**
    * If the customer is not found this will return null.
    */
@@ -184,7 +186,7 @@ export class PlainClient {
    */
   async getCustomerGroups(
     variables: VariablesOf<typeof CustomerGroupsDocument>
-  ): SDKResult<{ customerGroups: CustomerGroupPartsFragment[], pageInfo: PageInfo }> {
+  ): SDKResult<{ customerGroups: CustomerGroupPartsFragment[]; pageInfo: PageInfo }> {
     const res = await request(this.#ctx, {
       query: CustomerGroupsDocument,
       variables,
@@ -310,4 +312,41 @@ export class PlainClient {
       return nonNullable(q.myWorkspace);
     });
   }
+
+  /**
+   * Creates the configuration for a Customer Card. Useful if you want
+   * to programatically set up a customer card vs using the settings UI
+   */
+  async createCustomerCardConfig(
+    input: VariablesOf<typeof CreateCustomerCardConfigDocument>['input']
+  ): SDKResult<CustomerCardConfigPartsFragment> {
+    const res = await request(this.#ctx, {
+      query: CreateCustomerCardConfigDocument,
+      variables: {
+        input,
+      },
+    });
+
+    return unwrapData(res, (q) => {
+      return nonNullable(q.createCustomerCardConfig.customerCardConfig);
+    });
+  }
+
+  /**
+   * Updates the configuration for a Customer Card.
+   */
+  async updateCustomerCardConfig(
+    input: VariablesOf<typeof UpdateCustomerCardConfigDocument>['input']
+  ): SDKResult<CustomerCardConfigPartsFragment> {
+    const res = await request(this.#ctx, {
+      query: UpdateCustomerCardConfigDocument,
+      variables: {
+        input,
+      },
+    });
+
+    return unwrapData(res, (q) => {
+      return nonNullable(q.updateCustomerCardConfig.customerCardConfig);
+    });
+  }
 }

src/graphql/fragments/customerCardConfigParts.gql

@@ -0,0 +1,19 @@
+fragment CustomerCardConfigParts on CustomerCardConfig {
+  id
+  title
+  key
+  defaultTimeToLiveSeconds
+  apiUrl
+  order
+  apiHeaders {
+    name
+    value
+  }
+  isEnabled
+  createdAt {
+    ...DateTimeParts
+  }
+  updatedAt {
+    ...DateTimeParts
+  }
+}

src/graphql/mutations/createCustomerCardConfig.gql

@@ -0,0 +1,10 @@
+mutation createCustomerCardConfig($input: CreateCustomerCardConfigInput!) {
+  createCustomerCardConfig(input: $input) {
+    customerCardConfig {
+      ...CustomerCardConfigParts
+    }
+    error {
+      ...MutationErrorParts
+    }
+  }
+}

src/graphql/mutations/updateCustomerCardConfig.gql

@@ -0,0 +1,10 @@
+mutation updateCustomerCardConfig($input: UpdateCustomerCardConfigInput!) {
+  updateCustomerCardConfig(input: $input) {
+    customerCardConfig {
+      ...CustomerCardConfigParts
+    }
+    error {
+      ...MutationErrorParts
+    }
+  }
+}