Options
All
  • Public
  • Public/Protected
  • All
Menu

Class API

Hierarchy

  • API

Index

Constructors

Methods

Object literals

Constructors

constructor

  • new API(apiSettings: IXhrOptions, lang: string, useCache: boolean): API

  • Parameters

    • apiSettings: IXhrOptions
    • lang: string
    • useCache: boolean

    Returns API

Methods

business

  • business(): Promise<Model.Business>

businessAssign

  • businessAssign(tripianPoiId: string): Promise<Model.User>

businessCampaign

  • businessCampaign(campaignId: number): Promise<Model.Campaign | undefined>

  • Parameters

    • campaignId: number

    Returns Promise<Model.Campaign | undefined>

businessCampaignAdd

  • businessCampaignAdd(campaignRequest: Model.CampaignAddRequest): Promise<number>

  • Parameters

    • campaignRequest: Model.CampaignAddRequest

    Returns Promise<number>

businessCampaignUpdate

  • businessCampaignUpdate(campaignId: number, campaignRequest: Model.CampaignUpdateRequest): Promise<boolean>

  • Parameters

    • campaignId: number
    • campaignRequest: Model.CampaignUpdateRequest

    Returns Promise<boolean>

businessCampaigns

  • businessCampaigns(page: number, limit?: number): Promise<Model.DataPayload<Model.Campaign[]>>

  • Campaign

    Parameters

    • page: number
    • Default value limit: number = 1000

    Returns Promise<Model.DataPayload<Model.Campaign[]>>

businessCouponApplication

  • businessCouponApplication(applicationId: number): Promise<Model.CouponApplication | undefined>

  • Parameters

    • applicationId: number

    Returns Promise<Model.CouponApplication | undefined>

businessCouponApplicationAdd

  • businessCouponApplicationAdd(couponApplicationRequest: Model.CouponApplicationRequest): Promise<number>

  • Parameters

    • couponApplicationRequest: Model.CouponApplicationRequest

    Returns Promise<number>

businessCouponApplicationFileUpload

  • businessCouponApplicationFileUpload(file: string): Promise<{ url: string }>

businessCouponApplicationUserApprove

  • businessCouponApplicationUserApprove(applicationId: number, travelerId: number, campaignId: number, bookingDate: string, amount?: undefined | number): Promise<Model.CouponApplication | undefined>

  • Parameters

    • applicationId: number
    • travelerId: number
    • campaignId: number
    • bookingDate: string
    • Optional amount: undefined | number

    Returns Promise<Model.CouponApplication | undefined>

businessCouponApplicationUserReject

  • businessCouponApplicationUserReject(applicationId: number, travelerId: number, campaignId: number, bookingDate: string, notes: string): Promise<Model.CouponApplication | undefined>

  • Parameters

    • applicationId: number
    • travelerId: number
    • campaignId: number
    • bookingDate: string
    • notes: string

    Returns Promise<Model.CouponApplication | undefined>

businessCouponApplications

  • businessCouponApplications(page: number, status: "waiting" | "reviewed", limit?: number): Promise<Model.DataPayload<Model.CouponApplication[]>>

  • Coupon

    Parameters

    • page: number
    • status: "waiting" | "reviewed"
    • Default value limit: number = 150

    Returns Promise<Model.DataPayload<Model.CouponApplication[]>>

businessExport

  • businessExport(reportType: "campaign-customer-report" | "campaign-report" | "business-report" | "pre-register-report", campaignId?: undefined | number): Promise<{ url: string }>

  • Parameters

    • reportType: "campaign-customer-report" | "campaign-report" | "business-report" | "pre-register-report"
    • Optional campaignId: undefined | number

    Returns Promise<{ url: string }>

businessOffer

  • businessOffer(offerId: number): Promise<Model.Offer>

businessOfferAdd

  • businessOfferAdd(offerAddRequest: Model.OfferAddRequest): Promise<Model.Offer>

  • Parameters

    • offerAddRequest: Model.OfferAddRequest

    Returns Promise<Model.Offer>

businessOfferCustomers

  • businessOfferCustomers(offerId: number): Promise<Model.OfferCustomer[]>

  • Parameters

    • offerId: number

    Returns Promise<Model.OfferCustomer[]>

businessOfferDelete

  • businessOfferDelete(offerId: number): Promise<number>

