Overview
  • Namespace
  • Class
  • Tree

Namespaces

  • OpenDNS
    • MES
      • Recurring
      • Reporting
      • Trident

Classes

  • Report

Class Report

Base abstract for all MeS APIs

OpenDNS\MES\Request
Extended by OpenDNS\MES\Reporting\Report
Namespace: OpenDNS\MES\Reporting
Located at Reporting/Report.php

Methods summary

public OpenDNS\MES\Reporting\Report
# setAuthenticationInfo( string $userId, string $password )

Sets authentication info for the request

Sets authentication info for the request

This is required before calling execute()

Parameters

$userId
$profileId Your MeS User ID
$password
$profileKey Your MeS Password

Returns

OpenDNS\MES\Reporting\Report
The current class instance for chaining
public OpenDNS\MES\Reporting\Report
# setReportId( integer $reportId )

Sets the report ID you'd like returned

Sets the report ID you'd like returned

Expected values are the REPORT_ consts from this class

Parameters

$reportId
A report id

Returns

OpenDNS\MES\Reporting\Report
The current class instance for chaining
public OpenDNS\MES\Reporting\Report
# setBeginDate( DateTime $startDate )

Sets the start date of the report

Sets the start date of the report

Parameters

$startDate
$reportId A datetime instance representing the start date of the report

Returns

OpenDNS\MES\Reporting\Report
The current class instance for chaining
public OpenDNS\MES\Reporting\Report
# setEndDate( DateTime $endDate )

Sets the end date of the report

Sets the end date of the report

Parameters

$endDate
$reportId A datetime instance representing the end date of the report

Returns

OpenDNS\MES\Reporting\Report
The current class instance for chaining
public OpenDNS\MES\Reporting\Report
# setNodeId( string $nodeId )

Sets the node ID (AKA merchant account number)

Sets the node ID (AKA merchant account number)

Parameters

$nodeId

Returns

OpenDNS\MES\Reporting\Report
The current class instance for chaining
public OpenDNS\MES\Reporting\Report
# setReportType( integer $reportType )

Sets the report type to return.

Sets the report type to return.

Valid values are the TYPE_ constants from this class

Parameters

$reportType

Returns

OpenDNS\MES\Reporting\Report
The current class instance for chaining
public OpenDNS\MES\Reporting\Report
# setIncludeTridentTransactionId( boolean $includeId )

Sets whether the report should include the trident transaction ID or not

Sets whether the report should include the trident transaction ID or not

Parameters

$includeId

Returns

OpenDNS\MES\Reporting\Report
The current class instance for chaining
public OpenDNS\MES\Reporting\Report
# setIncludePurchaseId( boolean $includeId )

Sets whether the report should include the purchase ID or not

Sets whether the report should include the purchase ID or not

Parameters

$includeId

Returns

OpenDNS\MES\Reporting\Report
The current class instance for chaining
public OpenDNS\MES\Reporting\Report
# setCustomQueryId( integer $queryId )

Sets a customer query ID to be run.

Sets a customer query ID to be run.

This is only for use when fetching reports of type REPORT_CUSTOM. Some defaults are specified in the QUERY_ constants above.

Parameters

$queryId

Returns

OpenDNS\MES\Reporting\Report
The current class instance for chaining

Methods inherited from OpenDNS\MES\Request

__construct(), execute(), factory(), getApiUrl(), getClient(), processResponse(), removeField(), setDefaults(), setField()

Magic methods summary

Constants summary

integer REPORT_ACHP_RETURN_SUMMARY
# 18
integer REPORT_ACHP_SETTLEMENT_SUMMARY
# 17
integer REPORT_AUTHORIZATION_LOG
# 15
integer REPORT_BATCH_SUMMARY
# 1
integer REPORT_CHARGEBACK_ADJUSTMENTS
# 5
integer REPORT_CUSTOM
# 9
integer REPORT_DAILY_INTERCHANGE_SUMMARY
# 8
integer REPORT_DEPOSIT_SUMMARY
# 3
integer REPORT_FX_BATCH_SUMMARY
# 10
integer REPORT_FX_INTERCHANGE_SUMMARY
# 13
integer REPORT_INTERNATIONAL_CHARGEBACKS
# 11
integer REPORT_INTERNATIONAL_RETRIEVAL_REQUESTS
# 12
integer REPORT_INTERNATIONAL_SETTLEMENT_SUMMARY
# 14
integer REPORT_PAYMENT_GATEWAY_REJECTED_TRANSACTIONS
# 23
integer REPORT_PAYMENT_GATEWAY_SETTLED_TRANSACTIONS
# 22
integer REPORT_PAYMENT_GATEWAY_UNSETTLED_TRANSACTIONS
# 21
integer REPORT_RETRIEVAL_REQUESTS
# 7
integer REPORT_SETTLEMENT_SUMMARY
# 2
integer TYPE_SUMMARY
# 0
integer TYPE_DETAIL
# 1
integer QUERY_VISA_ARDEF_TABLES
# 283
integer QUERY_MC_ARDEF_TABLES
# 284

Constants inherited from OpenDNS\MES\Request

ENV_CERT, ENV_PROD, ENV_TEST

Properties summary

protected string $httpMethod

HTTP Method to use for the request

HTTP Method to use for the request
# 'GET'
protected string[] $defaultFieldValues

key/value pairs to be set by default on new requests

key/value pairs to be set by default on new requests
# array( 'reportType' => 0, 'encoding' => 'csv', 'includeTridentTranId' => 'true', )
protected string $apiBasePath

The path to an API's endpoints on the server

The path to an API's endpoints on the server
# '/jsp/reports/report_api.jsp'

Properties inherited from OpenDNS\MES\Request

$apiBaseDomain, $apiEndpointPath, $apiEnvironment

API documentation generated by ApiGen