Skip to content

Pluxbox/radiomanager-perl-client

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
bin
bin
 
 
docs
docs
 
 
lib/RadioManagerClient
lib/RadioManagerClient
 
 
t
t
 
 
.gitignore
.gitignore
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 

Repository files navigation

NAME

Pluxbox RadioManager gives you the power, flexibility and speed you always wanted in a lightweight and easy-to-use web-based radio solution. With Pluxbox RadioManager you can organise your radio workflow and automate your omnichannel communication with your listeners. We offer wide range specialised services for the radio and connections like Hybrid Radio, Visual Radio, your website and social media without losing focus on your broadcast. For more information visit: pluxbox.com

  • API version: 2.0
  • Package version: 1.1.12
  • Build package: io.swagger.codegen.languages.PerlClientCodegen For more information, please visit https://pluxbox.com

A note on Moose

This role is the only component of the library that uses Moose. See RadioManagerClient::ApiFactory for non-Moosey usage.

SYNOPSIS

The Perl Swagger Codegen project builds a library of Perl modules to interact with a web service defined by a OpenAPI Specification. See below for how to build the library.

This module provides an interface to the generated library. All the classes, objects, and methods (well, not quite *all*, see below) are flattened into this role.

    package MyApp;
    use Moose;
    with 'RadioManagerClient::Role';

    package main;

    my $api = MyApp->new({ tokens => $tokens });

    my $pet = $api->get_pet_by_id(pet_id => $pet_id);

Structure of the library

The library consists of a set of API classes, one for each endpoint. These APIs implement the method calls available on each endpoint.

Additionally, there is a set of "object" classes, which represent the objects returned by and sent to the methods on the endpoints.

An API factory class is provided, which builds instances of each endpoint API.

This Moose role flattens all the methods from the endpoint APIs onto the consuming class. It also provides methods to retrieve the endpoint API objects, and the API factory object, should you need it.

For documentation of all these methods, see AUTOMATIC DOCUMENTATION below.

Configuring authentication

In the normal case, the OpenAPI Spec will describe what parameters are required and where to put them. You just need to supply the tokens.

my $tokens = {
    # basic
    username => $username,
    password => $password,

    # oauth
    access_token => $oauth_token,

    # keys
    $some_key => { token => $token,
                   prefix => $prefix,
                   in => $in,             # 'head||query',
                   },

    $another => { token => $token,
                  prefix => $prefix,
                  in => $in,              # 'head||query',
                  },
    ...,

    };

    my $api = MyApp->new({ tokens => $tokens });

Note these are all optional, as are prefix and in, and depend on the API you are accessing. Usually prefix and in will be determined by the code generator from the spec and you will not need to set them at run time. If not, in will default to 'head' and prefix to the empty string.

The tokens will be placed in a LRadioManagerClient::Configuration instance as follows, but you don't need to know about this.

  • $cfg->{username}

    String. The username for basic auth.

  • $cfg->{password}

    String. The password for basic auth.

  • $cfg->{api_key}

    Hashref. Keyed on the name of each key (there can be multiple tokens).

          $cfg->{api_key} = {
              secretKey => 'aaaabbbbccccdddd',
              anotherKey => '1111222233334444',
              };

  • $cfg->{api_key_prefix}

    Hashref. Keyed on the name of each key (there can be multiple tokens). Note not all api keys require a prefix.

          $cfg->{api_key_prefix} = {
              secretKey => 'string',
              anotherKey => 'same or some other string',
              };

  • $cfg->{access_token}

    String. The OAuth access token.

METHODS

base_url

The generated code has the base_url already set as a default value. This method returns the current value of base_url.

api_factory

Returns an API factory object. You probably won't need to call this directly.

    $self->api_factory('Pet'); # returns a RadioManagerClient::PetApi instance

    $self->pet_api;            # the same

MISSING METHODS

