NexSDK
    Preparing search index...

      NexSDK

      Classes

      ApiError
      AuthError

      Interfaces

      AddCommentRequest
      AmenityListResponse
      AmenityResponse
      AnalyticsResponse
      ARISyncLogEntry
      ARISyncLogResponse
      AssignRoleRequest
      AssignRoomTypeRequest
      AuditLogListResponse
      AuditLogResponse
      AvailabilityBlockResponse
      BoardResponse
      BookingCalendarResponse
      BookingFormAnswerListResponse
      BookingFormAnswerResponse
      BookingFormFieldListResponse
      BookingFormFieldReorderRequest
      BookingFormFieldResponse
      BookingListResponse
      BookingResponse
      BookingRulesRequest
      BookingRulesResponse
      CancellationPolicyRequest
      CancellationPolicyResponse
      CancellationTier
      CatalogRoomTypeListResponse
      CatalogRoomTypeResponse
      ChannelManagerResponse
      ChannelMappingInput
      ChecklistItem
      ChecklistListResponse
      ChecklistResponse
      CMConfigResponse
      CMConfigUpsertRequest
      CollectionModeRequest
      CommentResponse
      CommunicationPreferenceListResponse
      CommunicationPreferenceResponse
      ConfirmPaymentRequest
      ConnectOTARequest
      ConsentRequest
      ConversationListResponse
      ConversationResponse
      CreateAmenityRequest
      CreateBookingRequest
      CreateCatalogRoomTypeRequest
      CreateEventRequest
      CreateFAQRequest
      CreateIssueRequest
      CreateOwnerBlockRequest
      CreatePropertyRequest
      CreateRatePlanRequest
      CreateRateRequest
      CreateReviewRequest
      CreateRoomRequest
      CreateRoomTypeRequest
      CreateTaskRequest
      EngineRunRequest
      EngineRunResponse
      EscalateIssueRequest
      EventListResponse
      EventResponse
      FAQResponse
      FeaturedReviewResponse
      GatewayConfigResponse
      GatewayCredentialsRequest
      GatewayDisableRequest
      GatewayOnboardingStateRequest
      GatewayPaymentResponse
      GatewayRefundRequest
      GBPStatusResponse
      GetOrCreateConversationRequest
      GuestPortalSummaryResponse
      HousekeepingStats
      InferredCatalogLinkListResponse
      InitiatePaymentRequest
      IssueListResponse
      IssueResponse
      KeywordSuggestionResponse
      LandmarkResponse
      LinkCatalogRequest
      MaintenanceStats
      MessageListResponse
      MessageResponse
      MessageTemplateInput
      MessageTemplateListResponse
      MessageTemplateResponse
      NightlyPrice
      NotificationScheduleRequest
      NotificationScheduleResponse
      OpenDisputeRequest
      OptInRequest
      OrderItemRequest
      OTAMappingOptionsResponse
      OTAResponse
      OTARoutingRequest
      OTARoutingResponse
      ParsedClaims
      PaymentConfigRequest
      PaymentConfigResponse
      PaymentInitiateResponse
      PaymentResponse
      PaymentVerifyRequest
      PhotoListResponse
      PhotoResponse
      PlaceOrderRequest
      PricePreviewResponse
      PropertyAmenityListResponse
      PropertyAmenityResponse
      PropertyAmenitySelection
      PropertyAvailabilityResponse
      PropertyListResponse
      PropertyResponse
      PropertyReviewResponse
      PropertySearchListResponse
      PropertySearchResponse
      RateConfigRequest
      RateConfigResponse
      RateListResponse
      RatePlanDerivationRequest
      RatePlanListResponse
      RatePlanOption
      RatePlanResponse
      RateResponse
      RedeemReferralRequest
      RegisterDeviceTokenRequest
      RejectTaskRequest
      ResolveDisputeRequest
      ResolveIssueRequest
      ReviewListItem
      ReviewListResponse
      ReviewResponse
      ReviewSummaryResponse
      RoomAvailabilityResponse
      RoomListResponse
      RoomResponse
      RoomStatusCard
      RoomStatusOverrideRequest
      RoomStatusResponse
      RoomTypeListResponse
      RoomTypeResponse
      SchemaResponse
      SdkConfig
      SendMessageRequest
      SetCommunicationPreferenceRequest
      SetPropertyAmenitiesRequest
      ShiftListResponse
      ShiftResponse
      SuggestionListResponse
      SuggestionResponse
      TaskListResponse
      TaskResponse
      TodayBookingsResponse
      UpdateAmenityRequest
      UpdateBookingRequest
      UpdateCatalogRoomTypeRequest
      UpdateConversationStatusRequest
      UpdateIssueRequest
      UpdateMyTaskRequest
      UpdatePhotoRequest
      UpdateProfileRequest
      UpdatePropertyRequest
      UpdateRatePlanRequest
      UpdateReviewRequest
      UpdateRoomRequest
      UpdateRoomTypeRequest
      UpdateTaskRequest
      UploadPropertyPhotoBody
      UploadRoomPhotoBody
      UpsertChecklistRequest
      UpsertLandmarkRequest
      UpsertMessageTemplateRequest
      UpsertShiftRequest
      UserListResponse
      UserResponse
      WebsiteSettingsPatchRequest
      WebsiteSettingsResponse

      Type Aliases

      AvailabilitySource
      BookingFormFieldResponseOptions
      BookingSourceKind
      BookingStatus
      CheckRoomAvailabilityParams
      GbpAnalyticsParams
      GetAvailabilityParams
      GetBookingsCalendarParams
      GetMyTasksParams
      GetResourceHistoryParams
      GetShiftsParams
      ListAmenitiesParams
      ListAuditLogsParams
      ListBookingsParams
      ListConversationsParams
      ListDisputesParams
      ListIssuesParams
      ListMessagesParams
      ListOrdersParams
      ListPropertiesParams
      ListRateSuggestionsParams
      ListReviewsParams
      ListTasksParams
      ListUsersParams
      MessageChannel
      NotificationType
      PaymentStatus
      PreviewPriceParams
      PropertyAvailabilityParams
      Role
      SearchPropertiesParams
      WebsiteSettingsSubsection

      Variables

      AVAILABILITY_SOURCE
      BOOKING_SOURCE
      BOOKING_STATUS
      MESSAGE_CHANNEL
      NOTIFICATION_TYPE
      PAYMENT_STATUS
      ROLE_HIERARCHY
      ROLES

      Functions

      addNights
      amenityQueryKey
      availabilityQueryKey
      boardQueryKey
      bookingFormAnswersQueryKey
      bookingQueryKey
      bookingsCalendarQueryKey
      canAccessProperty
      catalogRoomTypeQueryKey
      checkRoomAvailability

      Check Room Availability

      cmConfigQueryKey
      communicationPreferencesQueryKey
      conversationQueryKey
      effectiveRoomRateConfigQueryKey
      forceTokenRefresh
      formatDisplayDate
      formatDisplayPhone
      formatGuestName
      formatINR
      formatMonthKey
      formatShortDate
      gbpAnalyticsQueryKey
      gbpStatusQueryKey
      getAmenity

      Get Amenity

      getAvailability

      Get Availability

      getBoard

      Get Board

      getBooking

      Get Booking

      getBookingRules

      Get Booking Rules

      getBookingsCalendar

      Get Bookings Calendar

      getCatalogRoomType

      Get Catalog Room Type

      getChecklists

      Get Checklists

      getCmConfig

      Get Cm Config

      getCommunicationPreferences

      Get Communication Preferences

      getConfig
      getConversation

      Get Conversation

      getCurrentToken
      getCurrentUser
      getDispute

      Get Dispute

      getEffectiveRoomRateConfig

      Get Effective Room Rate Config

      getGatewayConfig

      Get Gateway Config

      getGbpStatus

      Get Gbp Status

      getHousekeepingStats

      Get Stats

      getHttpClient
      getInitials
      getIssue

      Get Issue

      getMaintenanceStats

      Get Stats

      getMe

      Get Me Endpoint

      getMyTasks

      Get My Tasks

      getNotificationSchedule

      Get Notification Schedule

      getOrder

      Get Order

      getPayment

      Get Payment

      getPortalSummary

      Get Portal Summary

      getProperty

      Get Property

      getPropertyAvailability

      Get Property Availability

      getRateConfig

      Get Rate Config

      getRatePlan

      Get Rate Plan

      getResourceHistory

      Get Resource History Endpoint

      getRoom

      Get Room

      getRoomBookingRules

      Get Room Booking Rules

      getRoomRateConfig

      Get Room Rate Config

      getRoomType

      Get Room Type

      getShifts

      Get Shifts

      getTodayBookings

      Get Today Bookings

      getUser

      Get User

      getWebsiteSettings

      Get Website Settings

      hasRole
      initSdk
      isExpired
      isFirebaseError
      issueQueryKey
      istToUtc
      listAmenities

      List Amenities

      listAmenitiesQueryKey
      listAuditLogsQueryKey
      listBookingFormAnswers

      List Booking Form Answers

      listBookingFormFields

      List Booking Form Fields

      listBookingFormFieldsQueryKey
      listBookingsQueryKey
      listCatalogRoomTypesQueryKey
      listChannelManagersQueryKey
      listConversationsQueryKey
      listDisputesQueryKey
      listFaqsQueryKey
      listIssuesQueryKey
      listKeywordSuggestionsQueryKey
      listLandmarksQueryKey
      listMessagesQueryKey
      listMessageTemplates

      List Message Templates

      listMessageTemplatesQueryKey
      listOrdersQueryKey
      listPropertiesQueryKey
      listPropertyAmenities

      List Property Amenities

      listRatePlansQueryKey
      listRoomsQueryKey
      listRoomTypesQueryKey
      listSyncLogQueryKey
      listTasksQueryKey
      listUsersQueryKey
      meQueryKey
      normaliseFirebaseError
      normalisePhone
      notificationScheduleQueryKey
      onSessionChange
      orderQueryKey
      otaChannelReadinessQueryKey
      otaMappingOptionsQueryKey
      paiseToRupees
      parseClaims
      parseClaimsFromUser
      paymentQueryKey
      portalSummaryQueryKey
      propertyAmenitiesQueryKey
      propertyAvailabilityQueryKey
      propertyQueryKey
      rateConfigQueryKey
      ratePlanQueryKey
      resetConfig
      resetHttpClient
      resourceHistoryQueryKey
      roomAvailabilityQueryKey
      roomQueryKey
      roomRateConfigQueryKey
      roomTypeQueryKey
      rupeesToPaise
      searchProperties

      Search Properties

      searchPropertiesQueryKey
      serverGetBookingRules
      serverGetCoverPhotoUrl
      serverGetFeaturedReviews
      serverGetProperty
      serverGetPropertyAmenities
      serverGetPropertyPhotos
      serverGetReviews
      serverGetReviewsSummary
      serverGetRoom
      serverGetRoomCoverPhotoUrl
      serverGetRoomPhotos
      serverGetRooms
      serverGetSchema
      serverGetWebsiteSettings
      setUserPhone
      signInWithEmail
      signInWithGoogle
      signInWithPhone
      signOutUser
      toApiDate
      todayBookingsQueryKey
      toIST
      toTitleCase
      useAcceptConsent

      Accept Consent

      useAcceptOrder

      Accept Order

      useActivateOtaChannel

      Activate Ota Channel

      useActivateProperty

      Activate Property

      useActivateRatePlan

      Activate Rate Plan

      useActivateRoom

      Activate Room

      useActivateRoomType

      Activate Room Type

      useActivateUser

      Activate User

      useAddComment

      Add Comment

      useApproveTask

      Approve Task

      useAssignRole

      Assign Role

      useAssignRoomType

      Assign Room Type

      useCancelBooking

      Cancel Booking

      useCancelOrder

      Cancel Order

      useCheckInBooking

      Check In Booking

      useCheckOtaChannelReadiness

      Check Ota Channel Readiness

      useCheckOutBooking

      Check Out Booking

      useCheckRoomAvailability

      Check Room Availability

      useCloseIssue

      Close Issue

      useCompleteTask

      Complete Task

      useConfirmBooking

      Confirm Booking

      useConfirmPayment

      Confirm Payment

      useConnectOtaChannel

      Connect Ota Channel

      useCreateAmenity

      Create Amenity

      useCreateBooking

      Create Booking

      useCreateCatalogRoomType

      Create Catalog Room Type

      useCreateEvent

      Create Event

      useCreateFaq

      Create Faq

      useCreateIssue

      Create Issue

      useCreateOwnerBlock

      Create Owner Block

      useCreateProperty

      Create Property

      useCreateRate

      Create Rate

      useCreateRatePlan

      Create Rate Plan

      useCreateReview

      Create Review

      useCreateRoom

      Create Room

      useCreateRoomType

      Create Room Type

      useCreateTask

      Create Task

      useDeactivateOtaChannel

      Deactivate Ota Channel

      useDeactivateProperty

      Deactivate Property

      useDeactivateRatePlan

      Deactivate Rate Plan

      useDeactivateRoom

      Deactivate Room

      useDeactivateRoomType

      Deactivate Room Type

      useDeactivateUser

      Deactivate User

      useDeleteEvent

      Delete Event

      useDeleteFaq

      Delete Faq

      useDeleteLandmark

      Delete Landmark

      useDeleteOwnerBlock

      Delete Owner Block

      useDeletePhoto

      Delete Property Photo

      useDeleteRate

      Delete Rate

      useDeleteRatePlan

      Delete Rate Plan

      useDeleteReview

      Delete Review

      useDeleteRoomRateConfig

      Delete Room Rate Config

      useDeleteRoomType

      Delete Room Type

      useDisableGateway

      Disable Gateway Config

      useDisconnectOtaChannel

      Disconnect Ota Channel

      useDismissKeywordSuggestion

      Dismiss Suggestion

      useEnableGateway

      Enable Gateway Config

      useEscalateIssue

      Escalate Issue

      useFailPayment

      Fail Payment

      useGbpAnalytics

      Gbp Analytics

      useGenerateReferralCode

      Generate Code

      useGetAmenity

      Get Amenity

      useGetAvailability

      Get Availability

      useGetBoard

      Get Board

      useGetBooking

      Get Booking

      useGetBookingRules

      Get Booking Rules

      useGetBookingsCalendar

      Get Bookings Calendar

      useGetCancellationPolicy

      Get Cancellation Policy

      useGetCatalogRoomType

      Get Catalog Room Type

      useGetChecklists

      Get Checklists

      useGetCmConfig

      Get Cm Config

      useGetCommunicationPreferences

      Get Communication Preferences

      useGetConversation

      Get Conversation

      useGetDispute

      Get Dispute

      useGetEffectiveRoomRateConfig

      Get Effective Room Rate Config

      useGetGatewayConfig

      Get Gateway Config

      useGetGbpStatus

      Get Gbp Status

      useGetHousekeepingStats

      Get Stats

      useGetIssue

      Get Issue

      useGetMaintenanceStats

      Get Stats

      useGetMe

      Get Me Endpoint

      useGetMyTasks

      Get My Tasks

      useGetNotificationSchedule

      Get Notification Schedule

      useGetOrder

      Get Order

      useGetPayment

      Get Payment

      useGetPaymentStatus

      Get Payment

      useGetPortalSummary

      Get Portal Summary

      useGetProperty

      Get Property

      useGetPropertyAvailability

      Get Property Availability

      useGetPropertyPaymentConfig

      Get Payment Config

      useGetPropertySchema

      Property Schema

      useGetRateConfig

      Get Rate Config

      useGetRatePlan

      Get Rate Plan

      useGetResourceHistory

      Get Resource History Endpoint

      useGetRoom

      Get Room

      useGetRoomBookingRules

      Get Room Booking Rules

      useGetRoomCancellationPolicy

      Get Room Cancellation Policy

      useGetRoomRateConfig

      Get Room Rate Config

      useGetRoomType

      Get Room Type

      useGetShifts

      Get Shifts

      useGetTodayBookings

      Get Today Bookings

      useGetUser

      Get User

      useGetWebsiteSettings

      Get Website Settings

      useHotelCenterAnalytics

      Hotel Center Analytics

      useInitiatePayment

      Initiate Payment

      useInitiatePaymentOrder

      Initiate Payment Order

      useInitiateRefund

      Initiate Refund

      useLinkRoomTypeCatalog

      Link Room Type Catalog

      useListAmenities

      List Amenities

      useListAuditLogs

      List Audit Logs Endpoint

      useListBookingFormAnswers

      List Booking Form Answers

      useListBookingFormFields

      List Booking Form Fields

      useListBookings

      List Bookings

      useListCatalogRoomTypes

      List Catalog Room Types

      useListChannelManagers

      List Channel Managers

      useListConversations

      List Conversations

      useListDisputes

      List Disputes

      useListEvents

      List Events

      useListFaqs

      List Faqs

      List Inferred Catalog Links

      useListIssues

      List Issues

      useListKeywordSuggestions

      List Keyword Suggestions

      useListLandmarks

      List Landmarks

      useListMessages

      List Messages

      useListMessageTemplates

      List Message Templates

      useListOrders

      List Orders

      useListOtaMappingOptions

      List Ota Mapping Options

      useListOtaRouting

      List Ota Routing

      useListProperties

      List Properties

      useListPropertyAmenities

      List Property Amenities

      useListPropertyPhotos

      List Property Photos

      useListRatePlans

      List Rate Plans

      useListRates

      List Rates

      useListRateSuggestions

      List Suggestions

      useListReferralCodes

      List My Codes

      useListReviews

      List Reviews

      useListRoomPhotos

      List Room Photos

      useListRooms

      List Rooms

      useListRoomTypes

      List Room Types

      useListSupportedOtas

      List Supported Otas

      useListSyncLog

      List Sync Log

      useListTasks

      List Tasks

      useListUsers

      List Users

      useMarkConversationRead

      Mark Read

      useMarkOrderDelivered

      Mark Delivered

      useMarkOrderReady

      Mark Ready

      useOnboardGbp

      Onboard Gbp

      useOnboardProperty

      Onboard Property

      useOpenDispute

      Open Dispute

      useOverrideRoomStatus

      Override Room Status

      usePlaceOrder

      Place Order

      usePreviewPrice

      Preview Price

      usePushHotelCenter

      Push Hotel Center

      useRedeemReferralCode

      Redeem Code

      useRegisterDeviceToken

      Register Device Token

      useRejectOrder

      Reject Order

      useRejectTask

      Reject Task

      useRemapOtaChannel

      Remap Ota Channel

      useReorderBookingFormFields

      Reorder Booking Form Fields

      useResolveDispute

      Resolve Dispute

      useResolveIssue

      Resolve Issue

      userQueryKey
      useRunRateEngine

      Run Engine

      useSearchConsoleAnalytics

      Search Console Analytics

      useSearchProperties

      Search Properties

      useSendMessage

      Send Message

      useSetCommunicationPreference

      Set Communication Preference

      useSetDefaultRatePlan

      Set Default Rate Plan

      useSetPropertyAmenities

      Set Property Amenities

      useSetRatePlanDerivation

      Set Rate Plan Derivation

      useSetWhatsAppOptIn

      Update Opt In

      useStartTask

      Start Task

      useTestOtaConnection

      Test Ota Connection

      useUnregisterDeviceToken

      Unregister Device Token

      useUpdateAmenity

      Update Amenity

      useUpdateBooking

      Update Booking

      useUpdateCatalogRoomType

      Update Catalog Room Type

      useUpdateConversationStatus

      Update Conversation Status

      useUpdateGatewayOnboardingState

      Update Onboarding State

      useUpdateIssue

      Update Issue

      useUpdateMe

      Patch Me

      useUpdateMyTask

      Update My Task

      useUpdatePhoto

      Update Property Photo

      useUpdateProperty

      Update Property

      useUpdateRatePlan

      Update Rate Plan

      useUpdateReview

      Update Review

      useUpdateRoom

      Update Room

      useUpdateRoomType

      Update Room Type

      useUpdateTask

      Update Task

      useUpdateWebsiteSettings

      Update Website Settings

      useUploadPropertyPhoto

      Upload Property Photo

      useUploadRoomPhoto

      Upload Room Photo

      useUpsertBookingRules

      Upsert Booking Rules

      useUpsertCancellationPolicy

      Upsert Cancellation Policy

      useUpsertChecklist

      Upsert Checklist

      useUpsertCmConfig

      Upsert Cm Config

      useUpsertConversation

      Get Or Create Conversation

      useUpsertLandmark

      Upsert Landmark

      useUpsertMessageTemplate

      Upsert Message Template

      useUpsertNotificationSchedule

      Upsert Notification Schedule

      useUpsertOtaRouting

      Upsert Ota Routing

      useUpsertPropertyPaymentConfig

      Upsert Payment Config

      useUpsertRateConfig

      Upsert Rate Config

      useUpsertRoomBookingRules

      Upsert Room Booking Rules

      useUpsertRoomCancellationPolicy

      Upsert Room Cancellation Policy

      useUpsertRoomRateConfig

      Upsert Room Rate Config

      useUpsertShift

      Upsert Shift

      useVerifyPayment

      Verify Payment

      useWhatsAppDeliveryStats

      Number Delivery Stats

      websiteSettingsQueryKey