businessOfferFileUpload

  • businessOfferFileUpload(file: string): Promise<{ url: string }>

businessOfferImageUpdate

  • businessOfferImageUpdate(offerId: number, imageUrl: string): Promise<Model.Offer>

  • Parameters

    • offerId: number
    • imageUrl: string

    Returns Promise<Model.Offer>

businessOfferRedeemStatus

  • businessOfferRedeemStatus(offerId: number, userId: number): Promise<"waiting" | "pending" | "completed">

  • Parameters

    • offerId: number
    • userId: number

    Returns Promise<"waiting" | "pending" | "completed">

businessOfferRedeemStatusUpdate

  • businessOfferRedeemStatusUpdate(offerId: number, userId: number, status: "waiting" | "pending" | "completed"): Promise<"waiting" | "pending" | "completed">

  • Parameters

    • offerId: number
    • userId: number
    • status: "waiting" | "pending" | "completed"

    Returns Promise<"waiting" | "pending" | "completed">

businessOfferReport

  • businessOfferReport(page?: number, limit?: number): Promise<Model.DataPayload<Model.BusinessOfferReport>>

  • Parameters

    • Default value page: number = 1
    • Default value limit: number = 1000

    Returns Promise<Model.DataPayload<Model.BusinessOfferReport>>

businessOfferStatusUpdate

  • businessOfferStatusUpdate(offerId: number, status: OFFER_STATUS): Promise<Model.Offer>

  • Parameters

    • offerId: number
    • status: OFFER_STATUS

    Returns Promise<Model.Offer>

businessOffers

  • businessOffers(statuses: OFFER_STATUS[], page?: number, limit?: undefined | number): Promise<Model.DataPayload<Model.Offer[]>>

  • Parameters

    • statuses: OFFER_STATUS[]
    • Default value page: number = 1
    • Optional limit: undefined | number

    Returns Promise<Model.DataPayload<Model.Offer[]>>

businessPreRegister

  • businessPreRegister(preRegister: Model.PreRegister): Promise<boolean>

  • Business Pre Registers

    Parameters

    • preRegister: Model.PreRegister

    Returns Promise<boolean>

businessPreRegisterReport

  • businessPreRegisterReport(query: Partial<Model.BusinessPreRegisterReportRequest>): Promise<Model.DataPayload<Model.BusinessReport>>

  • Parameters

    • query: Partial<Model.BusinessPreRegisterReportRequest>

    Returns Promise<Model.DataPayload<Model.BusinessReport>>

businessReport

  • businessReport(query: Partial<Model.BusinessReportRequest>): Promise<Model.DataPayload<Model.BusinessReport>>

  • Parameters

    • query: Partial<Model.BusinessReportRequest>

    Returns Promise<Model.DataPayload<Model.BusinessReport>>

businessSearch

  • businessSearch(q: string, cityId: number, bounds?: undefined | string): Promise<Model.BusinessSearch[]>

  • Small Business Tools

    Parameters

    • q: string
    • cityId: number
    • Optional bounds: undefined | string

    Returns Promise<Model.BusinessSearch[]>

businessVoucherOfferAdd

  • businessVoucherOfferAdd(voucherOfferAddRequest: Model.VoucherOfferAddRequest): Promise<Model.VoucherOffer>

  • Parameters

    • voucherOfferAddRequest: Model.VoucherOfferAddRequest

    Returns Promise<Model.VoucherOffer>

campaignCustomerReport

  • campaignCustomerReport(campaignId: number, query: Partial<Model.CampaignCustomerReportRequest>): Promise<Model.DataPayload<Model.CampaignCustomerReport>>

  • Parameters

    • campaignId: number
    • query: Partial<Model.CampaignCustomerReportRequest>

    Returns Promise<Model.DataPayload<Model.CampaignCustomerReport>>

campaignReport

  • campaignReport(campaignId: number, query: Partial<Model.CampaignReportRequest>): Promise<Model.DataPayload<Model.CampaignReport>>

  • Wallet

    Parameters

    • campaignId: number
    • query: Partial<Model.CampaignReportRequest>

    Returns Promise<Model.DataPayload<Model.CampaignReport>>

campaignReportPay

  • campaignReportPay(campaignId: number, id: number): Promise<boolean>

  • Parameters

    • campaignId: number
    • id: number

    Returns Promise<boolean>

