kinoheld / generic-provider-client
1.3.1
2020-11-11 11:44 UTC
Requires
- php: >=5.5
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^6.2
Requires (Dev)
- friendsofphp/php-cs-fixer: ~1.12
- phpunit/phpunit: ^4.8
- squizlabs/php_codesniffer: ~2.6
README
cinema movie
This PHP package is automatically generated by the Swagger Codegen project:
- API version: 1.0.0
- Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen
Requirements
PHP 5.5 and later
Installation & Usage
Composer
To install the bindings via Composer, add the following to composer.json
:
{
"repositories": [
{
"type": "git",
"url": "https://github.com/kinoheld/generic-provider-client.git"
}
],
"require": {
"kinoheld/generic-provider-client": "*@dev"
}
}
Then run composer install
Manual Installation
Download the files and include autoload.php
:
require_once('/path/to/SwaggerClient-php/vendor/autoload.php');
Tests
To run the unit tests:
composer install
./vendor/bin/phpunit
Getting Started
Please follow the installation procedure and then run the following:
<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: ApiKeyAuth $config = kinoheld\GenericProviderClient\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = kinoheld\GenericProviderClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer'); $apiInstance = new kinoheld\GenericProviderClient\Api\BasicApi( // 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 ); $chainId = 56; // int | chain/company ID $cinemaId = 56; // int | Pass a cinema id to retrieve the associated auditoriums. try { $result = $apiInstance->getAuditoriums($chainId, $cinemaId); print_r($result); } catch (Exception $e) { echo 'Exception when calling BasicApi->getAuditoriums: ', $e->getMessage(), PHP_EOL; } // Configure API key authorization: ApiKeyAuth $config = kinoheld\GenericProviderClient\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = kinoheld\GenericProviderClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer'); $apiInstance = new kinoheld\GenericProviderClient\Api\BasicApi( // 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 ); $id = 56; // int | Pass an optional chain id to retrieve just the chain details of the given chain. try { $result = $apiInstance->getChains($id); print_r($result); } catch (Exception $e) { echo 'Exception when calling BasicApi->getChains: ', $e->getMessage(), PHP_EOL; } // Configure API key authorization: ApiKeyAuth $config = kinoheld\GenericProviderClient\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = kinoheld\GenericProviderClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer'); $apiInstance = new kinoheld\GenericProviderClient\Api\BasicApi( // 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 ); $chainId = 56; // int | chain/company ID $id = 56; // int | Pass an optional cinema id to retrieve just the cinema details of the given cinema. try { $result = $apiInstance->getCinemas($chainId, $id); print_r($result); } catch (Exception $e) { echo 'Exception when calling BasicApi->getCinemas: ', $e->getMessage(), PHP_EOL; } // Configure API key authorization: ApiKeyAuth $config = kinoheld\GenericProviderClient\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = kinoheld\GenericProviderClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer'); $apiInstance = new kinoheld\GenericProviderClient\Api\BasicApi( // 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 ); $chainId = 56; // int | chain/company ID $cinemaId = 56; // int | Pass a cinema id to retrieve the associated products. try { $result = $apiInstance->getProducts($chainId, $cinemaId); print_r($result); } catch (Exception $e) { echo 'Exception when calling BasicApi->getProducts: ', $e->getMessage(), PHP_EOL; } ?>
Documentation for API Endpoints
All URIs are relative to https://virtserver.swaggerhub.com/mezmer/kinoheld/1.0.0
Class | Method | HTTP request | Description |
---|---|---|---|
BasicApi | getAuditoriums | GET /auditoriums | list of auditoriums for the given cinema |
BasicApi | getChains | GET /chains | list of chains/companies |
BasicApi | getCinemas | GET /cinemas | list of cinemas |
BasicApi | getProducts | GET /products | list of products for the given cinema |
CartApi | cartAddDiscount | POST /cart/addDiscount | add discount to the cart |
CartApi | cartAddItems | POST /cart/addItems | add items to the cart |
CartApi | cartAddLoyalty | POST /cart/addLoyalty | add loyalty card to the cart |
CartApi | cartAddProduct | POST /cart/addProduct | add product to the cart |
CartApi | cartCheckout | POST /cart/checkout | checkout the cart |
CartApi | cartConfirmCheckout | POST /cart/confirmCheckout | confirm the successful checkout of the cart |
CartApi | cartCreate | POST /cart/create | create a new cart |
CartApi | cartGet | GET /cart | get the cart contents |
CartApi | cartRemoveDiscount | POST /cart/removeDiscount | remove an already applied discount from the cart |
CartApi | cartRemoveLoyalty | POST /cart/removeLoyalty | remove an already applied loyalty card from the cart |
CartApi | cartRemoveProducts | POST /cart/removeProducts | remove all product from the cart |
CartApi | cartReset | POST /cart/reset | reset contents of the cart |
DiscountApi | discountGet | GET /discount | get the discount |
EventApi | getMovie | GET /movie | movie details for the given movie id |
EventApi | getSeats | GET /seats | list of seats for the given show |
EventApi | getShow | GET /show | show info for the given cinema and show ID |
EventApi | getShows | GET /shows | list of shows for the given cinema |
LoyaltyApi | loyaltyGet | GET /loyalty | get the loyalty card |
OrderApi | orderCancel | POST /order/cancel | cancel the order |
OrderApi | orderGet | GET /order | get the order |
Documentation For Models
- AuditoriumItem
- Body
- Body1
- Cart
- CartDiscount
- CartItem
- CartLoyalty
- CartPricing
- CartProduct
- CartProductAttribute
- ChainItem
- CinemaItem
- Discount
- Loyalty
- LoyaltyHistory
- MovieItem
- Order
- OrderItem
- OrderItemTicket
- OrderLoyalty
- OrderPricing
- OrderProduct
- PriceAreaItem
- PriceCategoryItem
- ProductItem
- ProductItemAttribute
- ProductItemAttributeOption
- SeatItem
- ShowItem
Documentation For Authorization
ApiKeyAuth
- Type: API key
- API key parameter name: X-API-Key
- Location: HTTP header