Class PlainSDKClient

Hierarchy

PlainSDKClient

Index

Constructors

Properties

Methods

createIssue getCustomerById rawRequest upsertCustomer

Constructors

constructor

new PlainSDKClient(options): PlainSDKClient
Parameters
- options: {
  apiKey: string;
  }
  - apiKey: string
Returns PlainSDKClient
- Defined in src/client.ts:44

Properties

`Private` #ctx

Methods

createIssue

createIssue(input): SDKResult<Issue>
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<Issue>
- Defined in src/client.ts:96

getCustomerById

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

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

upsertCustomer

upsertCustomer(input): SDKResult<null | Customer>
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<null | Customer>
- Defined in src/client.ts:81

Generated using TypeDoc