checkVerify

  • checkVerify(to_: string, channel: VERIFY_CHANNEL, code: string): Promise<Model.BusinessVerify>

  • Parameters

    • to_: string
    • channel: VERIFY_CHANNEL
    • code: string

    Returns Promise<Model.BusinessVerify>

citiesAll

  • citiesAll(): Promise<Model.City[]>

citiesPage

  • citiesPage(page: number, limit?: number): Promise<Model.DataPayload<Model.City[]>>

  • Cities

    Parameters

    • page: number
    • Default value limit: number = 1000

    Returns Promise<Model.DataPayload<Model.City[]>>

citiesSearch

  • citiesSearch(name: string): Promise<Model.City[]>

city

  • city(cityId: number): Promise<Model.City>

companionAdd

  • companionAdd(newCompanion: Model.CompanionRequest): Promise<Model.Companion>

  • Parameters

    • newCompanion: Model.CompanionRequest

    Returns Promise<Model.Companion>

companionDelete

  • companionDelete(companionId: number): Promise<number>

companionUpdate

  • companionUpdate(companion: Model.Companion): Promise<Model.Companion>

  • Parameters

    • companion: Model.Companion

    Returns Promise<Model.Companion>

companions

  • companions(force?: boolean): Promise<Model.Companion[]>

  • Companions

    Parameters

    • Default value force: boolean = this.forceRequest

    Returns Promise<Model.Companion[]>

configList

  • configList(): Promise<ConfigList>

coupons

  • coupons(page: number, limit?: number): Promise<Model.DataPayload<Model.Coupon[]>>

  • Wallet

    Parameters

    • page: number
    • Default value limit: number = 1000

    Returns Promise<Model.DataPayload<Model.Coupon[]>>

customPois

  • customPois(name?: undefined | string): Promise<Model.Poi[]>

  • Parameters

    • Optional name: undefined | string

    Returns Promise<Model.Poi[]>

customStepAdd

  • customStepAdd(planId: number, customPoi: Model.CustomPoi, stepType: string, startTime?: undefined | string, endTime?: undefined | string): Promise<Model.Step>

  • Parameters

    • planId: number
    • customPoi: Model.CustomPoi
    • stepType: string
    • Optional startTime: undefined | string
    • Optional endTime: undefined | string

    Returns Promise<Model.Step>

favoriteAdd

  • favoriteAdd(poiId: string, tripHash?: undefined | string): Promise<Model.Favorite>

  • Parameters

    • poiId: string
    • Optional tripHash: undefined | string

    Returns Promise<Model.Favorite>

favoriteDelete

  • favoriteDelete(favoriteId: number): Promise<number>

favorites

  • favorites(cityId: number): Promise<Model.Favorite[]>

  • Favorites

    Parameters

    • cityId: number

    Returns Promise<Model.Favorite[]>

feedbackSend

  • feedbackSend(feedbackRequest: Model.FeedbackRequest): Promise<Model.UserFeedback[]>

  • Parameters

    • feedbackRequest: Model.FeedbackRequest

    Returns Promise<Model.UserFeedback[]>

feedbacks

  • feedbacks(): Promise<Model.Feedbacks>

getToken

  • getToken(): Model.Token | undefined

lightLoginHash

  • lightLoginHash(tripHash: string): Promise<Model.Token>

lightRegisterLogin

  • lightRegisterLogin(uniqueId: string): Promise<Model.Token>

log

  • log(message: string, dataPayload?: any, type?: "ERROR" | "WARNING" | "INFO"): Promise<any>

  • Logs

    Parameters

    • message: string
    • Default value dataPayload: any = {}
    • Default value type: "ERROR" | "WARNING" | "INFO" = "ERROR"

    Returns Promise<any>

loginCognito

  • loginCognito(code: string, redirectUrl: string, device: Model.Device): Promise<Token>

  • Parameters

    • code: string
    • redirectUrl: string
    • device: Model.Device

    Returns Promise<Token>

loginEmail

  • loginEmail(email: string, password: string, business?: undefined | false | true): Promise<Model.Token>

  • Parameters

    • email: string
    • password: string
    • Optional business: undefined | false | true

    Returns Promise<Model.Token>

loginGuest

  • loginGuest(uniqueId: string): Promise<Model.Token>

  • Guest

    Parameters

    • uniqueId: string

    Returns Promise<Model.Token>

