Class PlainClient

Hierarchy

PlainClient

Constructors

constructor

new PlainClient(options): PlainClient
Parameters
- options: {
  apiKey: string;
  apiUrl?: string;
  }
  - apiKey: string
  - Optional apiUrl?: string
Returns PlainClient
- Defined in src/client.ts:83

Properties

`Private` #ctx

#ctx: Context

Methods

addCustomerToCustomerGroups

addCustomerToCustomerGroups(input): SDKResult<CustomerGroupMembershipPartsFragment[]>
Adds a customer to a customer groups.
Parameters
- input: AddCustomerToCustomerGroupsInput
Returns SDKResult<CustomerGroupMembershipPartsFragment[]>
- Defined in src/client.ts:285

addLabels

addLabels(input): SDKResult<{
labels: LabelPartsFragment[];
}>
WARNING: This is experimental and subject to change at any time without a major version bump.
Parameters
- input: AddLabelsInput
Returns SDKResult<{
labels: LabelPartsFragment[];
}>
- Defined in src/client.ts:581

changeCustomerStatus

changeCustomerStatus(input): SDKResult<{
customer: CustomerPartsFragment;
}>
Parameters
- input: ChangeCustomerStatusInput
Returns SDKResult<{
customer: CustomerPartsFragment;
}>
- Defined in src/client.ts:173

changeThreadPriority

changeThreadPriority(input): SDKResult<{
thread: ThreadPartsFragment;
}>
WARNING: This is experimental and subject to change at any time without a major version bump.
Parameters
- input: ChangeThreadPriorityInput
Returns SDKResult<{
thread: ThreadPartsFragment;
}>
- Defined in src/client.ts:524

createAttachmentUploadUrl

createAttachmentUploadUrl(input): SDKResult<AttachmentUploadUrlPartsFragment>
Parameters
- input: CreateAttachmentUploadUrlInput
Returns SDKResult<AttachmentUploadUrlPartsFragment>
- Defined in src/client.ts:384

createCustomerCardConfig

createCustomerCardConfig(input): SDKResult<CustomerCardConfigPartsFragment>
Creates the configuration for a Customer Card. Useful if you want to programatically set up a customer card vs using the settings UI
Parameters
- input: CreateCustomerCardConfigInput
Returns SDKResult<CustomerCardConfigPartsFragment>
- Defined in src/client.ts:416

createIssue

createIssue(input): SDKResult<IssuePartsFragment>
Create an issue for a customer. If you want you can override the default issue priority in your settings by specifying a priority manually here.
Parameters
- input: CreateIssueInput
Returns SDKResult<IssuePartsFragment>
- Defined in src/client.ts:194

createThread

createThread(input): SDKResult<{
thread: ThreadPartsFragment;
}>
WARNING: This is experimental and subject to change at any time without a major version bump.
Parameters
- input: CreateThreadInput
Returns SDKResult<{
thread: ThreadPartsFragment;
}>
- Defined in src/client.ts:503

deleteCustomerCardConfig

deleteCustomerCardConfig(input): SDKResult<null>
Delete the configuration for a Customer Card.
Parameters
- input: DeleteCustomerCardConfigInput
Returns SDKResult<null>
- Defined in src/client.ts:452

deleteIssue

deleteIssue(input): SDKResult<IssuePartsFragment>
Parameters
- input: DeleteIssueInput
Returns SDKResult<IssuePartsFragment>
- Defined in src/client.ts:223

getCustomerByEmail

getCustomerByEmail(variables): SDKResult<null | CustomerPartsFragment>
If the customer is not found this will return null.
Parameters
- variables: Exact<{
  email: string;
  }>
Returns SDKResult<null | CustomerPartsFragment>
- Defined in src/client.ts:140

getCustomerById

getCustomerById(variables): SDKResult<null | CustomerPartsFragment>
If the customer is not found this will return null.
Parameters
- variables: Exact<{
  customerId: string;
  }>
Returns SDKResult<null | CustomerPartsFragment>
- Defined in src/client.ts:126

getCustomerGroupById

getCustomerGroupById(variables): SDKResult<null | CustomerGroupPartsFragment>
If the customer group is not found this will return null.
Parameters
- variables: Exact<{
  customerGroupId: string;
  }>
