Skip to content

Generic provider client to access providers that match the kinoheld provider spec.

License

Notifications You must be signed in to change notification settings

kinoheld/generic-provider-client

Repository files navigation

OpenAPIClient-php

cinema movie

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "/~https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

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
);
$chain_id = 56; // int | chain/company ID
$cinema_id = 56; // int | Pass a cinema id to retrieve the associated auditoriums.

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

API Endpoints

All URIs are relative to https://virtserver.swaggerhub.com/mezmer/kinoheld/2.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 cartRemoveItems POST /cart/removeItems remove all items 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

Models

Authorization

Authentication schemes defined for the API:

ApiKeyAuth

  • Type: API key
  • API key parameter name: X-API-Key
  • Location: HTTP header

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

sm@kinoheld.de

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
    • Generator version: 7.9.0-SNAPSHOT
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen