Plain TypeScript SDK

https://plain-typescript-sdk-docs.vercel.app/
Admin
A TypeScript/Node.js SDK for Plain.com's Core GraphQL API, simplifying common API calls, error...
Tokens:241,343
Snippets:1,323
Trust Score:7.8
Update:1 year ago
Show doc for...
Tokens:
Raw
### PlainClient Error Handling Example (TypeScript)

Source: https://plain-typescript-sdk-docs.vercel.app/index

Illustrates the pattern for handling responses from Plain SDK methods, emphasizing that a result object will contain either data or an error, but never both. This example shows how to check for and log errors returned from an asynchronous operation.

```TypeScript
const client = new PlainClient({
  apiKey: 'plainApiKey__tmRD_xF5qiMH0667LkbLCC1maN2hLsBIbyOgjqEP4w',
});

function doThing() {
  const result = await client.getCustomerById({ customerId: 'c_01GHC4A88A9D49Q30AAWR3BN7P' });

  if (result.error) {
    console.log(result.error);
  } else {
    console.log(result.data.fullName);
  }
}
```

--------------------------------

### Get Paginated List of Tiers (TypeScript SDK)

Source: https://plain-typescript-sdk-docs.vercel.app/classes/PlainClient

Retrieves a paginated list of tiers.

```APIDOC
getTiers(variables): SDKResult<{
  pageInfo: PageInfoPartsFragment;
  tiers: TierPartsFragment[];
}>
  Description: Retrieves a paginated list of tiers.
  Parameters:
    variables: Exact<{
      after?: InputMaybe<string>;
      before?: InputMaybe<string>;
      first?: InputMaybe<number>;
      last?: InputMaybe<number>;
    }>
  Returns: SDKResult<{
  pageInfo: PageInfoPartsFragment;
  tiers: TierPartsFragment[];
}>
  Defined in: src/client.ts:1114
```

--------------------------------

### Upsert Customer API Method

Source: https://plain-typescript-sdk-docs.vercel.app/classes/PlainClient

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.

```APIDOC
upsertCustomer(input: UpsertCustomerInput): SDKResult<{
    customer: CustomerPartsFragment;
    result: UpsertResult;
  }>
  Parameters:
    - input: UpsertCustomerInput
  Returns:
    SDKResult<{
    customer: CustomerPartsFragment;
    result: UpsertResult;
  }>
  Defined in: src/client.ts:288
```

--------------------------------

### Initialize PlainClient and Fetch Customer by ID (TypeScript)

Source: https://plain-typescript-sdk-docs.vercel.app/index

Demonstrates how to initialize the PlainClient with an API key and make a basic API call to retrieve customer details by ID. It also shows how to handle successful data retrieval or log errors returned by the SDK.

```TypeScript
import { PlainClient } from '@team-plain/typescript-sdk';

const client = new PlainClient({
  apiKey: 'plainApiKey__tmRD_xF5qiMH0657LkbLCC1maN4hLsBIbyOgjqEP4w',
});

const result = await client.getCustomerById({ customerId: 'c_01GHC4A88A9D49Q30AAWR3BN7P' });

if (result.error) {
  console.log(result.error);
} else {
  console.log(result.data.fullName);
}
```

--------------------------------

### _getType Method

Source: https://plain-typescript-sdk-docs.vercel.app/classes/_internal_.ZodBranded-1

Internal method to get the type of the input. This method is inherited from ZodType.

```APIDOC
_getType(input: ParseInput): string

Parameters:
  input: ParseInput

Returns string
```

--------------------------------

### createCustomerCardConfig

Source: https://plain-typescript-sdk-docs.vercel.app/classes/PlainClient

Creates the configuration for a Customer Card. Useful if you want
  to programatically set up a customer card vs using the settings UI

```APIDOC
createCustomerCardConfig(input): SDKResult<CustomerCardConfigPartsFragment>
  input: CreateCustomerCardConfigInput
Returns: SDKResult<CustomerCardConfigPartsFragment>
```

--------------------------------

### Static create Method

Source: https://plain-typescript-sdk-docs.vercel.app/classes/_internal_.ZodReadonly-1

Describes the static `create` method for `ZodReadonly`, including its type parameters, input parameters, and the `ZodReadonly` instance it returns.

```APIDOC
create: (<T_1>(type, params?) => ZodReadonly<T_1>)

Type declaration:
  <T_1>(type, params?): ZodReadonly<T_1>
  Type Parameters:
    T_1 extends ZodTypeAny
  Parameters:
    type: T_1
    Optional params: RawCreateParams
  Returns ZodReadonly<T_1>

Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:889
```

--------------------------------

### Get User by ID (TypeScript SDK)

Source: https://plain-typescript-sdk-docs.vercel.app/classes/PlainClient

Retrieves a single user by their unique identifier.

```APIDOC
getUserById(variables): SDKResult<null | UserPartsFragment>
  Description: Get a user by id
  Parameters:
    variables: Exact<{
      id: string;
    }>
  Returns: SDKResult<null | UserPartsFragment>
  Defined in: src/client.ts:195
```

--------------------------------

### Documenting Static create Method

Source: https://plain-typescript-sdk-docs.vercel.app/classes/_internal_.ZodOptional-1

Documents the static `create` method, including its type parameters, regular parameters, and return type for creating `ZodOptional` instances.

