Interface ReviewsService

interface ReviewsService {
    approveReview(reviewId: string): Promise<null | SavedReview>;
    create(review: CreateReviewInput): Promise<SavedReview>;
    createTravelerReviewsFromJotform(
        input: CreateTravelerReviewInput,
    ): Promise<SavedReview[]>;
    findByEndorsalId(endorsalId: string): Promise<null | SavedReview>;
    listHostReviews(
        hostId: string,
        customFilters?: ReviewCustomFilters,
        listQueryOptions?: ListQueryOptions<Review>,
    ): Promise<SavedReview[]>;
    listItineraryReviews(
        itineraryId: string,
        customFilters?: ReviewCustomFilters,
        listQueryOptions?: ListQueryOptions<Review>,
    ): Promise<SavedReview[]>;
    listReviews(
        query: FilterQuery<Review>,
        listQueryOptions?: ListQueryOptions<Review>,
    ): Promise<SavedReview[]>;
    listReviewsForHost(
        hostId: string,
        customFilters?: ReviewCustomFilters,
        listQueryOptions?: ListQueryOptions<Review>,
    ): Promise<SavedReview[]>;
    listTripReviews(
        tripId: string,
        customFilters?: ReviewCustomFilters,
        listQueryOptions?: ListQueryOptions<Review>,
    ): Promise<SavedReview[]>;
    listUnapprovedReviews(
        listQueryOptions?: ListQueryOptions<Review>,
    ): Promise<SavedReview[]>;
    processTagsFromReview(review: SavedReview): Promise<void>;
    rejectReview(reviewId: string): Promise<null | SavedReview>;
    submitHostReviewFromJotform(
        reviewData: JotformWebhookEnvelopeDTO,
    ): Promise<SavedReview>;
    submitTravelerReviewFromJotform(
        reviewData: JotformWebhookEnvelopeDTO,
    ): Promise<SavedReview[]>;
    syncDownReviews(waitInterval?: number): Promise<SavedReview[]>;
}

Index

Methods

approveReview create createTravelerReviewsFromJotform findByEndorsalId listHostReviews listItineraryReviews listReviews listReviewsForHost listTripReviews listUnapprovedReviews processTagsFromReview rejectReview submitHostReviewFromJotform submitTravelerReviewFromJotform syncDownReviews

Methods

approveReview

approveReview(reviewId: string): Promise<null | SavedReview>
Approves a review by its ID
Parameters
- reviewId: string
  The review ID.
Returns Promise<null | SavedReview>
- Defined in packages/services/src/services/Reviews/ReviewsService.ts:24

create

create(review: CreateReviewInput): Promise<SavedReview>
Creates a new review in the database and also creates a review in Endorsal (including review tags)
Parameters
- review: CreateReviewInput
  The review input data.
Returns Promise<SavedReview>
- Defined in packages/services/src/services/Reviews/ReviewsService.ts:18

createTravelerReviewsFromJotform

createTravelerReviewsFromJotform(
input: CreateTravelerReviewInput,
): Promise<SavedReview[]>
Creates traveler reviews from Jotform input.
Parameters
- input: CreateTravelerReviewInput
  Input data for creating traveler review.
Returns Promise<SavedReview[]>
- Defined in packages/services/src/services/Reviews/ReviewsService.ts:114

findByEndorsalId

findByEndorsalId(endorsalId: string): Promise<null | SavedReview>
Finds a review by the Endorsal Id.
Parameters
- endorsalId: string
  The Endorsal Id.
Returns Promise<null | SavedReview>
- Defined in packages/services/src/services/Reviews/ReviewsService.ts:108

listHostReviews

listHostReviews(
    hostId: string,
    customFilters?: ReviewCustomFilters,
    listQueryOptions?: ListQueryOptions<Review>,
): Promise<SavedReview[]>
Lists reviews associated with a host by host ID and optional list query options.
Parameters
- hostId: string
  The host ID.
- OptionalcustomFilters: ReviewCustomFilters
- OptionallistQueryOptions: ListQueryOptions<Review>
  Optional list query options.
Returns Promise<SavedReview[]>
- Defined in packages/services/src/services/Reviews/ReviewsService.ts:56

listItineraryReviews

listItineraryReviews(
    itineraryId: string,
    customFilters?: ReviewCustomFilters,
    listQueryOptions?: ListQueryOptions<Review>,
): Promise<SavedReview[]>
Lists reviews associated with an itinerary by itinerary ID and optional list query options.
Parameters
- itineraryId: string
  The itinerary ID.
- OptionalcustomFilters: ReviewCustomFilters
- OptionallistQueryOptions: ListQueryOptions<Review>
  Optional list query options.
Returns Promise<SavedReview[]>
- Defined in packages/services/src/services/Reviews/ReviewsService.ts:78

listReviews

