btrz-api-client 8.28.0 → 8.30.0

package/lib/endpoints/accounts/shifts.js

@@ -1,12 +1,31 @@
 "use strict";
 
+/* eslint-disable max-len */
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for shifts API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, create: function, update: function, requiresAgencyShiftClosure: object, payments: object, transactions: object, tickets: object, fees: object, refunds: object, items: object, redeemableItems: object, giftCertificates: object, parcels: object, insurances: object, invoices: object, deposits: object, manualTickets: object, locationClosures: object, startingBalances: object, purchaseLimitPayments: object, salesSummary: object, commissions: object }}
+ */
+
+
 function shiftsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /shifts - list shifts.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var jwtToken = _ref2.jwtToken,
         token = _ref2.token,
@@ -21,6 +40,14 @@ function shiftsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /shift/user/:userId - get shift for user.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.userId - User id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var token = _ref3.token,
         userId = _ref3.userId,
@@ -31,6 +58,15 @@ function shiftsFactory(_ref) {
     });
   }
 
+  /**
+   * POST /shifts - create a shift.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.shiftData - Shift payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var jwtToken = _ref4.jwtToken,
         token = _ref4.token,
@@ -47,6 +83,17 @@ function shiftsFactory(_ref) {
     });
   }
 
+  /**
+   * PATCH /shifts/:shiftId - update a shift (operations).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.shiftId - Shift id (ObjectId)
+   * @param {Object} opts.operations - Operations payload
+   * @param {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref5) {
     var jwtToken = _ref5.jwtToken,
         token = _ref5.token,
@@ -69,6 +116,16 @@ function shiftsFactory(_ref) {
   }
 
   var locationClosureComments = {
+    /**
+     * POST /shifts/location-closures/:locationClosureId/comments - add comment to location closure.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.locationClosureId - Location closure id (ObjectId)
+     * @param {Object} opts.locationClosureComment - Comment payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create: function create(_ref6) {
       var jwtToken = _ref6.jwtToken,
           token = _ref6.token,
@@ -88,6 +145,16 @@ function shiftsFactory(_ref) {
   };
 
   var locationClosureStatus = {
+    /**
+     * PUT /shifts/location-closures/:locationClosureId/status - update location closure status.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.locationClosureId - Location closure id (ObjectId)
+     * @param {Object} opts.locationClosureStatusChange - Status change payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update: function update(_ref7) {
       var jwtToken = _ref7.jwtToken,
           token = _ref7.token,
@@ -107,6 +174,15 @@ function shiftsFactory(_ref) {
   };
 
   var locationClosures = {
+    /**
+     * POST /shifts/location-closures - create a location closure.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {Object} opts.locationClosure - Location closure payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create: function create(_ref8) {
       var jwtToken = _ref8.jwtToken,
           token = _ref8.token,
@@ -122,6 +198,16 @@ function shiftsFactory(_ref) {
         data: locationClosure
       });
     },
+
+    /**
+     * GET /shifts/location-closures - list location closures.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {Object} [opts.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     all: function all(_ref9) {
       var jwtToken = _ref9.jwtToken,
           token = _ref9.token,
@@ -135,6 +221,16 @@ function shiftsFactory(_ref) {
         params: query
       });
     },
+
+    /**
+     * GET /shifts/location-closures/:locationClosureId - get a location closure.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.locationClosureId - Location closure id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref10) {
       var token = _ref10.token,
           jwtToken = _ref10.jwtToken,
@@ -151,6 +247,15 @@ function shiftsFactory(_ref) {
   };
 
   var payments = {
+    /**
+     * GET /shifts/:shiftId/payments - get payments for shift.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.shiftId - Shift id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref11) {
       var token = _ref11.token,
           jwtToken = _ref11.jwtToken,
@@ -163,6 +268,15 @@ function shiftsFactory(_ref) {
     }
   };
   var transactions = {
+    /**
+     * GET /shifts/:shiftId/transactions - get transactions for shift.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.shiftId - Shift id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref12) {
       var token = _ref12.token,
           jwtToken = _ref12.jwtToken,
@@ -175,6 +289,15 @@ function shiftsFactory(_ref) {
     }
   };
   var tickets = {
+    /**
+     * GET /shifts/:shiftId/tickets - get tickets for shift.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.shiftId - Shift id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref13) {
       var token = _ref13.token,
           jwtToken = _ref13.jwtToken,
@@ -187,6 +310,15 @@ function shiftsFactory(_ref) {
     }
   };
   var fees = {
+    /**
+     * GET /shifts/:shiftId/fees - get fees for shift.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.shiftId - Shift id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref14) {
       var token = _ref14.token,
           jwtToken = _ref14.jwtToken,
@@ -199,6 +331,15 @@ function shiftsFactory(_ref) {
     }
   };
   var refunds = {
+    /**
+     * GET /shifts/:shiftId/refunds - get refunds for shift.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.shiftId - Shift id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref15) {
       var token = _ref15.token,
           jwtToken = _ref15.jwtToken,
@@ -211,6 +352,15 @@ function shiftsFactory(_ref) {
     }
   };
   var items = {
+    /**
+     * GET /shifts/:shiftId/items - get items for shift.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.shiftId - Shift id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref16) {
       var token = _ref16.token,
           jwtToken = _ref16.jwtToken,
@@ -223,6 +373,15 @@ function shiftsFactory(_ref) {
     }
   };
   var redeemableItems = {
+    /**
+     * GET /shifts/:shiftId/redeemable-items - get redeemable items for shift.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.shiftId - Shift id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref17) {
       var token = _ref17.token,
           jwtToken = _ref17.jwtToken,
@@ -235,6 +394,15 @@ function shiftsFactory(_ref) {
     }
   };
   var giftCertificates = {
+    /**
+     * GET /shifts/:shiftId/gift-certificates - get gift certificates for shift.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.shiftId - Shift id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref18) {
       var token = _ref18.token,
           jwtToken = _ref18.jwtToken,
@@ -247,6 +415,15 @@ function shiftsFactory(_ref) {
     }
   };
   var parcels = {
+    /**
+     * GET /shifts/:shiftId/parcels - get parcels for shift.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.shiftId - Shift id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref19) {
       var token = _ref19.token,
           jwtToken = _ref19.jwtToken,
@@ -259,6 +436,15 @@ function shiftsFactory(_ref) {
     }
   };
   var insurances = {
+    /**
+     * GET /shifts/:shiftId/insurances - get insurances for shift.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.shiftId - Shift id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref20) {
       var token = _ref20.token,
           jwtToken = _ref20.jwtToken,
@@ -271,6 +457,15 @@ function shiftsFactory(_ref) {
     }
   };
   var invoices = {
+    /**
+     * GET /shifts/:shiftId/invoices - get invoices for shift.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.shiftId - Shift id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref21) {
       var token = _ref21.token,
           jwtToken = _ref21.jwtToken,
@@ -283,6 +478,15 @@ function shiftsFactory(_ref) {
     }
   };
   var deposits = {
+    /**
+     * GET /shifts/:shiftId/deposits - get deposits for shift.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.shiftId - Shift id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref22) {
       var token = _ref22.token,
           jwtToken = _ref22.jwtToken,
@@ -293,6 +497,17 @@ function shiftsFactory(_ref) {
         headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     },
+
+    /**
+     * POST /shifts/:shiftId/deposits - create a deposit for shift.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.shiftId - Shift id (ObjectId)
+     * @param {Object} opts.deposit - Deposit payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create: function create(_ref23) {
       var jwtToken = _ref23.jwtToken,
           token = _ref23.token,
@@ -309,6 +524,15 @@ function shiftsFactory(_ref) {
     }
   };
   var manualTickets = {
+    /**
+     * GET /shifts/:shiftId/manual-tickets - get manual tickets for shift.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.shiftId - Shift id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref24) {
       var token = _ref24.token,
           jwtToken = _ref24.jwtToken,
@@ -319,6 +543,17 @@ function shiftsFactory(_ref) {
         headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     },
+
+    /**
+     * POST /shifts/:shiftId/manual-tickets - create a manual ticket for shift.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.shiftId - Shift id (ObjectId)
+     * @param {Object} opts.manualTicket - Manual ticket payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create: function create(_ref25) {
       var jwtToken = _ref25.jwtToken,
           token = _ref25.token,
@@ -335,6 +570,16 @@ function shiftsFactory(_ref) {
     }
   };
   var startingBalances = {
+    /**
+     * POST /shifts/:shiftId/starting-balance - create starting balance for shift.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.shiftId - Shift id (ObjectId)
+     * @param {Object} opts.startingBalance - Starting balance payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create: function create(_ref26) {
       var jwtToken = _ref26.jwtToken,
           token = _ref26.token,
@@ -351,6 +596,16 @@ function shiftsFactory(_ref) {
     }
   };
   var purchaseLimitPayments = {
+    /**
+     * GET /shifts/:locationId/purchase-limit-payments - get purchase limit payments for location.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.locationId - Location id (ObjectId)
+     * @param {Object} [opts.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref27) {
       var token = _ref27.token,
           jwtToken = _ref27.jwtToken,
@@ -367,6 +622,16 @@ function shiftsFactory(_ref) {
     }
   };
   var salesSummary = {
+    /**
+     * GET /shifts/:shiftId/sales-summary - get sales summary for shift.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.shiftId - Shift id (ObjectId)
+     * @param {Object} [opts.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref28) {
       var token = _ref28.token,
           jwtToken = _ref28.jwtToken,
@@ -383,6 +648,15 @@ function shiftsFactory(_ref) {
     }
   };
   var commissions = {
+    /**
+     * GET /shifts/:shiftId/commissions - get commissions for shift.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.shiftId - Shift id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref29) {
       var token = _ref29.token,
           jwtToken = _ref29.jwtToken,
@@ -396,6 +670,16 @@ function shiftsFactory(_ref) {
   };
 
   var requiresAgencyShiftClosure = {
+    /**
+     * PUT /shifts/:shiftId/requires-agency-shift-closure - set requires agency shift closure.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.shiftId - Shift id (ObjectId)
+     * @param {Object} [opts.shiftData] - Shift data payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     put: function put(_ref30) {
       var token = _ref30.token,
           jwtToken = _ref30.jwtToken,