logout

  • logout(): void

notifications

  • notifications(): Promise<Model.Notification[]>

notificationsSettings

  • notificationsSettings(): Promise<Model.NotificationSettings[]>

notificationsUnseen

  • notificationsUnseen(): Promise<Model.NotificationUnseen>

notificationsUpdateSettings

  • notificationsUpdateSettings(settingId: number, checked: boolean): Promise<Model.NotificationSettings[]>

  • Parameters

    • settingId: number
    • checked: boolean

    Returns Promise<Model.NotificationSettings[]>

notificationsUpdateUnseen

  • notificationsUpdateUnseen(): Promise<Model.DeleteUpdateResponse>

offer

  • offer(offerId: number): Promise<Model.Offer>

offerDelete

  • offerDelete(offerId: number): Promise<Model.DeleteUpdateResponse>

  • Parameters

    • offerId: number

    Returns Promise<Model.DeleteUpdateResponse>

offerRedeemStatus

  • offerRedeemStatus(offerId: number): Promise<"waiting" | "pending" | "completed">

  • Parameters

    • offerId: number

    Returns Promise<"waiting" | "pending" | "completed">

offerRedeemStatusUpdate

  • offerRedeemStatusUpdate(offerId: number, status: "waiting" | "pending" | "completed"): Promise<"waiting" | "pending" | "completed">

  • Parameters

    • offerId: number
    • status: "waiting" | "pending" | "completed"

    Returns Promise<"waiting" | "pending" | "completed">

offerSearch

  • offerSearch(dateFrom: string, dateTo: string, boundary: string, showOffersOnly: boolean): Promise<Model.Poi[]>

  • Parameters

    • dateFrom: string
    • dateTo: string
    • boundary: string
    • showOffersOnly: boolean

    Returns Promise<Model.Poi[]>

offerSearchCampaign

  • offerSearchCampaign(campaignId: number, showOffersOnly: boolean): Promise<Model.Poi[]>

  • Parameters

    • campaignId: number
    • showOffersOnly: boolean

    Returns Promise<Model.Poi[]>

offerSearchNew

  • offerSearchNew(dateFrom: string, dateTo: string, boundary: string): Promise<Model.DataPayload<Model.Poi[]>>

  • Parameters

    • dateFrom: string
    • dateTo: string
    • boundary: string

    Returns Promise<Model.DataPayload<Model.Poi[]>>

offerUpdateOptIn

  • offerUpdateOptIn(offerId: number, optInDate: string): Promise<Model.DeleteUpdateResponse>

  • Parameters

    • offerId: number
    • optInDate: string

    Returns Promise<Model.DeleteUpdateResponse>

offers

  • offers(dateFrom?: undefined | string, dateTo?: undefined | string): Promise<Model.Poi[]>

  • Parameters

    • Optional dateFrom: undefined | string
    • Optional dateTo: undefined | string

    Returns Promise<Model.Poi[]>

payment

  • payment(voucherOfferId: number): Promise<Model.Coupon>

  • Parameters

    • voucherOfferId: number

    Returns Promise<Model.Coupon>

plan

  • plan(planId: number, generate?: boolean, sleepMs?: number, retryCount?: number): Promise<Model.Plan>

  • Plan

    Parameters

    • planId: number
    • Default value generate: boolean = true
    • Default value sleepMs: number = 1000
    • Default value retryCount: number = 20

    Returns Promise<Model.Plan>

planRouteUrl

  • planRouteUrl(planId: number, tripHash: string): Promise<{ url: string }>

  • Parameters

    • planId: number
    • tripHash: string

    Returns Promise<{ url: string }>

planUpdateOrders

  • planUpdateOrders(planId: number, stepOrders: number[]): Promise<Model.Plan>

  • Parameters

    • planId: number
    • stepOrders: number[]

    Returns Promise<Model.Plan>

planUpdateTime

  • planUpdateTime(planId: number, startTime: string, endTime: string): Promise<Model.Plan>

  • Parameters

    • planId: number
    • startTime: string
    • endTime: string

    Returns Promise<Model.Plan>

poi

  • poi(poiId: string, withOffers?: number): Promise<Model.Poi>

  • Parameters

    • poiId: string
    • Default value withOffers: number = 1

    Returns Promise<Model.Poi>