Returns SDKResult<null | CustomerGroupPartsFragment>
- Defined in src/client.ts:254

getCustomerGroups

getCustomerGroups(variables): SDKResult<{
customerGroups: CustomerGroupPartsFragment[];
pageInfo: PageInfo;
}>
Get a paginated list of customer groups.
Parameters
- variables: Exact<{
      after?: InputMaybe<string>;
      before?: InputMaybe<string>;
      first?: InputMaybe<number>;
      last?: InputMaybe<number>;
  }>
Returns SDKResult<{
customerGroups: CustomerGroupPartsFragment[];
pageInfo: PageInfo;
}>
- Defined in src/client.ts:268

getCustomers

getCustomers(variables): SDKResult<{
    customers: CustomerPartsFragment[];
    pageInfo: PageInfoPartsFragment;
    totalCount: number;
}>
Get a paginated list of customers.
Parameters
- variables: Exact<{
      after?: InputMaybe<string>;
      before?: InputMaybe<string>;
      filters?: InputMaybe<CustomersFilter>;
      first?: InputMaybe<number>;
      last?: InputMaybe<number>;
      sortBy?: InputMaybe<CustomersSort>;
  }>
Returns SDKResult<{
    customers: CustomerPartsFragment[];
    pageInfo: PageInfoPartsFragment;
    totalCount: number;
}>
- Defined in src/client.ts:106

getIssues

getIssues(variables): SDKResult<{
issues: IssuePartsFragment[];
pageInfo: PageInfoPartsFragment;
}>
Parameters
- variables: Exact<{
      after?: InputMaybe<string>;
      before?: InputMaybe<string>;
      filters?: InputMaybe<IssuesFilter>;
      first?: InputMaybe<number>;
      last?: InputMaybe<number>;
      sortBy?: InputMaybe<IssuesSort>;
  }>
Returns SDKResult<{
issues: IssuePartsFragment[];
pageInfo: PageInfoPartsFragment;
}>
- Defined in src/client.ts:236

getLabelType

getLabelType(variables): SDKResult<null | LabelTypePartsFragment>
WARNING: This is experimental and subject to change at any time without a major version bump.
Parameters
- variables: Exact<{
  labelTypeId: string;
  }>
Returns SDKResult<null | LabelTypePartsFragment>
- Defined in src/client.ts:566

getLabelTypes

getLabelTypes(variables): SDKResult<{
labelTypes: LabelTypePartsFragment[];
pageInfo: PageInfoPartsFragment;
}>
WARNING: This is experimental and subject to change at any time without a major version bump.
Parameters
- variables: Exact<{
      after?: InputMaybe<string>;
      before?: InputMaybe<string>;
      filters?: InputMaybe<LabelTypeFilter>;
      first?: InputMaybe<number>;
      last?: InputMaybe<number>;
  }>
Returns SDKResult<{
labelTypes: LabelTypePartsFragment[];
pageInfo: PageInfoPartsFragment;
}>
- Defined in src/client.ts:547

getMyWorkspace

getMyWorkspace(): SDKResult<WorkspacePartsFragment>
Fetch the workspace for the authenticated API key.

Returns SDKResult<WorkspacePartsFragment>
- Defined in src/client.ts:402

getThread

getThread(variables): SDKResult<null | ThreadPartsFragment>
WARNING: This is experimental and subject to change at any time without a major version bump.
Parameters
- variables: Exact<{
  threadId: string;
  }>
Returns SDKResult<null | ThreadPartsFragment>
- Defined in src/client.ts:488

getThreads

getThreads(variables): SDKResult<{
pageInfo: PageInfoPartsFragment;
threads: ThreadPartsFragment[];
}>
WARNING: This is experimental and subject to change at any time without a major version bump.
Parameters
- variables: Exact<{
      after?: InputMaybe<string>;
      before?: InputMaybe<string>;
      filters?: InputMaybe<ThreadsFilter>;
      first?: InputMaybe<number>;
      last?: InputMaybe<number>;
      sortBy?: InputMaybe<ThreadsSort>;
  }>
Returns SDKResult<{
pageInfo: PageInfoPartsFragment;
threads: ThreadPartsFragment[];
}>
- Defined in src/client.ts:469

rawRequest

