btrz-api-client 8.30.0 → 8.31.0

package/src/endpoints/operations/waitlists.js

@@ -36,7 +36,7 @@ function waitlistsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /waitlists/:waitlistId - get waitlist by id.
+   * GET /waitlists/:waitlistId - get waitlist 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
@@ -70,7 +70,7 @@ function waitlistsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /waitlists - create waitlist.
+   * POST /waitlists - create waitlist. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol

package/src/endpoints/sales/bundles.js

@@ -2,8 +2,10 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
+ * Query params for GET /bundles (btrz-api-sales get-bundles getSpec).
  * @typedef {Object} BundlesListQuery
- * @property {string} [providerId] - Provider account ID
+ * @property {string} [providerId] - Provider account id to get bundles for
+ * @property {string} type - Filter bundles by bundle type (required)
  */
 
 /**
@@ -18,7 +20,7 @@ function bundlesFactory({client, internalAuthTokenProvider}) {
    * GET /bundles - list bundles.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {BundlesListQuery} [opts.query] - Query params
+   * @param {BundlesListQuery} [opts.query] - Query params (type required)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/sales/cancellations.js

@@ -32,7 +32,7 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 function cancellationEndpointsFactory({client, internalAuthTokenProvider}) {
   /**
-   * Creates a set of refundable items and payments to be refunded
+   * Creates a set of refundable items and payments to be refunded. API does not accept query params.
    * @param {Object} params
    * @param {string} params.token Public key
    * @param {string} params.jwtToken Auth token
@@ -70,7 +70,7 @@ function cancellationEndpointsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * Completes a pending payment for a cancellation transaction (e.g. one terminal refund).
+   * Completes a pending payment for a cancellation transaction (e.g. one terminal refund). API does not accept query params.
    * @param {Object} params
    * @param {string} params.token Public key
    * @param {string} params.jwtToken Auth token

package/src/endpoints/sales/cart-promo.js

@@ -1,11 +1,6 @@
 /* eslint-disable max-len */
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-/**
- * @typedef {Object} CartPromoQuery
- * @property {string} [providerId] - Provider account ID
- */
-
 /**
  * Factory for cart promos API (btrz-api-sales).
  * @param {Object} deps
@@ -15,12 +10,11 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function cartPromoFactory({client, internalAuthTokenProvider}) {
   /**
-   * POST /cart/:cartId/promos - add promo to cart.
+   * POST /cart/:cartId/promos - add promo to cart. 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.cartId - Cart id
-   * @param {CartPromoQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -34,12 +28,11 @@ function cartPromoFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /cart/:cartId - remove cart promo.
+   * DELETE /cart/:cartId - remove cart promo. 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.cartId - Cart id
-   * @param {CartPromoQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/sales/cart.js

@@ -2,8 +2,22 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * @typedef {Object} CartQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /cart/:cartId (btrz-api-sales get-cart getSpec).
+ * @typedef {Object} CartGetQuery
+ * @property {string} [providerId] - Provider account id
+ * @property {string} [transactionStatus] - Filter: 'created' or 'waiting_for_payment'
+ */
+
+/**
+ * Query params for POST /carts/:cartId/financing-costs (btrz-api-sales post-financingcost-handler getSpec).
+ * @typedef {Object} CartFinancingCostsCreateQuery
+ * @property {string} [providerId] - Provider id to get financing costs for
+ */
+
+/**
+ * Query params for DELETE /carts/:cartId/financing-costs (btrz-api-sales delete-financingcost-handler getSpec).
+ * @typedef {Object} CartFinancingCostsDeleteQuery
+ * @property {string} [internalId] - Internal id or code of the financing cost to match
  */
 
 /**
@@ -15,11 +29,11 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function cartFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /cart/:id - get cart by id.
+   * GET /cart/:id - get cart by id. Query: providerId, transactionStatus (per get-cart getSpec).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} opts.id - Cart id
-   * @param {string} [opts.providerId] - Provider id
+   * @param {string} [opts.providerId] - Provider id (sent as query)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -55,7 +69,7 @@ function cartFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /cart/:cartId/items - add items to cart.
+   * POST /cart/:cartId/items - add items to cart. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} opts.cartId - Cart id
@@ -74,7 +88,7 @@ function cartFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /cart/:cartId/items - delete items from cart.
+   * DELETE /cart/:cartId/items - delete items from cart. Query forwarded via opts.params if provided.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} opts.cartId - Cart id
@@ -93,7 +107,7 @@ function cartFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /carts/:cartId/paid-in-items/:itemId - delete paid-in item.
+   * DELETE /carts/:cartId/paid-in-items/:itemId - delete paid-in item. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} opts.cartId - Cart id
@@ -111,7 +125,7 @@ function cartFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /carts/:cartId/paid-in-items - delete paid-in items.
+   * DELETE /carts/:cartId/paid-in-items - delete paid-in items. Query forwarded via opts.params if provided.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} opts.cartId - Cart id
@@ -131,12 +145,11 @@ function cartFactory({client, internalAuthTokenProvider}) {
 
   const loyaltyPointsAmount = {
     /**
-     * GET /carts/:cartId/loyalty-points-amount - get loyalty points amount for cart.
+     * GET /carts/:cartId/loyalty-points-amount - get loyalty points amount for cart. 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.cartId - Cart id
-     * @param {CartQuery} [opts.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -151,7 +164,7 @@ function cartFactory({client, internalAuthTokenProvider}) {
 
 
   /**
-   * PATCH /cart/:cartId - patch cart.
+   * PATCH /cart/:cartId - patch cart. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -171,7 +184,7 @@ function cartFactory({client, internalAuthTokenProvider}) {
 
   const partialDepositStatus = {
     /**
-     * GET /cart/:shiftId/partial-deposit-status - get partial deposit status.
+     * GET /cart/:shiftId/partial-deposit-status - get partial deposit status. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -188,7 +201,7 @@ function cartFactory({client, internalAuthTokenProvider}) {
 
   const payments = {
     /**
-     * DELETE /carts/:cartId/payments - delete cart payments.
+     * DELETE /carts/:cartId/payments - delete cart payments. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} opts.cartId - Cart id
@@ -204,7 +217,7 @@ function cartFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * PUT /carts/:cartId/payments - put cart payments.
+     * PUT /carts/:cartId/payments - put cart payments. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} opts.cartId - Cart id
@@ -225,7 +238,7 @@ function cartFactory({client, internalAuthTokenProvider}) {
 
   const taxExemptPaymentMethod = {
     /**
-     * POST /carts/:cartId/tax-exempt-payment-method - set tax exempt payment method.
+     * POST /carts/:cartId/tax-exempt-payment-method - set tax exempt payment method. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} opts.cartId - Cart id
@@ -253,7 +266,7 @@ function cartFactory({client, internalAuthTokenProvider}) {
      * @param {Object} [opts.headers] - Optional headers
      * @param {string} opts.cartId - Cart id
      * @param {Object} opts.financingCost - Financing cost payload
-     * @param {CartQuery} [opts.query] - Query params
+     * @param {CartFinancingCostsCreateQuery} [opts.query] - Query params (providerId)
      * @returns {Promise<import("axios").AxiosResponse>}
      */
     create({token, jwtToken, headers, cartId, financingCost, query = {}}) {
@@ -274,7 +287,7 @@ function cartFactory({client, internalAuthTokenProvider}) {
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {Object} [opts.headers] - Optional headers
      * @param {string} opts.cartId - Cart id
-     * @param {CartQuery} [opts.query] - Query params
+     * @param {CartFinancingCostsDeleteQuery} [opts.query] - Query params (internalId)
      * @returns {Promise<import("axios").AxiosResponse>}
      */
     delete({token, jwtToken, headers, cartId, query = {}}) {

package/src/endpoints/sales/check-in-info.js

@@ -1,11 +1,6 @@
 /* eslint-disable max-len */
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-/**
- * @typedef {Object} CheckInInfoQuery
- * @property {string} [providerId] - Provider account ID
- */
-
 /**
  * Factory for check-in API (btrz-api-sales).
  * @param {Object} deps
@@ -15,13 +10,12 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function checkInInfoFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /check-in/:id - get check-in info.
+   * GET /check-in/:id - get check-in info. API does not accept query params (btrz-api-sales).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.id - Check-in id
    * @param {Object} [opts.headers] - Optional headers
-   * @param {CheckInInfoQuery} [opts.query] - Query params
    * @returns {Promise<import("axios").AxiosResponse>}
    */
   function get({token, jwtToken, id, headers, query = {}}) {

package/src/endpoints/sales/custom-fields.js

@@ -2,8 +2,9 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * @typedef {Object} CustomFieldsQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /custom-fields (btrz-api-sales get-custom-fields getSpec).
+ * @typedef {Object} CustomFieldsListQuery
+ * @property {string} [providerIds] - One or more provider account ids (comma-separated)
  */
 
 /**
@@ -18,7 +19,7 @@ function customFieldsFactory({client, internalAuthTokenProvider}) {
    * GET /custom-fields - list custom fields.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {CustomFieldsQuery} [opts.query] - Query params
+   * @param {CustomFieldsListQuery} [opts.query] - Query params (providerIds)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/sales/flexpasses.js

@@ -1,11 +1,6 @@
 /* eslint-disable max-len */
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-/**
- * @typedef {Object} FlexpassGetQuery
- * @property {string} [providerId] - Provider account ID
- */
-
 /**
  * Factory for flexpasses API (btrz-api-sales).
  * @param {Object} deps
@@ -15,12 +10,11 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function flexpassesEndpointsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /flexpasses/:flexpassId - get flexpass by id.
+   * GET /flexpasses/:flexpassId - get flexpass by id. API does not accept query params (btrz-api-sales).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.flexpassId - Flexpass id
-   * @param {FlexpassGetQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/sales/gift-certificates.js

@@ -4,8 +4,10 @@ const {
 } = require("./../endpoints_helpers.js");
 
 /**
+ * Query params for GET /gift-certificates/:GCNumber (btrz-api-sales get-gift-certificate getSpec).
  * @typedef {Object} GiftCertificateGetQuery
- * @property {string} [providerId] - Provider account ID
+ * @property {string} [providerId] - Provider account id
+ * @property {string} [cartId] - Calculate available balance for the voucher applied to the cart
  */
 
 /**
@@ -23,7 +25,7 @@ function giftCertificatesFactory({
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} opts.GCNumber - Gift certificate number
-   * @param {GiftCertificateGetQuery} [opts.query] - Query params
+   * @param {GiftCertificateGetQuery} [opts.query] - Query params (providerId, cartId)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/sales/order.js

@@ -2,14 +2,16 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
+ * Query params for POST /orders/:orderId/payments (btrz-api-sales post-payments-handler getSpec).
  * @typedef {Object} OrderPaymentsQuery
- * @property {string} channel - Channel where cart is being purchased (see API for allowed values)
- * @property {string} [providerId] - Account ID the transaction belongs to
+ * @property {string} [channel] - Channel where cart is being purchased (defaults to 'none' when not provided)
+ * @property {string} [providerId] - Account id the transaction belongs to
  */
 
 /**
+ * Query params for GET /order/:orderId (btrz-api-sales get-order getSpec).
  * @typedef {Object} OrderGetQuery
- * @property {string} [providerId] - Account ID for the order
+ * @property {string} [providerId] - Provider account id
  */
 
 /**
@@ -63,7 +65,7 @@ function orderFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts.payments - Payments payload
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {Object} [opts.headers] - Optional headers
-   * @param {OrderPaymentsQuery} [opts.query] - Query params (channel required, providerId optional)
+   * @param {OrderPaymentsQuery} [opts.query] - Query params (channel, providerId)
    * @returns {Promise<import("axios").AxiosResponse>}
    */
   function overwrite({token, orderId, payments, jwtToken, headers, query = {}}) {

package/src/endpoints/sales/parcel-quotes.js

@@ -12,7 +12,7 @@ const {
  */
 function parcelQuotesFactory({client, internalAuthTokenProvider}) {
   /**
-   * POST /parcel-quotes - get parcel quote.
+   * POST /parcel-quotes - get parcel quote. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {Object} opts.parcelQuoteData - Parcel quote request payload

package/src/endpoints/sales/payment-providers.js

@@ -2,8 +2,11 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * @typedef {Object} PaymentProvidersQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /payment-providers (btrz-api-sales get-payment-providers getSpec).
+ * @typedef {Object} PaymentProvidersListQuery
+ * @property {string} [providerId] - Provider id to get payment providers for
+ * @property {string} [channel] - Channel to get payment providers for
+ * @property {string} [enabled] - Filter by enabled [true, false]
  */
 
 /**
@@ -19,7 +22,7 @@ function paymentProvidersFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {PaymentProvidersQuery} [opts.query] - Query params
+   * @param {PaymentProvidersListQuery} [opts.query] - Query params (providerId, channel, enabled)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/sales/redeemable-items.js

@@ -2,8 +2,19 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * @typedef {Object} RedeemableItemsQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /redeemable-items/:redeemableItemId (btrz-api-sales get-redeemable-item getSpec).
+ * @typedef {Object} RedeemableItemsGetQuery
+ * @property {string} [providerId] - Provider account id
+ * @property {string} [providerIds] - One or more provider account ids (comma-separated)
+ * @property {string} [cartId] - Current cart id (item can be redeemed once per cart)
+ */
+
+/**
+ * Query params for GET /redeemable-items list (btrz-api-sales get-redeemable-items getSpec).
+ * @typedef {Object} RedeemableItemsListQuery
+ * @property {string} [ids] - Redeemable item display ID or _id, comma-separated
+ * @property {string} [providerId] - Provider account id
+ * @property {string} [cartId] - Current cart id
  */
 
 /**
@@ -18,8 +29,8 @@ function redeemableItemsFactory({client, internalAuthTokenProvider}) {
    * GET /redeemable-items/:redeemableItemId - get redeemable item by id.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {string} opts.redeemableItemId - Redeemable item id
-   * @param {RedeemableItemsQuery} [opts.query] - Query params
+   * @param {string} opts.redeemableItemId - Redeemable item display ID or _id
+   * @param {RedeemableItemsGetQuery} [opts.query] - Query params (providerId, providerIds, cartId)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -36,7 +47,7 @@ function redeemableItemsFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {RedeemableItemsQuery} [opts.query] - Query params
+   * @param {RedeemableItemsListQuery} [opts.query] - Query params (ids, providerId, cartId)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/sales/sync-entry.js

@@ -10,7 +10,7 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function syncEntryFactory({client, internalAuthTokenProvider}) {
   /**
-   * PATCH /sync-entry - patch sync entry.
+   * PATCH /sync-entry - patch sync entry. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {Object} opts.data - Request body

package/src/endpoints/sales/voucher.js

@@ -12,7 +12,7 @@ const {
  * @property {string} [productType] - Product type of the voucher
  * @property {string} [from] - Station "from" to validate if voucher has routes
  * @property {string} [to] - Station "to" to validate if voucher has routes
- * @property {string} [fareTypes] - (DEPRECATED) Validates if voucher has one fare
+ * @property {string} [fareTypes] - (DEPRECATED) Validates if voucher has one fare; use fareIds instead
  * @property {string} [fareIds] - Validates if voucher has one fare ID
  * @property {string} [displayCurrencyCode] - Display currency code for multi-currency accounts
  */