Mutation: {
    __typename?: "Mutation";
    cancelReservation: CancelReservationPayload;
    changeReservationStayDates: ChangeReservationStayDatesPayload;
    createProperty: CreatePropertyPayload;
    createReservation: CreateReservationPayload;
    deleteProperty: DeletePropertyPayload;
    deletePropertyReservations: DeletePropertyReservationsPayload;
    deleteReservation: DeleteReservationPayload;
    setupTestData: CreateDatasetPayload;
    updateProperty: UpdatePropertyPayload;
    updateReservation: UpdateReservationPayload;
}

Type declaration

  • Optional__typename?: "Mutation"
  • cancelReservation: CancelReservationPayload

    Cancels an existing reservation.

    The mutation accepts the reservation ID to cancel as input. An optional parameter is provided to send a notification upon the cancellation of the reservation. The mutation returns the updated reservation details.

  • changeReservationStayDates: ChangeReservationStayDatesPayload

    Changes the stay dates of an existing reservation.

    The mutation accepts the reservation ID, new check-in date, and new check-out date as parameters. The check-out date must be after the check-in date. An optional parameter is provided to send a notification upon the change of the reservation dates. The mutation returns the updated reservation details.

  • createProperty: CreatePropertyPayload

    Creates a property in the sandbox environment.

    The mutation accepts an optional name for the property. Unspecified fields will default to logical test data.

  • createReservation: CreateReservationPayload

    Creates a reservation in the sandbox environment. The mutation accepts various parameters such as property ID, check-in and check-out dates, adult and child counts, business model, remittance type, and more. Except for the property ID, all other parameters are optional. If not specified, these parameters will default to logical test data.

    The mutation also supports sending a notification upon the creation of a reservation via the sendNotification field.

  • deleteProperty: DeletePropertyPayload

    Deletes a property in the sandbox environment.

  • deletePropertyReservations: DeletePropertyReservationsPayload

    Deletes all reservations for a specified sandbox property.

    The mutation accepts the property ID on which to delete all reservations as input.

    This operation is irreversible and will permanently delete the property reservations.

  • deleteReservation: DeleteReservationPayload

    Deletes a sandbox reservation.

    The mutation accepts the reservation ID to delete as input.

    This operation is irreversible and will permanently delete the reservation.

  • setupTestData: CreateDatasetPayload

    Creates test data for a given capability and scenario. The mutation is currently setup to setup reservation specific test data but this can be extended to other capabilities.

  • updateProperty: UpdatePropertyPayload

    Updates a property in the sandbox environment.

    The mutation accepts an optional name for the property. Unspecified fields will not be updated.

  • updateReservation: UpdateReservationPayload

    Updates a reservation in the sandbox environment.

    The mutation accepts the reservation ID, new check-in date, new check-out date, new status, new special request text, new adult count, and new child count as parameters. The check-out date must be after the check-in date. An optional parameter is provided to send a notification upon the change of the reservation dates. The mutation returns the updated reservation details.