```APIDOC
static create<T_1 extends ZodTypeAny>(type: T_1, params?: RawCreateParams): ZodOptional<T_1>
  Type Parameters:
    T_1 extends ZodTypeAny
  Parameters:
    type: T_1
    params (Optional): RawCreateParams
  Returns: ZodOptional<T_1>
  Defined in: node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:800
```

--------------------------------

### Get User by Email (TypeScript SDK)

Source: https://plain-typescript-sdk-docs.vercel.app/classes/PlainClient

Retrieves a single user by their email address.

```APIDOC
getUserByEmail(variables): SDKResult<null | UserPartsFragment>
  Description: Get a a user by email
  Parameters:
    variables: Exact<{
      email: string;
    }>
  Returns: SDKResult<null | UserPartsFragment>
  Defined in: src/client.ts:181
```

--------------------------------

### ZodObject Constructor API Reference

Source: https://plain-typescript-sdk-docs.vercel.app/classes/_internal_.ZodObject-1

Documents the constructor for the ZodObject class, including its type parameters, input parameters, and return type. It shows how to instantiate a new ZodObject instance.

```APIDOC
ZodObject:
  constructor:
    new ZodObject<T, UnknownKeys, Catchall, Output, Input>(def): ZodObject<T, UnknownKeys, Catchall, Output, Input>
      Type Parameters:
        T: extends ZodRawShape
        UnknownKeys: extends UnknownKeysParam = UnknownKeysParam
        Catchall: extends ZodTypeAny = ZodTypeAny
        Output: = objectOutputType<T, Catchall, UnknownKeys>
        Input: = objectInputType<T, Catchall, UnknownKeys>
      Parameters:
        def: ZodObjectDef<T, UnknownKeys, Catchall>
      Returns: ZodObject<T, UnknownKeys, Catchall, Output, Input>
      Inherited from: ZodType.constructor
      Defined in: node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:73
```

--------------------------------

### PlainClient Class API Reference

Source: https://plain-typescript-sdk-docs.vercel.app/classes/PlainClient

Detailed API documentation for the `PlainClient` class, including its constructor, properties, and a comprehensive list of methods available for interacting with the Plain platform. This class serves as the primary interface for the Plain TypeScript SDK.

```APIDOC
Class PlainClient
Defined in src/client.ts:140

Constructors:
  constructor(options: ConstructorOptions): PlainClient
    Parameters:
      options: ConstructorOptions
    Returns: PlainClient

Properties:
  #ctx: Context (Private)

Methods:
  addCustomerToCustomerGroups
  addCustomerToTenants
  addLabels
  addMembersToTier
  archiveLabelType
  assignThread
  changeThreadPriority
  createAttachmentUploadUrl
  createCustomerCardConfig
  createCustomerEvent
  createLabelType
  createNote
  createThread
  createThreadEvent
  createWebhookTarget
  deleteCustomer
  deleteCustomerCardConfig
  deleteThreadField
  deleteWebhookTarget
  getCompanies
  getCustomerByEmail
  getCustomerByExternalId
  getCustomerById
  getCustomerCustomerGroupMemberships
  getCustomerGroupById
  getCustomerGroups
  getCustomerTenantMemberships
  getCustomers
  getLabelType
  getLabelTypes
  getMyWorkspace
  getTenantById
  getTenants
  getThread
  getThreadByExternalId
  getThreadByRef
  getThreads
  getTierById
  getTiers
  getUserByEmail
  getUserById
  getWebhookTargetById
  getWebhookTargets
  indexDocument
  markThreadAsDone
  markThreadAsTodo
  rawRequest
  removeCustomerFromCustomerGroups
  removeCustomerFromTenants
  removeLabels
  removeMembersFromTier
  replyToEmail
  replyToThread
  searchCompanies
  searchTenants
  sendCustomerChat
  sendNewEmail
  setCustomerTenants
  snoozeThread
  unassignThread
  updateCompanyTier
  updateCustomerCardConfig
  updateCustomerCompany
  updateTenantTier
  updateThreadTenant
  updateWebhookTarget
  upsertCompany
  upsertCustomer
  upsertTenant
  upsertThreadField
  userByEmail
```

--------------------------------

### Get Tier by ID (TypeScript SDK)

Source: https://plain-typescript-sdk-docs.vercel.app/classes/PlainClient

Retrieves a single tier by its unique identifier.

```APIDOC
getTierById(variables): SDKResult<null | TierPartsFragment>
  Description: Retrieves a single tier by its ID.
  Parameters:
    variables: Exact<{
      tierId: string;
    }>
  Returns: SDKResult<null | TierPartsFragment>
  Defined in: src/client.ts:1101
```

--------------------------------

### Set Customer Tenants using SDK

Source: https://plain-typescript-sdk-docs.vercel.app/classes/PlainClient

Defines the SDK method for associating tenants with a customer. It takes an input object containing tenant assignment details and returns a generic SDK result.

```APIDOC
setCustomerTenants(input: SetCustomerTenantsInput): SDKResult<null>
```

--------------------------------

### _getOrReturnCtx Method

Source: https://plain-typescript-sdk-docs.vercel.app/classes/_internal_.ZodBranded-1

Internal method to get or return the parse context. This method is inherited from ZodType.

```APIDOC
_getOrReturnCtx(input: ParseInput, ctx?: ParseContext): ParseContext

Parameters:
  input: ParseInput
  Optional ctx: ParseContext

Returns ParseContext
```

