@hipay/hipay-enterprise-sdk-nodejs/Gateway/Request/MaintenanceRequest.js

The HiPay Enterprise SDK for NodeJS is a library for developers who want to integrate HiPay Enterprise payment methods to any NodeJS platform.

'use strict';

const CommonRequest = require('./CommonRequest');
const InvalidArgumentException = require('../../Error/InvalidArgumentException');

class MaintenanceRequest extends CommonRequest {
    /**
     *  Creates a Maintenance Request Object ready to use with the SDK
     *
     * @param {Object} values
     *
     * Inherited from CommonRequest
     * @param {Object} [values.customData] Request's custom data
     * @param {Object} [values.source] Request's source data
     * @param {'AUTO'|'SAPI'|'CONS'|'PAGE'|'TPE'|'RTRY'|'MANU'|'PREF'|'REVI'|'CMS'|'SSDK'|'CSDK'} [values.source.source] Technical source of this call
     * @param {String} [values.source.integration_version] Integration version (version of the CMS module for example)
     * @param {String} [values.source.brand] Source Brand (CMS name or Site name)
     * @param {String} [values.source.brand_version] Version of the brand (version of your site)
     * @param {Object} [values.basket] Request's basket data. You must send only items that must be captured or refunded.
     *
     * @param {String} values.operation Maintenance Operation. See Transaction.Operation Enum
     * @param {String} [values.currency] Maintenance Operation currency. This three-character currency code complies with ISO 4217.
     * @param {String} [values.amount] Maintenance Operation amount. Amount is required for partial maintenances. Do not specify amount for full captures or refunds.
     * @param {String} [values.operation_id] Maintenance Operation ID. This will be returned in the notifications related to this operation.
     * @param {String} [values.sub_transaction_reference] Sub Transaction Reference targeted by the operation, if relevant.
     */
    constructor(values) {
        super(values);

        if (Object.hasOwn(values, 'operation')) {
            this.operation = values.operation;
        } else {
            throw new InvalidArgumentException('Maintenance Request must have an Operation');
        }

        if (Object.hasOwn(values, 'currency')) {
            this.currency = values.currency;
        }

        if (Object.hasOwn(values, 'amount')) {
            this.amount = values.amount;
        }

        if (Object.hasOwn(values, 'operation_id')) {
            this.operation_id = values.operation_id;
        }

        if (Object.hasOwn(values, 'sub_transaction_reference')) {
            this.sub_transaction_reference = values.sub_transaction_reference;
        }
    }

    initValues() {
        super.initValues();

        this.operation = null;
        this.currency = null;
        this.amount = null;
        this.operation_id = null;
        this.sub_transaction_reference = null;
    }
}

module.exports = MaintenanceRequest;