btrz-api-client 8.29.0 → 8.31.0

package/src/endpoints/inventory/getnet-terminals.js

@@ -2,7 +2,31 @@ const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
+/**
+ * Query params for GET /getnet-terminals (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} GetnetTerminalsQuery
+ * @property {number} [page] - The page number to retrieve
+ * @property {string} [stationId] - Filter terminals by station (location) ID
+ * @property {string} [serialNumber] - Filter terminals by serial number
+ */
+
+/**
+ * Factory for getnet-terminals API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, create: function, remove: function, update: function }}
+ */
 function getnetTerminalFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /getnet-terminals - list getnet terminals.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {GetnetTerminalsQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({
     token,
     jwtToken,
@@ -15,6 +39,15 @@ function getnetTerminalFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /getnet-terminals/:getnetTerminalId - get a getnet terminal. 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.getnetTerminalId - Getnet terminal id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({
     getnetTerminalId,
     token,
@@ -26,6 +59,15 @@ function getnetTerminalFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /getnet-terminals - create getnet terminal.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.getnetTerminal - Getnet terminal payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({
     jwtToken,
     token,
@@ -42,6 +84,15 @@ function getnetTerminalFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /getnet-terminals/:getnetTerminalId - remove getnet terminal. 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.getnetTerminalId - Getnet terminal id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({
     jwtToken,
     getnetTerminalId,
@@ -55,6 +106,16 @@ function getnetTerminalFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /getnet-terminals/:getnetTerminalId - update getnet terminal. 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.getnetTerminalId - Getnet terminal id
+   * @param {Object} opts.getnetTerminal - Getnet terminal payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({
     jwtToken,
     token,

package/src/endpoints/inventory/gift-certificate-definitions.js

@@ -1,6 +1,29 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /gift-certificate-definitions (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} GiftCertificateDefinitionsListQuery
+ * @property {string[]} [channels] - Filter by channels
+ * @property {string[]} [currencies] - Filter by currencies
+ * @property {string} providerId - Provider id (required by API)
+ */
+
+/**
+ * Factory for gift-certificate-definitions API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, create: function, update: function, remove: function }}
+ */
 function giftCertificateDefinitionsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /gift-certificate-definitions - list gift certificate definitions.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {GiftCertificateDefinitionsListQuery} [opts.query] - Query params (channels, currencies, providerId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, query = {}, headers}) {
     return client.get("/gift-certificate-definitions", {
       params: query,
@@ -8,6 +31,15 @@ function giftCertificateDefinitionsFactory({client, internalAuthTokenProvider})
     });
   }
 
+  /**
+   * GET /gift-certificate-definitions/:giftcertificateId - get gift certificate definition by id. 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.giftcertificateId - Gift certificate definition id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, jwtToken, giftcertificateId, query = {}, headers}) {
     return client({
       url: `/gift-certificate-definitions/${giftcertificateId}`,
@@ -17,6 +49,15 @@ function giftCertificateDefinitionsFactory({client, internalAuthTokenProvider})
     });
   }
 
+  /**
+   * POST /gift-certificate-definitions - create gift certificate definition. 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 {Object} opts.giftcertificate - Gift certificate payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({token, jwtToken, giftcertificate, query = {}, headers}) {
     return client({
       url: "/gift-certificate-definitions",
@@ -27,6 +68,16 @@ function giftCertificateDefinitionsFactory({client, internalAuthTokenProvider})
     });
   }
 
+  /**
+   * PUT /gift-certificate-definitions/:giftcertificateId - update gift certificate definition. 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.giftcertificateId - Gift certificate definition id
+   * @param {Object} opts.giftcertificate - Gift certificate payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({token, jwtToken, giftcertificateId, giftcertificate, query = {}, headers}) {
     return client({
       url: `/gift-certificate-definitions/${giftcertificateId}`,
@@ -37,6 +88,15 @@ function giftCertificateDefinitionsFactory({client, internalAuthTokenProvider})
     });
   }
 
+  /**
+   * DELETE /gift-certificate-definitions/:giftcertificateId - remove gift certificate definition. 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.giftcertificateId - Gift certificate definition id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({token, jwtToken, giftcertificateId, query = {}, headers}) {
     return client({
       url: `/gift-certificate-definitions/${giftcertificateId}`,

package/src/endpoints/inventory/healthcheck.js

@@ -1,6 +1,14 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
-
-function healthCheckFactory({client, internalAuthTokenProvider}) {
+/**
+ * Factory for healthcheck API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @returns {{ get: function }}
+ */
+function healthCheckFactory({client}) {
+  /**
+   * GET /healthcheck - health check.
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get() {
     return client({
       url: "/healthcheck",

package/src/endpoints/inventory/insurances.js

@@ -1,10 +1,33 @@
 const {
   authorizationHeaders
-} = require("./../endpoints_helpers");
+} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /insurances (btrz-api-inventory). See get-insurances getSpec().
+ * @typedef {Object} InsurancesListQuery
+ * @property {string} [productId] - Filter by product id
+ * @property {boolean} [enabled] - Filter by enabled
+ * @property {string[]} [providerIds] - Filter by provider ids
+ */
+
+/**
+ * Factory for insurances API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, create: function, get: function, update: function, remove: function }}
+ */
 function insurancesFactory({
   client, internalAuthTokenProvider
 }) {
+  /**
+   * GET /insurances - list insurances.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {InsurancesListQuery} [opts.query] - Query params (productId, enabled, providerIds)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({
     token, query = {}, headers
   }) {
@@ -16,6 +39,14 @@ function insurancesFactory({
     });
   }
 
+  /**
+   * GET /insurances/:insuranceId - get insurance by id. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.insuranceId - Insurance id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({
     token, insuranceId, headers
   }) {
@@ -26,6 +57,15 @@ function insurancesFactory({
     });
   }
 
+  /**
+   * POST /insurances - create insurance. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {Object} opts.insurance - Insurance payload
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({
     token, insurance, jwtToken, headers
   }) {
@@ -39,6 +79,16 @@ function insurancesFactory({
     });
   }
 
+  /**
+   * PUT /insurances/:insuranceId - update insurance. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {Object} opts.insurance - Insurance payload
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.insuranceId - Insurance id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({
     token, insurance, jwtToken, insuranceId, headers
   }) {
@@ -52,6 +102,15 @@ function insurancesFactory({
     });
   }
 
+  /**
+   * DELETE /insurances/:insuranceId - remove insurance. 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.insuranceId - Insurance id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({
     token, jwtToken, insuranceId, headers
   }) {
@@ -73,4 +132,4 @@ function insurancesFactory({
   };
 }
 
-module.exports = insurancesFactory;
+module.exports = insurancesFactory;

package/src/endpoints/inventory/insurancesCost.js

@@ -1,10 +1,35 @@
 const {
   authorizationHeaders
-} = require("./../endpoints_helpers");
+} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /insurances/:productId/cost (btrz-api-inventory). See GetInsuranceCostsHandler getSpec().
+ * Client merges opts.declaredValue into query.
+ * @typedef {Object} InsurancesCostQuery
+ * @property {*} declaredValue - Declared value (required by API; may be passed as opts.declaredValue)
+ * @property {string} [providerId] - Provider id
+ */
+
+/**
+ * Factory for insurances cost API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
 function insurancesCostFactory({
   client, internalAuthTokenProvider
 }) {
+  /**
+   * GET /insurances/:productId/cost - get insurance cost for product. Client merges opts.declaredValue into query.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.productId - Product id
+   * @param {*} opts.declaredValue - Declared value (required; merged into query)
+   * @param {InsurancesCostQuery} [opts.query] - Additional query params (e.g. providerId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({
     token, productId, declaredValue, query = {}, headers
   }) {

package/src/endpoints/inventory/items.js

@@ -2,7 +2,42 @@ const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /items (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} ItemsQuery
+ * @property {string} [productId] - The ids of the products to get products for
+ * @property {string} [associatedProductId] - The id of the associated products when used as an SSR
+ * @property {string} [disabled] - Filter by disabled: "true" | "false"
+ * @property {string} [type] - Filter by type: "paid_in" | "paid_out"
+ * @property {string} [providerIds] - The id of the provider to get products for
+ * @property {string} [filterToCurrentShiftLocation] - Filter items sellable in current location: "true" | "false". Requires JwtAuth
+ * @property {string} [channels] - Filter by channels (comma-separated, e.g. "backoffice,websales"). Requires JwtAuth
+ * @property {string} [currency] - The isocode of the selected currency
+ */
+
+/**
+ * Query params for GET /items/:itemId (btrz-api-inventory). See get-by-id-handler getSpec().
+ * @typedef {Object} ItemByIdQuery
+ * @property {string} [currency] - The isocode of the selected currency
+ */
+
+/**
+ * Factory for items API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, create: function, update: function, tickets: object }}
+ */
 function itemsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /items - list items.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {ItemsQuery} [opts.query] - Query params (productId, disabled, type, providerIds, channels, currency, etc.)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({
     token,
     query = {},
@@ -16,6 +51,16 @@ function itemsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /items/:itemId - get item by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.itemId - Item id (ObjectId format)
+   * @param {ItemByIdQuery} [opts.query] - Query params (currency)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({itemId, token, jwtToken, query = {}, headers}) {
     return client.get(`/items/${itemId}`, {
       params: query,
@@ -23,6 +68,15 @@ function itemsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /items - create item.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.item - Item payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({jwtToken, item, token, headers}) {
     return client({
       url: "/items",
@@ -32,6 +86,16 @@ function itemsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /items/:itemId - update item.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.itemId - Item id
+   * @param {Object} opts.item - Item payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, itemId, item, headers}) {
     return client({
       url: `/items/${itemId}`,
@@ -41,7 +105,18 @@ function itemsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /** @type {{ update: function }} */
   const tickets = {
+    /**
+     * PUT /items/:soldItemId/tickets/:ticketId - update ticket.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.soldItemId - Sold item id
+     * @param {string} opts.ticketId - Ticket id
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update({jwtToken, token, soldItemId, ticketId, headers, query}) {
       return client({
         url: `/items/${soldItemId}/tickets/${ticketId}`,

package/src/endpoints/inventory/journey-prices.js

@@ -1,15 +1,74 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function journeyPricesFactory({ client, internalAuthTokenProvider }) {
+/**
+ * Query params for GET /journey-prices (btrz-api-inventory). See get-journey-prices getSpec().
+ * @typedef {Object} JourneyPricesListQuery
+ * @property {string} providerIds - Provider IDs (required). Comma-separated for multiple
+ * @property {string} [versionIds] - Version IDs filter. Comma-separated
+ * @property {string} [productIds] - Product IDs filter. Comma-separated
+ * @property {string} [fareClassIds] - Fare class IDs. Comma-separated
+ * @property {string} [seatClassIds] - Seat class IDs. Comma-separated
+ * @property {string} [fareIds] - Fare IDs. Comma-separated
+ * @property {string} [brandIds] - Brand IDs. Comma-separated
+ * @property {string} [amenityGroupIds] - Amenity group IDs. Comma-separated
+ * @property {string} [operatingCompanyIds] - Operating company IDs. Comma-separated
+ * @property {string} [routeIds] - Route IDs. Comma-separated
+ * @property {string} [travelRoutesIds] - Travel route IDs. Comma-separated
+ * @property {string} [shiftLocationIds] - Shift location IDs. Comma-separated
+ * @property {string} [originIds] - Origin (departure) station IDs. Comma-separated
+ * @property {string} [destinationIds] - Destination (arrival) station IDs. Comma-separated
+ * @property {number} [price.min] - Min price filter
+ * @property {number} [price.max] - Max price filter
+ * @property {number} [regularPrice.min] - Min regular price filter
+ * @property {number} [regularPrice.max] - Max regular price filter
+ * @property {number} [returnPriceModifier.min] - Min return price modifier filter
+ * @property {number} [returnPriceModifier.max] - Max return price modifier filter
+ * @property {string} [currencies] - ISO 4217 codes. Comma-separated (e.g. USD,MXN)
+ * @property {string} [taxExempted] - Filter by tax exempted [true, false]
+ */
 
-  function all({ token, jwtToken, query = {}, headers }) {
+/**
+ * Query params for GET /journey-prices/:id (btrz-api-inventory). See get-journey-price getSpec().
+ * @typedef {Object} JourneyPriceGetQuery
+ * @property {boolean} [outdated] - If true, return history of updates
+ * @property {string} [versionId] - Return only this versionId (object id)
+ */
+
+/**
+ * Factory for journey-prices API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, deleteById: function, get: function, create: function, update: function }}
+ */
+function journeyPricesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /journey-prices - list journey prices.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {JourneyPricesListQuery} [opts.query] - Query params (providerIds required; see getSpec for full list)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function all({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/journey-prices",
       params: query,
-      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
+  /**
+   * GET /journey-prices/:id - get journey price by id.
+   * @param {Object} opts
+   * @param {string} opts.id - Journey price id
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {JourneyPriceGetQuery} [opts.query] - Query params (outdated, versionId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({id, token, jwtToken, query = {}, headers}) {
     return client({
       url: `/journey-prices/${id}`,
@@ -18,32 +77,59 @@ function journeyPricesFactory({ client, internalAuthTokenProvider }) {
     });
   }
 
-
-  function deleteById({ token, jwtToken, id, headers }) {
+  /**
+   * DELETE /journey-prices/:id - delete journey price. 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.id - Journey price id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function deleteById({token, jwtToken, id, headers}) {
     return client({
       url: `/journey-prices/${id}`,
       method: "delete",
-      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
-  function create({ token, jwtToken, journeyPrice, headers }) {
+  /**
+   * POST /journey-prices - create journey price. 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 {Object} opts.journeyPrice - Journey price payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function create({token, jwtToken, journeyPrice, headers}) {
     return client({
       url: "/journey-prices",
       method: "post",
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-      data: { journeyPrice }
+      data: {journeyPrice}
     });
   }
 
-  function update({ token, jwtToken, journeyPriceId, journeyPrice, headers }) {
+  /**
+   * PATCH /journey-prices/:journeyPriceId - update journey price. 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.journeyPriceId - Journey price id
+   * @param {Object} opts.journeyPrice - Journey price payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function update({token, jwtToken, journeyPriceId, journeyPrice, headers}) {
     return client({
       url: `/journey-prices/${journeyPriceId}`,
       method: "patch",
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-      data: { update: journeyPrice }
+      data: {update: journeyPrice}
     });
-  }  
+  }
 
   return {
     all,