--------------------------------

### Get Paginated List of Threads (TypeScript SDK)

Source: https://plain-typescript-sdk-docs.vercel.app/classes/PlainClient

Retrieves a paginated list of threads, with options for filtering and sorting.

```APIDOC
getThreads(variables): SDKResult<{
  pageInfo: PageInfoPartsFragment;
  threads: ThreadPartsFragment[];
}>
  Description: Get a paginated list of threads
  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:551
```

--------------------------------

### Search Tenants using SDK

Source: https://plain-typescript-sdk-docs.vercel.app/classes/PlainClient

Defines the SDK method for searching tenants. It accepts variables for pagination and a search query, returning a paginated list of tenants and page information.

```APIDOC
searchTenants(variables: Exact<{
  after?: InputMaybe<string>;
  before?: InputMaybe<string>;
  first?: InputMaybe<number>;
  last?: InputMaybe<number>;
  searchQuery: TenantsSearchQuery;
}>): SDKResult<{
  pageInfo: PageInfoPartsFragment;
  tenants: TenantPartsFragment[];
}>
```

--------------------------------

### Get Thread by Reference (TypeScript SDK)

Source: https://plain-typescript-sdk-docs.vercel.app/classes/PlainClient

Retrieves a single thread using its unique reference (e.g., T-12345).

```APIDOC
getThreadByRef(variables): SDKResult<null | ThreadPartsFragment>
  Description: Get a single thread by its ref (eg T-12345)
  Parameters:
    variables: Exact<{
      ref: string;
    }>
  Returns: SDKResult<null | ThreadPartsFragment>
  Defined in: src/client.ts:583
```

--------------------------------

### createCustomerEvent

Source: https://plain-typescript-sdk-docs.vercel.app/classes/PlainClient

Create a Customer Event

```APIDOC
createCustomerEvent(input): SDKResult<CustomerEventPartsFragment>
  input: CreateCustomerEventInput
Returns: SDKResult<CustomerEventPartsFragment>
```

--------------------------------

### Documenting _getOrReturnCtx Method

Source: https://plain-typescript-sdk-docs.vercel.app/classes/_internal_.ZodOptional-1

Documents the internal `_getOrReturnCtx` method, detailing its input and optional context parameters and the `ParseContext` return type.

```APIDOC
_getOrReturnCtx(input: ParseInput, ctx?: ParseContext): ParseContext
  Parameters:
    input: ParseInput
    ctx (Optional): ParseContext
  Returns: ParseContext
  Inherited from: ZodType._getOrReturnCtx
  Defined in: node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:52
```

--------------------------------

### ZodNullable _getOrReturnCtx Method

Source: https://plain-typescript-sdk-docs.vercel.app/classes/_internal_.ZodNullable-1

Internal method to get or return the ParseContext for parsing operations. It takes input and an optional context, returning a ParseContext instance.

```APIDOC
_getOrReturnCtx(input, ctx?): [ParseContext](../interfaces/_internal_.ParseContext.html)
* Parameters:
  + input: [ParseInput](../types/_internal_.ParseInput.html)
  + `Optional` ctx: [ParseContext](../interfaces/_internal_.ParseContext.html)
* Returns [ParseContext](../interfaces/_internal_.ParseContext.html)

Inherited from [ZodType](_internal_.ZodType.html).[_getOrReturnCtx](_internal_.ZodType.html#_getOrReturnCtx)
+ Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:52
```

--------------------------------

### Search Companies using SDK

Source: https://plain-typescript-sdk-docs.vercel.app/classes/PlainClient

Defines the SDK method for searching companies. It accepts variables for pagination and a search query, returning a paginated list of companies and page information.

```APIDOC
searchCompanies(variables: Exact<{
  after?: InputMaybe<string>;
  before?: InputMaybe<string>;
  first?: InputMaybe<number>;
  last?: InputMaybe<number>;
  searchQuery: CompaniesSearchQuery;
}>): SDKResult<{
  pageInfo: PageInfoPartsFragment;
  tenants: CompanyPartsFragment[];
}>
```

--------------------------------

### Get ZodType description property

Source: https://plain-typescript-sdk-docs.vercel.app/classes/_internal_.ZodIntersection-1

Retrieves the description property of a ZodType instance. This property is inherited from the base ZodType class and can be undefined or a string.

```APIDOC
description(): undefined | string
Returns: undefined | string
Inherited from: ZodType.description
Defined in: node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:49
```

--------------------------------

### API Method: getCustomerTenantMemberships

Source: https://plain-typescript-sdk-docs.vercel.app/classes/PlainClient

Retrieves a paginated list of tenant memberships for a specific customer.

```APIDOC
Method: getCustomerTenantMemberships
Signature: getCustomerTenantMemberships(variables): SDKResult<{ pageInfo: null | PageInfo; tenantMemberships: CustomerTenantMembershipPartsFragment[]; }>
Parameters:
  variables: Exact<{
    after?: InputMaybe<string>;
    before?: InputMaybe<string>;
    customerId: string;
    first?: InputMaybe<number>;
    last?: InputMaybe<number>;
  }>
Returns: SDKResult<{ pageInfo: null | PageInfo; tenantMemberships: CustomerTenantMembershipPartsFragment[]; }>
Source: src/client.ts:407
```

--------------------------------

### ZodPipeline Constructor Details

