9f01b9e3b3
* model changes
* Endpoint to get all avaible booking rooms per summit
GET /api/v1/summits/{id}/locations/bookable-rooms
query string params
page ( int ) current page number
per_page ( int) max amount of items per page
filter ( allowed fields: name, description, cost, capacity, availability_day[epoch], attribute[string|number])
order ( allowed fields id,name,capacity)
expand ( allowed relations venue,floor,attribute_type)
scopes
%s/bookable-rooms/read
%s/summits/read/all
* Endpoint to get slot availability per room
GET /api/v1/summits/{id}/locations/bookable-rooms/{room_id}/availability/{day}
where id is summit id (integer)
room_id ( integer)
and day (epoch timestamp)
scopes
%s/bookable-rooms/read
%s/summits/read/all
* endpoint create reservation
POST /api/v1/summits/{id}/locations/bookable-rooms/{room_id}/reservations
payload
'currency' => 'required|string|currency_iso',
'amount' => 'required|integer',
'start_datetime' => 'required|date_format:U',
'end_datetime' => 'required|date_format:U|after:start_datetime',
scopes
%s/bookable-rooms/my-reservations/write
* endpoint to get all my reservations
GET /api/v1/summits/{id}/locations/bookable-rooms/all/reservations/me
query string params
expand [owner, room, type]
scopes
%s/bookable-rooms/my-reservations/read
* endpoint to cancel/ask for refund a reservation
DELETE /api/v1/summits/{id}/locations/bookable-rooms/all/reservations/{reservation_id}
scopes
%s/bookable-rooms/my-reservations/write
Change-Id: I741878c6ffc833ba23fca40f09f4664b42c8edd4
52 lines
1.5 KiB
PHP
52 lines
1.5 KiB
PHP
<?php namespace App\Services\Apis;
|
|
/**
|
|
* Copyright 2019 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 models\summit\SummitRoomReservation;
|
|
use Illuminate\Http\Request as LaravelRequest;
|
|
/**
|
|
* Interface IPaymentGatewayAPI
|
|
* @package App\Services\Apis
|
|
*/
|
|
interface IPaymentGatewayAPI
|
|
{
|
|
/**
|
|
* @param SummitRoomReservation $reservation
|
|
* @return array
|
|
*/
|
|
public function generatePayment(SummitRoomReservation $reservation):array;
|
|
|
|
/**
|
|
* @param LaravelRequest $request
|
|
* @return array
|
|
*/
|
|
public function processCallback(LaravelRequest $request):array;
|
|
|
|
/**
|
|
* @param array $payload
|
|
* @return bool
|
|
*/
|
|
public function isSuccessFullPayment(array $payload):bool;
|
|
|
|
/**
|
|
* @param array $payload
|
|
* @return string
|
|
*/
|
|
public function getPaymentError(array $payload):string;
|
|
|
|
/**
|
|
* @param string $cart_id
|
|
* @param int $amount
|
|
* @throws \InvalidArgumentException
|
|
*/
|
|
public function refundPayment(string $cart_id, int $amount = 0): void;
|
|
} |