poiCategories

  • poiCategories(limit?: number): Promise<Model.PoiCategory[]>

  • POI

    Parameters

    • Default value limit: number = 100

    Returns Promise<Model.PoiCategory[]>

pois

  • pois(poiIds: string[], withOffers: number, cityId?: undefined | number): Promise<Model.Poi[]>

  • Parameters

    • poiIds: string[]
    • withOffers: number
    • Optional cityId: undefined | number

    Returns Promise<Model.Poi[]>

poisCoordinateSearch

  • poisCoordinateSearch(__namedParameters: { bounds: undefined | string; coordinate: undefined | string; distance: undefined | number; limit: number; poiCategories: undefined | string; showOffersOnly: undefined | false | true }): Promise<Model.Poi[]>

  • Parameters

    • __namedParameters: { bounds: undefined | string; coordinate: undefined | string; distance: undefined | number; limit: number; poiCategories: undefined | string; showOffersOnly: undefined | false | true }
      • bounds: undefined | string
      • coordinate: undefined | string
      • distance: undefined | number
      • limit: number
      • poiCategories: undefined | string
      • showOffersOnly: undefined | false | true

    Returns Promise<Model.Poi[]>

poisMustTrySearch

  • poisMustTrySearch(__namedParameters: { cityId: number; limit: number; mustTryIds: undefined | string }): Promise<Model.Poi[]>

  • Parameters

    • __namedParameters: { cityId: number; limit: number; mustTryIds: undefined | string }
      • cityId: number
      • limit: number
      • mustTryIds: undefined | string

    Returns Promise<Model.Poi[]>

poisNameSearch

  • poisNameSearch(__namedParameters: { cityId: undefined | number; limit: number; page: number; poiCategories: undefined | string; search: undefined | string; showOffersOnly: boolean }): Promise<Model.DataPayload<Model.Poi[]>>

  • Parameters

    • __namedParameters: { cityId: undefined | number; limit: number; page: number; poiCategories: undefined | string; search: undefined | string; showOffersOnly: boolean }
      • cityId: undefined | number
      • limit: number
      • page: number
      • poiCategories: undefined | string
      • search: undefined | string
      • showOffersOnly: boolean

    Returns Promise<Model.DataPayload<Model.Poi[]>>

poisOpenSearch

  • poisOpenSearch(__namedParameters: { cityId: undefined | number; limit: number; page: number; poiCategories: undefined | string; search: undefined | string; showOffersOnly: undefined | false | true }): Promise<Model.DataPayload<Model.Poi[]>>

  • Parameters

    • __namedParameters: { cityId: undefined | number; limit: number; page: number; poiCategories: undefined | string; search: undefined | string; showOffersOnly: undefined | false | true }
      • cityId: undefined | number
      • limit: number
      • page: number
      • poiCategories: undefined | string
      • search: undefined | string
      • showOffersOnly: undefined | false | true

    Returns Promise<Model.DataPayload<Model.Poi[]>>

poisSearch

  • poisSearch(poisRequest: Model.PoisRequest): Promise<Model.DataPayload<Model.Poi[]>>

  • Parameters

    • poisRequest: Model.PoisRequest

    Returns Promise<Model.DataPayload<Model.Poi[]>>

poisSearchAutoComplete

  • poisSearchAutoComplete(): Promise<string[]>

poisSearchAutoCompleteTags

  • poisSearchAutoCompleteTags(cityId: number, poiCategories?: undefined | string): Promise<{ id: number; name: string }[]>

  • Parameters

    • cityId: number
    • Optional poiCategories: undefined | string

    Returns Promise<{ id: number; name: string }[]>

productTypes

  • productTypes(): Promise<Model.OfferProductType[]>

questionsAll

  • questionsAll(cityId?: undefined | number): Promise<Model.Question[]>

  • Parameters

    • Optional cityId: undefined | number

    Returns Promise<Model.Question[]>

questionsCompanion

  • questionsCompanion(cityId?: undefined | number): Promise<Model.Question[]>

  • Parameters

    • Optional cityId: undefined | number

    Returns Promise<Model.Question[]>

questionsProfile

  • questionsProfile(cityId?: undefined | number): Promise<Model.Question[]>

  • Parameters

    • Optional cityId: undefined | number

    Returns Promise<Model.Question[]>

