mws-zodane-advanced

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <base data-ice="baseUrl" href="../../../"> <title data-ice="title">lib/endpoints/reports.js | mws-advanced</title> <link type="text/css" rel="stylesheet" href="css/style.css"> <link type="text/css" rel="stylesheet" href="css/prettify-tomorrow.css"> <script src="script/prettify/prettify.js"></script> <script src="script/manual.js"></script> </head> <body class="layout-container" data-ice="rootContainer"> <header> <a href="./">Home</a> <a href="identifiers.html">Reference</a> <a href="source.html">Source</a> <div class="search-box"> <img src="./image/search.png"> <input class="search-input"> <ul class="search-result"></ul> </div> </header> <nav class="navigation" data-ice="nav"><div> <ul> <li data-ice="doc">C<a href="class/lib/errors.js~InvalidUsage.html">InvalidUsage</a></li> <li data-ice="doc">C<a href="class/lib/errors.js~RequestCancelled.html">RequestCancelled</a></li> <li data-ice="doc">C<a href="class/lib/errors.js~ServiceError.html">ServiceError</a></li> <li data-ice="doc">C<a href="class/lib/errors.js~ValidationError.html">ValidationError</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-callEndpoint">callEndpoint</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-init">init</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getLowestPricedOffersForASIN">getLowestPricedOffersForASIN</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getMarketplaces">getMarketplaces</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getMatchingProductForId">getMatchingProductForId</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-listFinancialEvents">listFinancialEvents</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-listInventorySupply">listInventorySupply</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-listOrderItems">listOrderItems</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-listOrders">listOrders</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getReport">getReport</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getReportList">getReportList</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getReportListAll">getReportListAll</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getReportListByNextToken">getReportListByNextToken</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getReportRequestList">getReportRequestList</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-requestAndDownloadReport">requestAndDownloadReport</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-requestReport">requestReport</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-MWS_ENDPOINTS">MWS_ENDPOINTS</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-MWS_MARKETPLACES">MWS_MARKETPLACES</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-BuyBoxPrice">BuyBoxPrice</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-DetailedShippingTime">DetailedShippingTime</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-LowestPrice">LowestPrice</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-LowestPricedOffers">LowestPricedOffers</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-Money">Money</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-Offer">Offer</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-OfferCount">OfferCount</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-OfferSummary">OfferSummary</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-SellerFeedbackRating">SellerFeedbackRating</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-ShipsFrom">ShipsFrom</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-MarketDetail">MarketDetail</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-OrderItemList">OrderItemList</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-GetReportRequestListResult">GetReportRequestListResult</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-GetReportRequestListResult">GetReportRequestListResult</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-ReportRequestInfo">ReportRequestInfo</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#endpoints">endpoints</a>V<a href="variable/index.html#static-variable-REPORT_PROCESSING_STATUS_TYPES">REPORT_PROCESSING_STATUS_TYPES</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-REQUEST_REPORT_TYPES">REQUEST_REPORT_TYPES</a></li> </ul> </div> </nav> <div class="content" data-ice="content"><h1 data-ice="title">lib/endpoints/reports.js</h1> <pre class="source-code line-number raw-source-code"><code class="prettyprint linenums" data-ice="content">const path = require('path'); const generateEndpoints = require('./endpoints-utils'); const constants = require('./constants.js'); const scriptName = path.basename(__filename, '.js'); const categoryName = `${scriptName.charAt(0).toUpperCase()}${scriptName.slice(1)}`; const apiVersion = '2009-01-01'; const endpointList = [ 'RequestReport', 'GetReportRequestList', 'GetReportRequestListByNextToken', 'GetReportRequestCount', 'CancelReportRequests', 'GetReportList', 'GetReportListByNextToken', 'GetReportCount', 'GetReport', 'ManageReportSchedule', 'GetReportScheduleList', 'GetReportScheduleListByNextToken', 'GetReportScheduleCount', 'UpdateReportAcknowledgements', ]; const newEndpointList = { RequestReport: { throttle: { maxInFlight: 15, restoreRate: 1, }, params: { ReportType: { type: 'xs:string', required: true, }, StartDate: { type: 'xs:dateTime', required: false, }, EndDate: { type: 'xs:dateTime', required: false, }, ReportOptions: { type: 'xs:string', required: false, }, MarketplaceIdList: { type: 'xs:string', required: false, // TODO: only available in NA and EU regions }, }, returns: { ReportRequestInfo: { type: 'ReportRequestInfo', required: true, // TODO: Docs don't specifically state it's required. what if empty? }, }, }, GetReportRequestList: { throttle: { maxInFlight: 10, restoreRate: 0.75, // 1 request every 45 seconds = 3/4 of a request per minute }, params: { ReportRequestIdList: { type: 'xs:string', required: false, list: 'ReportRequestIdList.Id', }, ReportTypeList: { type: 'xs:string', required: false, list: 'ReportTypeList.Type', values: constants.REQUEST_REPORT_TYPES, }, ReportProcessingStatusList: { type: 'xs:string', required: false, list: 'ReportProcessingStatusList.Status', values: constants.REPORT_PROCESSING_STATUS_TYPES, }, MaxCount: { type: 'xs:positiveInteger', // Documentation page says 'xs:nonNegativeInteger', but the range starts at 1, which makes it a xs:positiveInteger required: false, maxValue: 100, }, RequestedFromDate: { type: 'xs:dateTime', required: false, }, RequestedToDate: { type: 'xs:dateTime', required: false, }, }, returns: { NextToken: { type: 'xs:string', required: false, }, HasNext: { type: 'xs:boolean', // TODO: need to add xs:boolean to the validate function.. does it come in as a string ("True"/"False") or a bool value? required: true, }, ReportRequestInfo: { type: 'ReportRequestInfo', required: true, }, }, }, GetReportRequestListByNextToken: { throttle: { maxInFlight: 30, restoreRate: 30, }, params: { NextToken: { type: 'xs:string', required: true, }, }, returns: { NextToken: { type: 'xs:string', required: false, }, HasNext: { type: 'xs:boolean', // TODO: need to add xs:boolean to the validate function.. does it come in as a string ("True"/"False") or a bool value? required: true, }, ReportRequestInfo: { type: 'ReportRequestInfo', required: true, }, }, }, GetReportRequestCount: { throttle: { maxInFlight: 10, restoreRate: 0.75, }, params: { ReportTypeList: { type: 'xs:string', required: false, values: constants.REQUEST_REPORT_TYPES, }, ReportProcessingStatusList: { type: 'xs:string', required: false, values: constants.REPORT_PROCESSING_STATUS_TYPES, }, RequestedFromDate: { type: 'xs:dateTime', required: false, }, RequestedToDate: { type: 'xs:dateTime', required: false, }, }, returns: { Count: { type: 'xs:nonNegativeInteger', required: true, }, }, }, CancelReportRequests: { throttle: { maxInFlight: 10, restoreRate: 0.75, }, params: { ReportRequestIdList: { type: 'xs:string', required: false, list: 'ReportRequestIdList.Id', }, ReportTypeList: { type: 'xs:string', required: false, values: constants.REQUEST_REPORT_TYPES, list: 'ReportTypeList.Type', }, ReportProcessingStatusList: { type: 'xs:string', required: false, values: constants.REPORT_PROCESSING_STATUS_TYPES, }, RequestedFromDate: { type: 'xs:dateTime', required: false, }, RequestedToDate: { type: 'xs:dateTime', required: false, }, }, returns: { Count: { type: 'xs:nonNegativeInteger', required: true, }, ReportRequestInfo: { type: 'ReportRequestInfo', required: true, }, }, }, GetReportList: { throttle: { maxInFlight: 10, restoreRate: 1, }, params: { MaxCount: { type: 'xs:positiveInteger', // docs say nonNegativeInteger, range 1-100 required: false, maxValue: 100, }, ReportTypeList: { type: 'xs:string', required: false, values: [ ...constants.REQUEST_REPORT_TYPES, ...constants.NOREQUEST_REPORT_TYPES, ...constants.SCHEDULED_REPORT_TYPES, ], list: 'ReportTypeList.Type', }, Acknowledged: { type: 'xs:boolean', required: false, }, ReportRequestIdList: { type: 'xs:string', required: false, list: 'ReportRequestIdList.Id', }, AvailableFromDate: { type: 'xs:dateTime', required: false, }, AvailableToDate: { type: 'xs:dateTime', required: false, }, }, returns: { NextToken: { type: 'xs:string', required: false, }, HasNext: { type: 'xs:boolean', required: true, }, ReportInfo: { type: 'ReportInfo', required: true, }, }, }, GetReportListByNextToken: { throttle: { maxInFlight: 30, restoreRate: 30, }, params: { NextToken: { type: 'xs:string', required: true, }, }, returns: { NextToken: { type: 'xs:string', required: false, }, HasNext: { type: 'xs:boolean', required: true, }, ReportInfo: { type: 'ReportInfo', required: true, }, }, }, GetReportCount: { throttle: { maxInFlight: 10, restoreRate: 0.75, }, params: { ReportTypeList: { type: 'xs:string', required: false, list: 'ReportTypeList.Type', values: [ ...constants.REQUEST_REPORT_TYPES, ...constants.NOREQUEST_REPORT_TYPES, ...constants.SCHEDULED_REPORT_TYPES, ], }, Acknowledged: { type: 'xs:boolean', required: false, }, AvailableFromDate: { type: 'xs:dateTime', required: false, }, AvailableToDate: { type: 'xs:dateTime', required: false, }, }, returns: { Count: { // Return types are not documented on this page! Assuming from example. type: 'xs:nonNegativeInteger', required: true, }, }, }, GetReport: { throttle: { maxInFlight: 15, restoreRate: 1, }, params: { ReportId: { type: 'xs:string', required: true, }, }, returns: { Report: { type: 'xs:string', required: true, }, }, }, ManageReportSchedule: { throttle: { maxInFlight: 10, restoreRate: 0.75, }, params: { ReportType: { type: 'xs:string', required: true, values: constants.SCHEDULED_REPORT_TYPES, }, Schedule: { type: 'xs:string', required: true, values: constants.SCHEDULE_TYPES, }, ScheduleDate: { type: 'xs:dateTime', required: false, }, }, returns: { Count: { type: 'xs:nonNegativeInteger', required: true, }, ReportSchedule: { type: 'ReportSchedule', required: true, }, }, }, GetReportScheduleList: { throttle: { maxInFlight: 10, restoreRate: 0.75, }, params: { ReportTypeList: { type: 'xs:string', required: false, values: constants.SCHEDULED_REPORT_TYPES, }, }, returns: { NextToken: { type: 'xs:string', required: false, }, HasNext: { type: 'xs:boolean', required: true, }, ReportSchedule: { type: 'ReportSchedule', required: true, }, }, }, GetReportScheduleListByNextToken: { // Doc says: "this operation can never be called ... it is included for future compatibility" throttle: { maxInFlight: 1, restoreRate: 1, }, params: { DO_NOT_USE_THIS: { type: 'DO NOT USE GETREPORTSCHEDULELISTBYNEXTTOKEN', required: true, }, }, returns: { // NextToken: { // type: 'xs:string', // required: false, // }, // HasNext: { // type: 'xs:boolean', // required: true, // }, // ReportSchedule: { // type: 'ReportSchedule', // required: true, // } }, }, GetReportScheduleCount: { throttle: { maxInFlight: 10, restoreRate: 0.75, }, params: { ReportTypeList: { type: 'xs:string', required: false, values: [ ...constants.SCHEDULED_REPORT_TYPES, ...constants.REQUEST_REPORT_TYPES, ], list: 'ReportTypeList.Type', }, }, returns: { Count: { type: 'xs:nonNegativeInteger', required: true, }, }, }, UpdateReportAcknowledgements: { throttle: { maxInFlight: 10, restoreRate: 0.75, }, params: { ReportIdList: { type: 'xs:string', required: true, list: 'ReportIdList.Id', }, Acknowledged: { type: 'xs:boolean', required: true, }, }, returns: { Count: { type: 'xs:nonNegativeInteger', required: true, }, ReportInfo: { type: 'ReportInfo', required: true, }, }, }, }; /** * @private */ const endpoints = generateEndpoints( categoryName, apiVersion, endpointList, newEndpointList, ); module.exports = endpoints; </code></pre> </div> <footer class="footer"> Generated by <a href="https://esdoc.org">ESDoc(1.0.4)<img src="./image/esdoc-logo-mini-black.png"></a> </footer> <script src="script/search_index.js"></script> <script src="script/search.js"></script> <script src="script/pretty-print.js"></script> <script src="script/inherited-summary.js"></script> <script src="script/test-summary.js"></script> <script src="script/inner-link.js"></script> <script src="script/patch-for-local.js"></script> </body> </html>