ti2 1.0.14 → 1.0.15

package/api.yml

@@ -816,6 +816,97 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/bookingsProductSearchReturn'
+  /bookings/{appKey}/{userId}/availabilitycalendar:
+    post:
+      security:
+        - bearerAuth: ['admin', 'user']
+      tags:
+        - bookings
+      summary: Availability Search
+      operationId: bookingsAvailabilityCalendar
+      parameters:
+        - name: appKey
+          in: path
+          description: app to search availability for, defaults to first token
+          required: true
+          example: 'travelgate-hotelx'
+          schema:
+            type: string
+        - name: userId
+          in: path
+          description: the user/company that the appKey belongs to
+          required: true
+          schema:
+            type: string
+      requestBody:
+        description: both app details
+        required:  true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/AnyValue'
+      responses:
+        '200':
+          description: search results
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  availability:
+                    type: array
+                    required: true
+                    items:
+                      $ref: '#/components/schemas/availabilityItem'
+  /bookings/{appKey}/{userId}/{hint}/availabilitycalendar:
+    post:
+      security:
+        - bearerAuth: ['admin', 'user']
+      tags:
+        - bookings
+      summary: Availability Search for an specific hint
+      operationId: bookingsAvailabilityCalendar
+      parameters:
+        - name: appKey
+          in: path
+          description: app to search availability for, defaults to first token
+          required: true
+          example: 'travelgate-hotelx'
+          schema:
+            type: string
+        - name: userId
+          in: path
+          description: the user/company that the appKey belongs to
+          required: true
+          schema:
+            type: string
+        - name: hint
+          in: path
+          description: a specific token hint to be used
+          required: true
+          example: 'travelgate-australia'
+          schema:
+            type: string
+      requestBody:
+        description: both app details
+        required:  true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/AnyValue'
+      responses:
+        '200':
+          description: search results
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  availability:
+                    type: array
+                    required: true
+                    items:
+                      $ref: '#/components/schemas/availabilityItem'
   /bookings/{appKey}/{userId}/availability:
     post:
       security:

package/controllers/bookings.js

@@ -110,6 +110,33 @@ const bookingsAvailabilitySearch = plugins => async (req, res, next) => {
   }
 };
 
+const bookingsAvailabilityCalendar = plugins => async (req, res, next) => {
+  const {
+    params: { appKey, userId, hint },
+    body: payload,
+  } = req;
+  try {
+    const app = plugins.find(({ name }) => name === appKey);
+    // const app = load(appKey);
+    const userAppKeys = (await UserAppKey.findOne({
+      where: {
+        userId,
+        integrationId: appKey,
+        ...(hint ? { hint } : {}),
+      },
+    }));
+    assert(userAppKeys, 'could not find the app key');
+    const token = userAppKeys.appKey;
+    const results = await app.availabilityCalendar({
+      token,
+      payload,
+    });
+    return res.json(results);
+  } catch (err) {
+    return next(err);
+  }
+};
+
 const searchQuote = plugins => async (req, res, next) => {
   const {
     params: { appKey, userId, hint },
@@ -171,6 +198,7 @@ module.exports = plugins => ({
   bookingsCancel: bookingsCancel(plugins),
   bookingsProductSearch: bookingsProductSearch(plugins),
   bookingsAvailabilitySearch: bookingsAvailabilitySearch(plugins),
+  bookingsAvailabilityCalendar: bookingsAvailabilityCalendar(plugins),
   searchQuote: searchQuote(plugins),
   createBooking: createBooking(plugins),
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ti2",
-  "version": "1.0.14",
+  "version": "1.0.15",
   "description": "Tourist Industry Exchange (TI2)",
   "main": "index.js",
   "scripts": {

package/test/plugin.js

@@ -363,7 +363,22 @@ class Plugin {
   searchAvailability() {
     // return (args);
   }
-
+  /**
+   * Retrieve an availability calendar over a date range
+   * @async
+   * @param {Object} args - Availability search arguments.
+   * @param {Object} args.token - A token definition, it's content varies between integrations.
+   * @param {Object} args.payload - Search spect object.
+   * @param {string} args.payload.dateFormat - Date format sent, using [momentjs formatting](https://momentjs.com/docs/#/parsing/string-format/).
+   * @param {string} args.payload.travelDateStart - Date of travel start.
+   * @param {string} args.payload.travelDateEnd - Date of travel end.
+   * @param {Occupancy[]} args.payload.occupancies - Occupancy detail.
+   * @returns {object} retVal - the return object
+   * @returns {Availability[]} retVal.availability - Array of availability objects
+   */
+  availabilityCalndar() {
+    // return (args);
+  }
   /**
    * A quote return spec
    * @typedef {Object} Quote