Search
Preparing search index...
The search index is not available
Xero Node.JS SDK Documentation
Menu
xero-node
Interface: IOAuth1HttpClient
Hierarchy
IHttpClient
IOAuth1Client
IOAuth1HttpClient
Implemented by
OAuth1HttpClient
Index
Properties
agent
Methods
build
Authorise
Url
delete
get
get
Request
Token
patch
post
put
read
Stream
ToRequest
refresh
Access
Token
swap
Request
Tokenfor
Access
Token
write
Binary
Response
ToStream
writeUTF8
Response
ToStream
Properties
Optional
agent
agent
:
Agent
Methods
build
Authorise
Url
build
Authorise
Url
(
requestToken
:
RequestToken
)
:
string
Parameters
requestToken:
RequestToken
Returns
string
delete
delete<T>
(
endpoint
:
string
, headers
?:
object
)
:
Promise
<
T
>
Type parameters
T
Parameters
endpoint:
string
Optional
headers:
object
[
key:
string
]:
string
Returns
Promise
<
T
>
get
get<T>
(
endpoint
:
string
, headers
?:
object
)
:
Promise
<
T
>
Type parameters
T
Parameters
endpoint:
string
Optional
headers:
object
[
key:
string
]:
string
Returns
Promise
<
T
>
get
Request
Token
get
Request
Token
(
)
:
Promise
<
RequestToken
>
Returns
Promise
<
RequestToken
>
patch
patch<T>
(
endpoint
:
string
, body
:
object
, headers
?:
object
)
:
Promise
<
T
>
Type parameters
T
Parameters
endpoint:
string
body:
object
Optional
headers:
object
[
key:
string
]:
string
Returns
Promise
<
T
>
post
post<T>
(
endpoint
:
string
, body
:
object
, headers
?:
object
)
:
Promise
<
T
>
Type parameters
T
Parameters
endpoint:
string
body:
object
Optional
headers:
object
[
key:
string
]:
string
Returns
Promise
<
T
>
put
put<T>
(
endpoint
:
string
, body
:
object
, headers
?:
object
)
:
Promise
<
T
>
Type parameters
T
Parameters
endpoint:
string
body:
object
Optional
headers:
object
[
key:
string
]:
string
Returns
Promise
<
T
>
read
Stream
ToRequest
read
Stream
ToRequest
(
endpoint
:
string
, mimeType
:
string
, size
:
number
, readStream
:
ReadStream
)
:
Promise
<
AttachmentsResponse
>
Parameters
endpoint:
string
mimeType:
string
size:
number
readStream:
ReadStream
Returns
Promise
<
AttachmentsResponse
>
refresh
Access
Token
refresh
Access
Token
(
)
:
Promise
<
AccessToken
>
Returns
Promise
<
AccessToken
>
swap
Request
Tokenfor
Access
Token
swap
Request
Tokenfor
Access
Token
(
requestToken
:
RequestToken
, oauth_verifier
:
string
)
:
Promise
<
AccessToken
>
Parameters
requestToken:
RequestToken
oauth_verifier:
string
Returns
Promise
<
AccessToken
>
write
Binary
Response
ToStream
write
Binary
Response
ToStream
(
endpoint
:
string
, mimeType
:
string
, writeStream
:
WriteStream
)
:
Promise
<
void
>
Parameters
endpoint:
string
mimeType:
string
writeStream:
WriteStream
Returns
Promise
<
void
>
writeUTF8
Response
ToStream
writeUTF8
Response
ToStream
(
endpoint
:
string
, mimeType
:
string
, writeStream
:
WriteStream
)
:
Promise
<
void
>
Parameters
endpoint:
string
mimeType:
string
writeStream:
WriteStream
Returns
Promise
<
void
>
IOAuth1
Http
Client
agent
build
Authorise
Url
delete
get
get
Request
Token
patch
post
put
read
Stream
ToRequest
refresh
Access
Token
swap
Request
Tokenfor
Access
Token
write
Binary
Response
ToStream
writeUTF8
Response
ToStream
Generated using
TypeDoc