@nht-pandats/sdk / @nht-pandats/sdk/clients / @nht-pandats/sdk/clients/affiliateApi / AffiliateApiCommentsModule
Class: AffiliateApiCommentsModule
@nht-pandats/sdk/clients.@nht-pandats/sdk/clients/affiliateApi.AffiliateApiCommentsModule
A module for interacting with the customer comments endpoint of the Affiliate API.
Since
v1.20240429.0
Methods
all
▸ all(options?): Promise<ResponseFields<AffiliateApiCommentsModelDefinition>[]>
List all customer comments matching the specified options via the Affiliate API.
Parameters
| Name | Type | Description |
|---|---|---|
options | Omit<ListCommentOptions, "limit" | "page"> | The options to use when listing all matching customer comments. |
Returns
Promise<ResponseFields<AffiliateApiCommentsModelDefinition>[]>
A list of all matching customer comments.
Throws
AffiliateApiOperationError If the operation was not successful.
Reference
Defined in
src/clients/affiliateApi/comments.ts:153
create
▸ create(payload): Promise<AffiliateApiOperationResponse<AffiliateApiCommentSaveSuccessfulResponse, AffiliateApiCommentSaveSuccessfulResponse>>
Create a new comment via the Affiliate API.
Parameters
| Name | Type | Description |
|---|---|---|
payload | CreatePayload<AffiliateApiCommentsModelDefinition> | The payload for creating a new comment via the Affiliate API. |
Returns
Promise<AffiliateApiOperationResponse<AffiliateApiCommentSaveSuccessfulResponse, AffiliateApiCommentSaveSuccessfulResponse>>
Creation Status and Resource Information on the created comment
Throws
AffiliateApiOperationError If the operation was not successful.
Reference
Defined in
src/clients/affiliateApi/comments.ts:177
list
▸ list(options?): Promise<AffiliateApiOperationResponse<ResponseFields<AffiliateApiCommentsModelDefinition>[], ResponseFields<AffiliateApiCommentsModelDefinition>[]>>
List customer comments via the Affiliate API.
Parameters
| Name | Type | Description |
|---|---|---|
options | ListCommentOptions | The options to use when listing customer comments. |
Returns
Promise<AffiliateApiOperationResponse<ResponseFields<AffiliateApiCommentsModelDefinition>[], ResponseFields<AffiliateApiCommentsModelDefinition>[]>>
List of customer comments
Throws
AffiliateApiOperationError If the operation was not successful.
Reference