cybersource-rest-client
Version:
Node.js SDK for the CyberSource REST API
214 lines (183 loc) • 10.6 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/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle', 'model/InvoicingV2InvoicesPost201ResponseInvoiceInformationCustomLabels'], factory);
} else if (typeof module === 'object' && module.exports) {
// CommonJS-like environments that support module.exports, like Node.
module.exports = factory(require('../ApiClient'), require('./InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle'), require('./InvoicingV2InvoicesPost201ResponseInvoiceInformationCustomLabels'));
} else {
// Browser globals (root is window)
if (!root.CyberSource) {
root.CyberSource = {};
}
root.CyberSource.InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformation = factory(root.CyberSource.ApiClient, root.CyberSource.InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle, root.CyberSource.InvoicingV2InvoicesPost201ResponseInvoiceInformationCustomLabels);
}
}(this, function(ApiClient, InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle, InvoicingV2InvoicesPost201ResponseInvoiceInformationCustomLabels) {
'use strict';
/**
* The InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformation model module.
* @module model/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformation
* @version 0.0.1
*/
/**
* Constructs a new <code>InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformation</code>.
* @alias module:model/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformation
* @class
*/
var exports = function() {
var _this = this;
};
/**
* Constructs a <code>InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformation</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/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformation} obj Optional instance to populate.
* @return {module:model/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformation} The populated <code>InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformation</code> instance.
*/
exports.constructFromObject = function(data, obj) {
if (data) {
obj = obj || new exports();
if (data.hasOwnProperty('merchantLogo')) {
obj['merchantLogo'] = ApiClient.convertToType(data['merchantLogo'], 'String');
}
if (data.hasOwnProperty('merchantDisplayName')) {
obj['merchantDisplayName'] = ApiClient.convertToType(data['merchantDisplayName'], 'String');
}
if (data.hasOwnProperty('customEmailMessage')) {
obj['customEmailMessage'] = ApiClient.convertToType(data['customEmailMessage'], 'String');
}
if (data.hasOwnProperty('enableReminders')) {
obj['enableReminders'] = ApiClient.convertToType(data['enableReminders'], 'Boolean');
}
if (data.hasOwnProperty('headerStyle')) {
obj['headerStyle'] = InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle.constructFromObject(data['headerStyle']);
}
if (data.hasOwnProperty('deliveryLanguage')) {
obj['deliveryLanguage'] = ApiClient.convertToType(data['deliveryLanguage'], 'String');
}
if (data.hasOwnProperty('defaultCurrencyCode')) {
obj['defaultCurrencyCode'] = ApiClient.convertToType(data['defaultCurrencyCode'], 'String');
}
if (data.hasOwnProperty('payerAuthentication3DSVersion')) {
obj['payerAuthentication3DSVersion'] = ApiClient.convertToType(data['payerAuthentication3DSVersion'], 'Boolean');
}
if (data.hasOwnProperty('showVatNumber')) {
obj['showVatNumber'] = ApiClient.convertToType(data['showVatNumber'], 'Boolean');
}
if (data.hasOwnProperty('vatRegistrationNumber')) {
obj['vatRegistrationNumber'] = ApiClient.convertToType(data['vatRegistrationNumber'], 'String');
}
if (data.hasOwnProperty('shipTo')) {
obj['shipTo'] = ApiClient.convertToType(data['shipTo'], 'Boolean');
}
if (data.hasOwnProperty('phoneNumber')) {
obj['phoneNumber'] = ApiClient.convertToType(data['phoneNumber'], 'Boolean');
}
if (data.hasOwnProperty('email')) {
obj['email'] = ApiClient.convertToType(data['email'], 'Boolean');
}
if (data.hasOwnProperty('enableMerchantEmailNotifications')) {
obj['enableMerchantEmailNotifications'] = ApiClient.convertToType(data['enableMerchantEmailNotifications'], 'Boolean');
}
if (data.hasOwnProperty('customLabels')) {
obj['customLabels'] = ApiClient.convertToType(data['customLabels'], [InvoicingV2InvoicesPost201ResponseInvoiceInformationCustomLabels]);
}
}
return obj;
}
/**
* The image file, which must be encoded in Base64 format. Supported file formats are `png`, `jpg`, and `gif`. The image file size restriction is 1 MB.
* @member {String} merchantLogo
*/
exports.prototype['merchantLogo'] = undefined;
/**
* The merchant's display name shown on the invoice.
* @member {String} merchantDisplayName
*/
exports.prototype['merchantDisplayName'] = undefined;
/**
* The content of the email message that we send to your customers.
* @member {String} customEmailMessage
*/
exports.prototype['customEmailMessage'] = undefined;
/**
* Whether you would like us to send an auto-generated reminder email to your invoice recipients. Currently, this reminder email is sent five days before the invoice is due and one day after it is past due.
* @member {Boolean} enableReminders
*/
exports.prototype['enableReminders'] = undefined;
/**
* @member {module:model/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle} headerStyle
*/
exports.prototype['headerStyle'] = undefined;
/**
* The language of the email that we send to your customers. Possible values are `zh-CN`, `zh-TW`, `en-US`, `fr-FR`, `de-DE`, `ja-JP`, `pt-BR`, `ru-RU` and `es-419`.
* @member {String} deliveryLanguage
*/
exports.prototype['deliveryLanguage'] = undefined;
/**
* Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency.
* @member {String} defaultCurrencyCode
*/
exports.prototype['defaultCurrencyCode'] = undefined;
/**
* The 3D Secure payer authentication status for a merchant's invoice payments.
* @member {Boolean} payerAuthentication3DSVersion
* @default false
*/
exports.prototype['payerAuthentication3DSVersion'] = false;
/**
* Display VAT number on Invoice.
* @member {Boolean} showVatNumber
* @default false
*/
exports.prototype['showVatNumber'] = false;
/**
* Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes.
* @member {String} vatRegistrationNumber
*/
exports.prototype['vatRegistrationNumber'] = undefined;
/**
* Collect the payers shipping address.
* @member {Boolean} shipTo
* @default false
*/
exports.prototype['shipTo'] = false;
/**
* Collect the payers phone number.
* @member {Boolean} phoneNumber
* @default false
*/
exports.prototype['phoneNumber'] = false;
/**
* Collect the payers email address when the email address is not known or confirm it if it is known at the time of invoice creation.
* @member {Boolean} email
* @default false
*/
exports.prototype['email'] = false;
/**
* Whether you would like to receive payment notification for successful transaction
* @member {Boolean} enableMerchantEmailNotifications
* @default false
*/
exports.prototype['enableMerchantEmailNotifications'] = false;
/**
* A list of custom labels that allows you to override (rename) default field names and control the visibility of specific fields on invoices and items. If the list is empty, the labels will not be overwritten.
* @member {Array.<module:model/InvoicingV2InvoicesPost201ResponseInvoiceInformationCustomLabels>} customLabels
*/
exports.prototype['customLabels'] = undefined;
return exports;
}));