SynergiTech\Cinolla\BookingsApi

All URIs are relative to https://api.prod.cinolla.com, except if the operation defines another base path.

Method	HTTP request	Description
addGroupToBooking()	POST /v3/client/bookings/{bookingHash}/groups	Add a group to a booking
addTagsToBooking()	POST /v3/client/bookings/{bookingHash}/tags	Add tags to a booking
createBooking()	POST /v3/client/bookings	Create a new Booking
getBooking()	GET /v3/client/bookings/{bookingHash}	Get detail for a single Booking
getBookingGuests()	GET /v3/client/bookings/{bookingHash}/guests	Returns all guests on a booking
getBookingTags()	GET /v3/client/bookings/tags	Returns all available booking tags
getBookings()	GET /v3/client/bookings	Get a collection of Bookings
removeTagsFromBooking()	DELETE /v3/client/bookings/{bookingHash}/tags	Remove tags from a booking
updateBooking()	PATCH /v3/client/bookings/{bookingHash}	Update an existing Booking

`addGroupToBooking()`

addGroupToBooking($bookingHash, $groups): \SynergiTech\Cinolla\Model\Groups2

Add a group to a booking

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = SynergiTech\Cinolla\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = SynergiTech\Cinolla\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new SynergiTech\Cinolla\Api\BookingsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$bookingHash = 'bookingHash_example'; // string
$groups = new \SynergiTech\Cinolla\Model\Groups(); // \SynergiTech\Cinolla\Model\Groups | The Group to create