questionsTrip

  • questionsTrip(cityId?: undefined | number): Promise<Model.Question[]>

  • Parameters

    • Optional cityId: undefined | number

    Returns Promise<Model.Question[]>

reactionAdd

  • reactionAdd(reactionRequest: Model.UserReactionRequest): Promise<Model.UserReaction>

  • Parameters

    • reactionRequest: Model.UserReactionRequest

    Returns Promise<Model.UserReaction>

reactionDelete

  • reactionDelete(reactionId: number): Promise<number>

reactionUpdate

  • reactionUpdate(id: number, comment: string): Promise<Model.UserReaction>

  • Parameters

    • id: number
    • comment: string

    Returns Promise<Model.UserReaction>

reactions

  • reactions(tripHash: string, reaction?: Model.REACTION, page?: number): Promise<Model.UserReaction[]>

  • Reactions

    Parameters

    • tripHash: string
    • Optional reaction: Model.REACTION
    • Default value page: number = 1

    Returns Promise<Model.UserReaction[]>

refreshToken

  • refreshToken(force?: boolean): Promise<Model.Token>

  • Parameters

    • Default value force: boolean = false

    Returns Promise<Model.Token>

register

  • register(registerRequest: Model.RegisterRequest): Promise<Model.Token>

  • Registers

    Parameters

    • registerRequest: Model.RegisterRequest

    Returns Promise<Model.Token>

removeToken

  • removeToken(): void

reservationAdd

  • reservationAdd(reservationRequest: Model.UserReservationRequest): Promise<Model.UserReservation>

  • Parameters

    • reservationRequest: Model.UserReservationRequest

    Returns Promise<Model.UserReservation>

reservationDelete

  • reservationDelete(reservationId: number): Promise<number>

reservationUpdate

  • reservationUpdate(reservation: Model.UserReservation): Promise<Model.UserReservation>

  • Parameters

    • reservation: Model.UserReservation

    Returns Promise<Model.UserReservation>

reservations

  • reservations(cityId?: undefined | number, tripHash?: undefined | string, poiId?: undefined | string, provider?: undefined | string, startDate?: undefined | string, endDate?: undefined | string, limit?: number): Promise<Model.UserReservation[]>

  • Reservations

    Parameters

    • Optional cityId: undefined | number
    • Optional tripHash: undefined | string
    • Optional poiId: undefined | string
    • Optional provider: undefined | string
    • Optional startDate: undefined | string
    • Optional endDate: undefined | string
    • Default value limit: number = 100

    Returns Promise<Model.UserReservation[]>

setLang

  • setLang(lang: string): void

setToken

  • setToken(token: Model.Token): void

startVerify

  • startVerify(to_: string, channel: VERIFY_CHANNEL): Promise<Model.BusinessVerify>

  • Parameters

    • to_: string
    • channel: VERIFY_CHANNEL

    Returns Promise<Model.BusinessVerify>

stepAdd

  • stepAdd(planId: number, poiId: string, startTime?: undefined | string, endTime?: undefined | string): Promise<Model.Step>

  • Step

    Parameters

    • planId: number
    • poiId: string
    • Optional startTime: undefined | string
    • Optional endTime: undefined | string

    Returns Promise<Model.Step>

stepDelete

  • stepDelete(stepId: number): Promise<number>

stepReplace

  • stepReplace(stepId: number, newPoiId: string): Promise<Model.Step>

  • Parameters

    • stepId: number
    • newPoiId: string

    Returns Promise<Model.Step>

stepUpdateTimes

  • stepUpdateTimes(stepId: number, startTime: string, endTime: string): Promise<Model.Step>

  • Parameters

    • stepId: number
    • startTime: string
    • endTime: string

    Returns Promise<Model.Step>

topTen

  • topTen(cityId: number, poiCategories?: undefined | string): Promise<Model.TopTen[]>

  • Top 10

    Parameters

    • cityId: number
    • Optional poiCategories: undefined | string

    Returns Promise<Model.TopTen[]>

translationList

  • translationList(): Promise<Model.TranslationList>

trip

  • trip(tripHash: string, minDayIndex?: number, force?: boolean, sleepMs?: number, retryCount?: number): Promise<Model.Trip>

  • Parameters

    • tripHash: string
    • Default value minDayIndex: number = 0
    • Default value force: boolean = this.forceRequest
    • Default value sleepMs: number = 500
    • Default value retryCount: number = 20

    Returns Promise<Model.Trip>

