xi_sdk_resellers/dist/api/ReturnsApi.js

Ingram Micro - Xvantage Integration (XI) Node.Js Server-side SDK.

"use strict";

Object.defineProperty(exports, "__esModule", {
  value: true
});
exports["default"] = void 0;
var _ApiClient = _interopRequireDefault(require("../ApiClient"));
var _PostCreateorderV7500Response = _interopRequireDefault(require("../model/PostCreateorderV7500Response"));
var _PostRenewalssearch400Response = _interopRequireDefault(require("../model/PostRenewalssearch400Response"));
var _ReturnsCreateRequest = _interopRequireDefault(require("../model/ReturnsCreateRequest"));
var _ReturnsCreateResponse = _interopRequireDefault(require("../model/ReturnsCreateResponse"));
var _ReturnsDetailsResponse = _interopRequireDefault(require("../model/ReturnsDetailsResponse"));
var _ReturnsSearchResponse = _interopRequireDefault(require("../model/ReturnsSearchResponse"));
function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
 * XI Sdk Resellers
 * For Resellers seeking to innovate with Ingram Micro's API solutions, automate your eCommerce experience with our array of API's and webhooks to craft a seamless journey for your customers.
 *
 * The version of the OpenAPI document: 1.0.0
 * 
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 *
 */