try {
    $result = $apiInstance->addGroupToBooking($bookingHash, $groups);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BookingsApi->addGroupToBooking: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
bookingHash	string
groups	\SynergiTech\Cinolla\Model\Groups	The Group to create

Return type

\SynergiTech\Cinolla\Model\Groups2

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`addTagsToBooking()`

addTagsToBooking($bookingHash, $bookingType): \SynergiTech\Cinolla\Model\Booking6

Add tags to a booking

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = SynergiTech\Cinolla\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = SynergiTech\Cinolla\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new SynergiTech\Cinolla\Api\BookingsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$bookingHash = 'bookingHash_example'; // string
$bookingType = array(new \SynergiTech\Cinolla\Model\BookingType()); // \SynergiTech\Cinolla\Model\BookingType[] | An array of tag IDs to add to the booking

try {
    $result = $apiInstance->addTagsToBooking($bookingHash, $bookingType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BookingsApi->addTagsToBooking: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
bookingHash	string
bookingType	\SynergiTech\Cinolla\Model\BookingType[]	An array of tag IDs to add to the booking

Return type

\SynergiTech\Cinolla\Model\Booking6

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`createBooking()`

createBooking($booking2, $contactHash, $organisationHash): \SynergiTech\Cinolla\Model\Booking3

Create a new Booking

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = SynergiTech\Cinolla\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = SynergiTech\Cinolla\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new SynergiTech\Cinolla\Api\BookingsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$booking2 = new \SynergiTech\Cinolla\Model\Booking2(); // \SynergiTech\Cinolla\Model\Booking2 | The Booking to create
$contactHash = 'contactHash_example'; // string | Hash of the Contact to associate with this booking
$organisationHash = 'organisationHash_example'; // string | Hash of the Organisation to associate with this booking

try {
    $result = $apiInstance->createBooking($booking2, $contactHash, $organisationHash);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BookingsApi->createBooking: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
booking2	\SynergiTech\Cinolla\Model\Booking2	The Booking to create
contactHash	string	Hash of the Contact to associate with this booking	[optional]
organisationHash	string	Hash of the Organisation to associate with this booking	[optional]

Return type

\SynergiTech\Cinolla\Model\Booking3

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getBooking()`

getBooking($bookingHash): \SynergiTech\Cinolla\Model\Booking3

Get detail for a single Booking

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = SynergiTech\Cinolla\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = SynergiTech\Cinolla\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new SynergiTech\Cinolla\Api\BookingsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$bookingHash = 'bookingHash_example'; // string

try {
    $result = $apiInstance->getBooking($bookingHash);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BookingsApi->getBooking: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
bookingHash	string

Return type

\SynergiTech\Cinolla\Model\Booking3

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getBookingGuests()`

getBookingGuests($bookingHash): \SynergiTech\Cinolla\Model\Guest[]

Returns all guests on a booking

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = SynergiTech\Cinolla\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = SynergiTech\Cinolla\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new SynergiTech\Cinolla\Api\BookingsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$bookingHash = 'bookingHash_example'; // string

try {
    $result = $apiInstance->getBookingGuests($bookingHash);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BookingsApi->getBookingGuests: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
bookingHash	string

Return type

\SynergiTech\Cinolla\Model\Guest[]

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getBookingTags()`

getBookingTags(): \SynergiTech\Cinolla\Model\BookingType2[]

Returns all available booking tags

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = SynergiTech\Cinolla\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = SynergiTech\Cinolla\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new SynergiTech\Cinolla\Api\BookingsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->getBookingTags();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BookingsApi->getBookingTags: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\SynergiTech\Cinolla\Model\BookingType2[]

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getBookings()`

getBookings($startDate, $endDate, $offset, $limit, $dateRangeFilter, $futureOnly, $tags, $tagIds, $tagsOperator, $reference): \SynergiTech\Cinolla\Model\Booking[]

Get a collection of Bookings

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = SynergiTech\Cinolla\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = SynergiTech\Cinolla\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new SynergiTech\Cinolla\Api\BookingsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$startDate = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime | Start date of a date range. Used in conjunction with endDate to create a date range to filter by.
$endDate = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime | End date of a date range. Used in conjunction with startDate to create a date range to filter by.
$offset = 0; // int | An offset to return a paginated list of results
$limit = 100; // int | The limit on the number of results
$dateRangeFilter = 'arrivalDate'; // string | Used in conjunction with startDate and endDate to filter bookings.
$futureOnly = false; // bool | Filter bookings by future only, based on arrival date being greater than now.
$tags = array('tags_example'); // string[] | Filter bookings by tag name. See tagsOperator.
$tagIds = array(56); // int[] | Filter bookings by tag ID. See tagsOperator.
$tagsOperator = 'all'; // string | Operator for use with tags or tagIds params. If all, bookings must have all given tags. If oneOf, bookings must contain one of the given tags.
$reference = 'reference_example'; // string | Fuzzy match on booking reference, e.g. B-001 will match B-00100, B-00101, B-00102 etc.

try {
    $result = $apiInstance->getBookings($startDate, $endDate, $offset, $limit, $dateRangeFilter, $futureOnly, $tags, $tagIds, $tagsOperator, $reference);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BookingsApi->getBookings: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
startDate	\DateTime	Start date of a date range. Used in conjunction with endDate to create a date range to filter by.	[optional]
endDate	\DateTime	End date of a date range. Used in conjunction with startDate to create a date range to filter by.	[optional]
offset	int	An offset to return a paginated list of results	[optional] [default to 0]
limit	int	The limit on the number of results	[optional] [default to 100]
dateRangeFilter	string	Used in conjunction with startDate and endDate to filter bookings.	[optional] [default to 'arrivalDate']
futureOnly	bool	Filter bookings by future only, based on arrival date being greater than now.	[optional] [default to false]
tags	string[]	Filter bookings by tag name. See tagsOperator.	[optional]
tagIds	int[]	Filter bookings by tag ID. See tagsOperator.	[optional]
tagsOperator	string	Operator for use with tags or tagIds params. If all, bookings must have all given tags. If oneOf, bookings must contain one of the given tags.	[optional] [default to 'all']
reference	string	Fuzzy match on booking reference, e.g. B-001 will match B-00100, B-00101, B-00102 etc.	[optional]

Return type

\SynergiTech\Cinolla\Model\Booking[]

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`removeTagsFromBooking()`

removeTagsFromBooking($bookingHash, $bookingType): \SynergiTech\Cinolla\Model\Booking6

Remove tags from a booking

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = SynergiTech\Cinolla\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = SynergiTech\Cinolla\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new SynergiTech\Cinolla\Api\BookingsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$bookingHash = 'bookingHash_example'; // string
$bookingType = array(new \SynergiTech\Cinolla\Model\BookingType()); // \SynergiTech\Cinolla\Model\BookingType[] | An array of tag IDs to remove from the booking

try {
    $result = $apiInstance->removeTagsFromBooking($bookingHash, $bookingType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BookingsApi->removeTagsFromBooking: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
bookingHash	string
bookingType	\SynergiTech\Cinolla\Model\BookingType[]	An array of tag IDs to remove from the booking

Return type

\SynergiTech\Cinolla\Model\Booking6

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`updateBooking()`

updateBooking($bookingHash, $booking4): \SynergiTech\Cinolla\Model\Booking5

Update an existing Booking

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = SynergiTech\Cinolla\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = SynergiTech\Cinolla\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new SynergiTech\Cinolla\Api\BookingsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$bookingHash = 'bookingHash_example'; // string
$booking4 = new \SynergiTech\Cinolla\Model\Booking4(); // \SynergiTech\Cinolla\Model\Booking4 | The Booking fields to update

try {
    $result = $apiInstance->updateBooking($bookingHash, $booking4);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BookingsApi->updateBooking: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
bookingHash	string
booking4	\SynergiTech\Cinolla\Model\Booking4	The Booking fields to update

Return type

\SynergiTech\Cinolla\Model\Booking5

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

BookingsApi.md

Latest commit

History

BookingsApi.md

File metadata and controls

SynergiTech\Cinolla\BookingsApi

addGroupToBooking()

Example

Parameters

Return type

Authorization

HTTP request headers

addTagsToBooking()

Example

Parameters

Return type

Authorization

HTTP request headers

createBooking()

Example

Parameters

Return type

Authorization

HTTP request headers

getBooking()

Example

Parameters

Return type

Authorization

HTTP request headers

getBookingGuests()

Example

Parameters

Return type

Authorization

HTTP request headers

getBookingTags()

Example

Parameters

Return type

Authorization

HTTP request headers

getBookings()

Example

Parameters

Return type

Authorization

HTTP request headers

removeTagsFromBooking()

Example

Parameters

Return type

Authorization

HTTP request headers

updateBooking()

Example

Parameters

Return type

Authorization

HTTP request headers

`addGroupToBooking()`

`addTagsToBooking()`

`createBooking()`

`getBooking()`

`getBookingGuests()`

`getBookingTags()`

`getBookings()`

`removeTagsFromBooking()`

`updateBooking()`