listReviews(
query: FilterQuery<Review>,
listQueryOptions?: ListQueryOptions<Review>,
): Promise<SavedReview[]>
Retrieves a list of reviews based on the provided query and list options.
Parameters
- query: FilterQuery<Review>
  Filter query to narrow down the reviews.
- OptionallistQueryOptions: ListQueryOptions<Review>
  Optional options for listing reviews.
Returns Promise<SavedReview[]>
- Defined in packages/services/src/services/Reviews/ReviewsService.ts:38

listReviewsForHost

listReviewsForHost(
    hostId: string,
    customFilters?: ReviewCustomFilters,
    listQueryOptions?: ListQueryOptions<Review>,
): Promise<SavedReview[]>
Lists reviews for host based on the stored review display type for the host.
Parameters
- hostId: string
- OptionalcustomFilters: ReviewCustomFilters
  Optional custom filters.
- OptionallistQueryOptions: ListQueryOptions<Review>
  Optional list query options.
Returns Promise<SavedReview[]>
- Defined in packages/services/src/services/Reviews/ReviewsService.ts:131

listTripReviews

listTripReviews(
    tripId: string,
    customFilters?: ReviewCustomFilters,
    listQueryOptions?: ListQueryOptions<Review>,
): Promise<SavedReview[]>
Lists reviews associated with a trip by trip ID and optional list query options.
Parameters
- tripId: string
  The trip ID.
- OptionalcustomFilters: ReviewCustomFilters
- OptionallistQueryOptions: ListQueryOptions<Review>
  Optional list query options.
Returns Promise<SavedReview[]>
- Defined in packages/services/src/services/Reviews/ReviewsService.ts:67

listUnapprovedReviews

listUnapprovedReviews(
listQueryOptions?: ListQueryOptions<Review>,
): Promise<SavedReview[]>
Lists unapproved reviews
Parameters
- OptionallistQueryOptions: ListQueryOptions<Review>
  Optional list query options.
Returns Promise<SavedReview[]>
- Defined in packages/services/src/services/Reviews/ReviewsService.ts:47

processTagsFromReview

processTagsFromReview(review: SavedReview): Promise<void>
Processes tags from a review.
Parameters
- review: SavedReview
  The review object to process tags from.
Returns Promise<void>
- Defined in packages/services/src/services/Reviews/ReviewsService.ts:123

rejectReview

rejectReview(reviewId: string): Promise<null | SavedReview>
Rejects a review by its ID
Parameters
- reviewId: string
  The reviewId ID.
Returns Promise<null | SavedReview>
- Defined in packages/services/src/services/Reviews/ReviewsService.ts:30

submitHostReviewFromJotform

submitHostReviewFromJotform(
reviewData: JotformWebhookEnvelopeDTO,
): Promise<SavedReview>
Creates a new host review from Jotform.
Parameters
- reviewData: JotformWebhookEnvelopeDTO
Returns Promise<SavedReview>
- Defined in packages/services/src/services/Reviews/ReviewsService.ts:100

submitTravelerReviewFromJotform

submitTravelerReviewFromJotform(
reviewData: JotformWebhookEnvelopeDTO,
): Promise<SavedReview[]>
Creates a new traveler reviews from Jotform.
Parameters
- reviewData: JotformWebhookEnvelopeDTO
Returns Promise<SavedReview[]>
- Defined in packages/services/src/services/Reviews/ReviewsService.ts:93

syncDownReviews

syncDownReviews(waitInterval?: number): Promise<SavedReview[]>
Synchronizes all "unapproved" reviews from Endorsal, checking for status changes and updating locally.
Parameters
- OptionalwaitInterval: number
  Milliseconds to await after each iteration
Returns Promise<SavedReview[]>
- Defined in packages/services/src/services/Reviews/ReviewsService.ts:88

Interface ReviewsService

Index

Methods

Methods

approveReview

Parameters

Returns Promise<null | SavedReview>

create

Parameters

Returns Promise<SavedReview>

createTravelerReviewsFromJotform

Parameters

Returns Promise<SavedReview[]>

findByEndorsalId

Parameters

Returns Promise<null | SavedReview>

listHostReviews

Parameters

Returns Promise<SavedReview[]>

listItineraryReviews

Parameters

Returns Promise<SavedReview[]>

listReviews

Parameters

Returns Promise<SavedReview[]>

listReviewsForHost

Parameters

Returns Promise<SavedReview[]>

listTripReviews

Parameters

Returns Promise<SavedReview[]>

listUnapprovedReviews

Parameters

Returns Promise<SavedReview[]>

processTagsFromReview

Parameters

Returns Promise<void>

rejectReview

Parameters

Returns Promise<null | SavedReview>

submitHostReviewFromJotform

Parameters

Returns Promise<SavedReview>

submitTravelerReviewFromJotform

Parameters

Returns Promise<SavedReview[]>

syncDownReviews

Parameters

Returns Promise<SavedReview[]>

Settings

On This Page