rawRequest(args): SDKResult<unknown>
If you need to do something custom you can use this method to do
Parameters
- args: {
  query: string;
  variables: Record<string, unknown>;
  }
  - query: string
  - variables: Record<string, unknown>
Returns SDKResult<unknown>
- Defined in src/client.ts:93

removeCustomerFromCustomerGroups

removeCustomerFromCustomerGroups(input): SDKResult<null>
Remove a customer from customer groups.
Parameters
- input: RemoveCustomerFromCustomerGroupsInput
Returns SDKResult<null>
- Defined in src/client.ts:303

replyToEmail

replyToEmail(input): SDKResult<EmailPartsFragment>
Parameters
- input: ReplyToEmailInput
Returns SDKResult<EmailPartsFragment>
- Defined in src/client.ts:354

resolveIssue

resolveIssue(input): SDKResult<IssuePartsFragment>
Resolve an issue for a customer.
Parameters
- input: ResolveIssueInput
Returns SDKResult<IssuePartsFragment>
- Defined in src/client.ts:210

sendChat

sendChat(input): SDKResult<ChatPartsFragment>
Parameters
- input: SendChatInput
Returns SDKResult<ChatPartsFragment>
- Defined in src/client.ts:369

sendNewEmail

sendNewEmail(input): SDKResult<EmailPartsFragment>
Parameters
- input: SendNewEmailInput
Returns SDKResult<EmailPartsFragment>
- Defined in src/client.ts:339

updateCustomerCardConfig

updateCustomerCardConfig(input): SDKResult<CustomerCardConfigPartsFragment>
Updates the configuration for a Customer Card.
Parameters
- input: UpdateCustomerCardConfigInput
Returns SDKResult<CustomerCardConfigPartsFragment>
- Defined in src/client.ts:434

upsertCustomTimelineEntry

upsertCustomTimelineEntry(input): SDKResult<{
result: UpsertResult;
timelineEntry: TimelineEntryPartsFragment;
}>
Add a custom timeline entry to a customer's timeline.

This can be used to power custom contact forms, log events from your own systems and much more.
Parameters
- input: UpsertCustomTimelineEntryInput
Returns SDKResult<{
result: UpsertResult;
timelineEntry: TimelineEntryPartsFragment;
}>
- Defined in src/client.ts:321

upsertCustomer

upsertCustomer(input): SDKResult<{
customer: CustomerPartsFragment;
result: UpsertResult;
}>
Allows you to create or update a customer. If you need to get the customer id for a customer in Plain, this is typically your first step.
Parameters
- input: UpsertCustomerInput
Returns SDKResult<{
customer: CustomerPartsFragment;
result: UpsertResult;
}>
- Defined in src/client.ts:155

Class PlainClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: { apiKey: string; apiUrl?: string; }

apiKey: string

Optional apiUrl?: string

Returns PlainClient

Properties

Private #ctx

Methods

addCustomerToCustomerGroups

Parameters

input: AddCustomerToCustomerGroupsInput

Returns SDKResult<CustomerGroupMembershipPartsFragment[]>

addLabels

Parameters

input: AddLabelsInput

Returns SDKResult<{ labels: LabelPartsFragment[]; }>

changeCustomerStatus

Parameters

input: ChangeCustomerStatusInput

Returns SDKResult<{ customer: CustomerPartsFragment; }>

changeThreadPriority

Parameters

input: ChangeThreadPriorityInput

Returns SDKResult<{ thread: ThreadPartsFragment; }>

createAttachmentUploadUrl

Parameters

input: CreateAttachmentUploadUrlInput

Returns SDKResult<AttachmentUploadUrlPartsFragment>

createCustomerCardConfig

Parameters

input: CreateCustomerCardConfigInput

Returns SDKResult<CustomerCardConfigPartsFragment>

createIssue

Parameters

input: CreateIssueInput

Returns SDKResult<IssuePartsFragment>

createThread

Parameters

input: CreateThreadInput

Returns SDKResult<{ thread: ThreadPartsFragment; }>

deleteCustomerCardConfig

Parameters

input: DeleteCustomerCardConfigInput

Returns SDKResult<null>

deleteIssue

Parameters

input: DeleteIssueInput

Returns SDKResult<IssuePartsFragment>

getCustomerByEmail

Parameters

variables: Exact<{ email: string; }>

Returns SDKResult<null | CustomerPartsFragment>