Source: https://plain-typescript-sdk-docs.vercel.app/classes/_internal_.ZodPipeline-1

Details the constructor for the ZodPipeline class, including its type parameters, input definition, and return type.

```APIDOC
constructor
  Signature: new ZodPipeline<A, B>(def): ZodPipeline<A, B>
  Type Parameters:
    A extends ZodTypeAny
    B extends ZodTypeAny
  Parameters:
    def: ZodPipelineDef<A, B>
  Returns: ZodPipeline<A, B>
  Inherited from: ZodType.constructor
  Defined in: node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:73
```

--------------------------------

### ZodNumber description Accessor

Source: https://plain-typescript-sdk-docs.vercel.app/classes/_internal_.ZodNumber-1

Gets the description associated with the ZodNumber schema, if one has been set. This accessor provides a way to retrieve metadata about the schema. It is inherited from the base ZodType.

```APIDOC
get description(): undefined | string
```

--------------------------------

### ZodEnum Static Method: create

Source: https://plain-typescript-sdk-docs.vercel.app/classes/_internal_.ZodEnum-1

Documents the static 'create' method of ZodEnum, which provides multiple overloads for constructing ZodEnum instances. It details type parameters, input values, optional creation parameters, and the resulting ZodEnum type.

```APIDOC
Static Method: create
  Overload 1:
    Signature: <U, T>(values: T, params?: RawCreateParams): ZodEnum<Writeable<T>>
    Type Parameters:
      U extends string
      T extends readonly [U, U]
    Parameters:
      values: T
      params: RawCreateParams (Optional)
    Returns: ZodEnum<Writeable<T>>
  Overload 2:
    Signature: <U, T>(values: T, params?: RawCreateParams): ZodEnum<T>
    Type Parameters:
      U extends string
      T extends [U, ...U[]]
    Parameters:
      values: T
      params: RawCreateParams (Optional)
    Returns: ZodEnum<T>
  Defined in: node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:740
```

--------------------------------

### ZodString includes method

Source: https://plain-typescript-sdk-docs.vercel.app/classes/_internal_.ZodString-1

Checks if the string includes a specific value. Optionally accepts an options object to customize the error message or specify a starting position for the search.

```APIDOC
includes(value: string, options?: {
  message?: string;
  position?: number;
}): ZodString
```

--------------------------------

### createWebhookTarget

Source: https://plain-typescript-sdk-docs.vercel.app/classes/PlainClient

API method to create a new webhook target.

```APIDOC
createWebhookTarget(input): SDKResult<WebhookTargetPartsFragment>
  Parameters:
    input: CreateWebhookTargetInput
  Returns: SDKResult<WebhookTargetPartsFragment>
```

--------------------------------

### ZodUnion: _getOrReturnCtx Internal Method

Source: https://plain-typescript-sdk-docs.vercel.app/classes/_internal_.ZodUnion-1

Internal method to get or return the parsing context. Inherited from ZodType, it manages the context for parsing operations, ensuring consistent state management during validation.

```APIDOC
_getOrReturnCtx:
  _getOrReturnCtx(input: ParseInput, ctx?: ParseContext): ParseContext
  Inherited from ZodType._getOrReturnCtx
  Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:52
```

--------------------------------

### Get Keys of ZodObject as ZodEnum

Source: https://plain-typescript-sdk-docs.vercel.app/classes/_internal_.ZodObject-1

Generates a ZodEnum schema from the keys of the current ZodObject. This is useful for creating a schema that validates against the literal keys of the object, ensuring type safety for object keys.

```APIDOC
keyof(): ZodEnum<CastToStringTuple<UnionToTuple<keyof T, []>>>

Returns: ZodEnum<CastToStringTuple<UnionToTuple<keyof T, []>>>

Defined in: node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:547
```

--------------------------------

### Retrieve Workspace: SDK getMyWorkspace Method

Source: https://plain-typescript-sdk-docs.vercel.app/classes/PlainClient

This method fetches the workspace associated with the currently authenticated API key. It does not require any parameters and returns an 'SDKResult' containing the workspace details.

```APIDOC
Method Signature:
  getMyWorkspace(): SDKResult<WorkspacePartsFragment>

Returns:
  SDKResult<WorkspacePartsFragment>

Defined in: src/client.ts:485
```

--------------------------------

### ZodError Constructor Details

Source: https://plain-typescript-sdk-docs.vercel.app/classes/_internal_.ZodError

Documents the constructor for ZodError, explaining how to instantiate the error with an array of Zod issues. It details the parameters, return type, and inheritance.

```APIDOC
Constructor: new ZodError<T>(issues)
  Type Parameters:
    T = any
  Parameters:
    issues: ZodIssue[] - An array of ZodIssue objects representing validation errors.
  Returns: ZodError<T> - A new instance of ZodError.
  Overrides: Error.constructor
  Defined in: node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/ZodError.d.ts:138
```

--------------------------------

### Get Thread by External ID (TypeScript SDK)

Source: https://plain-typescript-sdk-docs.vercel.app/classes/PlainClient

Retrieves a single thread using its external ID. This method requires both the external ID and the customer ID, as external IDs are unique per customer.

```APIDOC
getThreadByExternalId(variables): SDKResult<null | ThreadPartsFragment>
  Description: Get a single thread by external id. A thread's external id is unique per customer, hence why the customer id is also required.
  Parameters:
    variables: Exact<{
      customerId: string;
      externalId: string;
    }>
  Returns: SDKResult<null | ThreadPartsFragment>
  Defined in: src/client.ts:598
```