Most of the methods on the API are delegated to individual endpoint API objects (e.g. Pet API, Store API, User API etc). Where different endpoint APIs use the same method name (e.g. new()), these methods can't be delegated. So you need to call $api->pet_api->new().

In principle, every API is susceptible to the presence of a few, random, undelegatable method names. In practice, because of the way method names are constructed, it's unlikely in general that any methods will be undelegatable, except for:

    new()
    class_documentation()
    method_documentation()

To call these methods, you need to get a handle on the relevant object, either by calling $api->foo_api or by retrieving an object, e.g. $api->get_pet_by_id(pet_id => $pet_id). They are class methods, so you could also call them on class names.

BUILDING YOUR LIBRARY

See the homepage https://github.com/swagger-api/swagger-codegen for full details. But briefly, clone the git repository, build the codegen codebase, set up your build config file, then run the API build script. You will need git, Java 7 or 8 and Apache maven 3.0.3 or better already installed.

The config file should specify the project name for the generated library:

    {"moduleName":"WWW::MyProjectName"}

Your library files will be built under WWW::MyProjectName.

      $ git clone https://github.com/swagger-api/swagger-codegen.git
      $ cd swagger-codegen
      $ mvn package
      $ java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \
-i [URL or file path to JSON swagger API spec] \
-l perl \
-c /path/to/config/file.json \
-o /path/to/output/folder

Bang, all done. Run the autodoc script in the bin directory to see the API you just built.

AUTOMATIC DOCUMENTATION

You can print out a summary of the generated API by running the included autodoc script in the bin directory of your generated library. A few output formats are supported:

      Usage: autodoc [OPTION]

-w           wide format (default)
-n           narrow format
-p           POD format
-H           HTML format
-m           Markdown format
-h           print this help message
-c           your application class

The -c option allows you to load and inspect your own application. A dummy namespace is used if you don't supply your own class.

DOCUMENTATION FROM THE OpenAPI Spec

Additional documentation for each class and method may be provided by the Swagger spec. If so, this is available via the class_documentation() and method_documentation() methods on each generated object class, and the method_documentation() method on the endpoint API classes:

    my $cmdoc = $api->pet_api->method_documentation->{$method_name};

    my $odoc = $api->get_pet_by_id->(pet_id => $pet_id)->class_documentation;
    my $omdoc = $api->get_pet_by_id->(pet_id => $pet_id)->method_documentation->{method_name};

Each of these calls returns a hashref with various useful pieces of information.

LOAD THE MODULES

To load the API packages:

use RadioManagerClient::BlockApi;
use RadioManagerClient::BroadcastApi;
use RadioManagerClient::CampaignApi;
use RadioManagerClient::ContactApi;
use RadioManagerClient::GenreApi;
use RadioManagerClient::ItemApi;
use RadioManagerClient::ModelTypeApi;
use RadioManagerClient::PresenterApi;
use RadioManagerClient::ProgramApi;
use RadioManagerClient::StationApi;
use RadioManagerClient::StoryApi;
use RadioManagerClient::StringApi;
use RadioManagerClient::TagApi;
use RadioManagerClient::UserApi;
use RadioManagerClient::VisualSlideApi;

To load the models:

