/** * Klaviyo API * The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. * * Contact: developers@klaviyo.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { AxiosResponse } from "axios"; import { GetReviewResponseDTOCollectionCompoundDocument } from '../model/getReviewResponseDTOCollectionCompoundDocument'; import { GetReviewResponseDTOCompoundDocument } from '../model/getReviewResponseDTOCompoundDocument'; import { PatchReviewResponseDTO } from '../model/patchReviewResponseDTO'; import { ReviewPatchQuery } from '../model/reviewPatchQuery'; import { Session } from './apis'; export declare class ReviewsApi { session: Session; protected _basePath: string; protected _defaultHeaders: any; protected _useQuerystring: boolean; constructor(session: Session); set useQuerystring(value: boolean); set basePath(basePath: string); set defaultHeaders(defaultHeaders: any); get defaultHeaders(): any; get basePath(): string; /** * Get the review with the given ID.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `reviews:read` * @summary Get Review * @param id The ID of the review * @param fieldsEvent For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets* @param fieldsReview For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets* @param include For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships */ getReview(id: string, options?: { fieldsEvent?: Array<'datetime' | 'event_properties' | 'timestamp' | 'uuid'>; fieldsReview?: Array<'author' | 'content' | 'created' | 'email' | 'images' | 'product' | 'product.external_id' | 'product.image_url' | 'product.name' | 'product.url' | 'public_reply' | 'public_reply.author' | 'public_reply.content' | 'public_reply.updated' | 'rating' | 'review_type' | 'smart_quote' | 'status' | 'status.rejection_reason' | 'status.rejection_reason.reason' | 'status.rejection_reason.status_explanation' | 'status.value' | 'title' | 'updated' | 'verified'>; include?: Array<'events'>; }): Promise<{ response: AxiosResponse; body: GetReviewResponseDTOCompoundDocument; }>; /** * Get all reviews.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `reviews:read` * @summary Get Reviews * @param fieldsEvent For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets* @param fieldsReview For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets* @param filter For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`created`: `greater-or-equal`, `less-or-equal`<br>`rating`: `any`, `equals`, `greater-or-equal`, `less-or-equal`<br>`id`: `any`, `equals`<br>`item.id`: `any`, `equals`<br>`content`: `contains`<br>`status`: `equals`<br>`review_type`: `equals`<br>`verified`: `equals`* @param include For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships* @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination* @param pageSize Default: 20. Min: 1. Max: 100.* @param sort For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting */ getReviews(options?: { fieldsEvent?: Array<'datetime' | 'event_properties' | 'timestamp' | 'uuid'>; fieldsReview?: Array<'author' | 'content' | 'created' | 'email' | 'images' | 'product' | 'product.external_id' | 'product.image_url' | 'product.name' | 'product.url' | 'public_reply' | 'public_reply.author' | 'public_reply.content' | 'public_reply.updated' | 'rating' | 'review_type' | 'smart_quote' | 'status' | 'status.rejection_reason' | 'status.rejection_reason.reason' | 'status.rejection_reason.status_explanation' | 'status.value' | 'title' | 'updated' | 'verified'>; filter?: string; include?: Array<'events'>; pageCursor?: string; pageSize?: number; sort?: 'created' | '-created' | 'rating' | '-rating' | 'updated' | '-updated'; }): Promise<{ response: AxiosResponse; body: GetReviewResponseDTOCollectionCompoundDocument; }>; /** * Update a review.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `reviews:write` * @summary Update Review * @param id The id of the review (review ID).* @param reviewPatchQuery DTO for updating reviews */ updateReview(id: string, reviewPatchQuery: ReviewPatchQuery): Promise<{ response: AxiosResponse; body: PatchReviewResponseDTO; }>; }