--------------------------------

### ZodNumber minValue Accessor

Source: https://plain-typescript-sdk-docs.vercel.app/classes/_internal_.ZodNumber-1

Gets the minimum value constraint applied to the number schema. This accessor returns the lower bound if set, or null otherwise. It's useful for inspecting the schema's range limitations.

```APIDOC
get minValue(): null | number
```

--------------------------------

### createNote

Source: https://plain-typescript-sdk-docs.vercel.app/classes/PlainClient

Create a note on a thread.

```APIDOC
createNote(input): SDKResult<NotePartsFragment>
  Parameters:
    input: CreateNoteInput
  Returns: SDKResult<NotePartsFragment>
```

--------------------------------

### ZodNumber maxValue Accessor

Source: https://plain-typescript-sdk-docs.vercel.app/classes/_internal_.ZodNumber-1

Gets the maximum value constraint applied to the number schema. This accessor returns the upper bound if set, or null otherwise. It's useful for inspecting the schema's range limitations.

```APIDOC
get maxValue(): null | number
```

--------------------------------

### API Method: getCustomerGroups

Source: https://plain-typescript-sdk-docs.vercel.app/classes/PlainClient

Retrieves a paginated list of all customer groups.

```APIDOC
Method: getCustomerGroups
Signature: getCustomerGroups(variables): SDKResult<{ customerGroups: CustomerGroupPartsFragment[]; pageInfo: PageInfo; }>
Description: 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; }>
Source: src/client.ts:337
```

--------------------------------

### Upsert Tenant API Method

Source: https://plain-typescript-sdk-docs.vercel.app/classes/PlainClient

Creates or updates a tenant record in the system.

```APIDOC
upsertTenant(input: UpsertTenantInput): SDKResult<TenantPartsFragment>
  Parameters:
    - input: UpsertTenantInput
  Returns:
    SDKResult<TenantPartsFragment>
  Defined in: src/client.ts:993
```

--------------------------------

### ZodNumber transform Method

Source: https://plain-typescript-sdk-docs.vercel.app/classes/_internal_.ZodNumber-1

Documents the `transform` method for `ZodNumber` instances, enabling synchronous or asynchronous data transformation after parsing. This method allows changing the output type of the schema, for example, converting a number to a string or a custom object.

```APIDOC
transform<NewOut>(transform): ZodEffects<ZodNumber, NewOut, number>
  Type Parameters
    NewOut
  Parameters
    transform: ((arg, ctx) => NewOut | Promise<NewOut>)
      (arg, ctx): NewOut | Promise<NewOut>
        Parameters
          arg: number
          ctx: RefinementCtx
        Returns NewOut | Promise<NewOut>
  Returns ZodEffects<ZodNumber, NewOut, number>
  Inherited from ZodType.transform
  Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:81
```

--------------------------------

### Retrieve Customers: SDK getCustomers Method

Source: https://plain-typescript-sdk-docs.vercel.app/classes/PlainClient

This method retrieves a paginated list of customers. It accepts a 'variables' object to control pagination, filtering, and sorting. The method returns an 'SDKResult' containing customer data, page information, and total count.

```APIDOC
Method Signature:
  getCustomers(variables): SDKResult<{
    customers: CustomerPartsFragment[];
    pageInfo: PageInfoPartsFragment;
    totalCount: number;
  }>

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:209
```

--------------------------------

### Documenting spa Method (safeParseAsync Alias)

Source: https://plain-typescript-sdk-docs.vercel.app/classes/_internal_.ZodOptional-1

Documents the `spa` method, an alias for `safeParseAsync`, detailing its parameters and return type for asynchronous parsing.

```APIDOC
spa(data: unknown, params?: Partial<ParseParams>): Promise<SafeParseReturnType<undefined | T["_input"], undefined | T["_output"]>>
  Alias of: safeParseAsync
  Parameters:
    data: unknown
    params (Optional): Partial<ParseParams>
  Returns: Promise<SafeParseReturnType<undefined | T["_input"], undefined | T["_output"]>>
  Inherited from: ZodType.spa
  Defined in: node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:64
```

--------------------------------

### Reply to a Thread using SDK

Source: https://plain-typescript-sdk-docs.vercel.app/classes/PlainClient

Defines the SDK method for replying to an existing thread. It takes an input object containing reply details and returns a generic SDK result.

```APIDOC
replyToThread(input: ReplyToThreadInput): SDKResult<null>
```

--------------------------------

### _getOrReturnCtx Method

Source: https://plain-typescript-sdk-docs.vercel.app/classes/_internal_.ZodReadonly-1

Details the internal `_getOrReturnCtx` method, which handles parsing context, including its input parameters and the `ParseContext` it returns.

```APIDOC
_getOrReturnCtx(input, ctx?): ParseContext
Parameters:
  input: ParseInput
  Optional ctx: ParseContext
Returns ParseContext

Inherited from ZodType._getOrReturnCtx

Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:52
```

--------------------------------

### addMembersToTier

Source: https://plain-typescript-sdk-docs.vercel.app/classes/PlainClient

No description

```APIDOC
addMembersToTier(input): SDKResult<TierMembershipPartsFragment[]>
  input: AddMembersToTierInput
Returns: SDKResult<TierMembershipPartsFragment[]>
```

