AppendixApi.md

root / docs / classes

[Back to README.md]

dataforseo-client / Exports / AppendixApi

Class: AppendixApi

Table of contents

Constructors

• constructor

Properties

• baseUrl
• http
• jsonParseReviver

Methods

• appendixErrors
• appendixStatus
• processAppendixErrors
• processAppendixStatus
• processUserData
• processWebhookResend
• userData
• webhookResend

Constructors

constructor

• new AppendixApi(baseUrl?, http?): AppendixApi

Parameters

Name	Type
baseUrl?	string
http?	Object
http.fetch	(url: RequestInfo, init?: RequestInit) => Promise<Response>

Returns

AppendixApi

Defined in

main.ts:19174

Properties

baseUrl

• Private baseUrl: string

Defined in

main.ts:19171

---

http

• Private http: Object

Type declaration

Name	Type
fetch	(url: RequestInfo, init?: RequestInit) => Promise<Response>

Defined in

main.ts:19170

---

jsonParseReviver

• Protected jsonParseReviver: (key: string, value: any) => any = undefined

Type declaration

▸ (key, value): any

Parameters

Name	Type
key	string
value	any

Returns

any

Defined in

main.ts:19172

Methods

appendixErrors

▸ appendixErrors(): Promise<AppendixErrorsResponseInfo>

Returns

Promise<AppendixErrorsResponseInfo>

Successful operation

Defined in

main.ts:19219

---

appendixStatus

▸ appendixStatus(): Promise<AppendixStatusResponseInfo>

Returns

Promise<AppendixStatusResponseInfo>

Successful operation

Defined in

main.ts:19298

---

processAppendixErrors

▸ processAppendixErrors(response): Promise<AppendixErrorsResponseInfo>

Parameters

Name	Type
response	Response

Returns

Promise<AppendixErrorsResponseInfo>

Defined in

main.ts:19235

---

processAppendixStatus

▸ processAppendixStatus(response): Promise<AppendixStatusResponseInfo>

Parameters

Name	Type
response	Response

Returns

Promise<AppendixStatusResponseInfo>

Defined in

main.ts:19314

---

processUserData

▸ processUserData(response): Promise<AppendixUserDataResponseInfo>

Parameters

Name	Type
response	Response

Returns

Promise<AppendixUserDataResponseInfo>

Defined in

main.ts:19198

---

processWebhookResend

▸ processWebhookResend(response): Promise<AppendixWebhookResendResponseInfo>

Parameters

Name	Type
response	Response

Returns

Promise<AppendixWebhookResendResponseInfo>

Defined in

main.ts:19277

---

userData

▸ userData(): Promise<AppendixUserDataResponseInfo>

Returns

Promise<AppendixUserDataResponseInfo>

Successful operation

Defined in

main.ts:19182

---

webhookResend

▸ webhookResend(body): Promise<AppendixWebhookResendResponseInfo>

Parameters

Name	Type	Description
body	AppendixWebhookResendRequestInfo[]	(optional)

Returns

Promise<AppendixWebhookResendResponseInfo>

Successful operation

Defined in

main.ts:19257

root / docs / classes

[Back to README.md]