tripAdd

  • tripAdd(tripProfile: Model.TripProfile, minDayIndex?: undefined | number): Promise<Model.Trip>

  • Parameters

    • tripProfile: Model.TripProfile
    • Optional minDayIndex: undefined | number

    Returns Promise<Model.Trip>

tripClone

  • tripClone(tripHash: string): Promise<Model.Trip>

tripCloneCombo

  • tripCloneCombo(tripHash: string): Promise<{ trip: Model.Trip; tripReferences: Model.TripReference[] }>

  • Parameters

    • tripHash: string

    Returns Promise<{ trip: Model.Trip; tripReferences: Model.TripReference[] }>

tripDelete

  • tripDelete(tripHash: string): Promise<number>

tripDownloadIcs

  • tripDownloadIcs(tripHash: string): Promise<void>

tripGetShared

  • tripGetShared(tripHash: string): Promise<Model.Trip>

tripRef

  • tripRef(hash: string): Promise<Model.TripReference>

  • Parameters

    • hash: string

    Returns Promise<Model.TripReference>

tripRefs

  • tripRefs(limit?: number): Promise<Model.TripReference[]>

  • Trips

    Parameters

    • Default value limit: number = 40

    Returns Promise<Model.TripReference[]>

tripShare

  • tripShare(tripHash: string, share: boolean): Promise<boolean>

  • Parameters

    • tripHash: string
    • share: boolean

    Returns Promise<boolean>

tripUpdate

  • tripUpdate(tripHash: string, tripProfile: Model.TripProfile, minDayIndex?: number): Promise<Model.Trip>

  • Parameters

    • tripHash: string
    • tripProfile: Model.TripProfile
    • Default value minDayIndex: number = 0

    Returns Promise<Model.Trip>

user

  • user(force?: boolean): Promise<Model.User>

  • User

    Parameters

    • Default value force: boolean = this.forceRequest

    Returns Promise<Model.User>

userDelete

  • userDelete(): Promise<Model.DeleteUpdateResponse>

userFeedbacks

  • userFeedbacks(forceOnce?: boolean): Promise<Model.UserFeedback[]>

  • Parameters

    • Default value forceOnce: boolean = false

    Returns Promise<Model.UserFeedback[]>

userResetPassword

  • userResetPassword(email: string, resetPasswordUrl?: undefined | string): Promise<Model.UserResetPassword>

  • Parameters

    • email: string
    • Optional resetPasswordUrl: undefined | string

    Returns Promise<Model.UserResetPassword>

userUpdate

  • userUpdate(userUpdateRequest: Model.UserUpdateRequest): Promise<Model.User>

  • Parameters

    • userUpdateRequest: Model.UserUpdateRequest

    Returns Promise<Model.User>

userUpdatePassword

  • userUpdatePassword(password: string, hash: string): Promise<Model.UserResetPassword>

  • Parameters

    • password: string
    • hash: string

    Returns Promise<Model.UserResetPassword>

Object literals

combo

combo: object

COMBO

businessPayloadData

  • businessPayloadData(): Promise<{ business?: Model.Business; user: Model.User }>

  • Business Combo

    Returns Promise<{ business?: Model.Business; user: Model.User }>

campaignReportPayCombo

  • campaignReportPayCombo(campaignId: number, id: number, query: Partial<Model.CampaignReportRequest>): Promise<Model.DataPayload<Model.CampaignReport>>

  • Parameters

    • campaignId: number
    • id: number
    • query: Partial<Model.CampaignReportRequest>

    Returns Promise<Model.DataPayload<Model.CampaignReport>>

companionAdd

  • companionAdd(newCompanion: Model.CompanionRequest, companionsForce?: undefined | false | true): Promise<Model.Companion[]>

  • Companion Combo

    Parameters

    • newCompanion: Model.CompanionRequest
    • Optional companionsForce: undefined | false | true

    Returns Promise<Model.Companion[]>

companionDelete

  • companionDelete(companionId: number, companionsForce?: undefined | false | true): Promise<Model.Companion[]>

  • Parameters

    • companionId: number
    • Optional companionsForce: undefined | false | true

    Returns Promise<Model.Companion[]>