--------------------------------

### API Reference for ThreadStatusTransitionedPublicEventPayload Interface

Source: https://plain-typescript-sdk-docs.vercel.app/interfaces/ThreadStatusTransitionedPublicEventPayload

Detailed API documentation for the `ThreadStatusTransitionedPublicEventPayload` interface, including a description of its purpose and a breakdown of each property with its type and a brief explanation. This provides a structured overview of the event payload's contents.

```APIDOC
Interface: ThreadStatusTransitionedPublicEventPayload
  Description: Defines the payload structure for an event indicating a thread's status transition.
  Properties:
    eventType:
      Type: "thread.thread_status_transitioned"
      Description: The type of the event, a literal string indicating a thread status transitioned event.
    previousThread:
      Type: Thread
      Description: The state of the thread object before the status transition.
    thread:
      Type: Thread
      Description: The current state of the thread object after the status transition.
    [k: string]:
      Type: unknown
      Description: An index signature allowing for additional, unspecified string-keyed properties.
```

--------------------------------

### ZodEnum Class API Reference

Source: https://plain-typescript-sdk-docs.vercel.app/classes/_internal_.ZodEnum-1

Detailed API documentation for the `ZodEnum` class, outlining its structure, type parameters, inheritance, constructor signature, properties, accessors, and all available methods for schema definition and validation.

```APIDOC
Class ZodEnum<T>
  Type Parameters:
    T extends [string, ...string[]]

  Hierarchy:
    ZodType<T[number], ZodEnumDef<T>>
    + ZodEnum

  Defined in: node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:732

  Constructors:
    constructor(def: ZodEnumDef<T>): ZodEnum<T>
      Type Parameters:
        T extends [string, ...string[]]
      Parameters:
        def: ZodEnumDef<T>
      Returns: ZodEnum<T>
      Inherited from: ZodType.constructor
      Defined in: node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:73

  Properties:
    Readonly _def: ZodEnumDef<T>
      Inherited from: ZodType._def
      Defined in: node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:48

    Readonly _input: T[number]
      Inherited from: ZodType._input
      Defined in: node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:47

    Readonly _output: T[number]
      Inherited from: ZodType._output
      Defined in: node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:46

    Readonly _type: T[number]
      Inherited from: ZodType._type
      Defined in: node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:45

    spa: (data, params?) => Promise<SafeParseReturnType<T[number], T[number]>>
      Alias of safeParseAsync

  Accessors:
    Enum
    Values
    description
    enum
    options

  Methods:
    _getOrReturnCtx()
    _getType()
    _parse()
    _parseAsync()
    _parseSync()
    _processInputParams()
    _refinement()
    and()
    array()
    brand()
    catch()
    default()
    describe()
    exclude()
    extract()
    isNullable()
    isOptional()
    nullable()
    nullish()
    optional()
    or()
    parse()
    parseAsync()
    pipe()
    promise()
    readonly()
    refine()
    refinement()
    safeParse()
    safeParseAsync()
    superRefine()
    transform()
```

--------------------------------

### Retrieve Webhook Targets

Source: https://plain-typescript-sdk-docs.vercel.app/classes/PlainClient

Retrieves a paginated list of webhook targets. Supports pagination parameters like 'after', 'before', 'first', and 'last' for efficient data retrieval.

```APIDOC
getWebhookTargets(variables: Exact<{ after?: InputMaybe<string>; before?: InputMaybe<string>; first?: InputMaybe<number>; last?: InputMaybe<number>; }>): SDKResult<{ pageInfo: PageInfoPartsFragment; webhookTargets: WebhookTargetPartsFragment[]; }>
  Parameters:
    variables: Exact<{ after?: InputMaybe<string>; before?: InputMaybe<string>; first?: InputMaybe<number>; last?: InputMaybe<number>; }>
```

--------------------------------

### ZodPromise Constructor

Source: https://plain-typescript-sdk-docs.vercel.app/classes/_internal_.ZodPromise-1

Details the constructor for the ZodPromise class, including its parameters and return type. It initializes a new ZodPromise instance with a given definition.

```APIDOC
constructor
  Signature: new ZodPromise<T>(def): ZodPromise<T>
  Type Parameters:
    T extends ZodTypeAny
  Parameters:
    def: ZodPromiseDef<T>
  Returns: ZodPromise<T>
  Inherited from: ZodType.constructor
  Defined in: node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:73
```

--------------------------------

### Retrieve Tenants: SDK getTenants Method

Source: https://plain-typescript-sdk-docs.vercel.app/classes/PlainClient

This method retrieves a paginated list of tenants. It supports pagination parameters like 'after', 'before', 'first', and 'last' to control the result set. It returns an 'SDKResult' containing a list of tenants and pagination information.

```APIDOC
Method Signature:
  getTenants(variables): SDKResult<{
    pageInfo: PageInfoPartsFragment;
    tenants: TenantPartsFragment[];
  }>

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

Returns:
  SDKResult<{
    pageInfo: PageInfoPartsFragment;
    tenants: TenantPartsFragment[];
  }>

Defined in: src/client.ts:963
```

--------------------------------

### addCustomerToCustomerGroups

Source: https://plain-typescript-sdk-docs.vercel.app/classes/PlainClient

Adds a customer to a customer groups.

