btrz-api-client 8.30.0 → 8.32.0

package/lib/endpoints/inventory/operation-messages.js

@@ -4,8 +4,17 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * Query params for operation-messages endpoints (btrz-api-inventory). Forwarded to API as-is.
- * @typedef {Object} InventoryOperationMessagesQuery
+ * Query params for GET /operation-messages (btrz-api-inventory). See get-operation-messages getSpec().
+ * @typedef {Object} OperationMessagesListQuery
+ * @property {string} [providerId] - Provider id to get operation messages for
+ * @property {number} [page] - Page number (default 1)
+ * @property {string} [name] - Full or partial name (non case sensitive)
+ * @property {string} [type] - Operation message type
+ * @property {string} [stationId] - Station id of the operation message
+ * @property {string} [avoidPagination] - Any value = true to avoid pagination
+ * @property {string} [active] - Filter active/inactive [true, false]
+ * @property {string} [effectiveDateTimeStartBefore] - ISO datetime (start before/at)
+ * @property {string} [effectiveDateTimeEndAfter] - ISO datetime (end after/at)
  */
 
 /**
@@ -25,7 +34,7 @@ function operationMessagesFactory(_ref) {
    * GET /operation-messages - list operation messages.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {InventoryOperationMessagesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {OperationMessagesListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -44,7 +53,7 @@ function operationMessagesFactory(_ref) {
   }
 
   /**
-   * POST /operation-messages - create operation message.
+   * POST /operation-messages - create operation message. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -67,7 +76,7 @@ function operationMessagesFactory(_ref) {
   }
 
   /**
-   * PUT /operation-messages/:operationMessageId - update operation message.
+   * PUT /operation-messages/:operationMessageId - update operation message. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -92,7 +101,7 @@ function operationMessagesFactory(_ref) {
   }
 
   /**
-   * GET /operation-messages/:operationMessageId - get operation message by id.
+   * GET /operation-messages/:operationMessageId - get operation message by id. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} opts.operationMessageId - Operation message id
@@ -112,7 +121,7 @@ function operationMessagesFactory(_ref) {
   }
 
   /**
-   * DELETE /operation-messages/:operationMessageId - remove operation message.
+   * DELETE /operation-messages/:operationMessageId - remove operation message. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.operationMessageId - Operation message id

package/lib/endpoints/inventory/operation-reasons.js

@@ -3,6 +3,12 @@
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /operation-reasons (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} OperationReasonsListQuery
+ * @property {number} [page] - The page number to retrieve
+ */
+
 /**
  * Factory for operation-reasons API (btrz-api-inventory).
  * @param {Object} deps
@@ -21,7 +27,7 @@ function operationReasonFactory(_ref) {
    * @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 {OperationReasonsListQuery} [opts.query] - Query params (page)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -41,12 +47,11 @@ function operationReasonFactory(_ref) {
   }
 
   /**
-   * GET /operation-reasons/:id - get operation reason by id.
+   * GET /operation-reasons/:id - get operation reason 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.id - Operation reason id
-   * @param {Object} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -67,13 +72,12 @@ function operationReasonFactory(_ref) {
   }
 
   /**
-   * PUT /operation-reasons/:id - update operation reason.
+   * PUT /operation-reasons/:id - update operation reason. 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 - Operation reason id
    * @param {Object} opts.operationReason - Operation reason payload
-   * @param {Object} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -96,12 +100,11 @@ function operationReasonFactory(_ref) {
   }
 
   /**
-   * DELETE /operation-reasons/:id - remove operation reason.
+   * DELETE /operation-reasons/:id - remove operation reason. 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 - Operation reason id
-   * @param {Object} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -122,12 +125,11 @@ function operationReasonFactory(_ref) {
   }
 
   /**
-   * POST /operation-reasons - create operation reason.
+   * POST /operation-reasons - create operation reason. 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.operationReason - Operation reason payload
-   * @param {Object} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/lib/endpoints/inventory/parcel-zones.js

@@ -4,8 +4,9 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * Query params for parcel-zones endpoints (btrz-api-inventory). Forwarded to API as-is.
- * @typedef {Object} InventoryParcelZonesQuery
+ * Query params for GET /parcel-zones (btrz-api-inventory). See get-parcel-zones getSpec().
+ * @typedef {Object} ParcelZonesListQuery
+ * @property {string} [providerIds] - Provider IDs to get parcel zones for
  */
 
 /**
@@ -25,7 +26,7 @@ function parcelZonesFactory(_ref) {
    * GET /parcel-zones - list parcel zones.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {InventoryParcelZonesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {ParcelZonesListQuery} [opts.query] - Query params (providerIds)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -42,7 +43,7 @@ function parcelZonesFactory(_ref) {
   }
 
   /**
-   * POST /parcel-zones - create parcel zone.
+   * POST /parcel-zones - create parcel zone. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {Object} opts.parcelZone - Parcel zone payload
@@ -65,7 +66,7 @@ function parcelZonesFactory(_ref) {
   }
 
   /**
-   * PUT /parcel-zone/:parcelZoneId - update parcel zone.
+   * PUT /parcel-zone/:parcelZoneId - update parcel zone. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} [opts.token] - API key

package/lib/endpoints/inventory/pay-on-accounts.js

@@ -4,8 +4,14 @@ var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * @typedef {Object} PayOnAccountsQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /pay-on-accounts (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} PayOnAccountsListQuery
+ * @property {number} [page] - Page number
+ * @property {string} [format] - Format to retrieve the data
+ * @property {string} [disabled] - Filter by disabled [true, false]
+ * @property {string} [term] - Search term to filter PayOnAccounts
+ * @property {string} [fareIds] - Fare ids to filter
+ * @property {string} [providerId] - Provider id to filter
  */
 
 /**
@@ -26,7 +32,7 @@ function payOnAccountsFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {PayOnAccountsQuery} [opts.query] - Query params
+   * @param {PayOnAccountsListQuery} [opts.query] - Query params
    * @param {string} [opts.responseType] - Response type (e.g. json)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}

package/lib/endpoints/inventory/payment-terminals.js

@@ -3,11 +3,6 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
-/**
- * Query params for payment-terminals endpoints (btrz-api-inventory). Forwarded to API as-is.
- * @typedef {Object} InventoryPaymentTerminalsQuery
- */
-
 /**
  * Factory for payment-terminals API (btrz-api-inventory).
  * @param {Object} deps
@@ -22,10 +17,9 @@ function paymentTerminalFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /payment-terminals - list payment terminals.
+   * GET /payment-terminals - list payment terminals. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {InventoryPaymentTerminalsQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -42,7 +36,7 @@ function paymentTerminalFactory(_ref) {
   }
 
   /**
-   * GET /payment-terminals/:paymentTerminalId - get payment terminal by id.
+   * GET /payment-terminals/:paymentTerminalId - get payment terminal by id. API does not accept query params.
    * @param {Object} opts
    * @param {string} opts.paymentTerminalId - Payment terminal id
    * @param {string} [opts.token] - API key
@@ -60,7 +54,7 @@ function paymentTerminalFactory(_ref) {
   }
 
   /**
-   * POST /payment-terminals - create payment terminal.
+   * POST /payment-terminals - create payment terminal. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} [opts.token] - API key
@@ -85,7 +79,7 @@ function paymentTerminalFactory(_ref) {
   }
 
   /**
-   * DELETE /payment-terminals/:paymentTerminalId - remove payment terminal.
+   * DELETE /payment-terminals/:paymentTerminalId - remove payment terminal. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.paymentTerminalId - Payment terminal id
@@ -107,7 +101,7 @@ function paymentTerminalFactory(_ref) {
   }
 
   /**
-   * PUT /payment-terminals/:paymentTerminalId - update payment terminal.
+   * PUT /payment-terminals/:paymentTerminalId - update payment terminal. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} [opts.token] - API key

package/lib/endpoints/inventory/prisma-terminals.js

@@ -4,8 +4,12 @@ var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * @typedef {Object} InventoryPrismaTerminalsQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /prisma-terminals (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} PrismaTerminalsListQuery
+ * @property {number} [page] - Page number
+ * @property {string} [providerId] - Account provider (operator) ID
+ * @property {string} [name] - Filter by terminal name (exact match)
+ * @property {string} [externalId] - Filter by terminal externalId (exact match)
  */
 
 /**
@@ -26,7 +30,7 @@ function prismaTerminalFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {InventoryPrismaTerminalsQuery} [opts.query] - Query params
+   * @param {PrismaTerminalsListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -64,7 +68,7 @@ function prismaTerminalFactory(_ref) {
   }
 
   /**
-   * POST /prisma-terminals - create prisma terminal.
+   * POST /prisma-terminals - create prisma 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
@@ -89,7 +93,7 @@ function prismaTerminalFactory(_ref) {
   }
 
   /**
-   * DELETE /prisma-terminals/:prismaTerminalId - remove prisma terminal.
+   * DELETE /prisma-terminals/:prismaTerminalId - remove prisma 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
@@ -111,7 +115,7 @@ function prismaTerminalFactory(_ref) {
   }
 
   /**
-   * PUT /prisma-terminals/:prismaTerminalId - update prisma terminal.
+   * PUT /prisma-terminals/:prismaTerminalId - update prisma 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

package/lib/endpoints/inventory/products.js

@@ -3,6 +3,31 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /products (btrz-api-inventory). See get-products getSpec().
+ * @typedef {Object} ProductsListQuery
+ * @property {string} [providerIds] - Provider IDs to get products for
+ * @property {string} [channels] - Filter by channels
+ * @property {string} [enabled] - 'true', 'false' or 'any' (default 'true')
+ * @property {string} [pricingType] - One of point-to-point, distance, journey, etc.
+ * @property {string} [hasRoutes] - 'true' or 'false' (deprecated, use family)
+ * @property {string} [hasDates] - 'true' or 'false' (deprecated)
+ * @property {string} [hasPassengerInfo] - 'true' or 'false' (deprecated)
+ * @property {string} [isParcel] - 'true' or 'false' (deprecated)
+ * @property {string} [family] - One of bundle, parcel, paid in, paid out, reservation, flexpass, ticket
+ * @property {string} [domain] - Filter by domain
+ * @property {string} [parentProductId] - Child products of this parent
+ * @property {string} [dynamicFormId] - Filter by dynamic form
+ */
+
+/**
+ * Query params for GET /products/:productId (btrz-api-inventory). See get-products-id getSpec().
+ * @typedef {Object} ProductGetQuery
+ * @property {string} [providerIds] - Provider IDs to get product for
+ * @property {string} [channels] - Filter by channels
+ * @property {string} [enabled] - 'true', 'false' or 'any'
+ */
+
 /**
  * Factory for products API (btrz-api-inventory).
  * @param {Object} deps
@@ -21,7 +46,7 @@ function productsFactory(_ref) {
    * @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 {ProductsListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -44,7 +69,7 @@ function productsFactory(_ref) {
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.productId - Product id
-   * @param {Object} [opts.query] - Query params
+   * @param {ProductGetQuery} [opts.query] - Query params (providerIds, channels, enabled)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -64,7 +89,7 @@ function productsFactory(_ref) {
   }
 
   /**
-   * POST /products - create product.
+   * POST /products - create product. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -87,7 +112,7 @@ function productsFactory(_ref) {
   }
 
   /**
-   * PUT /products/:productId - update product.
+   * PUT /products/:productId - update product. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -114,7 +139,7 @@ function productsFactory(_ref) {
   /** @type {{ remove: function }} */
   var domains = {
     /**
-     * DELETE /products/domains/:domain - remove product domain.
+     * DELETE /products/domains/:domain - remove product domain. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -139,11 +164,10 @@ function productsFactory(_ref) {
   /** @type {{ all: function }} */
   var families = {
     /**
-     * GET /products/families - list product families.
+     * GET /products/families - list product families. 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.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */

package/lib/endpoints/inventory/promos.js

@@ -5,8 +5,27 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * Query params for promos endpoints (btrz-api-inventory). Forwarded to API as-is.
- * @typedef {Object} InventoryPromosQuery
+ * Query params for GET /promos (btrz-api-inventory). See get-promos getSpec().
+ * @typedef {Object} PromosListQuery
+ * @property {string} [providerIds] - Provider IDs to get promos for
+ * @property {string} [productId] - Product id
+ * @property {string} [productIds] - Comma-separated product IDs (mutually exclusive with productId)
+ * @property {string} [promoCode] - Promo internal id
+ * @property {string} [name] - Promo name
+ * @property {string} [campaign] - Campaign the promo belongs to
+ * @property {string} [origin] - Departure station name
+ * @property {string} [destination] - Destination station name
+ * @property {string} [fareIds] - Comma-separated fare IDs
+ * @property {string} [tripType] - 'oneway' or 'roundtrip'
+ * @property {string} [channels] - Filter by channels (mandatory if promoCode not given)
+ * @property {boolean} [autoApply] - Filter only auto-applied promos
+ * @property {string} [includeExpired] - Include expired promos (deprecated)
+ * @property {string} [searchOutboundTravelDate] - Outbound travel date for validity
+ * @property {string} [searchReturnTravelDate] - Return travel date for validity
+ * @property {string} [qty] - Number of tickets
+ * @property {number} [page] - Page for pagination
+ * @property {string} [orderBy] - Field to order by
+ * @property {string} [orderDir] - 'asc' (1) or 'desc' (-1)
  */
 
 /**
@@ -27,7 +46,7 @@ function promosFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {InventoryPromosQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {PromosListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -44,12 +63,11 @@ function promosFactory(_ref) {
   }
 
   /**
-   * GET /promos/:promoId - get promo by id.
+   * GET /promos/:promoId - get promo 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.promoId - Promo id
-   * @param {InventoryPromosQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -67,7 +85,7 @@ function promosFactory(_ref) {
   }
 
   /**
-   * POST /promos - create promo.
+   * POST /promos - create 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
@@ -90,7 +108,7 @@ function promosFactory(_ref) {
   }
 
   /**
-   * DELETE /promos/:promoId - remove promo.
+   * DELETE /promos/:promoId - remove 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
@@ -112,7 +130,7 @@ function promosFactory(_ref) {
   }
 
   /**
-   * PATCH /promos/:promoId - update promo.
+   * PATCH /promos/:promoId - update 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
@@ -138,7 +156,7 @@ function promosFactory(_ref) {
   }
 
   /**
-   * PATCH /promo/:promoId - patch promo with operations.
+   * PATCH /promo/:promoId - patch promo with operations. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -163,7 +181,7 @@ function promosFactory(_ref) {
   }
 
   /**
-   * POST /promos/:promoId/rules - add promo rule.
+   * POST /promos/:promoId/rules - add promo rule. 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 +206,7 @@ function promosFactory(_ref) {
   }
 
   /**
-   * PUT /promos/:promoId/rules/:ruleId - update promo rule.
+   * PUT /promos/:promoId/rules/:ruleId - update promo rule. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol