NAME

WWW::SwaggerClient::Role – a Moose role for the <PBXDom API>

VERSION

Automatically generated by the Swagger Codegen project:

API version: 2.1.0
Package version: 1.0.0
Build date: 2016-06-25T14:20:13.328Z
Build package: class io.swagger.codegen.languages.PerlClientCodegen

A note on Moose

This role is the only component of the library that uses Moose. See
WWW::SwaggerClient::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 'WWW::SwaggerClient::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 the WWW::SwaggerClient::Configuration namespace
as follows, but you don’t need to know about this.

$WWW::SwaggerClient::Configuration::username
String. The username for basic auth.
$WWW::SwaggerClient::Configuration::password
String. The password for basic auth.

$WWW::SwaggerClient::Configuration::api_key

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

      $WWW::SwaggerClient::Configuration::api_key = {
              secretKey => 'aaaabbbbccccdddd',
              anotherKey => '1111222233334444',
              };

$WWW::SwaggerClient::Configuration::api_key_prefix

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

      $WWW::SwaggerClient::Configuration::api_key_prefix = {
              secretKey => 'string',
              anotherKey => 'same or some other string',
              };

$WWW::SwaggerClient::Configuration::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 (and optionally sets, but only if the API client has not been
created yet) 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 WWW::SwaggerClient::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 WWW::SwaggerClient::DefaultApi;

To load the models:

use WWW::SwaggerClient::Object::InlineResponse200;

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 WWW::SwaggerClient::DefaultApi;

# load the models
use WWW::SwaggerClient::Object::InlineResponse200;

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

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $rpt_type = 1.2; # double | Report type. (0 report, 1 widget, 2 chart).
my $rpt_id = 1.2; # double | Report id.
my $start = 3.4; # Number | Start offset.
my $limit = 3.4; # Number | Number of results to return. Max 10K.
my $sort_by = 'sort_by_example'; # string | Sort column.
my $sort_type = 'sort_type_example'; # string | Sort mode asc/desc.
my $from_date = 'from_date_example'; # string | Start date time.
my $to_date = 'to_date_example'; # string | End date time.
my $duration = 3.4; # Number | Duration range.
my $phone = 'phone_example'; # string | List of caller phone.
my $phone1 = 'phone1_example'; # string | List of dialled phones.
my $co = 'co_example'; # string | List of trunk/co.
my $ext = 'ext_example'; # string | list of extensions.
my $pbx_id = 3.4; # Number | list of PBX Ids.
my $call_source = 3.4; # Number | list of callsource.
my $call_type = 3.4; # Number | list of call type signatures.(5 Unanswered Calls, 7 Transfered Calls, 8 Forwarded Calls)
my $direction = 3.4; # Number | list of direction.(0 incoming, 1 outgoing, 2 internal)
my $caller_name = 'caller_name_example'; # string | list of caller name.
my $did = 'did_example'; # string | list of did.
my $dnis = 'dnis_example'; # string | list of dnis.
my $acc = 'acc_example'; # string | list of account code.
my $ring = 3.4; # Number | Ring range.Seconds unit.
my $cost = 3.4; # Number | Cost range.
my $group = 3.4; # Number | Department/Group id.

eval {
    my $result = $api_instance->calls_get(rpt_type => $rpt_type, rpt_id => $rpt_id, start => $start, limit => $limit, sort_by => $sort_by, sort_type => $sort_type, from_date => $from_date, to_date => $to_date, duration => $duration, phone => $phone, phone1 => $phone1, co => $co, ext => $ext, pbx_id => $pbx_id, call_source => $call_source, call_type => $call_type, direction => $direction, caller_name => $caller_name, did => $did, dnis => $dnis, acc => $acc, ring => $ring, cost => $cost, group => $group);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling DefaultApi->calls_get: [email protected]\n";
}

DOCUMENTATION FOR API ENDPOINTS

All URIs are relative to https://api.pbxdom.com

Class	Method	HTTP request
DefaultApi	calls_get	GET /Calls
DefaultApi	features_charts_get	GET /Features/charts
DefaultApi	features_reports_get	GET /Features/reports
DefaultApi	features_widget_get	GET /Features/widget

Download Perl Sample Code

PBXDom

API Perl Sample Code