/**
* Returns service.
* @module api/ReturnsApi
* @version 1.0.0
*/
var ReturnsApi = exports["default"] = /*#__PURE__*/function () {
  /**
  * Constructs a new ReturnsApi. 
  * @alias module:api/ReturnsApi
  * @class
  * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
  * default to {@link module:ApiClient#instance} if unspecified.
  */
  function ReturnsApi(apiClient) {
    _classCallCheck(this, ReturnsApi);
    this.apiClient = apiClient || _ApiClient["default"].instance;
  }

  /**
   * Callback function to receive the result of the getResellersV6Returnsdetails operation.
   * @callback module:api/ReturnsApi~getResellersV6ReturnsdetailsCallback
   * @param {String} error Error message, if any.
   * @param {module:model/ReturnsDetailsResponse} data The data returned by the service call.
   * @param {String} response The complete HTTP response.
   */

  /**
   * Returns Details
   * The Returns Details API will retrieve all the details related to the specific caseRequestNumber.
   * @param {String} iMCustomerNumber Your unique Ingram Micro customer number.
   * @param {String} iMCountryCode Two-character ISO country code.
   * @param {String} iMCorrelationID Unique transaction number to identify each transaction across all the systems.
   * @param {String} caseRequestNumber A unique return request number.
   * @param {Object} opts Optional parameters
   * @param {String} [iMSenderID] Unique value used to identify the sender of the transaction. Example: MyCompany
   * @param {module:api/ReturnsApi~getResellersV6ReturnsdetailsCallback} callback The callback function, accepting three arguments: error, data, response
   * data is of type: {@link module:model/ReturnsDetailsResponse}
   */
  return _createClass(ReturnsApi, [{
    key: "getResellersV6Returnsdetails",
    value: function getResellersV6Returnsdetails(iMCustomerNumber, iMCountryCode, iMCorrelationID, caseRequestNumber, opts, callback) {
      opts = opts || {};
      var postBody = null;
      // verify the required parameter 'iMCustomerNumber' is set
      if (iMCustomerNumber === undefined || iMCustomerNumber === null) {
        throw new Error("Missing the required parameter 'iMCustomerNumber' when calling getResellersV6Returnsdetails");
      }
      // verify the required parameter 'iMCountryCode' is set
      if (iMCountryCode === undefined || iMCountryCode === null) {
        throw new Error("Missing the required parameter 'iMCountryCode' when calling getResellersV6Returnsdetails");
      }
      // verify the required parameter 'iMCorrelationID' is set
      if (iMCorrelationID === undefined || iMCorrelationID === null) {
        throw new Error("Missing the required parameter 'iMCorrelationID' when calling getResellersV6Returnsdetails");
      }
      // verify the required parameter 'caseRequestNumber' is set
      if (caseRequestNumber === undefined || caseRequestNumber === null) {
        throw new Error("Missing the required parameter 'caseRequestNumber' when calling getResellersV6Returnsdetails");
      }
      var pathParams = {
        'caseRequestNumber': caseRequestNumber
      };
      var queryParams = {};
      var headerParams = {
        'IM-CustomerNumber': iMCustomerNumber,
        'IM-CountryCode': iMCountryCode,
        'IM-CorrelationID': iMCorrelationID,
        'IM-SenderID': opts['iMSenderID']
      };
      var formParams = {};
      var authNames = ['application'];
      var contentTypes = [];
      var accepts = ['application/json'];
      var returnType = _ReturnsDetailsResponse["default"];
      return this.apiClient.callApi('/resellers/v6/returns/{caseRequestNumber}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
    }

    /**
     * Callback function to receive the result of the getResellersV6Returnssearch operation.
     * @callback module:api/ReturnsApi~getResellersV6ReturnssearchCallback
     * @param {String} error Error message, if any.
     * @param {module:model/ReturnsSearchResponse} data The data returned by the service call.
     * @param {String} response The complete HTTP response.
     */

    /**
     * Returns Search
     * The Returns Search API, by default, will retrieve all the returns that are associated with the customer’s account. The customer will be able to search returns using the query parameters. The Returns Search response will return the following information:  returnClaimId, caseRequestNumber, createdOn, referenceNumber, and returnReason.
     * @param {String} iMCustomerNumber Your unique Ingram Micro customer number.
     * @param {String} iMCountryCode Two-character ISO country code.
     * @param {String} iMCorrelationID Unique transaction number to identify each transaction across all the systems.
     * @param {Object} opts Optional parameters
     * @param {String} [iMSenderID] Unique value used to identify the sender of the transaction. Example: MyCompany
     * @param {String} [caseRequestNumber] A unique return request number.
     * @param {String} [invoiceNumber] The Invoice number for the order.
     * @param {String} [returnClaimId] A unique return claim Id.
     * @param {String} [referenceNumber] The reference number for the return.
     * @param {String} [ingramPartNumber] Unique IngramMicro part number.
     * @param {String} [vendorPartNumber] The vendor's part number.
     * @param {String} [returnStatusIn] Comma-separated values of pre-defined status. Open, Approved, Partially Approved, Denied, Voided.
     * @param {String} [claimStatusIn] Comma-separated values of pre-defined status. Open, Approved, Partially Approved, Denied, Voided.
     * @param {String} [createdOnBt] The date on which the return request was created. 
     * @param {String} [modifiedOnBt] The date on which the return request was last updated.
     * @param {String} [returnReasonIn] Comma separated Pre-defined value. test, (EW) Express Warehousing, (AR) Account Receivables, (BB) Buy Back, (BE) Stock Balance Exception, (BO) Bill Only, (CE) Credit Dept Use - Credit Exception, (CF) Configuration Fee, (CS ) Customer Service Discretion, (CS1) Customer Service Discretion CS Error, (DE) Defective Exception, (DF) Defective Items, (DI) Direct Credit, (DM) Damaged from Carrier, (DN) Damaged Without Product, (DT) Direct/ Special Order, (DT1) Direct Ship billed, not shipped., (FO) Freight Out, (FX) No-Scan, (IN) Incomplete, (LS) Lost Shipment, (MN) Minimum Order Fee Credit, (OS) Over Shipment, (PR) Pricing Error, (RF) Refusal Credit, (RI) Re-Invoice, (RP) Return For Repair, (RT) Return Not Credited, (RTD) RCN, (SB) Stock Balance, (SD) Sales Discretion, (SH) Incorrect Shipping And Handling, (SS) Short Shipment, (SSK) Short Ship kit, (SW) Sales Writeoff, (TE) Opened Return, (TR) Training Refund, (TX) Tax Credit, (WS) Wrong Sales Sealed, (WW) Wrong Warehouse, (FS) Warehouse Failed Serial# Capture, Latin America Vebdor Credits, Select Source, ITAD - Trade-in Credit, Withholding Tax
     * @param {String} [page] Number of page.
     * @param {String} [size] The submitted pagesize, default is 25
     * @param {String} [sort] Refers to the column selected to apply the sorting criteria.
     * @param {String} [sortingColumnName] The column name which will be sorted on.
     * @param {module:api/ReturnsApi~getResellersV6ReturnssearchCallback} callback The callback function, accepting three arguments: error, data, response
     * data is of type: {@link module:model/ReturnsSearchResponse}
     */
  }, {
    key: "getResellersV6Returnssearch",
    value: function getResellersV6Returnssearch(iMCustomerNumber, iMCountryCode, iMCorrelationID, opts, callback) {
      opts = opts || {};
      var postBody = null;
      // verify the required parameter 'iMCustomerNumber' is set
      if (iMCustomerNumber === undefined || iMCustomerNumber === null) {
        throw new Error("Missing the required parameter 'iMCustomerNumber' when calling getResellersV6Returnssearch");
      }
      // verify the required parameter 'iMCountryCode' is set
      if (iMCountryCode === undefined || iMCountryCode === null) {
        throw new Error("Missing the required parameter 'iMCountryCode' when calling getResellersV6Returnssearch");
      }
      // verify the required parameter 'iMCorrelationID' is set
      if (iMCorrelationID === undefined || iMCorrelationID === null) {
        throw new Error("Missing the required parameter 'iMCorrelationID' when calling getResellersV6Returnssearch");
      }
      var pathParams = {};
      var queryParams = {
        'caseRequestNumber': opts['caseRequestNumber'],
        'invoiceNumber': opts['invoiceNumber'],
        'returnClaimId': opts['returnClaimId'],
        'referenceNumber': opts['referenceNumber'],
        'ingramPartNumber': opts['ingramPartNumber'],
        'vendorPartNumber': opts['vendorPartNumber'],
        'returnStatus-in': opts['returnStatusIn'],
        'claimStatus-in': opts['claimStatusIn'],
        'createdOn-bt': opts['createdOnBt'],
        'modifiedOn-bt': opts['modifiedOnBt'],
        'returnReason-in': opts['returnReasonIn'],
        'page': opts['page'],
        'size': opts['size'],
        'sort': opts['sort'],
        'sortingColumnName': opts['sortingColumnName']
      };
      var headerParams = {
        'IM-CustomerNumber': iMCustomerNumber,
        'IM-CountryCode': iMCountryCode,
        'IM-CorrelationID': iMCorrelationID,
        'IM-SenderID': opts['iMSenderID']
      };
      var formParams = {};
      var authNames = ['application'];
      var contentTypes = [];
      var accepts = ['application/json'];
      var returnType = _ReturnsSearchResponse["default"];
      return this.apiClient.callApi('/resellers/v6/returns/search', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
    }

    /**
     * Callback function to receive the result of the postReturnscreate operation.
     * @callback module:api/ReturnsApi~postReturnscreateCallback
     * @param {String} error Error message, if any.
     * @param {module:model/ReturnsCreateResponse} data The data returned by the service call.
     * @param {String} response The complete HTTP response.
     */

    /**
     * Returns Create
     * Return create endpoint will allow customers to create a return request. In order to create a request, the customer must provide either ingramPartNumber or vendorPartNumber along with other required fields listed below. 
     * @param {String} iMCustomerNumber Your unique Ingram Micro customer number.
     * @param {String} iMCountryCode Two-character ISO country code.
     * @param {String} iMCorrelationID Unique transaction number to identify each transaction across all the systems.
     * @param {Object} opts Optional parameters
     * @param {String} [iMSenderID] Unique value used to identify the sender of the transaction. Example: MyCompany
     * @param {module:model/ReturnsCreateRequest} [returnsCreateRequest] 
     * @param {module:api/ReturnsApi~postReturnscreateCallback} callback The callback function, accepting three arguments: error, data, response
     * data is of type: {@link module:model/ReturnsCreateResponse}
     */
  }, {
    key: "postReturnscreate",
    value: function postReturnscreate(iMCustomerNumber, iMCountryCode, iMCorrelationID, opts, callback) {
      opts = opts || {};
      var postBody = opts['returnsCreateRequest'];
      // verify the required parameter 'iMCustomerNumber' is set
      if (iMCustomerNumber === undefined || iMCustomerNumber === null) {
        throw new Error("Missing the required parameter 'iMCustomerNumber' when calling postReturnscreate");
      }
      // verify the required parameter 'iMCountryCode' is set
      if (iMCountryCode === undefined || iMCountryCode === null) {
        throw new Error("Missing the required parameter 'iMCountryCode' when calling postReturnscreate");
      }
      // verify the required parameter 'iMCorrelationID' is set
      if (iMCorrelationID === undefined || iMCorrelationID === null) {
        throw new Error("Missing the required parameter 'iMCorrelationID' when calling postReturnscreate");
      }
      var pathParams = {};
      var queryParams = {};
      var headerParams = {
        'IM-CustomerNumber': iMCustomerNumber,
        'IM-CountryCode': iMCountryCode,
        'IM-CorrelationID': iMCorrelationID,
        'IM-SenderID': opts['iMSenderID']
      };
      var formParams = {};
      var authNames = ['application'];
      var contentTypes = ['application/json'];
      var accepts = ['application/json'];
      var returnType = _ReturnsCreateResponse["default"];
      return this.apiClient.callApi('/resellers/v6/returns/create', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
    }
  }]);
}();