Hierarchy

  • PlainSDKClient

Constructors

  • Parameters

    • options: {
          apiKey: string;
      }
      • apiKey: string

    Returns PlainSDKClient

Properties

#ctx: Context

Methods

  • 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

    Returns SDKResult<Issue>

  • If the customer is not found this will return null.

    Parameters

    • variables: Exact<{
          customerId: string;
      }>

    Returns SDKResult<null | Customer>

  • 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>

  • 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

    Returns SDKResult<Customer>

Generated using TypeDoc