ReportSubscriptionsApi.md

CyberSource.ReportSubscriptionsApi

All URIs are relative to https://apitest.cybersource.com

Method	HTTP request	Description
createSubscription	PUT /reporting/v3/report-subscriptions/{reportName}	Create Report Subscription for a report name by organization
deleteSubscription	DELETE /reporting/v3/report-subscriptions/{reportName}	Delete subscription of a report name by organization
getAllSubscriptions	GET /reporting/v3/report-subscriptions	Retrieve all subscriptions by organization
getSubscription	GET /reporting/v3/report-subscriptions/{reportName}	Retrieve subscription for a report name by organization

createSubscription

createSubscription(reportName, requestBody)

Create Report Subscription for a report name by organization

Example

var CyberSource = require('CyberSource');

var apiInstance = new CyberSource.ReportSubscriptionsApi();

var reportName = "reportName_example"; // String | Name of the Report to Create

var requestBody = new CyberSource.RequestBody(); // RequestBody | Report subscription request payload


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.createSubscription(reportName, requestBody, callback);

Parameters

Name	Type	Description	Notes
reportName	String	Name of the Report to Create
requestBody	RequestBody	Report subscription request payload

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/hal+json

deleteSubscription

deleteSubscription(reportName)

Delete subscription of a report name by organization

Example

var CyberSource = require('CyberSource');

var apiInstance = new CyberSource.ReportSubscriptionsApi();

var reportName = "reportName_example"; // String | Name of the Report to Delete


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.deleteSubscription(reportName, callback);

Parameters

Name	Type	Description	Notes
reportName	String	Name of the Report to Delete

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json;charset=utf-8
• Accept: application/hal+json

getAllSubscriptions

ReportingV3ReportSubscriptionsGet200Response getAllSubscriptions()

Retrieve all subscriptions by organization

Example

var CyberSource = require('CyberSource');

var apiInstance = new CyberSource.ReportSubscriptionsApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getAllSubscriptions(callback);

Parameters

This endpoint does not need any parameter.

Return type

ReportingV3ReportSubscriptionsGet200Response

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json;charset=utf-8
• Accept: application/hal+json

getSubscription

ReportingV3ReportSubscriptionsGet200ResponseSubscriptions getSubscription(reportName)

Retrieve subscription for a report name by organization

Example

var CyberSource = require('CyberSource');

var apiInstance = new CyberSource.ReportSubscriptionsApi();

var reportName = "reportName_example"; // String | Name of the Report to Retrieve


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getSubscription(reportName, callback);

Parameters

Name	Type	Description	Notes
reportName	String	Name of the Report to Retrieve

Return type

ReportingV3ReportSubscriptionsGet200ResponseSubscriptions

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json;charset=utf-8
• Accept: application/hal+json