feat: get report request list api

src/sections/reports.ts

@@ -2,7 +2,7 @@ import { boolean, Codec, GetInterface, optional, string } from 'purify-ts'
 
 import { ParsingError } from '../error'
 import { HttpClient, RequestMeta, Resource } from '../http'
-import { ensureString, mwsDate } from '../parsing'
+import { ensureString, mwsDate, nextToken as nextTokenCodec } from '../parsing'
 import { getServiceStatusByResource } from './shared'
 
 const REPORTS_API_VERSION = '2009-01-01'
@@ -13,6 +13,7 @@ const REPORTS_API_VERSION = '2009-01-01'
  */
 const ReportType = string
 type ReportType = GetInterface<typeof ReportType>
+
 interface RequestReportParameters {
   ReportType: ReportType
   StartDate?: Date
@@ -30,7 +31,7 @@ const ReportRequestInfo = Codec.interface({
   Scheduled: optional(boolean),
   SubmittedDate: optional(mwsDate),
   ReportProcessingStatus: optional(string),
-  GeneratedReportId: optional(string),
+  GeneratedReportId: optional(ensureString),
   StartedProcessingDate: optional(mwsDate),
   CompletedDate: optional(mwsDate),
 })
@@ -45,9 +46,64 @@ const RequestReportResponse = Codec.interface({
   }),
 })
 
+type ReportProcessing =
+  | '_SUBMITTED_'
+  | '_IN_PROGRESS_'
+  | '_CANCELLED_'
+  | '_DONE_'
+  | '_DONE_NO_DATA_'
+  | 'All'
+interface GetReportRequestListParameters {
+  ReportRequestIdList?: string[]
+  ReportTypeList?: ReportType[]
+  ReportProcessingStatusList?: ReportProcessing[]
+  MaxCount?: number
+  RequestedFromDate?: Date
+  RequestedToDate?: Date
+}
+
+const GetReportRequestListResult = Codec.interface({
+  NextToken: optional(nextTokenCodec('GetReportRequestList')),
+  HasNext: optional(boolean),
+  ReportRequestInfo: optional(ReportRequestInfo),
+})
+
+type GetReportRequestListResult = GetInterface<typeof GetReportRequestListResult>
+
+const GetReportRequestListResponse = Codec.interface({
+  GetReportRequestListResponse: Codec.interface({
+    GetReportRequestListResult,
+  }),
+})
+
 export class Reports {
   constructor(private httpClient: HttpClient) {}
 
+  async getReportRequestList(
+    parameters: GetReportRequestListParameters,
+  ): Promise<[GetReportRequestListResult, RequestMeta]> {
+    const [response, meta] = await this.httpClient.request('POST', {
+      resource: Resource.Report,
+      version: REPORTS_API_VERSION,
+      action: 'GetReportRequestList',
+      parameters: {
+        'ReportRequestIdList.Id': parameters.ReportRequestIdList,
+        'ReportTypeList.Type': parameters.ReportRequestIdList,
+        'ReportProcessingStatusList.Status': parameters.ReportProcessingStatusList,
+        MaxCount: parameters.MaxCount,
+        RequestedFromDate: parameters.RequestedFromDate?.toISOString(),
+        RequestedToDate: parameters.RequestedToDate?.toISOString(),
+      },
+    })
+
+    return GetReportRequestListResponse.decode(response).caseOf({
+      Right: (x) => [x.GetReportRequestListResponse.GetReportRequestListResult, meta],
+      Left: (error) => {
+        throw new ParsingError(error)
+      },
+    })
+  }
+
   async requestReport(
     parameters: RequestReportParameters,
   ): Promise<[ReportRequestInfo, RequestMeta]> {

test/unit/__snapshots__/reports.test.ts.snap

@@ -1,5 +1,36 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`reports getReportRequestList returns a parsed model when the response is valid 1`] = `
+Array [
+  Object {
+    "HasNext": true,
+    "NextToken": NextToken {
+      "action": "GetReportRequestList",
+      "token": "2YgYW55IPQhcm5hbCBwbGVhc3VyZS4=",
+    },
+    "ReportRequestInfo": Object {
+      "CompletedDate": 2011-02-17T23:44:48.000Z,
+      "EndDate": 2011-02-13T02:10:39.000Z,
+      "GeneratedReportId": "3538561173",
+      "ReportProcessingStatus": "_DONE_",
+      "ReportRequestId": "2291326454",
+      "ReportType": "_GET_MERCHANT_LISTINGS_DATA_",
+      "Scheduled": false,
+      "StartDate": 2011-01-21T02:10:39.000Z,
+      "StartedProcessingDate": 2011-02-17T23:44:43.000Z,
+      "SubmittedDate": 2011-02-17T23:44:09.000Z,
+    },
+  },
+  Object {
+    "quotaMax": 1000,
+    "quotaRemaining": 999,
+    "quotaResetOn": 2020-04-06T10:22:23.582Z,
+    "requestId": "0",
+    "timestamp": 2020-05-06T09:22:23.582Z,
+  },
+]
+`;
+
 exports[`reports getServiceStatus returns a parsed model when the status response is valid 1`] = `
 Array [
   Object {
@@ -9,9 +40,9 @@ Array [
   Object {
     "quotaMax": 1000,
     "quotaRemaining": 999,
-    "quotaResetOn": 2020-05-06T10:22:23.582Z,
+    "quotaResetOn": 2020-04-06T10:22:23.582Z,
     "requestId": "0",
-    "timestamp": 2020-05-06T08:22:23.582Z,
+    "timestamp": 2020-05-06T09:22:23.582Z,
   },
 ]
 `;