feat: manage report schedule

src/sections/reports.ts

@@ -13,7 +13,13 @@ import {
 
 import { ParsingError } from '../error'
 import { HttpClient, RequestMeta, Resource } from '../http'
-import { ensureString, mwsDate, NextToken, nextToken as nextTokenCodec } from '../parsing'
+import {
+  ensureString,
+  mwsDate,
+  NextToken,
+  nextToken as nextTokenCodec,
+  oneOfEnum,
+} from '../parsing'
 
 const REPORTS_API_VERSION = '2009-01-01'
 /**
@@ -63,6 +69,44 @@ type ReportProcessing =
   | '_DONE_'
   | '_DONE_NO_DATA_'
   | 'All'
+
+enum ScheduleEnum {
+  _15_MINUTES_ = '_15_MINUTES_',
+  _30_MINUTES_ = '_30_MINUTES_',
+  _1_HOUR_ = '_1_HOUR_',
+  _2_HOURS_ = '_2_HOURS_',
+  _4_HOURS_ = '_4_HOURS_',
+  _8_HOURS_ = '_8_HOURS_',
+  _12_HOURS_ = '_12_HOURS_',
+  _1_DAY_ = '_1_DAY_',
+  _2_DAYS_ = '_2_DAYS_',
+  _72_HOURS_ = '_72_HOURS_',
+  _1_WEEK_ = '_1_WEEK_',
+  _14_DAYS_ = '_14_DAYS_',
+  _15_DAYS_ = '_15_DAYS_',
+  _30_DAYS_ = '_30_DAYS_',
+  _NEVER_ = '_NEVER_',
+}
+
+const ScheduleCodec = oneOfEnum(ScheduleEnum)
+
+export type ScheduleType =
+  | '_15_MINUTES_'
+  | '_30_MINUTES_'
+  | '_1_HOUR_'
+  | '_2_HOURS_'
+  | '_4_HOURS_'
+  | '_8_HOURS_'
+  | '_12_HOURS_'
+  | '_1_DAY_'
+  | '_2_DAYS_'
+  | '_72_HOURS_'
+  | '_1_WEEK_'
+  | '_14_DAYS_'
+  | '_15_DAYS_'
+  | '_30_DAYS_'
+  | '_NEVER_'
+
 interface GetReportRequestListParameters {
   ReportRequestIdList?: string[]
   ReportTypeList?: ReportType[]
@@ -211,9 +255,57 @@ const GetReportResponse = Codec.custom<string>({
 type Report = string
 
 type GetReportCount = GetInterface<typeof GetReportCount>
+
+interface ManageReportScheduleParameters {
+  ReportType: ReportType
+  Schedule: ScheduleType
+  ScheduleDate?: Date
+}
+
+const ReportSchedule = Codec.interface({
+  ReportType: optional(ReportType),
+  Schedule: optional(ScheduleCodec),
+  ScheduleDate: optional(mwsDate),
+})
+
+const ManageReportSchedule = Codec.interface({
+  Count: number,
+  ReportSchedule: optional(ReportSchedule),
+})
+
+type ManageReportSchedule = GetInterface<typeof ManageReportSchedule>
+
+const ManageReportScheduleResponse = Codec.interface({
+  ManageReportScheduleResponse: Codec.interface({
+    ManageReportScheduleResult: ManageReportSchedule,
+  }),
+})
+
 export class Reports {
   constructor(private httpClient: HttpClient) {}
 
+  async manageReportSchedule(
+    parameters: ManageReportScheduleParameters,
+  ): Promise<[ManageReportSchedule, RequestMeta]> {
+    const [response, meta] = await this.httpClient.request('POST', {
+      resource: Resource.Reports,
+      version: REPORTS_API_VERSION,
+      action: 'ManageReportSchedule',
+      parameters: {
+        ReportType: parameters.ReportType,
+        Schedule: parameters.Schedule,
+        ScheduleDate: parameters.ScheduleDate?.toISOString(),
+      },
+    })
+
+    return ManageReportScheduleResponse.decode(response).caseOf({
+      Right: (x) => [x.ManageReportScheduleResponse.ManageReportScheduleResult, meta],
+      Left: (error) => {
+        throw new ParsingError(error)
+      },
+    })
+  }
+
   async getReport(parameters: { ReportId: string }): Promise<[Report, RequestMeta]> {
     const [response, meta] = await this.httpClient.request('POST', {
       resource: Resource.Reports,

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

@@ -350,6 +350,26 @@ Array [
 ]
 `;
 
+exports[`reports manageReportSchedule returns count and report schedule if succesful 1`] = `
+Array [
+  Object {
+    "Count": 1,
+    "ReportSchedule": Object {
+      "ReportType": "_GET_ORDERS_DATA_",
+      "Schedule": "_30_DAYS_",
+      "ScheduleDate": undefined,
+    },
+  },
+  Object {
+    "quotaMax": 1000,
+    "quotaRemaining": 999,
+    "quotaResetOn": 2020-04-06T10:22:23.582Z,
+    "requestId": "0",
+    "timestamp": 2020-05-06T09:22:23.582Z,
+  },
+]
+`;
+
 exports[`reports requestReport returns a parsed model when the response is valid 1`] = `
 Array [
   Object {

test/unit/reports.test.ts

@@ -1,6 +1,7 @@
 import { amazonMarketplaces, HttpClient, ParsingError } from '../../src'
 import { MWS } from '../../src/mws'
 import { NextToken } from '../../src/parsing'
+import { ScheduleType } from '../../src/sections/reports'
 import { getFixture } from '../utils'
 
 const httpConfig = {
@@ -39,7 +40,7 @@ describe('reports', () => {
   describe('manageReportSchedule', () => {
     const parameters = {
       ReportType: '_GET_ORDERS_DATA_',
-      Schedule: '_30_DAYS_',
+      Schedule: '_30_DAYS_' as ScheduleType,
     }
 
     it('returns count and report schedule if succesful', async () => {