smarcet a1b8c46273 Added enpoints to CRUD bookable rooms
Add bookable room to summit

POST /api/v1/summits/{id}/locations/venues/{venue_id}/bookable-rooms

payload

time_slot_cost: required|numeric
currency:required|iso_currency_code(USD,EUR)
capacity:required|integer
floor_id:sometimes|integer
name:sometimes|string|max:255
description:sometimes|string
order:sometimes|integer|min:1

update bookable room per summit

PUT /api/v1/summits/{id}/locations/venues/{venue_id}/bookable-rooms/{room_id}

payload

time_slot_cost: required|numeric
currency:required|iso_currency_code(USD,EUR)
capacity:required|integer
floor_id:sometimes|integer
name:sometimes|string|max:255
description:sometimes|string
order:sometimes|integer|min:1

delete bookable room

DELETE /api/v1/summits/{id}/locations/venues/{venue_id}/bookable-rooms/{room_id}

add attribute value to bookable room

PUT /api/v1/summits/{id}/locations/venues/{venue_id}/bookable-rooms/{room_id}/attributes/{attribute_id}

delete attribute value from bookable room

DELETE /api/v1/summits/{id}/locations/venues/{venue_id}/bookable-rooms/{room_id}/attributes/{attribute_id}

Added missing endpoints to CRUD bookable rooms attributes
per summit

Get all bookable rooms attribute types

GET /api/v1/summits/{id}/bookable-room-attribute-types

Get bookable room attribute type by id

GET /api/v1/summits/{id}/bookable-room-attribute-types/{type_id}

Add bookable room attribute type

POST /api/v1/summits/{id}/bookable-room-attribute-types

payload

type [required|string]

Update bookable room attribute type

PUT /api/v1/summits/{id}/bookable-room-attribute-types/{type_id}

payload

type [required|string]

delete attribute type by id

DELETE /api/v1/summits/{id}/bookable-room-attribute-types/{type_id}

get all attribute values by attribute type

GET /api/v1/summits/{id}/bookable-room-attribute-types/{type_id}/values

add attribute value to attribute type

POST /api/v1/summits/{id}/bookable-room-attribute-types/{type_id}/values

payload

value [required|string]

update attribute value

PUT /api/v1/summits/{id}/bookable-room-attribute-types/{type_id}/values/{value_id}

payload

value [required|string]

delete attribute value by id

DELETE /api/v1/summits/{id}/bookable-room-attribute-types/{type_id}/values/{value_id}

refund endpoint (admin only)

DELETE /api/v1/summits/{id}/bookable-rooms/{room_id}/reservations/{reservation_id}/refund

payload

amount [numeric|required]

get all reservations by summit (admin)

GET /api/v1/summits/{id}/locations/bookable-rooms/all/reservations

query params

page:integer|min:1
per_page:required_with:page|integer|min:1|max:100
filter:

allowed filters

summit_id: ['==']
room_name: ['==', '=@']
room_id: ['==']
owner_id: ['==']
status:  ['==']
start_datetime: ['>', '<', '<=', '>=', '==']
end_datetime:  ['>', '<', '<=', '>=', '==']

order

allowed ordering

id,start_datetime,end_datetime

Change-Id: Ic7f6ed7defaf20b8799a7d94beb0a82103b206f0
2019-06-19 18:19:58 -03:00

338 lines
9.8 KiB
PHP