use RadioManagerClient::Object::Block;
use RadioManagerClient::Object::BlockRelations;
use RadioManagerClient::Object::BlockRelationsBroadcast;
use RadioManagerClient::Object::BlockRelationsBroadcastParams;
use RadioManagerClient::Object::BlockRelationsItems;
use RadioManagerClient::Object::BlockRelationsItemsParams;
use RadioManagerClient::Object::BlockRelationsProgram;
use RadioManagerClient::Object::BlockResults;
use RadioManagerClient::Object::Broadcast;
use RadioManagerClient::Object::BroadcastEPGDay;
use RadioManagerClient::Object::BroadcastEPGRelations;
use RadioManagerClient::Object::BroadcastInputOnly;
use RadioManagerClient::Object::BroadcastOutputOnly;
use RadioManagerClient::Object::BroadcastRelations;
use RadioManagerClient::Object::BroadcastRelationsBlocks;
use RadioManagerClient::Object::BroadcastRelationsGenre;
use RadioManagerClient::Object::BroadcastRelationsItems;
use RadioManagerClient::Object::BroadcastRelationsItemsParams;
use RadioManagerClient::Object::BroadcastRelationsModelType;
use RadioManagerClient::Object::BroadcastRelationsPresenters;
use RadioManagerClient::Object::BroadcastRelationsTags;
use RadioManagerClient::Object::BroadcastResults;
use RadioManagerClient::Object::Campaign;
use RadioManagerClient::Object::CampaignOutputOnly;
use RadioManagerClient::Object::CampaignRelations;
use RadioManagerClient::Object::CampaignRelationsItems;
use RadioManagerClient::Object::CampaignRelationsItemsParams;
use RadioManagerClient::Object::CampaignResults;
use RadioManagerClient::Object::CampaignTemplateItem;
use RadioManagerClient::Object::Contact;
use RadioManagerClient::Object::ContactOutputOnly;
use RadioManagerClient::Object::ContactRelations;
use RadioManagerClient::Object::ContactRelationsItems;
use RadioManagerClient::Object::ContactRelationsTags;
use RadioManagerClient::Object::ContactRelationsTagsParams;
use RadioManagerClient::Object::ContactResults;
use RadioManagerClient::Object::Data;
use RadioManagerClient::Object::Data1;
use RadioManagerClient::Object::Data2;
use RadioManagerClient::Object::Data3;
use RadioManagerClient::Object::EPGResults;
use RadioManagerClient::Object::Forbidden;
use RadioManagerClient::Object::Genre;
use RadioManagerClient::Object::GenreOutputOnly;
use RadioManagerClient::Object::GenreRelations;
use RadioManagerClient::Object::GenreRelationsBroadcasts;
use RadioManagerClient::Object::GenreRelationsBroadcastsParams;
use RadioManagerClient::Object::GenreRelationsPrograms;
use RadioManagerClient::Object::GenreResults;
use RadioManagerClient::Object::ImportItem;
use RadioManagerClient::Object::InlineResponse202;
use RadioManagerClient::Object::InternalServerError;
use RadioManagerClient::Object::InviteUserData;
use RadioManagerClient::Object::InviteUserSuccess;
use RadioManagerClient::Object::Item;
use RadioManagerClient::Object::ItemInputOnly;
use RadioManagerClient::Object::ItemOutputOnly;
use RadioManagerClient::Object::ItemRelations;
use RadioManagerClient::Object::ItemRelationsBlock;
use RadioManagerClient::Object::ItemRelationsCampaign;
use RadioManagerClient::Object::ItemRelationsContacts;
use RadioManagerClient::Object::ItemRelationsContactsParams;
use RadioManagerClient::Object::ItemRelationsProgram;
use RadioManagerClient::Object::ItemRelationsTags;
use RadioManagerClient::Object::ItemResults;
use RadioManagerClient::Object::ModelType;
use RadioManagerClient::Object::ModelTypeOptions;
use RadioManagerClient::Object::ModelTypeOutputOnly;
use RadioManagerClient::Object::ModelTypeRelations;
use RadioManagerClient::Object::ModelTypeRelationsBroadcasts;
use RadioManagerClient::Object::ModelTypeRelationsCampaigns;
use RadioManagerClient::Object::ModelTypeRelationsCampaignsParams;
use RadioManagerClient::Object::ModelTypeRelationsContacts;
use RadioManagerClient::Object::ModelTypeRelationsItems;
use RadioManagerClient::Object::ModelTypeRelationsPresenters;
use RadioManagerClient::Object::ModelTypeRelationsPrograms;
use RadioManagerClient::Object::ModelTypeResults;
use RadioManagerClient::Object::NotFound;
use RadioManagerClient::Object::PostSuccess;
use RadioManagerClient::Object::Presenter;
use RadioManagerClient::Object::PresenterOutputOnly;
use RadioManagerClient::Object::PresenterRelations;
use RadioManagerClient::Object::PresenterRelationsBroadcasts;
use RadioManagerClient::Object::PresenterRelationsPrograms;
use RadioManagerClient::Object::PresenterRelationsProgramsParams;
use RadioManagerClient::Object::PresenterResults;
use RadioManagerClient::Object::Program;
use RadioManagerClient::Object::ProgramInputOnly;
use RadioManagerClient::Object::ProgramOutputOnly;
use RadioManagerClient::Object::ProgramRelations;
use RadioManagerClient::Object::ProgramRelationsBlocks;
use RadioManagerClient::Object::ProgramRelationsBroadcasts;
use RadioManagerClient::Object::ProgramRelationsItems;
use RadioManagerClient::Object::ProgramRelationsItemsParams;
use RadioManagerClient::Object::ProgramRelationsPresenters;
use RadioManagerClient::Object::ProgramRelationsTags;
use RadioManagerClient::Object::ProgramResults;
use RadioManagerClient::Object::ReadOnly;
use RadioManagerClient::Object::RelationsPlaceholder;
use RadioManagerClient::Object::StationResult;
use RadioManagerClient::Object::StationResultStation;
use RadioManagerClient::Object::StationResultStationStartDays;
use RadioManagerClient::Object::Story;
use RadioManagerClient::Object::StoryInputOnly;
use RadioManagerClient::Object::StoryOutputOnly;
use RadioManagerClient::Object::StoryRelations;
use RadioManagerClient::Object::StoryRelationsItems;
use RadioManagerClient::Object::StoryRelationsTags;
use RadioManagerClient::Object::StoryRelationsTagsParams;
use RadioManagerClient::Object::StoryResults;
use RadioManagerClient::Object::Success;
use RadioManagerClient::Object::Tag;
use RadioManagerClient::Object::TagOutputOnly;
use RadioManagerClient::Object::TagRelations;
use RadioManagerClient::Object::TagRelationsBroadcasts;
use RadioManagerClient::Object::TagRelationsBroadcastsParams;
use RadioManagerClient::Object::TagRelationsContacts;
use RadioManagerClient::Object::TagRelationsItems;
use RadioManagerClient::Object::TagRelationsPrograms;
use RadioManagerClient::Object::TagResults;
use RadioManagerClient::Object::TextString;
use RadioManagerClient::Object::TooManyRequests;
use RadioManagerClient::Object::UnprocessableEntity;
use RadioManagerClient::Object::UserResult;
use RadioManagerClient::Object::UserResultRoles;
use RadioManagerClient::Object::UserResultSettings;
use RadioManagerClient::Object::UserResults;
use RadioManagerClient::Object::VisualResult;
use RadioManagerClient::Object::BlockResult;
use RadioManagerClient::Object::BroadcastDataInput;
use RadioManagerClient::Object::BroadcastEPGResult;
use RadioManagerClient::Object::BroadcastResult;
use RadioManagerClient::Object::CampaignDataInput;
use RadioManagerClient::Object::CampaignResult;
use RadioManagerClient::Object::ContactDataInput;
use RadioManagerClient::Object::ContactResult;
use RadioManagerClient::Object::GenreResult;
use RadioManagerClient::Object::ItemDataInput;
use RadioManagerClient::Object::ItemResult;
use RadioManagerClient::Object::ModelTypeResult;
use RadioManagerClient::Object::PresenterDataInput;
use RadioManagerClient::Object::PresenterEPGResult;
use RadioManagerClient::Object::PresenterResult;
use RadioManagerClient::Object::ProgramDataInput;
use RadioManagerClient::Object::ProgramResult;
use RadioManagerClient::Object::StoryDataInput;
use RadioManagerClient::Object::StoryResult;
use RadioManagerClient::Object::TagDataInput;
use RadioManagerClient::Object::TagResult;

