btrz-api-client 8.43.0 → 8.44.0

package/lib/endpoints/inventory/schedules.js

@@ -104,27 +104,25 @@ function schedulesFactory(_ref) {
   }
 
   /**
-   * PUT /routes/:routeId/schedules/:scheduleId - update schedule. API does not accept query params.
+   * POST /routes/:routeId/schedules/validations - validate schedule creation. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.routeId - Route id
-   * @param {string} opts.scheduleId - Schedule id
    * @param {Object} opts.data - Schedule payload
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
-  function update(_ref5) {
+  function validations(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,
         data = _ref5.data,
         routeId = _ref5.routeId,
-        scheduleId = _ref5.scheduleId,
         headers = _ref5.headers;
 
     return client({
-      url: "/routes/" + routeId + "/schedules/" + scheduleId,
-      method: "put",
+      url: "/routes/" + routeId + "/schedules/validations",
+      method: "post",
       headers: authorizationHeaders({
         token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers
       }),
@@ -133,22 +131,51 @@ function schedulesFactory(_ref) {
   }
 
   /**
-   * DELETE /routes/:routeId/schedules/:scheduleId - delete schedule. API does not accept query params.
+   * PUT /routes/:routeId/schedules/:scheduleId - update schedule. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.routeId - Route id
    * @param {string} opts.scheduleId - Schedule id
+   * @param {Object} opts.data - Schedule payload
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
-  function deleteSchedule(_ref6) {
+  function update(_ref6) {
     var token = _ref6.token,
         jwtToken = _ref6.jwtToken,
+        data = _ref6.data,
         routeId = _ref6.routeId,
         scheduleId = _ref6.scheduleId,
         headers = _ref6.headers;
 
+    return client({
+      url: "/routes/" + routeId + "/schedules/" + scheduleId,
+      method: "put",
+      headers: authorizationHeaders({
+        token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers
+      }),
+      data: data
+    });
+  }
+
+  /**
+   * DELETE /routes/:routeId/schedules/:scheduleId - delete schedule. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.routeId - Route id
+   * @param {string} opts.scheduleId - Schedule id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function deleteSchedule(_ref7) {
+    var token = _ref7.token,
+        jwtToken = _ref7.jwtToken,
+        routeId = _ref7.routeId,
+        scheduleId = _ref7.scheduleId,
+        headers = _ref7.headers;
+
     return client({
       url: "/routes/" + routeId + "/schedules/" + scheduleId,
       method: "delete",
@@ -169,11 +196,11 @@ function schedulesFactory(_ref) {
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
-    create: function create(_ref7) {
-      var token = _ref7.token,
-          jwtToken = _ref7.jwtToken,
-          data = _ref7.data,
-          headers = _ref7.headers;
+    create: function create(_ref8) {
+      var token = _ref8.token,
+          jwtToken = _ref8.jwtToken,
+          data = _ref8.data,
+          headers = _ref8.headers;
 
       return client({
         url: "/routes/schedules/auto-bouncing",
@@ -194,12 +221,12 @@ function schedulesFactory(_ref) {
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
-    delete: function _delete(_ref8) {
-      var token = _ref8.token,
-          jwtToken = _ref8.jwtToken,
-          routeId = _ref8.routeId,
-          parentScheduleId = _ref8.parentScheduleId,
-          headers = _ref8.headers;
+    delete: function _delete(_ref9) {
+      var token = _ref9.token,
+          jwtToken = _ref9.jwtToken,
+          routeId = _ref9.routeId,
+          parentScheduleId = _ref9.parentScheduleId,
+          headers = _ref9.headers;
 
       return client({
         url: "/routes/" + routeId + "/schedules/" + parentScheduleId + "/auto-bouncing",
@@ -223,12 +250,12 @@ function schedulesFactory(_ref) {
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
-    create: function create(_ref9) {
-      var token = _ref9.token,
-          jwtToken = _ref9.jwtToken,
-          data = _ref9.data,
-          scheduleId = _ref9.scheduleId,
-          headers = _ref9.headers;
+    create: function create(_ref10) {
+      var token = _ref10.token,
+          jwtToken = _ref10.jwtToken,
+          data = _ref10.data,
+          scheduleId = _ref10.scheduleId,
+          headers = _ref10.headers;
 
       return client({
         url: "/schedules/" + scheduleId + "/schedule-exceptions",
@@ -249,12 +276,12 @@ function schedulesFactory(_ref) {
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
-    delete: function _delete(_ref10) {
-      var token = _ref10.token,
-          jwtToken = _ref10.jwtToken,
-          scheduleId = _ref10.scheduleId,
-          exceptionId = _ref10.exceptionId,
-          headers = _ref10.headers;
+    delete: function _delete(_ref11) {
+      var token = _ref11.token,
+          jwtToken = _ref11.jwtToken,
+          scheduleId = _ref11.scheduleId,
+          exceptionId = _ref11.exceptionId,
+          headers = _ref11.headers;
 
       return client({
         url: "/schedules/" + scheduleId + "/schedule-exceptions/" + exceptionId,
@@ -275,13 +302,13 @@ function schedulesFactory(_ref) {
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
-    update: function update(_ref11) {
-      var token = _ref11.token,
-          jwtToken = _ref11.jwtToken,
-          data = _ref11.data,
-          scheduleId = _ref11.scheduleId,
-          exceptionId = _ref11.exceptionId,
-          headers = _ref11.headers;
+    update: function update(_ref12) {
+      var token = _ref12.token,
+          jwtToken = _ref12.jwtToken,
+          data = _ref12.data,
+          scheduleId = _ref12.scheduleId,
+          exceptionId = _ref12.exceptionId,
+          headers = _ref12.headers;
 
       return client({
         url: "/schedules/" + scheduleId + "/schedule-exceptions/" + exceptionId,
@@ -300,6 +327,7 @@ function schedulesFactory(_ref) {
     create: create,
     update: update,
     delete: deleteSchedule,
+    validations: validations,
     autoBouncing: autoBouncing,
     exceptions: exceptions
   };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "btrz-api-client",
-  "version": "8.43.0",
+  "version": "8.44.0",
   "description": "Api client for Betterez endpoints",
   "main": "index.js",
   "scripts": {

package/src/endpoints/inventory/schedules.js

@@ -77,6 +77,27 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /routes/:routeId/schedules/validations - validate schedule creation. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.routeId - Route id
+   * @param {Object} opts.data - Schedule payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function validations({token, jwtToken, data, routeId, headers}) {
+    return client({
+      url: `/routes/${routeId}/schedules/validations`,
+      method: "post",
+      headers: authorizationHeaders({
+        token, jwtToken, internalAuthTokenProvider, headers
+      }),
+      data
+    });
+  }
+
   /**
    * PUT /routes/:routeId/schedules/:scheduleId - update schedule. API does not accept query params.
    * @param {Object} opts
@@ -231,6 +252,7 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
     create,
     update,
     delete: deleteSchedule,
+    validations,
     autoBouncing,
     exceptions
   };

package/test/endpoints/inventory/schedules.test.js

@@ -95,4 +95,11 @@ describe("inventory/routes/shedules", () => {
       .reply(expectRequest({statusCode: 200, token, jwtToken}));
     return api.inventory.schedules.exceptions.update({token, jwtToken, data, scheduleId, exceptionId});
   });
+
+  it("should validate a schedule creation request", () => {
+    axiosMock.onPost(`/routes/${routeId}/schedules/validations`).reply(expectRequest({
+      statusCode: 200, token, jwtToken
+    }));
+    return api.inventory.schedules.validations({token, jwtToken, data, routeId});
+  });
 });