<?php namespace services\model;
/**
* Copyright 2015 OpenStack Foundation
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
**/
use Illuminate\Http\UploadedFile;
use models\exceptions\EntityNotFoundException;
use models\exceptions\ValidationException;
use models\main\File;
use models\main\Member;
use models\summit\ConfirmationExternalOrderRequest;
use models\summit\Summit;
use models\summit\SummitAttendee;
use models\summit\SummitBookableVenueRoomAttributeType;
use models\summit\SummitBookableVenueRoomAttributeValue;
use models\summit\SummitEvent;
use models\summit\SummitEventFeedback;
use models\summit\SummitScheduleEmptySpot;
use utils\Filter;
/**
* Interface ISummitService
* @package services\model
*/
interface ISummitService
{
/**
* @param Summit $summit
* @param array $data
* @return SummitEvent
*/
public function addEvent(Summit $summit, array $data);
/**
* @param Summit $summit
* @param int $event_id
* @param array $data
* @param null|Member $current_member
* @return SummitEvent
*/
public function updateEvent(Summit $summit, $event_id, array $data, Member $current_member = null);
/**
* @param Summit $summit
* @param $event_id
* @param array $data
* @return mixed
*/
public function publishEvent(Summit $summit, $event_id, array $data);
/**
* @param Summit $summit
* @param $event_id
* @return mixed
*/
public function unPublishEvent(Summit $summit, $event_id);
/**
* @param Summit $summit
* @param $event_id
* @return mixed
*/
public function deleteEvent(Summit $summit, $event_id);
/**
* @param Summit $summit
* @param Member $member
* @param int $event_id
* @param bool $check_rsvp
* @return bool
*/
public function addEventToMemberSchedule(Summit $summit, Member $member, $event_id, $check_rsvp = true);
/**
* @param Summit $summit
* @param Member $member
* @param int $event_id
* @param bool $check_rsvp
* @return void
*/
public function removeEventFromMemberSchedule(Summit $summit, Member $member, $event_id, $check_rsvp = true);
/**
* @param Summit $summit
* @param SummitEvent $event
* @param array $feedback
* @return SummitEventFeedback
*/
public function addEventFeedback(Summit $summit, SummitEvent $event, array $feedback);
/**
* @param Summit $summit
* @param SummitEvent $event
* @param array $feedback
* @return SummitEventFeedback
*/
public function updateEventFeedback(Summit $summit, SummitEvent $event, array $feedback);
/**
* @param Summit $summit
* @param null|int $member_id
* @param null|\DateTime $from_date
* @param null|int $from_id
* @param null|int $limit
* @return array
*/
public function getSummitEntityEvents(Summit $summit, $member_id = null, \DateTime $from_date = null, $from_id = null, $limit = 25);
/**
* @param Summit $summit
* @param $external_order_id
* @return array
*/
public function getExternalOrder(Summit $summit, $external_order_id);
/**
* @param ConfirmationExternalOrderRequest $request
* @return SummitAttendee
*/
public function confirmExternalOrderAttendee(ConfirmationExternalOrderRequest $request);
/**
* @param Summit $summit
* @param Member $member
* @param int $event_id
* @throws EntityNotFoundException
*/
public function removeEventFromMemberFavorites(Summit $summit, Member $member, $event_id);
/**
* @param Summit $summit
* @param Member $member
* @param int $event_id
* @throws ValidationException
* @throws EntityNotFoundException
*/
public function addEventToMemberFavorites(Summit $summit, Member $member, $event_id);
/**
* @param Summit $summit
* @param Member $member
* @param $event_id
* @return bool
*/
public function unRSVPEvent(Summit $summit, Member $member, $event_id);
/**
* @param Summit $summit
* @param int $event_id
* @param UploadedFile $file
* @param int $max_file_size
* @throws ValidationException
* @throws EntityNotFoundException
* @return File
*/
public function addEventAttachment(Summit $summit, $event_id, UploadedFile $file, $max_file_size = 10485760);
/**
* @param Summit $summit
* @param Filter $filter
* @return SummitScheduleEmptySpot[]
*/
public function getSummitScheduleEmptySpots
(
Summit $summit,
Filter $filter
);
/**
* @param Summit $summit
* @param array $data
* @throws ValidationException
* @throws EntityNotFoundException
* @return bool
*/
public function unPublishEvents(Summit $summit, array $data);
/**
* @param Summit $summit
* @param array $data
* @throws ValidationException
* @throws EntityNotFoundException
* @return bool
*/
public function updateAndPublishEvents(Summit $summit, array $data);
/**
* @param Summit $summit
* @param array $data
* @throws ValidationException
* @throws EntityNotFoundException
* @return bool
*/
public function updateEvents(Summit $summit, array $data);
/**
* @param array $data
* @throws ValidationException
* @throws EntityNotFoundException
* @return Summit
*/
public function addSummit(array $data);
/**
* @param int $summit_id
* @param array $data
* @throws ValidationException
* @throws EntityNotFoundException
* @return Summit
*/
public function updateSummit($summit_id, array $data);
/**
* @param int $summit_id
* @throws ValidationException
* @throws EntityNotFoundException
* @return void
*/
public function deleteSummit($summit_id);
/**
* @param int $current_member_id
* @param int $speaker_id
* @param int $presentation_id
* @throws ValidationException
* @throws EntityNotFoundException
* @return void
*/
public function addSpeaker2Presentation($current_member_id, $speaker_id, $presentation_id);
/**
* @param int $current_member_id
* @param int $speaker_id
* @param int $presentation_id
* @throws ValidationException
* @throws EntityNotFoundException
* @return void
*/
public function addModerator2Presentation($current_member_id, $speaker_id, $presentation_id);
/**
* @param int $current_member_id
* @param int $speaker_id
* @param int $presentation_id
* @throws ValidationException
* @throws EntityNotFoundException
* @return void
*/
public function removeSpeakerFromPresentation($current_member_id, $speaker_id, $presentation_id);
/**
* @param int $current_member_id
* @param int $speaker_id
* @param int $presentation_id
* @throws ValidationException
* @throws EntityNotFoundException
* @return void
*/
public function removeModeratorFromPresentation($current_member_id, $speaker_id, $presentation_id);
/**
* @param Summit $summit
* @param int $event_id
* @return SummitEvent
* @throws ValidationException
* @throws EntityNotFoundException
*/
public function cloneEvent(Summit $summit, int $event_id):SummitEvent;
// bookable room attribute types
/**
* @param Summit $summit
* @param array $payload
* @return SummitBookableVenueRoomAttributeType
* @throws ValidationException
* @throws EntityNotFoundException
*/
public function addBookableRoomAttribute(Summit $summit, array $payload):SummitBookableVenueRoomAttributeType;
/**
* @param Summit $summit
* @param int $type_id
* @param array $payload
* @return SummitBookableVenueRoomAttributeType
* @throws ValidationException
* @throws EntityNotFoundException
*/
public function updateBookableRoomAttribute(Summit $summit, int $type_id, array $payload):SummitBookableVenueRoomAttributeType;
/**
* @param Summit $summit
* @param int $type_id
* @return void
* @throws ValidationException
* @throws EntityNotFoundException
*/
public function deleteBookableRoomAttribute(Summit $summit, int $type_id):void;
/**
* @param Summit $summit
* @param int $type_id
* @param array $payload
* @return SummitBookableVenueRoomAttributeValue
* @throws ValidationException
* @throws EntityNotFoundException
*/
public function addBookableRoomAttributeValue(Summit $summit, int $type_id, array $payload):SummitBookableVenueRoomAttributeValue;
/**
* @param Summit $summit
* @param int $type_id
* @param int $value_id
* @param array $payload
* @return SummitBookableVenueRoomAttributeValue
* @throws ValidationException
* @throws EntityNotFoundException
*/
public function updateBookableRoomAttributeValue(Summit $summit, int $type_id, int $value_id, array $payload):SummitBookableVenueRoomAttributeValue;
/**
* @param Summit $summit
* @param int $type_id
* @param int $value_id
* @return void
* @throws ValidationException
* @throws EntityNotFoundException
*/
public function deleteBookableRoomAttributeValue(Summit $summit, int $type_id, int $value_id):void;
}