reporting-sdk

PAI Report Client SDK

License	MIT License
Categories	Reporting Business Logic Libraries
GroupId	com.gopai
ArtifactId	reporting-sdk
Last Version	1.0.3
Release Date	Mar 24, 2020
Type	pom
Description	reporting-sdk PAI Report Client SDK
Project URL	https://github.com/gopai/reporting-sdk
Project Organization	Payment Alliance International
Source Code Management	https://github.com/gopai/reporting-sdk

Download reporting-sdk

Filename	Size
reporting-sdk-1.0.3.pom
reporting-sdk-1.0.3.jar	1 KB
reporting-sdk-1.0.3-sources.jar	6 KB
reporting-sdk-1.0.3-javadoc.jar	43 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/com.gopai/reporting-sdk/ -->
<dependency>
    <groupId>com.gopai</groupId>
    <artifactId>reporting-sdk</artifactId>
    <version>1.0.3</version>
    <type>pom</type>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/com.gopai/reporting-sdk/
implementation 'com.gopai:reporting-sdk:1.0.3'

Gradle Kotlin

// https://jarcasting.com/artifacts/com.gopai/reporting-sdk/
implementation ("com.gopai:reporting-sdk:1.0.3")

Apache Buildr

'com.gopai:reporting-sdk:pom:1.0.3'

Apache Ivy

<dependency org="com.gopai" name="reporting-sdk" rev="1.0.3">
  <artifact name="reporting-sdk" type="pom" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='com.gopai', module='reporting-sdk', version='1.0.3')
)

Scala SBT

libraryDependencies += "com.gopai" % "reporting-sdk" % "1.0.3"

Leiningen

[com.gopai/reporting-sdk "1.0.3"]

Dependencies

compile (2)

Group / Artifact	Type	Version
com.google.code.gson : gson	jar	2.8.5
org.apache.httpcomponents : httpclient	jar	4.5.9

Project Modules

There are no modules declared in this project.

reporting-sdk

The Reporting SDK contains our implementation of a client which gives access to our Report and Data API. This gives users a solid access point for interacting with PAI Reports and the report data available to the user.

The API is designed around a standard HTTP request process and will allow access to any data that a user can access through the screens provided within PAI Reports. Using this SDK, you can develop applications that utilize the large amount of data that PAI Reports possesses to build new data integrations.

Usage

The PAIClient class is used to substantiate a session to PAI Reports and provides mechanisms for running reports and queries.

The ReportRequest class allows for filtering, sorting, and adjusting the number of columns in your requests to make it easier for your applications to digest the response data.

The ReportConfig class allows you to see the columns, types, format, and acceptable values of a given report to allow you to properly construct your filters.

The StreamUtil class is a simple support class to convert the output data into a desired form.

Available commands

The Wiki describes the available commands and the Report API Documentation.

Installation

The reporting-sdk is available on the Maven Central Repository, reporting-sdk. Importing from maven will depend on the build for the project. reporting-sdk can also be downloaded directly from Github as source, compiled, and included as a library.

License

reporting-sdk is published under the MIT license.

Versions

Version
1.0.3 Mar 24, 2020
1.0.2 Oct 28, 2019
1.0.1 Oct 25, 2019
1.0.0 Oct 22, 2019