@paciolan/cybersource-sdk
Version:
CyberSource REST API Typescript SDK
211 lines (210 loc) • 15.8 kB
JavaScript
;
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.PurchaseAndRefundDetailsApi = exports.PurchaseAndRefundDetailsApiFactory = exports.PurchaseAndRefundDetailsApiFp = exports.PurchaseAndRefundDetailsApiAxiosParamCreator = void 0;
/* tslint:disable */
/* eslint-disable */
/**
* CyberSource Merged Spec
* All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html
*
* OpenAPI spec version: 0.0.1
*
*
* NOTE: This class is auto generated by the swagger code generator program.
* https://github.com/swagger-api/swagger-codegen.git
* Do not edit the class manually.
*/
const axios_1 = __importDefault(require("axios"));
const AuthenticationHeader_1 = require("../authentication/core/AuthenticationHeader");
// Some imports not used depending on template conditions
// @ts-ignore
const base_1 = require("../base");
/**
* PurchaseAndRefundDetailsApi - axios parameter creator
* @export
*/
const PurchaseAndRefundDetailsApiAxiosParamCreator = function (configuration) {
return {
/**
* Download the Purchase and Refund Details report. This report report includes all purchases and refund transactions, as well as all activities related to transactions resulting in an adjustment to the net proceeds.
* @summary Get Purchase and Refund Details
* @param {Date} startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z)
* @param {Date} endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z)
* @param {string} [organizationId] Valid Organization Id
* @param {string} [paymentSubtype] Payment Subtypes. - **ALL**: All Payment Subtypes - **VI** : Visa - **MC** : Master Card - **AX** : American Express - **DI** : Discover - **DP** : Pinless Debit
* @param {string} [viewBy] View results by Request Date or Submission Date. - **requestDate** : Request Date - **submissionDate**: Submission Date
* @param {string} [groupName] Valid CyberSource Group Name.User can define groups using CBAPI and Group Management Module in EBC2. Groups are collection of organizationIds
* @param {number} [offset] Offset of the Purchase and Refund Results.
* @param {number} [limit] Results count per page. Range(1-2000)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getPurchaseAndRefundDetails: (startTime, endTime, organizationId, paymentSubtype, viewBy, groupName, offset, limit, options = {}) => __awaiter(this, void 0, void 0, function* () {
// verify required parameter 'startTime' is not null or undefined
if (startTime === null || startTime === undefined) {
throw new base_1.RequiredError('startTime', 'Required parameter startTime was null or undefined when calling getPurchaseAndRefundDetails.');
}
// verify required parameter 'endTime' is not null or undefined
if (endTime === null || endTime === undefined) {
throw new base_1.RequiredError('endTime', 'Required parameter endTime was null or undefined when calling getPurchaseAndRefundDetails.');
}
const localVarPath = `/reporting/v3/purchase-refund-details`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
if (startTime !== undefined) {
localVarQueryParameter['startTime'] = (startTime instanceof Date) ?
startTime.toISOString() :
startTime;
}
if (endTime !== undefined) {
localVarQueryParameter['endTime'] = (endTime instanceof Date) ?
endTime.toISOString() :
endTime;
}
if (organizationId !== undefined) {
localVarQueryParameter['organizationId'] = organizationId;
}
if (paymentSubtype !== undefined) {
localVarQueryParameter['paymentSubtype'] = paymentSubtype;
}
if (viewBy !== undefined) {
localVarQueryParameter['viewBy'] = viewBy;
}
if (groupName !== undefined) {
localVarQueryParameter['groupName'] = groupName;
}
if (offset !== undefined) {
localVarQueryParameter['offset'] = offset;
}
if (limit !== undefined) {
localVarQueryParameter['limit'] = limit;
}
const query = new URLSearchParams(localVarUrlObj.search);
for (const key in localVarQueryParameter) {
query.set(key, localVarQueryParameter[key]);
}
for (const key in options.params) {
query.set(key, options.params[key]);
}
localVarUrlObj.search = (new URLSearchParams(query)).toString();
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
const authHeader = new AuthenticationHeader_1.AuthenticationHeader();
authHeader.setConfiguration(Object.assign(Object.assign({}, configuration), options));
localVarRequestOptions.headers = authHeader.callAuthenticationHeader(localVarRequestOptions.method, localVarPath, localVarRequestOptions.data, localVarRequestOptions.headers);
return {
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
options: localVarRequestOptions,
};
}),
};
};
exports.PurchaseAndRefundDetailsApiAxiosParamCreator = PurchaseAndRefundDetailsApiAxiosParamCreator;
/**
* PurchaseAndRefundDetailsApi - functional programming interface
* @export
*/
const PurchaseAndRefundDetailsApiFp = function (configuration) {
return {
/**
* Download the Purchase and Refund Details report. This report report includes all purchases and refund transactions, as well as all activities related to transactions resulting in an adjustment to the net proceeds.
* @summary Get Purchase and Refund Details
* @param {Date} startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z)
* @param {Date} endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z)
* @param {string} [organizationId] Valid Organization Id
* @param {string} [paymentSubtype] Payment Subtypes. - **ALL**: All Payment Subtypes - **VI** : Visa - **MC** : Master Card - **AX** : American Express - **DI** : Discover - **DP** : Pinless Debit
* @param {string} [viewBy] View results by Request Date or Submission Date. - **requestDate** : Request Date - **submissionDate**: Submission Date
* @param {string} [groupName] Valid CyberSource Group Name.User can define groups using CBAPI and Group Management Module in EBC2. Groups are collection of organizationIds
* @param {number} [offset] Offset of the Purchase and Refund Results.
* @param {number} [limit] Results count per page. Range(1-2000)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getPurchaseAndRefundDetails(startTime, endTime, organizationId, paymentSubtype, viewBy, groupName, offset, limit, options) {
return __awaiter(this, void 0, void 0, function* () {
const localVarAxiosArgs = yield (0, exports.PurchaseAndRefundDetailsApiAxiosParamCreator)(configuration).getPurchaseAndRefundDetails(startTime, endTime, organizationId, paymentSubtype, viewBy, groupName, offset, limit, options);
return (axios = axios_1.default, basePath = base_1.BASE_PATH) => {
const axiosRequestArgs = Object.assign(Object.assign({}, localVarAxiosArgs.options), { url: basePath + localVarAxiosArgs.url });
return axios.request(axiosRequestArgs);
};
});
},
};
};
exports.PurchaseAndRefundDetailsApiFp = PurchaseAndRefundDetailsApiFp;
/**
* PurchaseAndRefundDetailsApi - factory interface
* @export
*/
const PurchaseAndRefundDetailsApiFactory = function (configuration, basePath, axios) {
return {
/**
* Download the Purchase and Refund Details report. This report report includes all purchases and refund transactions, as well as all activities related to transactions resulting in an adjustment to the net proceeds.
* @summary Get Purchase and Refund Details
* @param {Date} startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z)
* @param {Date} endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z)
* @param {string} [organizationId] Valid Organization Id
* @param {string} [paymentSubtype] Payment Subtypes. - **ALL**: All Payment Subtypes - **VI** : Visa - **MC** : Master Card - **AX** : American Express - **DI** : Discover - **DP** : Pinless Debit
* @param {string} [viewBy] View results by Request Date or Submission Date. - **requestDate** : Request Date - **submissionDate**: Submission Date
* @param {string} [groupName] Valid CyberSource Group Name.User can define groups using CBAPI and Group Management Module in EBC2. Groups are collection of organizationIds
* @param {number} [offset] Offset of the Purchase and Refund Results.
* @param {number} [limit] Results count per page. Range(1-2000)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getPurchaseAndRefundDetails(startTime, endTime, organizationId, paymentSubtype, viewBy, groupName, offset, limit, options) {
return __awaiter(this, void 0, void 0, function* () {
return (0, exports.PurchaseAndRefundDetailsApiFp)(configuration).getPurchaseAndRefundDetails(startTime, endTime, organizationId, paymentSubtype, viewBy, groupName, offset, limit, options).then((request) => request(axios, basePath));
});
},
};
};
exports.PurchaseAndRefundDetailsApiFactory = PurchaseAndRefundDetailsApiFactory;
/**
* PurchaseAndRefundDetailsApi - object-oriented interface
* @export
* @class PurchaseAndRefundDetailsApi
* @extends {BaseAPI}
*/
class PurchaseAndRefundDetailsApi extends base_1.BaseAPI {
/**
* Download the Purchase and Refund Details report. This report report includes all purchases and refund transactions, as well as all activities related to transactions resulting in an adjustment to the net proceeds.
* @summary Get Purchase and Refund Details
* @param {Date} startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z)
* @param {Date} endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z)
* @param {string} [organizationId] Valid Organization Id
* @param {string} [paymentSubtype] Payment Subtypes. - **ALL**: All Payment Subtypes - **VI** : Visa - **MC** : Master Card - **AX** : American Express - **DI** : Discover - **DP** : Pinless Debit
* @param {string} [viewBy] View results by Request Date or Submission Date. - **requestDate** : Request Date - **submissionDate**: Submission Date
* @param {string} [groupName] Valid CyberSource Group Name.User can define groups using CBAPI and Group Management Module in EBC2. Groups are collection of organizationIds
* @param {number} [offset] Offset of the Purchase and Refund Results.
* @param {number} [limit] Results count per page. Range(1-2000)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof PurchaseAndRefundDetailsApi
*/
getPurchaseAndRefundDetails(startTime, endTime, organizationId, paymentSubtype, viewBy, groupName, offset, limit, options) {
return __awaiter(this, void 0, void 0, function* () {
return (0, exports.PurchaseAndRefundDetailsApiFp)(this.configuration).getPurchaseAndRefundDetails(startTime, endTime, organizationId, paymentSubtype, viewBy, groupName, offset, limit, options).then((request) => request(this.axios, options.runEnvironment != null ? `https://${options.runEnvironment}` : this.basePath));
});
}
}
exports.PurchaseAndRefundDetailsApi = PurchaseAndRefundDetailsApi;