Validate params before request (#42)

* Update for flights

* Update changelog

* Validate parameters with corresponding class

* Cleanup test

* Simplify the test

Author: pcothenet

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.11.1] - 2021-09-07
+
+### Changed
+
+- Body parameters are validated before being sent to the API. This gives developers faster feedback as they develop their applications.
+
 ## [1.11.0] - 2021-09-07
 
 ### Added

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@patch-technology/patch",
-  "version": "1.11.0",
+  "version": "1.11.1",
   "description": "Node.js wrapper for the Patch API",
   "license": "MIT",
   "repository": {

package.json

@@ -16,7 +16,7 @@ class ApiClient {
     };
 
     this.defaultHeaders = {
-      'User-Agent': 'patch-node/1.11.0'
+      'User-Agent': 'patch-node/1.11.1'
     };
 
     /**

src/ApiClient.js

@@ -22,12 +22,17 @@ export default class EstimatesApi {
   }
 
   createBitcoinEstimateWithHttpInfo(createBitcoinEstimateRequest) {
-    let postBody = createBitcoinEstimateRequest;
+    const _createBitcoinEstimateRequest =
+      CreateBitcoinEstimateRequest.constructFromObject(
+        createBitcoinEstimateRequest,
+        new CreateBitcoinEstimateRequest()
+      );
+    let postBody = _createBitcoinEstimateRequest;
 
     // verify the required parameter 'createBitcoinEstimateRequest' is set
     if (
-      createBitcoinEstimateRequest === undefined ||
-      createBitcoinEstimateRequest === null
+      _createBitcoinEstimateRequest === undefined ||
+      _createBitcoinEstimateRequest === null
     ) {
       throw new Error(
         "Missing the required parameter 'createBitcoinEstimateRequest' when calling createBitcoinEstimate"
@@ -64,12 +69,17 @@ export default class EstimatesApi {
   }
 
   createEthereumEstimateWithHttpInfo(createEthereumEstimateRequest) {
-    let postBody = createEthereumEstimateRequest;
+    const _createEthereumEstimateRequest =
+      CreateEthereumEstimateRequest.constructFromObject(
+        createEthereumEstimateRequest,
+        new CreateEthereumEstimateRequest()
+      );
+    let postBody = _createEthereumEstimateRequest;
 
     // verify the required parameter 'createEthereumEstimateRequest' is set
     if (
-      createEthereumEstimateRequest === undefined ||
-      createEthereumEstimateRequest === null
+      _createEthereumEstimateRequest === undefined ||
+      _createEthereumEstimateRequest === null
     ) {
       throw new Error(
         "Missing the required parameter 'createEthereumEstimateRequest' when calling createEthereumEstimate"
@@ -108,12 +118,17 @@ export default class EstimatesApi {
   }
 
   createFlightEstimateWithHttpInfo(createFlightEstimateRequest) {
-    let postBody = createFlightEstimateRequest;
+    const _createFlightEstimateRequest =
+      CreateFlightEstimateRequest.constructFromObject(
+        createFlightEstimateRequest,
+        new CreateFlightEstimateRequest()
+      );
+    let postBody = _createFlightEstimateRequest;
 
     // verify the required parameter 'createFlightEstimateRequest' is set
     if (
-      createFlightEstimateRequest === undefined ||
-      createFlightEstimateRequest === null
+      _createFlightEstimateRequest === undefined ||
+      _createFlightEstimateRequest === null
     ) {
       throw new Error(
         "Missing the required parameter 'createFlightEstimateRequest' when calling createFlightEstimate"
@@ -150,12 +165,17 @@ export default class EstimatesApi {
   }
 
   createMassEstimateWithHttpInfo(createMassEstimateRequest) {
-    let postBody = createMassEstimateRequest;
+    const _createMassEstimateRequest =
+      CreateMassEstimateRequest.constructFromObject(
+        createMassEstimateRequest,
+        new CreateMassEstimateRequest()
+      );
+    let postBody = _createMassEstimateRequest;
 
     // verify the required parameter 'createMassEstimateRequest' is set
     if (
-      createMassEstimateRequest === undefined ||
-      createMassEstimateRequest === null
+      _createMassEstimateRequest === undefined ||
+      _createMassEstimateRequest === null
     ) {
       throw new Error(
         "Missing the required parameter 'createMassEstimateRequest' when calling createMassEstimate"
@@ -192,12 +212,17 @@ export default class EstimatesApi {
   }
 
   createShippingEstimateWithHttpInfo(createShippingEstimateRequest) {
-    let postBody = createShippingEstimateRequest;
+    const _createShippingEstimateRequest =
+      CreateShippingEstimateRequest.constructFromObject(
+        createShippingEstimateRequest,
+        new CreateShippingEstimateRequest()
+      );
+    let postBody = _createShippingEstimateRequest;
 
     // verify the required parameter 'createShippingEstimateRequest' is set
     if (
-      createShippingEstimateRequest === undefined ||
-      createShippingEstimateRequest === null
+      _createShippingEstimateRequest === undefined ||
+      _createShippingEstimateRequest === null
     ) {
       throw new Error(
         "Missing the required parameter 'createShippingEstimateRequest' when calling createShippingEstimate"
@@ -236,12 +261,17 @@ export default class EstimatesApi {
   }
 
   createVehicleEstimateWithHttpInfo(createVehicleEstimateRequest) {
-    let postBody = createVehicleEstimateRequest;
+    const _createVehicleEstimateRequest =
+      CreateVehicleEstimateRequest.constructFromObject(
+        createVehicleEstimateRequest,
+        new CreateVehicleEstimateRequest()
+      );
+    let postBody = _createVehicleEstimateRequest;
 
     // verify the required parameter 'createVehicleEstimateRequest' is set
     if (
-      createVehicleEstimateRequest === undefined ||
-      createVehicleEstimateRequest === null
+      _createVehicleEstimateRequest === undefined ||
+      _createVehicleEstimateRequest === null
     ) {
       throw new Error(
         "Missing the required parameter 'createVehicleEstimateRequest' when calling createVehicleEstimate"

src/api/EstimatesApi.js

@@ -58,10 +58,14 @@ export default class OrdersApi {
   }
 
   createOrderWithHttpInfo(createOrderRequest) {
-    let postBody = createOrderRequest;
+    const _createOrderRequest = CreateOrderRequest.constructFromObject(
+      createOrderRequest,
+      new CreateOrderRequest()
+    );
+    let postBody = _createOrderRequest;
 
     // verify the required parameter 'createOrderRequest' is set
-    if (createOrderRequest === undefined || createOrderRequest === null) {
+    if (_createOrderRequest === undefined || _createOrderRequest === null) {
       throw new Error(
         "Missing the required parameter 'createOrderRequest' when calling createOrder"
       );

src/api/OrdersApi.js

@@ -17,12 +17,17 @@ export default class PreferencesApi {
   }
 
   createPreferenceWithHttpInfo(createPreferenceRequest) {
-    let postBody = createPreferenceRequest;
+    const _createPreferenceRequest =
+      CreatePreferenceRequest.constructFromObject(
+        createPreferenceRequest,
+        new CreatePreferenceRequest()
+      );
+    let postBody = _createPreferenceRequest;
 
     // verify the required parameter 'createPreferenceRequest' is set
     if (
-      createPreferenceRequest === undefined ||
-      createPreferenceRequest === null
+      _createPreferenceRequest === undefined ||
+      _createPreferenceRequest === null
     ) {
       throw new Error(
         "Missing the required parameter 'createPreferenceRequest' when calling createPreference"

src/api/PreferencesApi.js

@@ -80,14 +80,11 @@ describe('Estimates Integration', function () {
   });
 
   it('supports creating bitcoin estimates without parameters', async function () {
-    const { data: estimate } = await patch.estimates.createBitcoinEstimate({
-      create_order: false // TODO: this should work without this
-    });
+    const { data: estimate } = await patch.estimates.createBitcoinEstimate();
 
     expect(estimate.type).to.be.eq('bitcoin');
     expect(estimate.mass_g).to.be.above(0);
     expect(estimate.production).to.be.eq(false);
-    expect(estimate.order).to.be.eq(null);
   });
 
   it('supports creating bitcoin estimates with a timestamp', async function () {

test/integration/estimates.test.js

@@ -2,45 +2,44 @@ import { expect } from 'chai';
 import Patch from '../../dist/index';
 const patch = Patch(process.env.SANDBOX_API_KEY);
 
+async function getProjectId() {
+  const retrieveProjectResponse = await patch.projects.retrieveProjects();
+  return retrieveProjectResponse.data[0].id;
+}
+
 describe('Preferences Integration', async function () {
   it('supports creating, deleting, and listing preferences', async function () {
-    const preferencesList = await patch.preferences.retrievePreferences();
-
-    // If there is an existing preference, delete it and create a new one with the same
-    // project id. If there is not any existing preferences, create and delete one with
-    // any project id.
-    if (preferencesList.data.length > 0) {
-      const preference = preferencesList.data[0];
-      const projectId = preference.project.id;
-
-      await patch.preferences.deletePreference(preference.id);
-      const createdPreference = await patch.preferences.createPreference({
-        project_id: projectId
-      });
-
-      expect(createdPreference.data.project.id).to.eq(projectId);
+    const projectId = await getProjectId();
 
-      const preferencesList2 = await patch.preferences.retrievePreferences();
-      expect(preferencesList2.data.length).to.be.above(0);
-    } else {
-      const projectResponse = await patch.projects.retrieveProjects();
-      expect(projectResponse.data.length).to.be.above(0);
-      const projectId = projectResponse.data[0].id;
+    let preferenceId;
 
+    try {
       const createdPreference = await patch.preferences.createPreference({
         project_id: projectId
       });
+      preferenceId = createdPreference.data.id;
+    } catch (err) {
+      if (
+        !/Your organization already has a preferred project/.test(
+          err.error.message
+        )
+      ) {
+        throw err;
+      }
+      const preferencesList = await patch.preferences.retrievePreferences();
+      preferenceId = preferencesList.data[0].id;
+    }
 
-      expect(createdPreference.data.projectId).to.eq(projectId);
-
-      const preferencesList2 = await patch.preferences.retrievePreferences();
-      const preferencesCount = preferencesList2.data.length;
-      expect(preferencesList2.data.length).to.be.above(0);
+    const preferencesList = await patch.preferences.retrievePreferences();
+    expect(preferencesList.data.length).to.be.above(0);
 
-      await patch.preferences.deletePreference(preference.id);
+    const preferencesResponse = await patch.preferences.retrievePreference(
+      preferenceId
+    );
+    expect(preferencesResponse.data.id).to.eq(preferenceId);
 
-      const preferencesList3 = await patch.preferences.retrievePreferences();
-      expect(preferencesList3.data.length).to.eq(preferencesCount - 1);
-    }
+    const deletePreferenceResponse =
+      await patch.preferences.retrievePreferences(preferenceId);
+    expect(deletePreferenceResponse.data[0].id).to.eq(preferenceId);
   });
 });