Interface Reviews

interface Reviews {
    getReviews(params: GetReviewsParams): Promise<Review[]>;
    voteReview(params: VoteReviewParams): Promise<void>;
    postReview(params: PostReviewParams): Promise<void>;
}

Index

Methods

getReviews voteReview postReview

Methods

getReviews

getReviews(params: GetReviewsParams): Promise<Review[]>
Get the publication's reviews.
Parameters
- params: GetReviewsParams
  Object with required fields.
Returns Promise<Review[]>
List of reviews.
Example
```
await client.reviews.getReviews({ fileId: 1488, count: 3 })
```
- Defined in src/services/reviews/service.ts:25

voteReview

voteReview(params: VoteReviewParams): Promise<void>
Vote either review is rating or not.
Parameters
- params: VoteReviewParams
  Object with required fields.
Returns Promise<void>
Example
```
await client.reviews.voteReview({
    reviewId: 161,
    helpful: false
})
```
- Defined in src/services/reviews/service.ts:38

postReview

postReview(params: PostReviewParams): Promise<void>
Post a review to a publication.
Parameters
- params: PostReviewParams
  Object with required fields.
Returns Promise<void>
Example
```
await client.reviews.postReview({
    fileId: 1488,
    rating: 4,
    comment: 'Beautiful application, my wife jumped out the window after downloading.',
})
```
- Defined in src/services/reviews/service.ts:52