NAME

WWW::SwaggerClient::Role - a Moose role for the Brainrex API Explorer

Welcome to the Brainrex API explorer, we make analytics tools for crypto and blockchain. Our currently propiertary models offer sentiment analysis, market making, blockchain monitoring and face-id verification. This AI models can be consumed from this API. We also offer integrations to open data and propietary data providers, as well as free test data we collect. There is a collection of data transformation tools. Join our Telegram group to get the latest news and ask questions https://t.me/brainrex, #brainrex. More about Brainrex at https://brainrex.com. Full Documentation can be found at https://brainrexapi.github.io/docs

VERSION

Automatically generated by the Swagger Codegen project:

API version: 0.1.1
Package version: 1.0.0
Build package: 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 a LWWW::SwaggerClient::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 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::BlockchainApi;
use WWW::SwaggerClient::CryptoApi;
use WWW::SwaggerClient::SentimentAnalysisApi;

To load the models:

use WWW::SwaggerClient::Object::InlineResponse200;
use WWW::SwaggerClient::Object::InlineResponse2001;
use WWW::SwaggerClient::Object::InlineResponse2002;
use WWW::SwaggerClient::Object::InlineResponse201;
use WWW::SwaggerClient::Object::InlineResponse2011;
use WWW::SwaggerClient::Object::Request;
use WWW::SwaggerClient::Object::Request1;
use WWW::SwaggerClient::Object::Request2;
use WWW::SwaggerClient::Object::Request3;
use WWW::SwaggerClient::Object::Text;
use WWW::SwaggerClient::Object::Text1;

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::BlockchainApi;
use WWW::SwaggerClient::CryptoApi;
use WWW::SwaggerClient::SentimentAnalysisApi;

# load the models
use WWW::SwaggerClient::Object::InlineResponse200;
use WWW::SwaggerClient::Object::InlineResponse2001;
use WWW::SwaggerClient::Object::InlineResponse2002;
use WWW::SwaggerClient::Object::InlineResponse201;
use WWW::SwaggerClient::Object::InlineResponse2011;
use WWW::SwaggerClient::Object::Request;
use WWW::SwaggerClient::Object::Request1;
use WWW::SwaggerClient::Object::Request2;
use WWW::SwaggerClient::Object::Request3;
use WWW::SwaggerClient::Object::Text;
use WWW::SwaggerClient::Object::Text1;

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

my $api_instance = WWW::SwaggerClient::->new(
);

my $request = WWW::SwaggerClient::Object::Request->new(); # Request | Name of the blockchain and date range.

eval {
    my $result = $api_instance->blockchain_average_tx(request => $request);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BlockchainApi->blockchain_average_tx: $@\n";
}

DOCUMENTATION FOR API ENDPOINTS

All URIs are relative to https://brainrexapi.appspot.com:5000/api

Class	Method	HTTP request	Description
BlockchainApi	blockchain_average_tx	POST /average_tx_fee	Calculate average transccion fee of a given blockchain
BlockchainApi	blockchain_list	GET /list_blockchain	The blockchains data structure supported by the Brainrex API
CryptoApi	exchanges_download_candles	POST /download_candles	Downloads candle format market data
CryptoApi	exchanges_list	GET /markets	The markets data structure supported by the Brainrex Market API
CryptoApi	exchanges_marketmaker	POST /market_making	Market Making as a Service API.
CryptoApi	exchanges_read	GET /exchanges	The exchanges data structure supported by the Brainrex API
CryptoApi	exchanges_ticker_data_download	POST /download_ticker	Download raw ticker data from major crypto markets
SentimentAnalysisApi	sentiment_get_price_sentiment	POST /get_buy_sentiment	Sentiment analysis score using a model trained for buy signals.
SentimentAnalysisApi	sentiment_get_sentiment	POST /get_sentiment	Sentiment analysis for any given blob of text

DOCUMENTATION FOR MODELS

DOCUMENTATION FOR AUTHORIZATION

All endpoints do not require authorization.

Name		Name	Last commit message	Last commit date
Latest commit History 1 Commits
bin		bin
docs		docs
lib/WWW/SwaggerClient		lib/WWW/SwaggerClient
t		t
README.md		README.md
git_push.sh		git_push.sh

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

bin

bin

docs

docs

lib/WWW/SwaggerClient

lib/WWW/SwaggerClient

t

t

README.md

README.md

git_push.sh

git_push.sh

Repository files navigation

NAME

VERSION

A note on Moose

SYNOPSIS

Structure of the library

Configuring authentication

METHODS

`base_url`

`api_factory`

MISSING METHODS

BUILDING YOUR LIBRARY

AUTOMATIC DOCUMENTATION

DOCUMENTATION FROM THE OpenAPI Spec

LOAD THE MODULES

GETTING STARTED

DOCUMENTATION FOR API ENDPOINTS

DOCUMENTATION FOR MODELS

DOCUMENTATION FOR AUTHORIZATION

About

Releases

Packages

Languages

codabl/brainrex-perl

Folders and files

Latest commit

History

Repository files navigation

NAME

VERSION

A note on Moose

SYNOPSIS

Structure of the library

Configuring authentication

METHODS

base_url

api_factory

MISSING METHODS

BUILDING YOUR LIBRARY

AUTOMATIC DOCUMENTATION

DOCUMENTATION FROM THE OpenAPI Spec

LOAD THE MODULES

GETTING STARTED

DOCUMENTATION FOR API ENDPOINTS

DOCUMENTATION FOR MODELS

DOCUMENTATION FOR AUTHORIZATION

About

Resources

Stars

Watchers

Forks

Languages

`base_url`

`api_factory`