fix!: use parcel_contents over deprecated contents, closes #5

Gomah · Mar 25, 2023 · 75bb1aa · 75bb1aa
1 parent 919088f
commit 75bb1aa
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 20 deletions.
diff --git a/docs/content/en/orders.md b/docs/content/en/orders.md
@@ -186,12 +186,14 @@ const order = await client.orders.create({
     },
     instructions: 'Give directly to Clark',
   },
-  contents: {
-    description: 'T-shirt',
-    value: '20.00',
-    country_of_origin: 'CN',
-    hs_code: '610910',
-  },
+  parcel_contents: [
+    {
+      description: 'T-shirt',
+      value: '20.00',
+      country_of_origin: 'CN',
+      hs_code: '610910',
+    },
+  ],
 });
 ```
 
@@ -259,12 +261,14 @@ You can prevent duplicate orders by using an **Idempotency Key** header with thi
     },
     "instructions": "Give directly to Clark"
   },
-  "contents": {
-    "description": "T-shirt",
-    "value": "20.00",
-    "country_of_origin": "China",
-    "hs_code": "610910"
-  }
+  "parcel_contents": [
+    {
+      "description": "T-shirt",
+      "value": "20.00",
+      "country_of_origin": "China",
+      "hs_code": "610910"
+    }
+  ]
 }
 ```
 

diff --git a/src/types.ts b/src/types.ts
@@ -518,7 +518,7 @@ export namespace Sendle {
     /**
      * Description, value & country of origin must be provided when creating an international order.
      */
-    contents?: {
+    parcel_contents?: Array<{
       /**
        * Detailed description of the parcel contents for customs purposes.
        * Must be between 3 and 300 characters in length. Examples: Shoes, hat, sunglasses
@@ -543,7 +543,7 @@ export namespace Sendle {
        * Must contain 6–10 digits with separating dots.
        */
       hs_code: string;
-    };
+    }>;
   }
 
   export interface Order {

diff --git a/test/orders.test.ts b/test/orders.test.ts
@@ -141,12 +141,14 @@ describe('Orders', () => {
         },
         instructions: 'Give directly to Clark',
       },
-      contents: {
-        description: 'T-shirt',
-        value: '20.00',
-        country_of_origin: 'China',
-        hs_code: '610910',
-      },
+      parcel_contents: [
+        {
+          description: 'T-shirt',
+          value: '20.00',
+          country_of_origin: 'China',
+          hs_code: '610910',
+        },
+      ],
     });
 
     expect(order).toMatchSnapshot({