cybersource-rest-client
Version:
Node.js SDK for the CyberSource REST API
154 lines (129 loc) • 7.14 kB
JavaScript
/**
* 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
*
* Swagger Codegen version: 2.4.38
*
* Do not edit the class manually.
*
*/
(function(root, factory) {
if (typeof define === 'function' && define.amd) {
// AMD. Register as an anonymous module.
define(['ApiClient', 'model/Ptsv2paymentsClientReferenceInformationPartner'], factory);
} else if (typeof module === 'object' && module.exports) {
// CommonJS-like environments that support module.exports, like Node.
module.exports = factory(require('../ApiClient'), require('./Ptsv2paymentsClientReferenceInformationPartner'));
} else {
// Browser globals (root is window)
if (!root.CyberSource) {
root.CyberSource = {};
}
root.CyberSource.Ptsv2paymentsClientReferenceInformation = factory(root.CyberSource.ApiClient, root.CyberSource.Ptsv2paymentsClientReferenceInformationPartner);
}
}(this, function(ApiClient, Ptsv2paymentsClientReferenceInformationPartner) {
'use strict';
/**
* The Ptsv2paymentsClientReferenceInformation model module.
* @module model/Ptsv2paymentsClientReferenceInformation
* @version 0.0.1
*/
/**
* Constructs a new <code>Ptsv2paymentsClientReferenceInformation</code>.
* @alias module:model/Ptsv2paymentsClientReferenceInformation
* @class
*/
var exports = function() {
var _this = this;
};
/**
* Constructs a <code>Ptsv2paymentsClientReferenceInformation</code> from a plain JavaScript object, optionally creating a new instance.
* Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
* @param {Object} data The plain JavaScript object bearing properties of interest.
* @param {module:model/Ptsv2paymentsClientReferenceInformation} obj Optional instance to populate.
* @return {module:model/Ptsv2paymentsClientReferenceInformation} The populated <code>Ptsv2paymentsClientReferenceInformation</code> instance.
*/
exports.constructFromObject = function(data, obj) {
if (data) {
obj = obj || new exports();
if (data.hasOwnProperty('code')) {
obj['code'] = ApiClient.convertToType(data['code'], 'String');
}
if (data.hasOwnProperty('reconciliationId')) {
obj['reconciliationId'] = ApiClient.convertToType(data['reconciliationId'], 'String');
}
if (data.hasOwnProperty('pausedRequestId')) {
obj['pausedRequestId'] = ApiClient.convertToType(data['pausedRequestId'], 'String');
}
if (data.hasOwnProperty('transactionId')) {
obj['transactionId'] = ApiClient.convertToType(data['transactionId'], 'String');
}
if (data.hasOwnProperty('comments')) {
obj['comments'] = ApiClient.convertToType(data['comments'], 'String');
}
if (data.hasOwnProperty('partner')) {
obj['partner'] = Ptsv2paymentsClientReferenceInformationPartner.constructFromObject(data['partner']);
}
if (data.hasOwnProperty('applicationName')) {
obj['applicationName'] = ApiClient.convertToType(data['applicationName'], 'String');
}
if (data.hasOwnProperty('applicationVersion')) {
obj['applicationVersion'] = ApiClient.convertToType(data['applicationVersion'], 'String');
}
if (data.hasOwnProperty('applicationUser')) {
obj['applicationUser'] = ApiClient.convertToType(data['applicationUser'], 'String');
}
}
return obj;
}
/**
* Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. #### Used by **Authorization** Required field. #### PIN Debit Requests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being reversed. Required field for all PIN Debit requests (purchase, credit, and reversal). #### FDC Nashville Global Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.
* @member {String} code
*/
exports.prototype['code'] = undefined;
/**
* Reference number for the transaction. Depending on how your Cybersource account is configured, this value could either be provided in the API request or generated by CyberSource. The actual value used in the request to the processor is provided back to you by Cybersource in the response.
* @member {String} reconciliationId
*/
exports.prototype['reconciliationId'] = undefined;
/**
* Used to resume a transaction that was paused for an order modification rule to allow for payer authentication to complete. To resume and continue with the authorization/decision service flow, call the services and include the request id from the prior decision call.
* @member {String} pausedRequestId
*/
exports.prototype['pausedRequestId'] = undefined;
/**
* Identifier that you assign to the transaction. Normally generated by a client server to identify a unique API request. **Note** Use this field only if you want to support merchant-initiated reversal and void operations. #### Used by **Authorization, Authorization Reversal, Capture, Credit, and Void** Optional field. #### PIN Debit For a PIN debit reversal, your request must include a request ID or a merchant transaction identifier. Optional field for PIN debit purchase or credit requests.
* @member {String} transactionId
*/
exports.prototype['transactionId'] = undefined;
/**
* Brief description of the order or any comment you wish to add to the order.
* @member {String} comments
*/
exports.prototype['comments'] = undefined;
/**
* @member {module:model/Ptsv2paymentsClientReferenceInformationPartner} partner
*/
exports.prototype['partner'] = undefined;
/**
* The name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource.
* @member {String} applicationName
*/
exports.prototype['applicationName'] = undefined;
/**
* Version of the CyberSource application or integration used for a transaction.
* @member {String} applicationVersion
*/
exports.prototype['applicationVersion'] = undefined;
/**
* The entity that is responsible for running the transaction and submitting the processing request to CyberSource. This could be a person, a system, or a connection method.
* @member {String} applicationUser
*/
exports.prototype['applicationUser'] = undefined;
return exports;
}));