Skip to content

Commit

Permalink
Release of version 1.1.12
Browse files Browse the repository at this point in the history
  • Loading branch information
siebe committed Nov 20, 2019
1 parent 2dace32 commit 01da151
Show file tree
Hide file tree
Showing 368 changed files with 36,555 additions and 9,849 deletions.
28 changes: 20 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ For more information, please visit [https://pluxbox.com](https://pluxbox.com)

## Requirements

PHP 5.4.0 and later
PHP 5.5 and later

## Installation & Usage
### Composer
Expand Down Expand Up @@ -35,7 +35,7 @@ Then run `composer install`
Download the files and include `autoload.php`:

```php
require_once('/path/to/RadioManager/autoload.php');
require_once('/path/to/RadioManager/vendor/autoload.php');
```

## Tests
Expand All @@ -56,16 +56,21 @@ Please follow the [installation procedure](#installation--usage) and then run th
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new RadioManager\Api\BlockApi();
// $config = RadioManager\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');

$apiInstance = new RadioManager\Api\BlockApi(
// 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 = 789; // int | ID of Block **(Required)**
$_external_station_id = 789; // int | Query on a different (content providing) station *(Optional)*

try {
$result = $api_instance->getBlockById($id, $_external_station_id);
$result = $apiInstance->getBlockById($id, $_external_station_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BlockApi->getBlockById: ', $e->getMessage(), PHP_EOL;
Expand Down Expand Up @@ -93,7 +98,7 @@ Class | Method | HTTP request | Description
*BroadcastApi* | [**getNextBroadcast**](docs/Api/BroadcastApi.md#getnextbroadcast) | **GET** /broadcasts/next | Get next Broadcast
*BroadcastApi* | [**getWeeklyEPG**](docs/Api/BroadcastApi.md#getweeklyepg) | **GET** /broadcasts/epg/weekly | Get weekly EPG
*BroadcastApi* | [**listBroadcasts**](docs/Api/BroadcastApi.md#listbroadcasts) | **GET** /broadcasts | Get all broadcasts.
*BroadcastApi* | [**printBroadcastById**](docs/Api/BroadcastApi.md#printbroadcastbyid) | **GET** /broadcasts/print/{id} | Print Broadcast by id
*BroadcastApi* | [**printBroadcastById**](docs/Api/BroadcastApi.md#printbroadcastbyid) | **GET** /broadcasts/print/{id} | Print broadcast by id with template
*BroadcastApi* | [**updateBroadcastByID**](docs/Api/BroadcastApi.md#updatebroadcastbyid) | **PATCH** /broadcasts/{id} | Update broadcast by id
*CampaignApi* | [**createCampaign**](docs/Api/CampaignApi.md#createcampaign) | **POST** /campaigns | Create campaign.
*CampaignApi* | [**deleteCampaignById**](docs/Api/CampaignApi.md#deletecampaignbyid) | **DELETE** /campaigns/{id} | Delete campaign by id
Expand All @@ -114,8 +119,10 @@ Class | Method | HTTP request | Description
*ItemApi* | [**getCurrentItem**](docs/Api/ItemApi.md#getcurrentitem) | **GET** /items/current | Get current Item
*ItemApi* | [**getItemById**](docs/Api/ItemApi.md#getitembyid) | **GET** /items/{id} | Get extended item details by ID.
*ItemApi* | [**listItems**](docs/Api/ItemApi.md#listitems) | **GET** /items | Get a list of all the items currently in your station.
*ItemApi* | [**playlistPostMerge**](docs/Api/ItemApi.md#playlistpostmerge) | **POST** /items/playlist/merge | Post a playlist, do not remove previously imported items
*ItemApi* | [**playlistPostStructure**](docs/Api/ItemApi.md#playlistpoststructure) | **POST** /items/playlist/structure | Post a playlist, keep current structure
*ItemApi* | [**playlistPostTiming**](docs/Api/ItemApi.md#playlistposttiming) | **POST** /items/playlist/timing | Post a playlist
*ItemApi* | [**stopCurrentItem**](docs/Api/ItemApi.md#stopcurrentitem) | **POST** /items/stopcurrent | Stop an Item
*ItemApi* | [**updateItemById**](docs/Api/ItemApi.md#updateitembyid) | **PATCH** /items/{id} | Update extended item details by ID.
*ModelTypeApi* | [**getModelTypeById**](docs/Api/ModelTypeApi.md#getmodeltypebyid) | **GET** /model_types/{id} | Get modelType by id
*ModelTypeApi* | [**listModelTypes**](docs/Api/ModelTypeApi.md#listmodeltypes) | **GET** /model_types | Get all modelTypes.
Expand Down Expand Up @@ -165,6 +172,7 @@ Class | Method | HTTP request | Description
- [BroadcastOutputOnly](docs/Model/BroadcastOutputOnly.md)
- [BroadcastRelations](docs/Model/BroadcastRelations.md)
- [BroadcastRelationsBlocks](docs/Model/BroadcastRelationsBlocks.md)
- [BroadcastRelationsGenre](docs/Model/BroadcastRelationsGenre.md)
- [BroadcastRelationsItems](docs/Model/BroadcastRelationsItems.md)
- [BroadcastRelationsItemsParams](docs/Model/BroadcastRelationsItemsParams.md)
- [BroadcastRelationsModelType](docs/Model/BroadcastRelationsModelType.md)
Expand All @@ -177,6 +185,7 @@ Class | Method | HTTP request | Description
- [CampaignRelationsItems](docs/Model/CampaignRelationsItems.md)
- [CampaignRelationsItemsParams](docs/Model/CampaignRelationsItemsParams.md)
- [CampaignResults](docs/Model/CampaignResults.md)
- [CampaignTemplateItem](docs/Model/CampaignTemplateItem.md)
- [Contact](docs/Model/Contact.md)
- [ContactOutputOnly](docs/Model/ContactOutputOnly.md)
- [ContactRelations](docs/Model/ContactRelations.md)
Expand All @@ -186,6 +195,8 @@ Class | Method | HTTP request | Description
- [ContactResults](docs/Model/ContactResults.md)
- [Data](docs/Model/Data.md)
- [Data1](docs/Model/Data1.md)
- [Data2](docs/Model/Data2.md)
- [Data3](docs/Model/Data3.md)
- [EPGResults](docs/Model/EPGResults.md)
- [Forbidden](docs/Model/Forbidden.md)
- [Genre](docs/Model/Genre.md)
Expand Down Expand Up @@ -247,6 +258,7 @@ Class | Method | HTTP request | Description
- [RelationsPlaceholder](docs/Model/RelationsPlaceholder.md)
- [StationResult](docs/Model/StationResult.md)
- [StationResultStation](docs/Model/StationResultStation.md)
- [StationResultStationStartDays](docs/Model/StationResultStationStartDays.md)
- [Story](docs/Model/Story.md)
- [StoryInputOnly](docs/Model/StoryInputOnly.md)
- [StoryOutputOnly](docs/Model/StoryOutputOnly.md)
Expand Down
54 changes: 0 additions & 54 deletions autoload.php

This file was deleted.

56 changes: 38 additions & 18 deletions docs/Api/BlockApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,21 @@ Get block by id
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new RadioManager\Api\BlockApi();
// $config = RadioManager\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');

$apiInstance = new RadioManager\Api\BlockApi(
// 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 = 789; // int | ID of Block **(Required)**
$_external_station_id = 789; // int | Query on a different (content providing) station *(Optional)*

try {
$result = $api_instance->getBlockById($id, $_external_station_id);
$result = $apiInstance->getBlockById($id, $_external_station_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BlockApi->getBlockById: ', $e->getMessage(), PHP_EOL;
Expand Down Expand Up @@ -75,14 +80,19 @@ Get current Block
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new RadioManager\Api\BlockApi();
$apiInstance = new RadioManager\Api\BlockApi(
// 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 = $api_instance->getCurrentBlock();
$result = $apiInstance->getCurrentBlock();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BlockApi->getCurrentBlock: ', $e->getMessage(), PHP_EOL;
Expand Down Expand Up @@ -121,14 +131,19 @@ Get upcoming Block
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new RadioManager\Api\BlockApi();
$apiInstance = new RadioManager\Api\BlockApi(
// 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 = $api_instance->getNextBlock();
$result = $apiInstance->getNextBlock();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BlockApi->getNextBlock: ', $e->getMessage(), PHP_EOL;
Expand Down Expand Up @@ -167,11 +182,16 @@ Get a list of all blocks currently in your station. This feature supports pagina
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new RadioManager\Api\BlockApi();
// $config = RadioManager\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');

$apiInstance = new RadioManager\Api\BlockApi(
// 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
);
$page = 1; // int | Current page *(Optional)*
$broadcast_id = 789; // int | Search on Broadcast ID *(Optional)* `(Relation)`
$item_id = 789; // int | Search on Item ID *(Optional)* `(Relation)`
Expand All @@ -184,7 +204,7 @@ $order_direction = "order_direction_example"; // string | Direction of ordering
$_external_station_id = 789; // int | Query on a different (content providing) station *(Optional)*

try {
$result = $api_instance->listBlocks($page, $broadcast_id, $item_id, $program_id, $start_min, $start_max, $limit, $order_by, $order_direction, $_external_station_id);
$result = $apiInstance->listBlocks($page, $broadcast_id, $item_id, $program_id, $start_min, $start_max, $limit, $order_by, $order_direction, $_external_station_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BlockApi->listBlocks: ', $e->getMessage(), PHP_EOL;
Expand Down
Loading

0 comments on commit 01da151

Please sign in to comment.