feat: made listInboundShipments

ScaleLeap · Jul 15, 2020 · 71c366d · 71c366d
1 parent 2f5e150
commit 71c366d
Show file tree

Hide file tree

Showing 4 changed files with 181 additions and 2 deletions.
diff --git a/src/sections/fulfillment-inbound-shipment/codec.ts b/src/sections/fulfillment-inbound-shipment/codec.ts
@@ -1,6 +1,6 @@
 import { boolean, Codec, enumeration, GetInterface, number, optional, string } from 'purify-ts'
 
-import { ensureArray, ensureString, mwsDate } from '../../parsing'
+import { ensureArray, ensureString, mwsDate, nextToken as nextTokenCodec } from '../../parsing'
 import { DimensionsUnitEnum } from '../merchant-fulfillment/codec'
 import {
   CreateInboundShipmentParameters,
@@ -490,3 +490,62 @@ export const GetBillOfLadingResponse = Codec.interface({
     GetBillOfLadingResult: GetBillOfLading,
   }),
 })
+
+const FIBAddress = Codec.interface({
+  Name: string,
+  AddressLine1: string,
+  AddressLine2: optional(string),
+  City: string,
+  DistrictOrCounty: optional(string),
+  StateOrProvinceCode: optional(string),
+  CountryCode: string,
+  PostalCode: optional(string),
+})
+
+enum LabelPrepTypeEnum {
+  'NO_LABEL',
+  'SELLER_LABEL',
+  'AMAZON_LABEL',
+}
+
+const LabelPrepType = enumeration(LabelPrepTypeEnum)
+
+enum ShipmentStatusEnum {
+  'WORKING',
+  'SHIPPED',
+  'IN_TRANSIT',
+  'DELIVERED',
+  'CHECKED_IN',
+  'RECEIVING',
+  'CLOSED',
+  'CANCELLED',
+  'DELETED',
+  'ERROR',
+}
+
+const ShipmentStatus = enumeration(ShipmentStatusEnum)
+
+const InboundShipmentInfo = Codec.interface({
+  ShipmentId: optional(ensureString),
+  ShipmentName: optional(string),
+  ShipFromAddress: FIBAddress,
+  DestinationFulfillmentCenterId: optional(ensureString),
+  LabelPrepType: optional(LabelPrepType),
+  ShipmentStatus: optional(ShipmentStatus),
+  AreCasesRequired: optional(boolean),
+  ConfirmedNeedByDate: optional(string),
+  BoxContentsSource: optional(string),
+  EstimatedBoxContentsFeeDetails: optional(BoxContentsFeeDetails),
+})
+
+const ListInboundShipments = Codec.interface({
+  NextToken: optional(nextTokenCodec('ListInboundShipments')),
+  ShipmentData: ensureArray('member', InboundShipmentInfo),
+})
+
+export type ListInboundShipments = GetInterface<typeof ListInboundShipments>
+export const ListInboundShipmentsResponse = Codec.interface({
+  ListInboundShipmentsResponse: Codec.interface({
+    ListInboundShipmentsResult: ListInboundShipments,
+  }),
+})
diff --git a/src/sections/fulfillment-inbound-shipment/fulfillment-inbound-shipment.ts b/src/sections/fulfillment-inbound-shipment/fulfillment-inbound-shipment.ts
@@ -32,6 +32,8 @@ import {
   GetTransportContentResponse,
   GetUniquePackageLabels,
   GetUniquePackageLabelsResponse,
+  ListInboundShipments,
+  ListInboundShipmentsResponse,
   PutTransportContent,
   PutTransportContentResponse,
   UpdateInboundShipment,
@@ -59,6 +61,7 @@ import {
   GetPrepInstructionsForSKUParameters,
   GetTransportContentParameters,
   GetUniquePackageLabelsParameters,
+  ListInboundShipmentsParameters,
   PutTransportContentParameters,
   VoidTransportRequestParameters,
 } from './type'
@@ -68,6 +71,29 @@ const FULFILLMENT_INBOUND_SHIPMENT_API_VERSION = '2010-10-01'
 export class FulfillmentInboundShipment {
   constructor(private httpClient: HttpClient) {}
 
+  async listInboundShipments(
+    parameters: ListInboundShipmentsParameters,
+  ): Promise<[ListInboundShipments, RequestMeta]> {
+    const [response, meta] = await this.httpClient.request('POST', {
+      resource: Resource.FulfillmentInboundShipment,
+      version: FULFILLMENT_INBOUND_SHIPMENT_API_VERSION,
+      action: 'ListInboundShipments',
+      parameters: {
+        'ShipmentStatusList.member': parameters.ShipmentStatusList,
+        'ShipmentIdList.member': parameters.ShipmentIdList,
+        LastUpdatedAfter: parameters.LastUpdatedAfter?.toISOString(),
+        LastUpdatedBefore: parameters.LastUpdatedBefore?.toISOString(),
+      },
+    })
+
+    return ListInboundShipmentsResponse.decode(response).caseOf({
+      Right: (x) => [x.ListInboundShipmentsResponse.ListInboundShipmentsResult, meta],
+      Left: (error) => {
+        throw new ParsingError(error)
+      },
+    })
+  }
+
   async getBillOfLading(
     parameters: GetBillOfLadingParameters,
   ): Promise<[GetBillOfLading, RequestMeta]> {
@@ -108,7 +134,7 @@ export class FulfillmentInboundShipment {
         throw new ParsingError(error)
       },
     })
-}
+  }
 
   async getUniquePackageLabels(
     parameters: GetUniquePackageLabelsParameters,

diff --git a/src/sections/fulfillment-inbound-shipment/type.ts b/src/sections/fulfillment-inbound-shipment/type.ts
@@ -401,3 +401,10 @@ export interface GetPalletLabelsParameters {
 }
 
 export type GetBillOfLadingParameters = SingleShipmentIdParameters
+
+export interface ListInboundShipmentsParameters {
+  ShipmentStatusList?: string[]
+  ShipmentIdList?: string[]
+  LastUpdatedAfter?: Date
+  LastUpdatedBefore?: Date
+}
diff --git a/test/unit/__snapshots__/fulfillment-inbound-shipment.test.ts.snap b/test/unit/__snapshots__/fulfillment-inbound-shipment.test.ts.snap
@@ -424,6 +424,93 @@ Array [
 ]
 `;
 
+exports[`fulfillmentInboundShipment listInboundShipments returns shipment data if succesful 1`] = `
+Array [
+  Object {
+    "ShipmentData": Array [
+      Object {
+        "DestinationFulfillmentCenterId": "YYZ1",
+        "LabelPrepType": "NO_LABEL",
+        "ShipFromAddress": Object {
+          "AddressLine1": "Address Line 1",
+          "City": "Vancouver",
+          "CountryCode": "CA",
+          "Name": "jsowprni Devo CA20",
+          "PostalCode": "V5V 1A1",
+          "StateOrProvinceCode": "BC",
+        },
+        "ShipmentId": "FBAN4QNH",
+        "ShipmentName": "FBA (8/27/12 1:55 PM)",
+        "ShipmentStatus": "WORKING",
+      },
+      Object {
+        "BoxContentsSource": "NONE",
+        "DestinationFulfillmentCenterId": "RIC2",
+        "LabelPrepType": "NO_LABEL",
+        "ShipFromAddress": Object {
+          "AddressLine1": "Address 1",
+          "City": "Vancouver",
+          "CountryCode": "CA",
+          "Name": "Janani Arvind FBA QA",
+          "PostalCode": "V5V 1A1",
+          "StateOrProvinceCode": "BC",
+        },
+        "ShipmentId": "FBA1123",
+        "ShipmentName": "Test MWS CA Shipment 1",
+        "ShipmentStatus": "WORKING",
+      },
+    ],
+  },
+  Object {
+    "quotaMax": 1000,
+    "quotaRemaining": 999,
+    "quotaResetOn": 2020-04-06T10:22:23.582Z,
+    "requestId": "0",
+    "timestamp": 2020-05-06T09:22:23.582Z,
+  },
+]
+`;
+
+exports[`fulfillmentInboundShipment listInboundShipments returns the correct structure succesfully 1`] = `
+Array [
+  Object {
+    "NextToken": NextToken {
+      "action": "ListInboundShipments",
+      "token": "String",
+    },
+    "ShipmentData": Array [
+      Object {
+        "AreCasesRequired": true,
+        "BoxContentsSource": "String",
+        "ConfirmedNeedByDate": "String",
+        "DestinationFulfillmentCenterId": "String",
+        "LabelPrepType": "String",
+        "ShipFromAddress": Object {
+          "AddressLine1": "String",
+          "AddressLine2": "String",
+          "City": "String",
+          "CountryCode": "String",
+          "DistrictOrCounty": "String",
+          "Name": "String",
+          "PostalCode": "String",
+          "StateOrProvinceCode": "String",
+        },
+        "ShipmentId": "String",
+        "ShipmentName": "String",
+        "ShipmentStatus": "String",
+      },
+    ],
+  },
+  Object {
+    "quotaMax": 1000,
+    "quotaRemaining": 999,
+    "quotaResetOn": 2020-04-06T10:22:23.582Z,
+    "requestId": "0",
+    "timestamp": 2020-05-06T09:22:23.582Z,
+  },
+]
+`;
+
 exports[`fulfillmentInboundShipment putTransportContent returns tranport result if succesful 1`] = `
 Array [
   Object {