Class MyAccountApiError

Error class representing a connect account request error.

Hierarchy (View Summary)

SdkError
- MyAccountApiError

Index

Constructors

Properties

code detail name status title type validationErrors?

Constructors

constructor

new MyAccountApiError(
    __namedParameters: {
        detail: string;
        status: number;
        title: string;
        type: string;
        validationErrors?: {
            detail: string;
            field?: string;
            pointer?: string;
            source?: string;
        }[];
    },
): MyAccountApiError
Parameters
- __namedParameters: {
      detail: string;
      status: number;
      title: string;
      type: string;
      validationErrors?: {
          detail: string;
          field?: string;
          pointer?: string;
          source?: string;
      }[];
  }
Returns MyAccountApiError
Overrides SdkError.constructor
- Defined in src/errors/index.ts:337

Properties

code

code: string = "my_account_api_error"

detail

detail: string

name

name: string = "MyAccountApiError"

status

status: number

title

title: string

type

type: string

`Optional`validationErrors

validationErrors?: {
    detail: string;
    field?: string;
    pointer?: string;
    source?: string;
}[]

Type Declaration

detail: string
A human-readable description of the specific error. Required.
Optionalfield?: string
The name of the invalid parameter. Optional.
Optionalpointer?: string
A JSON Pointer that points to the exact location of the error in a JSON document being validated. Optional.
Optionalsource?: string
Specifies the source of the error (e.g., body, query, or header in an HTML message). Optional.