GETTING STARTED

Put the Perl SDK under the 'lib' folder in your project directory, then run the following

#!/usr/bin/perl
use lib 'lib';
use strict;
use warnings;
# load the API package
use RadioManagerClient::BlockApi;
use RadioManagerClient::BroadcastApi;
use RadioManagerClient::CampaignApi;
use RadioManagerClient::ContactApi;
use RadioManagerClient::GenreApi;
use RadioManagerClient::ItemApi;
use RadioManagerClient::ModelTypeApi;
use RadioManagerClient::PresenterApi;
use RadioManagerClient::ProgramApi;
use RadioManagerClient::StationApi;
use RadioManagerClient::StoryApi;
use RadioManagerClient::StringApi;
use RadioManagerClient::TagApi;
use RadioManagerClient::UserApi;
use RadioManagerClient::VisualSlideApi;

# load the models
use RadioManagerClient::Object::Block;
use RadioManagerClient::Object::BlockRelations;
use RadioManagerClient::Object::BlockRelationsBroadcast;
use RadioManagerClient::Object::BlockRelationsBroadcastParams;
use RadioManagerClient::Object::BlockRelationsItems;
use RadioManagerClient::Object::BlockRelationsItemsParams;
use RadioManagerClient::Object::BlockRelationsProgram;
use RadioManagerClient::Object::BlockResults;
use RadioManagerClient::Object::Broadcast;
use RadioManagerClient::Object::BroadcastEPGDay;
use RadioManagerClient::Object::BroadcastEPGRelations;
use RadioManagerClient::Object::BroadcastInputOnly;
use RadioManagerClient::Object::BroadcastOutputOnly;
use RadioManagerClient::Object::BroadcastRelations;
use RadioManagerClient::Object::BroadcastRelationsBlocks;
use RadioManagerClient::Object::BroadcastRelationsGenre;
use RadioManagerClient::Object::BroadcastRelationsItems;
use RadioManagerClient::Object::BroadcastRelationsItemsParams;
use RadioManagerClient::Object::BroadcastRelationsModelType;
use RadioManagerClient::Object::BroadcastRelationsPresenters;
use RadioManagerClient::Object::BroadcastRelationsTags;
use RadioManagerClient::Object::BroadcastResults;
use RadioManagerClient::Object::Campaign;
use RadioManagerClient::Object::CampaignOutputOnly;
use RadioManagerClient::Object::CampaignRelations;
use RadioManagerClient::Object::CampaignRelationsItems;
use RadioManagerClient::Object::CampaignRelationsItemsParams;
use RadioManagerClient::Object::CampaignResults;
use RadioManagerClient::Object::CampaignTemplateItem;
use RadioManagerClient::Object::Contact;
use RadioManagerClient::Object::ContactOutputOnly;
use RadioManagerClient::Object::ContactRelations;
use RadioManagerClient::Object::ContactRelationsItems;
use RadioManagerClient::Object::ContactRelationsTags;
use RadioManagerClient::Object::ContactRelationsTagsParams;
use RadioManagerClient::Object::ContactResults;
use RadioManagerClient::Object::Data;
use RadioManagerClient::Object::Data1;
use RadioManagerClient::Object::Data2;
use RadioManagerClient::Object::Data3;
use RadioManagerClient::Object::EPGResults;
use RadioManagerClient::Object::Forbidden;
use RadioManagerClient::Object::Genre;
use RadioManagerClient::Object::GenreOutputOnly;
use RadioManagerClient::Object::GenreRelations;
use RadioManagerClient::Object::GenreRelationsBroadcasts;
use RadioManagerClient::Object::GenreRelationsBroadcastsParams;
use RadioManagerClient::Object::GenreRelationsPrograms;
use RadioManagerClient::Object::GenreResults;
use RadioManagerClient::Object::ImportItem;
use RadioManagerClient::Object::InlineResponse202;
use RadioManagerClient::Object::InternalServerError;
use RadioManagerClient::Object::InviteUserData;
use RadioManagerClient::Object::InviteUserSuccess;
use RadioManagerClient::Object::Item;
use RadioManagerClient::Object::ItemInputOnly;
use RadioManagerClient::Object::ItemOutputOnly;
use RadioManagerClient::Object::ItemRelations;
use RadioManagerClient::Object::ItemRelationsBlock;
use RadioManagerClient::Object::ItemRelationsCampaign;
use RadioManagerClient::Object::ItemRelationsContacts;
use RadioManagerClient::Object::ItemRelationsContactsParams;
use RadioManagerClient::Object::ItemRelationsProgram;
use RadioManagerClient::Object::ItemRelationsTags;
use RadioManagerClient::Object::ItemResults;
use RadioManagerClient::Object::ModelType;
use RadioManagerClient::Object::ModelTypeOptions;
use RadioManagerClient::Object::ModelTypeOutputOnly;
use RadioManagerClient::Object::ModelTypeRelations;
use RadioManagerClient::Object::ModelTypeRelationsBroadcasts;
use RadioManagerClient::Object::ModelTypeRelationsCampaigns;
use RadioManagerClient::Object::ModelTypeRelationsCampaignsParams;
use RadioManagerClient::Object::ModelTypeRelationsContacts;
use RadioManagerClient::Object::ModelTypeRelationsItems;
use RadioManagerClient::Object::ModelTypeRelationsPresenters;
use RadioManagerClient::Object::ModelTypeRelationsPrograms;
use RadioManagerClient::Object::ModelTypeResults;
use RadioManagerClient::Object::NotFound;
use RadioManagerClient::Object::PostSuccess;
use RadioManagerClient::Object::Presenter;
use RadioManagerClient::Object::PresenterOutputOnly;
use RadioManagerClient::Object::PresenterRelations;
use RadioManagerClient::Object::PresenterRelationsBroadcasts;
use RadioManagerClient::Object::PresenterRelationsPrograms;
use RadioManagerClient::Object::PresenterRelationsProgramsParams;
use RadioManagerClient::Object::PresenterResults;
use RadioManagerClient::Object::Program;
use RadioManagerClient::Object::ProgramInputOnly;
use RadioManagerClient::Object::ProgramOutputOnly;
use RadioManagerClient::Object::ProgramRelations;
use RadioManagerClient::Object::ProgramRelationsBlocks;
use RadioManagerClient::Object::ProgramRelationsBroadcasts;
use RadioManagerClient::Object::ProgramRelationsItems;
use RadioManagerClient::Object::ProgramRelationsItemsParams;
use RadioManagerClient::Object::ProgramRelationsPresenters;
use RadioManagerClient::Object::ProgramRelationsTags;
use RadioManagerClient::Object::ProgramResults;
use RadioManagerClient::Object::ReadOnly;
use RadioManagerClient::Object::RelationsPlaceholder;
use RadioManagerClient::Object::StationResult;
use RadioManagerClient::Object::StationResultStation;
use RadioManagerClient::Object::StationResultStationStartDays;
use RadioManagerClient::Object::Story;
use RadioManagerClient::Object::StoryInputOnly;
use RadioManagerClient::Object::StoryOutputOnly;
use RadioManagerClient::Object::StoryRelations;
use RadioManagerClient::Object::StoryRelationsItems;
use RadioManagerClient::Object::StoryRelationsTags;
use RadioManagerClient::Object::StoryRelationsTagsParams;
use RadioManagerClient::Object::StoryResults;
use RadioManagerClient::Object::Success;
use RadioManagerClient::Object::Tag;
use RadioManagerClient::Object::TagOutputOnly;
use RadioManagerClient::Object::TagRelations;
use RadioManagerClient::Object::TagRelationsBroadcasts;
use RadioManagerClient::Object::TagRelationsBroadcastsParams;
use RadioManagerClient::Object::TagRelationsContacts;
use RadioManagerClient::Object::TagRelationsItems;
use RadioManagerClient::Object::TagRelationsPrograms;
use RadioManagerClient::Object::TagResults;
use RadioManagerClient::Object::TextString;
use RadioManagerClient::Object::TooManyRequests;
use RadioManagerClient::Object::UnprocessableEntity;
use RadioManagerClient::Object::UserResult;
use RadioManagerClient::Object::UserResultRoles;
use RadioManagerClient::Object::UserResultSettings;
use RadioManagerClient::Object::UserResults;
use RadioManagerClient::Object::VisualResult;
use RadioManagerClient::Object::BlockResult;
use RadioManagerClient::Object::BroadcastDataInput;
use RadioManagerClient::Object::BroadcastEPGResult;
use RadioManagerClient::Object::BroadcastResult;
use RadioManagerClient::Object::CampaignDataInput;
use RadioManagerClient::Object::CampaignResult;
use RadioManagerClient::Object::ContactDataInput;
use RadioManagerClient::Object::ContactResult;
use RadioManagerClient::Object::GenreResult;
use RadioManagerClient::Object::ItemDataInput;
use RadioManagerClient::Object::ItemResult;
use RadioManagerClient::Object::ModelTypeResult;
use RadioManagerClient::Object::PresenterDataInput;
use RadioManagerClient::Object::PresenterEPGResult;
use RadioManagerClient::Object::PresenterResult;
use RadioManagerClient::Object::ProgramDataInput;
use RadioManagerClient::Object::ProgramResult;
use RadioManagerClient::Object::StoryDataInput;
use RadioManagerClient::Object::StoryResult;
use RadioManagerClient::Object::TagDataInput;
use RadioManagerClient::Object::TagResult;

