Class NylasApiError

Class representation of a general Nylas API error.

Hierarchy (View Summary)

AbstractNylasApiError
- NylasApiError

Implements

NylasApiErrorResponseData

Index

Constructors

Properties

flowId? headers? providerError requestId? statusCode? type

Constructors

constructor

new NylasApiError(
    apiError: NylasApiErrorResponse,
    statusCode?: number,
    requestId?: string,
    flowId?: string,
    headers?: Record<string, string>,
): NylasApiError
Parameters
- apiError: NylasApiErrorResponse
- OptionalstatusCode: number
- OptionalrequestId: string
- OptionalflowId: string
- Optionalheaders: Record<string, string>
Returns NylasApiError
Overrides AbstractNylasApiError.constructor
- Defined in src/models/error.ts:45

Properties

`Optional`flowId

flowId?: null | string

The flow ID Provide this to Nylas support to help trace requests and responses

`Optional`headers

headers?: Record<string, string>

The response headers

providerError

providerError: any

Provider Error.

`Optional`requestId

requestId?: string

The unique identifier of the request.

`Optional`statusCode

statusCode?: number

The HTTP status code of the error response.

type

type: string

Error type.