ReviewsService
A list of all methods in the ReviewsService service. Click on the method name to view detailed information about that method.
| Methods | Description |
|---|---|
| list_reviews | Returns a list of all the reviews sent to the user. Reviews are sorted by creation date, descending. |
| get_review_by_id | Returns the details of a review |
| approve_review | Updates the specified review with an approval decision. |
| deny_review | Updates the specified review with a deny decision. |
list_reviews
Returns a list of all the reviews sent to the user. Reviews are sorted by creation date, descending.
- HTTP Method:
GET - Endpoint:
/reviews
Return Type
List[Review]
Example Usage Code Snippet
from test_sdk import TestSdk
sdk = TestSdk(
access_token="YOUR_ACCESS_TOKEN",
timeout=10000
)
result = sdk.reviews.list_reviews()
print(result)
get_review_by_id
Returns the details of a review
- HTTP Method:
GET - Endpoint:
/reviews/{review_id}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| review_id | str | ✅ | The ID of the review to retrieve. |
Return Type
Review
Example Usage Code Snippet
from test_sdk import TestSdk
sdk = TestSdk(
access_token="YOUR_ACCESS_TOKEN",
timeout=10000
)
result = sdk.reviews.get_review_by_id(review_id="review_id")
print(result)
approve_review
Updates the specified review with an approval decision.
- HTTP Method:
PUT - Endpoint:
/reviews/{review_id}/approve
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| request_body | ReviewUpdateParams | ✅ | The request body. |
| review_id | str | ✅ | The ID of the review to approve |
Return Type
Review
Example Usage Code Snippet
from test_sdk import TestSdk
from test_sdk.models import ReviewUpdateParams
sdk = TestSdk(
access_token="YOUR_ACCESS_TOKEN",
timeout=10000
)
request_body = ReviewUpdateParams(
reason="reason"
)
result = sdk.reviews.approve_review(
request_body=request_body,
review_id="review_id"
)
print(result)
deny_review
Updates the specified review with a deny decision.
- HTTP Method:
PUT - Endpoint:
/reviews/{review_id}/deny
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| request_body | ReviewUpdateParams | ✅ | The request body. |
| review_id | str | ✅ | The ID of the review to deny |
Return Type
Review
Example Usage Code Snippet
from test_sdk import TestSdk
from test_sdk.models import ReviewUpdateParams
sdk = TestSdk(
access_token="YOUR_ACCESS_TOKEN",
timeout=10000
)
request_body = ReviewUpdateParams(
reason="reason"
)
result = sdk.reviews.deny_review(
request_body=request_body,
review_id="review_id"
)
print(result)