btrz-api-client 8.49.0 → 8.50.0

package/lib/endpoints/inventory/promos.js

@@ -28,12 +28,17 @@ var _require = require("./../endpoints_helpers.js"),
  * @property {string} [orderDir] - 'asc' (1) or 'desc' (-1)
  */
 
+/**
+ * Promo rule payload for POST/PUT rule endpoints (subset; see inventory PromoRule model).
+ * @typedef {Object} PromoRulePayload
+ * @property {boolean} [requireSameOperation] - When true and minPassengersQty > 0, minimum is evaluated per journey.
+ * @property {string[]} [excludedFareTypes] - When fareId is empty and minPassengersQty > 0, passengers with these fare types are excluded from the minimum count. Must be empty when fareId is set.
+ */
+
 /**
  * Promo create / PATCH update body (subset; see inventory API models for full shape).
+ * Group-style behavior is configured per rule via minPassengersQty, requireSameOperation, and excludedFareTypes (not on the promo root).
  * @typedef {Object} PromoUpdateRequest
- * @property {boolean} [groupDiscount] - When true, min passenger rules use group semantics in sales.
- * @property {boolean} [requireSameOperation] - When true with group discount, cart context is scoped by journeyId.
- * @property {string[]} [groupDiscountEligibleFareIds] - Non-empty: only these fare IDs count toward minimum and may receive discount; empty: all fares.
  */
 
 /**
@@ -177,7 +182,7 @@ function promosFactory(_ref) {
    * @param {string} opts.promoId - Promo id
    * @param {Object} opts.operations - Array of PromoUpdateOperation (op, path, value).
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse<object>>} Resolves with PatchedPromos.
+   * @returns {Promise<import("axios").AxiosResponse<object>>} Resolves with body `{ results, promo? }`: patch outcome plus full persisted promo after a successful update (same document emitted on `promo.updated`).
    * @throws When the request fails (400/401/404/500).
    */
   function patch(_ref7) {
@@ -201,7 +206,7 @@ function promosFactory(_ref) {
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.promoId - Promo id
-   * @param {Object} opts.rule - Rule payload (PromoRule).
+   * @param {PromoRulePayload} opts.rule - Rule payload (subset of PromoRule).
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse<object>>} Resolves with Promo including new rule.
    * @throws When the request fails (400/401/404/500). Body: WRONG_DATA, INVALID_PRODUCT_ID, INVALID_FARE_ID, etc.
@@ -228,7 +233,7 @@ function promosFactory(_ref) {
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.promoId - Promo id
    * @param {string} opts.ruleId - Rule id
-   * @param {Object} opts.rule - Full rule payload (PromoRule).
+   * @param {PromoRulePayload} opts.rule - Full rule payload (subset of PromoRule).
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse<object>>} Resolves with updated Promo.
    * @throws When the request fails (400/401/404/500). Body: WRONG_DATA, INVALID_PRODUCT_ID, INVALID_FARE_ID, etc.

package/lib/endpoints/inventory/schedules.js

@@ -284,7 +284,9 @@ function schedulesFactory(_ref) {
           jwtToken = _ref11.jwtToken,
           data = _ref11.data,
           scheduleId = _ref11.scheduleId,
-          headers = _ref11.headers;
+          headers = _ref11.headers,
+          _ref11$query = _ref11.query,
+          query = _ref11$query === undefined ? {} : _ref11$query;
 
       return client({
         url: "/schedules/" + scheduleId + "/schedule-exceptions",
@@ -292,7 +294,8 @@ function schedulesFactory(_ref) {
         headers: authorizationHeaders({
           token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers
         }),
-        data: data
+        data: data,
+        params: query
       });
     },
     /**
@@ -310,14 +313,17 @@ function schedulesFactory(_ref) {
           jwtToken = _ref12.jwtToken,
           scheduleId = _ref12.scheduleId,
           exceptionId = _ref12.exceptionId,
-          headers = _ref12.headers;
+          headers = _ref12.headers,
+          _ref12$query = _ref12.query,
+          query = _ref12$query === undefined ? {} : _ref12$query;
 
       return client({
         url: "/schedules/" + scheduleId + "/schedule-exceptions/" + exceptionId,
         method: "delete",
         headers: authorizationHeaders({
           token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers
-        })
+        }),
+        params: query
       });
     },
     /**
@@ -337,7 +343,9 @@ function schedulesFactory(_ref) {
           data = _ref13.data,
           scheduleId = _ref13.scheduleId,
           exceptionId = _ref13.exceptionId,
-          headers = _ref13.headers;
+          headers = _ref13.headers,
+          _ref13$query = _ref13.query,
+          query = _ref13$query === undefined ? {} : _ref13$query;
 
       return client({
         url: "/schedules/" + scheduleId + "/schedule-exceptions/" + exceptionId,
@@ -345,7 +353,8 @@ function schedulesFactory(_ref) {
         headers: authorizationHeaders({
           token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers
         }),
-        data: data
+        data: data,
+        params: query
       });
     }
   };

package/package.json

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

package/src/endpoints/inventory/promos.js

@@ -25,12 +25,17 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  * @property {string} [orderDir] - 'asc' (1) or 'desc' (-1)
  */
 
+/**
+ * Promo rule payload for POST/PUT rule endpoints (subset; see inventory PromoRule model).
+ * @typedef {Object} PromoRulePayload
+ * @property {boolean} [requireSameOperation] - When true and minPassengersQty > 0, minimum is evaluated per journey.
+ * @property {string[]} [excludedFareTypes] - When fareId is empty and minPassengersQty > 0, passengers with these fare types are excluded from the minimum count. Must be empty when fareId is set.
+ */
+
 /**
  * Promo create / PATCH update body (subset; see inventory API models for full shape).
+ * Group-style behavior is configured per rule via minPassengersQty, requireSameOperation, and excludedFareTypes (not on the promo root).
  * @typedef {Object} PromoUpdateRequest
- * @property {boolean} [groupDiscount] - When true, min passenger rules use group semantics in sales.
- * @property {boolean} [requireSameOperation] - When true with group discount, cart context is scoped by journeyId.
- * @property {string[]} [groupDiscountEligibleFareIds] - Non-empty: only these fare IDs count toward minimum and may receive discount; empty: all fares.
  */
 
 /**
@@ -142,7 +147,7 @@ function promosFactory({client, internalAuthTokenProvider}) {
    * @param {string} opts.promoId - Promo id
    * @param {Object} opts.operations - Array of PromoUpdateOperation (op, path, value).
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse<object>>} Resolves with PatchedPromos.
+   * @returns {Promise<import("axios").AxiosResponse<object>>} Resolves with body `{ results, promo? }`: patch outcome plus full persisted promo after a successful update (same document emitted on `promo.updated`).
    * @throws When the request fails (400/401/404/500).
    */
   function patch({jwtToken, token, promoId, operations, headers}) {
@@ -160,7 +165,7 @@ function promosFactory({client, internalAuthTokenProvider}) {
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.promoId - Promo id
-   * @param {Object} opts.rule - Rule payload (PromoRule).
+   * @param {PromoRulePayload} opts.rule - Rule payload (subset of PromoRule).
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse<object>>} Resolves with Promo including new rule.
    * @throws When the request fails (400/401/404/500). Body: WRONG_DATA, INVALID_PRODUCT_ID, INVALID_FARE_ID, etc.
@@ -181,7 +186,7 @@ function promosFactory({client, internalAuthTokenProvider}) {
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.promoId - Promo id
    * @param {string} opts.ruleId - Rule id
-   * @param {Object} opts.rule - Full rule payload (PromoRule).
+   * @param {PromoRulePayload} opts.rule - Full rule payload (subset of PromoRule).
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse<object>>} Resolves with updated Promo.
    * @throws When the request fails (400/401/404/500). Body: WRONG_DATA, INVALID_PRODUCT_ID, INVALID_FARE_ID, etc.

package/src/endpoints/inventory/schedules.js

@@ -216,14 +216,15 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
-    create: ({token, jwtToken, data, scheduleId, headers}) => {
+    create: ({token, jwtToken, data, scheduleId, headers, query = {}}) => {
       return client({
         url: `/schedules/${scheduleId}/schedule-exceptions`,
         method: "post",
         headers: authorizationHeaders({
           token, jwtToken, internalAuthTokenProvider, headers
         }),
-        data
+        data,
+        params: query
       });
     },
     /**
@@ -236,13 +237,14 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
-    delete: ({token, jwtToken, scheduleId, exceptionId, headers}) => {
+    delete: ({token, jwtToken, scheduleId, exceptionId, headers, query = {}}) => {
       return client({
         url: `/schedules/${scheduleId}/schedule-exceptions/${exceptionId}`,
         method: "delete",
         headers: authorizationHeaders({
           token, jwtToken, internalAuthTokenProvider, headers
-        })
+        }),
+        params: query
       });
     },
     /**
@@ -256,14 +258,15 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
-    update: ({token, jwtToken, data, scheduleId, exceptionId, headers}) => {
+    update: ({token, jwtToken, data, scheduleId, exceptionId, headers, query = {}}) => {
       return client({
         url: `/schedules/${scheduleId}/schedule-exceptions/${exceptionId}`,
         method: "put",
         headers: authorizationHeaders({
           token, jwtToken, internalAuthTokenProvider, headers
         }),
-        data
+        data,
+        params: query
       });
     }
   };