```APIDOC
addCustomerToCustomerGroups(input): SDKResult<CustomerGroupMembershipPartsFragment[]>
  input: AddCustomerToCustomerGroupsInput
Returns: SDKResult<CustomerGroupMembershipPartsFragment[]>
```

--------------------------------

### addCustomerToTenants

Source: https://plain-typescript-sdk-docs.vercel.app/classes/PlainClient

No description

```APIDOC
addCustomerToTenants(input): SDKResult<null>
  input: AddCustomerToTenantsInput
Returns: SDKResult<null>
```

--------------------------------

### SystemActor Interface API Definition

Source: https://plain-typescript-sdk-docs.vercel.app/interfaces/_internal_.SystemActor

Comprehensive API documentation for the `SystemActor` interface, detailing its structure, properties, and their types within the `@team-plain/typescript-sdk`. This includes the TypeScript interface definition and a structured breakdown of its members.

```TypeScript
interface SystemActor {
    actorType: "system";
    system: string;
    [k: string]: unknown;
}
```

```APIDOC
Interface: SystemActor

Properties:
  actorType:
    Type: "system"
    Defined in: src/webhooks/webhook-schema.ts:353

  system:
    Type: string
    Defined in: src/webhooks/webhook-schema.ts:354

Indexable Signature:
  [k: string]: unknown
  Defined in: src/webhooks/webhook-schema.ts:352
```

--------------------------------

### Documenting description Accessor

Source: https://plain-typescript-sdk-docs.vercel.app/classes/_internal_.ZodOptional-1

Documents the `description` accessor, which provides an optional string description and is inherited from `ZodType`.

```APIDOC
get description(): undefined | string
  Returns: undefined | string
  Inherited from: ZodType.description
  Defined in: node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:49
```

--------------------------------

### createAttachmentUploadUrl

Source: https://plain-typescript-sdk-docs.vercel.app/classes/PlainClient

No description

```APIDOC
createAttachmentUploadUrl(input): SDKResult<AttachmentUploadUrlPartsFragment>
  input: CreateAttachmentUploadUrlInput
Returns: SDKResult<AttachmentUploadUrlPartsFragment>
```

--------------------------------

### API Documentation for ZodDefault Class

Source: https://plain-typescript-sdk-docs.vercel.app/classes/_internal_.ZodDefault-1

Detailed API documentation for the ZodDefault class, including its type parameters, inheritance hierarchy, constructor signature, and inherited properties with their types and definitions. It also lists all available accessors and methods.

```APIDOC
Class ZodDefault<T>
  Type Parameters:
    T extends ZodTypeAny

  Hierarchy:
    ZodType<noUndefined<T["_output"]>, ZodDefaultDef<T>, T["_input"] | undefined>
      + ZodDefault
    Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:817

  Constructors:
    constructor(def: ZodDefaultDef<T>): ZodDefault<T>
      Type Parameters:
        T extends ZodTypeAny
      Parameters:
        def: ZodDefaultDef<T>
      Returns: ZodDefault<T>
      Inherited from ZodType.constructor
      Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:73

  Properties:
    Readonly _def: ZodDefaultDef<T>
      Inherited from ZodType._def
      Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:48
    Readonly _input: undefined | T["_input"]
      Inherited from ZodType._input
      Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:47
    Readonly _output: noUndefined<T["_output"]>
      Inherited from ZodType._output
      Defined in node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:46
    _type
    spa
    create

  Accessors:
    description

  Methods:
    _getOrReturnCtx
    _getType
    _parse
    _parseAsync
    _parseSync
    _processInputParams
    _refinement
    and
    array
    brand
    catch
    default
    describe
    isNullable
    isOptional
    nullable
    nullish
    optional
    or
    parse
    parseAsync
    pipe
    promise
    readonly
    refine
    refinement
    removeDefault
    safeParse
    safeParseAsync
    superRefine
    transform
```

--------------------------------

### Documenting _parseAsync Method

Source: https://plain-typescript-sdk-docs.vercel.app/classes/_internal_.ZodOptional-1

Documents the internal `_parseAsync` method, detailing its input and the `AsyncParseReturnType` it returns for asynchronous parsing.

```APIDOC
_parseAsync(input: ParseInput): AsyncParseReturnType<undefined | T["_output"]>
  Parameters:
    input: ParseInput
  Returns: AsyncParseReturnType<undefined | T["_output"]>
  Inherited from: ZodType._parseAsync
  Defined in: node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:58
```

--------------------------------

### ZodPipeline Class Overview and Members

Source: https://plain-typescript-sdk-docs.vercel.app/classes/_internal_.ZodPipeline-1

Provides an overview of the ZodPipeline class, including its generic type parameters, inheritance hierarchy, and a comprehensive list of its constructors, properties, accessors, and methods.

```APIDOC
Class ZodPipeline<A, B>
  Type Parameters:
    A extends ZodTypeAny
    B extends ZodTypeAny
  Hierarchy:
    ZodType<B["_output"], ZodPipelineDef<A, B>, A["_input"]>
      + ZodPipeline
  Defined in: node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:875

  Members Index:
    Constructors:
      constructor
    Properties:
      _def
      _input
      _output
      _type
      spa
    Accessors:
      description
    Methods:
      _getOrReturnCtx
      _getType
      _parse
      _parseAsync
      _parseSync
      _processInputParams
      _refinement
      and
      array
      brand
      catch
      default
      describe
      isNullable
      isOptional
      nullable
      nullish
      optional
      or
      parse
      parseAsync
      pipe
      promise
      readonly
      refine
      refinement
      safeParse
      safeParseAsync
      superRefine
      transform
      create
```