getCustomerById

Parameters

variables: Exact<{ customerId: string; }>

Returns SDKResult<null | CustomerPartsFragment>

getCustomerGroupById

Parameters

variables: Exact<{ customerGroupId: string; }>

Returns SDKResult<null | CustomerGroupPartsFragment>

getCustomerGroups

Parameters

variables: Exact<{ after?: InputMaybe<string>; before?: InputMaybe<string>; first?: InputMaybe<number>; last?: InputMaybe<number>; }>

Returns SDKResult<{ customerGroups: CustomerGroupPartsFragment[]; pageInfo: PageInfo; }>

getCustomers

Parameters

variables: Exact<{ after?: InputMaybe<string>; before?: InputMaybe<string>; filters?: InputMaybe<CustomersFilter>; first?: InputMaybe<number>; last?: InputMaybe<number>; sortBy?: InputMaybe<CustomersSort>; }>

Returns SDKResult<{ customers: CustomerPartsFragment[]; pageInfo: PageInfoPartsFragment; totalCount: number; }>

getIssues

Parameters

variables: Exact<{ after?: InputMaybe<string>; before?: InputMaybe<string>; filters?: InputMaybe<IssuesFilter>; first?: InputMaybe<number>; last?: InputMaybe<number>; sortBy?: InputMaybe<IssuesSort>; }>

Returns SDKResult<{ issues: IssuePartsFragment[]; pageInfo: PageInfoPartsFragment; }>

options: {
apiKey: string;
apiUrl?: string;
}

`Optional` apiUrl?: string

`Private` #ctx

Returns SDKResult<{
labels: LabelPartsFragment[];
}>

Returns SDKResult<{
customer: CustomerPartsFragment;
}>

Returns SDKResult<{
thread: ThreadPartsFragment;
}>

Returns SDKResult<{
thread: ThreadPartsFragment;
}>

variables: Exact<{
email: string;
}>

variables: Exact<{
customerId: string;
}>

variables: Exact<{
customerGroupId: string;
}>

variables: Exact<{
after?: InputMaybe<string>;
before?: InputMaybe<string>;
first?: InputMaybe<number>;
last?: InputMaybe<number>;
}>

Returns SDKResult<{
customerGroups: CustomerGroupPartsFragment[];
pageInfo: PageInfo;
}>

variables: Exact<{
after?: InputMaybe<string>;
before?: InputMaybe<string>;
filters?: InputMaybe<CustomersFilter>;
first?: InputMaybe<number>;
last?: InputMaybe<number>;
sortBy?: InputMaybe<CustomersSort>;
}>

Returns SDKResult<{
customers: CustomerPartsFragment[];
pageInfo: PageInfoPartsFragment;
totalCount: number;
}>

variables: Exact<{
after?: InputMaybe<string>;
before?: InputMaybe<string>;
filters?: InputMaybe<IssuesFilter>;
first?: InputMaybe<number>;
last?: InputMaybe<number>;
sortBy?: InputMaybe<IssuesSort>;
}>

Returns SDKResult<{
issues: IssuePartsFragment[];
pageInfo: PageInfoPartsFragment;
}>

variables: Exact<{
labelTypeId: string;
}>

variables: Exact<{
after?: InputMaybe<string>;
before?: InputMaybe<string>;
filters?: InputMaybe<LabelTypeFilter>;
first?: InputMaybe<number>;
last?: InputMaybe<number>;
}>

Returns SDKResult<{
labelTypes: LabelTypePartsFragment[];
pageInfo: PageInfoPartsFragment;
}>

variables: Exact<{
threadId: string;
}>

variables: Exact<{
after?: InputMaybe<string>;
before?: InputMaybe<string>;
filters?: InputMaybe<ThreadsFilter>;
first?: InputMaybe<number>;
last?: InputMaybe<number>;
sortBy?: InputMaybe<ThreadsSort>;
}>

Returns SDKResult<{
pageInfo: PageInfoPartsFragment;
threads: ThreadPartsFragment[];
}>

args: {
query: string;
variables: Record<string, unknown>;
}

Returns SDKResult<{
result: UpsertResult;
timelineEntry: TimelineEntryPartsFragment;
}>

Returns SDKResult<{
customer: CustomerPartsFragment;
result: UpsertResult;
}>