# for displaying the API response data
use Data::Dumper;
use RadioManagerClient::;

my $api_instance = RadioManagerClient::->new(

    # Configure API key authorization: API Key
    api_key => {'api-key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'api-key' => 'Bearer'},
);

my $id = 789; # int | ID of Block **(Required)**
my $_external_station_id = 789; # int | Query on a different (content providing) station *(Optional)*

eval {
    my $result = $api_instance->get_block_by_id(id => $id, _external_station_id => $_external_station_id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BlockApi->get_block_by_id: $@\n";
}

DOCUMENTATION FOR API ENDPOINTS

All URIs are relative to https://radiomanager.io/api/v2

Class Method HTTP request Description
BlockApi get_block_by_id GET /blocks/{id} Get block by id
BlockApi get_current_block GET /blocks/current Get current Block
BlockApi get_next_block GET /blocks/next Get upcoming Block
BlockApi list_blocks GET /blocks Get a list of all blocks currently in your station.
BroadcastApi create_broadcast POST /broadcasts Create broadcast.
BroadcastApi delete_broadcast_by_id DELETE /broadcasts/{id} Delete broadcast by id
BroadcastApi get_broadcast_by_id GET /broadcasts/{id} Get broadcast by id
BroadcastApi get_current_broadcast GET /broadcasts/current Get current Broadcast
BroadcastApi get_daily_epg GET /broadcasts/epg/daily Get daily EPG
BroadcastApi get_epg_by_date GET /broadcasts/epg Get EPG by date
BroadcastApi get_next_broadcast GET /broadcasts/next Get next Broadcast
BroadcastApi get_weekly_epg GET /broadcasts/epg/weekly Get weekly EPG
BroadcastApi list_broadcasts GET /broadcasts Get all broadcasts.
BroadcastApi print_broadcast_by_id GET /broadcasts/print/{id} Print broadcast by id with template
BroadcastApi update_broadcast_by_id PATCH /broadcasts/{id} Update broadcast by id
CampaignApi create_campaign POST /campaigns Create campaign.
CampaignApi delete_campaign_by_id DELETE /campaigns/{id} Delete campaign by id
CampaignApi get_campaign_by_id GET /campaigns/{id} Get campaign by id
CampaignApi list_campaigns GET /campaigns Get all campaigns.
CampaignApi update_campaign_by_id PATCH /campaigns/{id} Update campaign by id
ContactApi create_contact POST /contacts Create contact.
ContactApi delete_contact_by_id DELETE /contacts/{id} Delete contact by id
ContactApi get_contact_by_id GET /contacts/{id} Get contact by id
ContactApi list_contacts GET /contacts Get all contacts.
ContactApi update_contact_by_id PATCH /contacts/{id} Update contact by id
GenreApi get_genre_by_id GET /genres/{id} Get genre by id
GenreApi list_genres GET /genres List all genres.
ItemApi create_item POST /items Create an new item.
ItemApi current_item_post_structure POST /items/current/structure Post a current playing item, keep structure
ItemApi current_item_post_timing POST /items/current/timing Post a current playing item
ItemApi delete_item_by_id DELETE /items/{id} Delete item by ID.
ItemApi get_current_item GET /items/current Get current Item
ItemApi get_item_by_id GET /items/{id} Get extended item details by ID.
ItemApi list_items GET /items Get a list of all the items currently in your station.
ItemApi playlist_post_merge POST /items/playlist/merge Post a playlist, do not remove previously imported items
ItemApi playlist_post_structure POST /items/playlist/structure Post a playlist, keep current structure
ItemApi playlist_post_timing POST /items/playlist/timing Post a playlist
ItemApi stop_current_item POST /items/stopcurrent Stop an Item
ItemApi update_item_by_id PATCH /items/{id} Update extended item details by ID.
ModelTypeApi get_model_type_by_id GET /model_types/{id} Get modelType by id
ModelTypeApi list_model_types GET /model_types Get all modelTypes.
PresenterApi create_presenter POST /presenters Create presenter.
PresenterApi delete_presenter_by_id DELETE /presenters/{id} Delete presenter by id
PresenterApi get_presenter_by_id GET /presenters/{id} Get presenter by id
PresenterApi list_presenters GET /presenters Get all presenters.
PresenterApi update_presenter_by_id PATCH /presenters/{id} Update presenter by id
ProgramApi create_program POST /programs Create program.
ProgramApi delete_program_by_id DELETE /programs/{id} Delete program by id
ProgramApi get_program_by_id GET /programs/{id} Get program by id
ProgramApi list_programs GET /programs Get all programs.
ProgramApi update_program_by_id PATCH /programs/{id} Update program by id
StationApi get_station GET /station Get own station only
StoryApi create_story POST /stories Create story.
StoryApi delete_story_by_id DELETE /stories/{id} Delete story by id
StoryApi get_story_by_id GET /stories/{id} Get story by id
StoryApi list_stories GET /stories Get all stories.
StoryApi update_story_by_id PATCH /stories/{id} Update story by id
StringApi get_strings_by_name GET /strings/{name} Get Strings (formatted)
TagApi create_tag POST /tags Create tag.
TagApi delete_tag_by_id DELETE /tags/{id} Delete tag by id
TagApi get_tag_by_id GET /tags/{id} Get tags by id
TagApi list_tags GET /tags Get a list of all the tags currently in your station.
TagApi update_tag_by_id PATCH /tags/{id} Update tag by id
UserApi delete_user_by_id DELETE /users/{id} Remove user from station by Id
UserApi get_user_by_id GET /users/{id} Get user by id
UserApi invite_user_by_mail POST /users/invite Invite user by mail
UserApi list_users GET /users Get all users.
VisualSlideApi get_visual_slide GET /visual Get Visual Slide Image as Base64

DOCUMENTATION FOR MODELS

DOCUMENTATION FOR AUTHORIZATION

API Key

  • Type: API key
  • API key parameter name: api-key
  • Location: HTTP header

About

Pluxbox RadioManager Perl 2/3 client for API v2

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

0 stars

Watchers

6 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages