Home Manual Reference Source

Typedef

Static Public Summary
public
public
public
public
public
public
public

At least an email or id is required.

Static Public

public Endpoint: Object source

Properties:

NameTypeAttributeDescription
method string

The HTTP method
path string

The pathname to the endpoint
body Array<string> | string | boolean

The parameter names to pass as the request body. If a string is passed, the request body will contain only the value of the parameter. If a boolean is passed, all the parameters will be used as the body.
chain Array<string>

The parameters to chain onto the path
anonymous boolean
  • optional
  • default: false

Whether the endpoint can be called without authorization headers
trailing boolean
  • optional
  • default: false

Whether to include a trailing slash at the end of the path

public KeyIV: Object source

Properties:

NameTypeAttributeDescription
key string

The symmetric key
iv string

The IV

public KeyPair: Object source

Properties:

NameTypeAttributeDescription
privateKeyPEM string

The private key
publicKeyPEM string

The public key

public OwnerUserDefinition: Object source

Properties:

NameTypeAttributeDescription
email string

The user's email address (instead of id)
id string

The user id (instead of email)

public QueueItem: Object source

Properties:

NameTypeAttributeDescription
deferred Deferred

The promise for when the item has been processed
message *

The message object/data to be sent to the Worker

public WorkflowStepDefinition: Object source

Properties:

NameTypeAttributeDescription
name string
  • optional

The name of the step (by default steps have no name)
users Array<WorkflowUserDefinition>

The users within the workflow step

public WorkflowUserDefinition: Object source

At least an email or id is required.

Properties:

NameTypeAttributeDescription
email string

The user's email address (instead of id)
id string

The user id (instead of email)
role WorkflowUserRole
  • optional
  • default: WorkflowUserRole.REVIEWER

The role the user has within the workflow step
permissions object
  • optional

Any additional permissions the user has
permissions.inviter boolean
  • optional

Whether the user has the ability to invite others to the proof