@nht-pandats/sdk / @nht-pandats/sdk/clients / @nht-pandats/sdk/clients/affiliateApi / AffiliateApiOperationResponse
Class: AffiliateApiOperationResponse<T, R>
@nht-pandats/sdk/clients.@nht-pandats/sdk/clients/affiliateApi.AffiliateApiOperationResponse
An object representing the response from an Affiliate API operation.
Type parameters
| Name | Type | Description |
|---|---|---|
T | any | The type of the response body. |
R | T | AffiliateApiErrorResponse | The type of the response body or error returned by the AffiliateApiOperationResponse.body accessor. |
Properties
data
• data: T
Defined in
src/clients/affiliateApi/utils.ts:250
Accessors
asJson
• get asJson(): Object
Returns
Object
| Name | Type |
|---|---|
body | R |
pagination | undefined | { limit: number ; next: undefined | number ; page: number ; previous: undefined | number } |
rateLimit | undefined | { limit: number ; remaining: number ; used: number ; utilization: number } |
requestId | undefined | string |
status | number |
body: R
-
pagination: undefined | { limit: number ; next: undefined | number ; page: number ; previous: undefined | number }
-
rateLimit: undefined | { limit: number ; remaining: number ; used: number ; utilization: number }
-
requestId: undefined | string
-
status: number
-
Defined in
src/clients/affiliateApi/utils.ts:362
body
• get body(): R
The body of the response.
Returns
R
Defined in
src/clients/affiliateApi/utils.ts:358
pagination
• get pagination(): undefined | AffiliateApiOperationResponsePaginationInformation
Information about the pagination of the operation.
Returns
undefined | AffiliateApiOperationResponsePaginationInformation
Defined in
src/clients/affiliateApi/utils.ts:351
rateLimit
• get rateLimit(): undefined | AffiliateApiOperationResponseRateLimitInformation
Information about the rate limit of the operation.
Returns
undefined | AffiliateApiOperationResponseRateLimitInformation
Defined in
src/clients/affiliateApi/utils.ts:344
requestId
• get requestId(): undefined | string
A unique identifier for the request.
Returns
undefined | string
Defined in
src/clients/affiliateApi/utils.ts:337
status
• get status(): number
The HTTP status code of the response.
Returns
number
Defined in
src/clients/affiliateApi/utils.ts:323
successful
• get successful(): boolean
Whether the operation was successful.
Returns
boolean