companionUpdate

  • companionUpdate(companion: Model.Companion, companionsForce?: undefined | false | true): Promise<Model.Companion[]>

  • Parameters

    • companion: Model.Companion
    • Optional companionsForce: undefined | false | true

    Returns Promise<Model.Companion[]>

customStepAdd

  • customStepAdd(planId: number, customPoi: Model.CustomPoi, tripHash: string, stepType: string, startTime?: undefined | string, endTime?: undefined | string): Promise<Model.Trip>

  • Parameters

    • planId: number
    • customPoi: Model.CustomPoi
    • tripHash: string
    • stepType: string
    • Optional startTime: undefined | string
    • Optional endTime: undefined | string

    Returns Promise<Model.Trip>

favoriteAdd

  • favoriteAdd(tripHash: string, poiId: string, cityId: number): Promise<Model.Favorite[]>

  • Favorite Combo

    Parameters

    • tripHash: string
    • poiId: string
    • cityId: number

    Returns Promise<Model.Favorite[]>

favoriteDelete

  • favoriteDelete(favoriteId: number, cityId: number): Promise<Model.Favorite[]>

  • Parameters

    • favoriteId: number
    • cityId: number

    Returns Promise<Model.Favorite[]>

payloadDataEx

  • payloadDataEx(): Promise<{ business: Business; user: User }>

planUpdateOrders

  • planUpdateOrders(planId: number, orders: number[], tripHash: string): Promise<Model.Trip>

  • Plan Combo

    Parameters

    • planId: number
    • orders: number[]
    • tripHash: string

    Returns Promise<Model.Trip>

planUpdateTime

  • planUpdateTime(planId: number, startTime: string, endTime: string, tripHash: string): Promise<Model.Trip>

  • Parameters

    • planId: number
    • startTime: string
    • endTime: string
    • tripHash: string

    Returns Promise<Model.Trip>

reactionAdd

  • reactionAdd(newReaction: Model.UserReactionRequest, tripHash: string): Promise<Model.UserReaction[]>

  • Reaction Combo

    Parameters

    • newReaction: Model.UserReactionRequest
    • tripHash: string

    Returns Promise<Model.UserReaction[]>

reservationAdd

  • reservationAdd(newReservation: Model.UserReservationRequest, cityId: number): Promise<Model.UserReservation[]>

  • Reservation Combo

    Parameters

    • newReservation: Model.UserReservationRequest
    • cityId: number

    Returns Promise<Model.UserReservation[]>

reservationDelete

  • reservationDelete(reservationId: number, cityId: number): Promise<Model.UserReservation[]>

  • Parameters

    • reservationId: number
    • cityId: number

    Returns Promise<Model.UserReservation[]>

reservationUpdate

  • reservationUpdate(reservation: Model.UserReservation, cityId: number): Promise<Model.UserReservation[]>

  • Parameters

    • reservation: Model.UserReservation
    • cityId: number

    Returns Promise<Model.UserReservation[]>

stepAdd

  • stepAdd(planId: number, poiId: string, tripHash: string, startTime?: undefined | string, endTime?: undefined | string): Promise<Model.Trip>

  • Step Combo

    Parameters

    • planId: number
    • poiId: string
    • tripHash: string
    • Optional startTime: undefined | string
    • Optional endTime: undefined | string

    Returns Promise<Model.Trip>

stepDelete

  • stepDelete(stepId: number, tripHash: string): Promise<Model.Trip>

  • Parameters

    • stepId: number
    • tripHash: string

    Returns Promise<Model.Trip>

stepReplace

  • stepReplace(stepId: number, newPoiId: string, tripHash: string): Promise<Model.Trip>

  • Parameters

    • stepId: number
    • newPoiId: string
    • tripHash: string

    Returns Promise<Model.Trip>

stepUpdateTimes

  • stepUpdateTimes(stepId: number, startTime: string, endTime: string, tripHash: string): Promise<Model.Trip>

  • Parameters

    • stepId: number
    • startTime: string
    • endTime: string
    • tripHash: string

    Returns Promise<Model.Trip>

tripDelete

  • tripDelete(tripHash: string, tripRefsLimit?: undefined | number): Promise<Model.TripReference[]>

  • Trip Combo

    Parameters

    • tripHash: string
    • Optional tripRefsLimit: undefined | number

    Returns Promise<Model.TripReference[]>