--------------------------------

### ZodString Static create Method

Source: https://plain-typescript-sdk-docs.vercel.app/classes/_internal_.ZodString-1

Documents the static `create` method for `ZodString`, used to instantiate a new `ZodString` schema with optional configuration parameters.

```APIDOC
Static Method: create
Signature: (params?: { description?: string; errorMap?: ZodErrorMap; invalid_type_error?: string; required_error?: string; } & { coerce?: true; }) => ZodString
Parameters:
  params (Optional):
    description (Optional): string
    errorMap (Optional): ZodErrorMap
    invalid_type_error (Optional): string
    required_error (Optional): string
    coerce (Optional): true
Returns: ZodString
Defined In: node_modules/.pnpm/zod@3.22.4/node_modules/zod/lib/types.d.ts:220
```

--------------------------------

### API Documentation for PlainWebhookVersionMismatchError Class

Source: https://plain-typescript-sdk-docs.vercel.app/classes/PlainWebhookVersionMismatchError

Comprehensive API documentation for the PlainWebhookVersionMismatchError class, outlining its inheritance from PlainWebhookError, its constructor signature, and all available properties and methods, including those inherited from base classes. This class is defined in src/webhooks/errors.ts.

```APIDOC
Class: PlainWebhookVersionMismatchError
  Hierarchy:
    PlainWebhookError
      + PlainWebhookVersionMismatchError
  Defined in: src/webhooks/errors.ts:5

  Constructors:
    constructor
      Signature: new PlainWebhookVersionMismatchError(error: string, payloadVersion: string): PlainWebhookVersionMismatchError
      Parameters:
        error: string
        payloadVersion: string
      Returns: PlainWebhookVersionMismatchError
      Overrides: PlainWebhookError.constructor
      Defined in: src/webhooks/errors.ts:6

  Properties:
    cause? (Optional)
      Type: unknown
      Inherited from: PlainWebhookError.cause
      Defined in: node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.es2022.error.d.ts:24

    message
      Type: string
      Inherited from: PlainWebhookError.message
      Defined in: node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.es5.d.ts:1077

    name
      Type: string
      Inherited from: PlainWebhookError.name
      Defined in: node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.es5.d.ts:1076

    stack? (Optional)
      Type: string
      Inherited from: PlainWebhookError.stack
      Defined in: node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.es5.d.ts:1078

    prepareStackTrace? (Static, Optional)
      Type: ((err: Error, stackTraces: CallSite[]) => any)
      Description: Optional override for formatting stack traces
      Parameters:
        err: Error
        stackTraces: CallSite[]
      Returns: any
      See: https://v8.dev/docs/stack-trace-api#customizing-stack-traces
      Inherited from: PlainWebhookError.prepareStackTrace
      Defined in: node_modules/.pnpm/@types+node@22.7.2/node_modules/@types/node/globals.d.ts:143

    stackTraceLimit (Static)
      Type: number
      Inherited from: PlainWebhookError.stackTraceLimit
      Defined in: node_modules/.pnpm/@types+node@22.7.2/node_modules/@types/node/globals.d.ts:145

  Methods:
    captureStackTrace (Static)
      Signature: captureStackTrace(targetObject: object, constructorOpt?: Function): void
      Description: Create .stack property on a target object
      Parameters:
        targetObject: object
        constructorOpt? (Optional): Function
      Returns: void
      Inherited from: PlainWebhookError.captureStackTrace
      Defined in: node_modules/.pnpm/@types+node@22.7.2/node_modules/@types/node/globals.d.ts:136
```

--------------------------------

### Update Customer Card Configuration API Method

Source: https://plain-typescript-sdk-docs.vercel.app/classes/PlainClient

Updates the configuration for a Customer Card using the Plain SDK. This method allows modification of existing customer card settings.

```APIDOC
updateCustomerCardConfig(input: UpdateCustomerCardConfigInput): SDKResult<CustomerCardConfigPartsFragment>
  Parameters:
    - input: UpdateCustomerCardConfigInput
  Returns:
    SDKResult<CustomerCardConfigPartsFragment>
  Defined in: src/client.ts:517
```

--------------------------------

### deleteCustomer

Source: https://plain-typescript-sdk-docs.vercel.app/classes/PlainClient

API method to delete a customer.

```APIDOC
deleteCustomer(input): SDKResult<null>
  Parameters:
    input: DeleteCustomerInput
  Returns: SDKResult<null>
```

--------------------------------

### Plain TypeScript SDK Global Variables Reference

Source: https://plain-typescript-sdk-docs.vercel.app/modules

A list of global variables available in the Plain TypeScript SDK, providing access to common components or configurations. Each variable links to its detailed documentation.

```APIDOC
uiComponent
```

--------------------------------

### Reply to an Email using SDK

Source: https://plain-typescript-sdk-docs.vercel.app/classes/PlainClient

Defines the SDK method for replying to an existing email. It takes an input object containing reply details and returns the result of the operation, including the updated email parts.

```APIDOC
replyToEmail(input: ReplyToEmailInput): SDKResult<EmailPartsFragment>
```
Tokens:
Raw