Class PlainClient

Hierarchy

PlainClient

Index

Constructors

Properties

Methods

addCustomerToCustomerGroups createAttachmentUploadUrl createIssue getCustomerByEmail getCustomerById getCustomerGroupById getCustomerGroups getCustomers rawRequest removeCustomerFromCustomerGroups replyToEmail sendNewEmail upsertCustomTimelineEntry upsertCustomer

Constructors

constructor

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

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:198

createAttachmentUploadUrl

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

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:151

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:114

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:100

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:167

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:181

getCustomers

getCustomers(variables): SDKResult<{
    customers: CustomerPartsFragment[];
    pageInfo: PageInfo;
    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: PageInfo;
    totalCount: number;
}>
- Defined in src/client.ts:81

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:68

removeCustomerFromCustomerGroups

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

replyToEmail

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

sendNewEmail

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

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:234

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:129

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[]>

createAttachmentUploadUrl

Parameters

input: CreateAttachmentUploadUrlInput

Returns SDKResult<AttachmentUploadUrlPartsFragment>

createIssue

Parameters

input: CreateIssueInput

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: PageInfo; totalCount: number; }>

rawRequest

Parameters

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

query: string

variables: Record<string, unknown>

Returns SDKResult<unknown>

removeCustomerFromCustomerGroups

Parameters

input: RemoveCustomerFromCustomerGroupsInput

Returns SDKResult<null>

replyToEmail

Parameters

input: ReplyToEmailInput

Returns SDKResult<EmailPartsFragment>

sendNewEmail

Parameters

input: SendNewEmailInput

Returns SDKResult<EmailPartsFragment>

upsertCustomTimelineEntry

Parameters

input: UpsertCustomTimelineEntryInput

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

upsertCustomer

Parameters

input: UpsertCustomerInput

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

Settings

Member Visibility

Theme

On This Page

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

`Optional` apiUrl?: string

`Private` #ctx

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: PageInfo;
totalCount: number;
}>

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

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

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