Skip to content

Latest commit

 

History

History
337 lines (234 loc) · 13.5 KB

ReportingApi.md

File metadata and controls

337 lines (234 loc) · 13.5 KB

TheLogicStudio\ExactPay\ReportingApi

All URIs are relative to https://api.exactpaysandbox.com, except if the operation defines another base path.

Method HTTP request Description
deleteReport() DELETE /report/{reportId} Delete Report
getReport() GET /report/{reportId} Download Report
getReportDetails() GET /report/{reportId}/details Get Report Details
getReports() GET /report List Reports
postReport() POST /report/{domain} Create Report

deleteReport()

deleteReport($report_id)

Delete Report

Deletes an specific Report for the given Report identifier.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


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


$apiInstance = new TheLogicStudio\ExactPay\Api\ReportingApi(
    // 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
);
$report_id = 61a91d429bf82a2d8e95738f; // string | The ID of the report query

try {
    $apiInstance->deleteReport($report_id);
} catch (Exception $e) {
    echo 'Exception when calling ReportingApi->deleteReport: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
report_id string The ID of the report query

Return type

void (empty response body)

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getReport()

getReport($report_id, $select, $format): \TheLogicStudio\ExactPay\Model\ReportDetailsResponse[]

Download Report

Download report query results in JSON or CSV format.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


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


$apiInstance = new TheLogicStudio\ExactPay\Api\ReportingApi(
    // 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
);
$report_id = 61a91d429bf82a2d8e95738f; // string | The ID of the report query
$select = transactionId,transactionType,transactionStatus; // string | The fields that will be returned in the Report.
$format = csv; // string | The format of the file that will be downloaded.

try {
    $result = $apiInstance->getReport($report_id, $select, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportingApi->getReport: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
report_id string The ID of the report query
select string The fields that will be returned in the Report. [optional]
format string The format of the file that will be downloaded. [optional] [default to 'json']

Return type

\TheLogicStudio\ExactPay\Model\ReportDetailsResponse[]

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getReportDetails()

getReportDetails($report_id, $skip, $limit, $sort): \TheLogicStudio\ExactPay\Model\ReportDetailsResponse[]

Get Report Details

Retrieves the details of a report query that a user has previously created.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


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


$apiInstance = new TheLogicStudio\ExactPay\Api\ReportingApi(
    // 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
);
$report_id = 61a91d429bf82a2d8e95738f; // string | The ID of the report query
$skip = 10; // int | The number of records to be skipped per call. By default, starts with `0` and you should provide the current value plus the `$limit` value in subsequent calls to retrieve following sets of values (pages). So it will skip the number of records on the previous page and bring the next set of records.
$limit = 20; // int | The maximum number of items to retrieve within the current page of results. Defaults to 100 if not set.
$sort = -name; // string | Sets the sort order If an object is passed, values allowed are asc, desc, ascending, descending, 1, and -1. If a string is passed, it must be a space delimited list of path names. The sort order of each path is ascending unless the path name is prefixed with - which will be treated as descending.

try {
    $result = $apiInstance->getReportDetails($report_id, $skip, $limit, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportingApi->getReportDetails: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
report_id string The ID of the report query
skip int The number of records to be skipped per call. By default, starts with `0` and you should provide the current value plus the `$limit` value in subsequent calls to retrieve following sets of values (pages). So it will skip the number of records on the previous page and bring the next set of records. [optional] [default to 0]
limit int The maximum number of items to retrieve within the current page of results. Defaults to 100 if not set. [optional] [default to 100]
sort string Sets the sort order If an object is passed, values allowed are asc, desc, ascending, descending, 1, and -1. If a string is passed, it must be a space delimited list of path names. The sort order of each path is ascending unless the path name is prefixed with - which will be treated as descending. [optional]

Return type

\TheLogicStudio\ExactPay\Model\ReportDetailsResponse[]

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getReports()

getReports($skip, $limit, $sort): \TheLogicStudio\ExactPay\Model\ReportQueryResponse[]

List Reports

Retrieves a list of Report queries that a user has previously created.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


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


$apiInstance = new TheLogicStudio\ExactPay\Api\ReportingApi(
    // 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
);
$skip = 10; // int | The number of records to be skipped per call. By default, starts with `0` and you should provide the current value plus the `$limit` value in subsequent calls to retrieve following sets of values (pages). So it will skip the number of records on the previous page and bring the next set of records.
$limit = 20; // int | The maximum number of items to retrieve within the current page of results. Defaults to 100 if not set.
$sort = createdAt:asc; // string | Sets the sort order if the field names are passed. Sorting can be done by multiple fields in the specified order, `asc` (ascending) or `desc` (descending). To sort by a `fieldName`, use the `fieldName:` followed by the sort order. To sort by fields in the nested object, use `objectName.fieldName` followed by the sort order. Sorting can be done by multiple fields by providing the `fieldNames` with sort direction as comma-separated values.

try {
    $result = $apiInstance->getReports($skip, $limit, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportingApi->getReports: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
skip int The number of records to be skipped per call. By default, starts with `0` and you should provide the current value plus the `$limit` value in subsequent calls to retrieve following sets of values (pages). So it will skip the number of records on the previous page and bring the next set of records. [optional] [default to 0]
limit int The maximum number of items to retrieve within the current page of results. Defaults to 100 if not set. [optional] [default to 100]
sort string Sets the sort order if the field names are passed. Sorting can be done by multiple fields in the specified order, `asc` (ascending) or `desc` (descending). To sort by a `fieldName`, use the `fieldName:` followed by the sort order. To sort by fields in the nested object, use `objectName.fieldName` followed by the sort order. Sorting can be done by multiple fields by providing the `fieldNames` with sort direction as comma-separated values. [optional]

Return type

\TheLogicStudio\ExactPay\Model\ReportQueryResponse[]

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postReport()

postReport($domain, $report_query_request): \TheLogicStudio\ExactPay\Model\ReportQueryResponse

Create Report

Creates a new Report by domain and time period.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


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


$apiInstance = new TheLogicStudio\ExactPay\Api\ReportingApi(
    // 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
);
$domain = account; // string | The domain of the Report to be generated.
$report_query_request = new \TheLogicStudio\ExactPay\Model\ReportQueryRequest(); // \TheLogicStudio\ExactPay\Model\ReportQueryRequest

try {
    $result = $apiInstance->postReport($domain, $report_query_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportingApi->postReport: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
domain string The domain of the Report to be generated.
report_query_request \TheLogicStudio\ExactPay\Model\ReportQueryRequest

Return type

\TheLogicStudio\ExactPay\Model\ReportQueryResponse

Authorization

apiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]