btrz-api-client 8.29.0 → 8.31.0

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

@@ -3,10 +3,37 @@
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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)
+ */
+
+/**
+ * Factory for prisma-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, update: function, remove: function }}
+ */
+
+
 function prismaTerminalFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /prisma-terminals - list prisma terminals.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {PrismaTerminalsListQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -20,6 +47,15 @@ function prismaTerminalFactory(_ref) {
     });
   }
 
+  /**
+   * GET /prisma-terminals/:prismaTerminalId - get prisma terminal by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.prismaTerminalId - Prisma terminal id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var prismaTerminalId = _ref3.prismaTerminalId,
         token = _ref3.token,
@@ -31,6 +67,15 @@ function prismaTerminalFactory(_ref) {
     });
   }
 
+  /**
+   * 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
+   * @param {Object} opts.prismaTerminal - Prisma terminal payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var jwtToken = _ref4.jwtToken,
         token = _ref4.token,
@@ -47,6 +92,15 @@ function prismaTerminalFactory(_ref) {
     });
   }
 
+  /**
+   * 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
+   * @param {string} opts.prismaTerminalId - Prisma terminal id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove(_ref5) {
     var jwtToken = _ref5.jwtToken,
         prismaTerminalId = _ref5.prismaTerminalId,
@@ -60,6 +114,16 @@ function prismaTerminalFactory(_ref) {
     });
   }
 
+  /**
+   * 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
+   * @param {string} opts.prismaTerminalId - Prisma terminal id
+   * @param {Object} opts.prismaTerminal - Prisma terminal payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref6) {
     var jwtToken = _ref6.jwtToken,
         token = _ref6.token,

package/lib/endpoints/inventory/products.js

@@ -3,10 +3,53 @@
 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
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, create: function, update: function, families: object, domains: object }}
+ */
+
+
 function productsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /products - list products.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {ProductsListQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,
@@ -20,6 +63,16 @@ function productsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /products/:productId - get product by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.productId - Product id
+   * @param {ProductGetQuery} [opts.query] - Query params (providerIds, channels, enabled)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var productId = _ref3.productId,
         token = _ref3.token,
@@ -35,6 +88,15 @@ function productsFactory(_ref) {
     });
   }
 
+  /**
+   * 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
+   * @param {Object} opts.data - Product payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var data = _ref4.data,
         token = _ref4.token,
@@ -49,6 +111,16 @@ function productsFactory(_ref) {
     });
   }
 
+  /**
+   * 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
+   * @param {string} opts.productId - Product id
+   * @param {Object} opts.data - Product payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref5) {
     var productId = _ref5.productId,
         data = _ref5.data,
@@ -64,7 +136,17 @@ function productsFactory(_ref) {
     });
   }
 
+  /** @type {{ remove: function }} */
   var domains = {
+    /**
+     * 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
+     * @param {string} opts.domain - Domain
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     remove: function remove(_ref6) {
       var token = _ref6.token,
           jwtToken = _ref6.jwtToken,
@@ -79,7 +161,16 @@ function productsFactory(_ref) {
     }
   };
 
+  /** @type {{ all: function }} */
   var 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.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     all: function all(_ref7) {
       var token = _ref7.token,
           _ref7$query = _ref7.query,

package/lib/endpoints/inventory/promos.js

@@ -1,12 +1,55 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+/* eslint-disable max-len */
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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)
+ */
+
+/**
+ * Factory for promos 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, patch: function, remove: function, addRule: function, updateRule: function }}
+ */
+
+
 function promosFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /promos - list promos.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {PromosListQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,
@@ -19,6 +62,15 @@ function promosFactory(_ref) {
     });
   }
 
+  /**
+   * 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 {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var promoId = _ref3.promoId,
         token = _ref3.token,
@@ -32,6 +84,15 @@ function promosFactory(_ref) {
     });
   }
 
+  /**
+   * 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
+   * @param {Object} opts.promo - Promo payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var jwtToken = _ref4.jwtToken,
         promo = _ref4.promo,
@@ -46,6 +107,15 @@ function promosFactory(_ref) {
     });
   }
 
+  /**
+   * 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
+   * @param {string} opts.promoId - Promo id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove(_ref5) {
     var jwtToken = _ref5.jwtToken,
         promoId = _ref5.promoId,
@@ -59,6 +129,17 @@ function promosFactory(_ref) {
     });
   }
 
+  /**
+   * 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
+   * @param {string} opts.promoId - Promo id
+   * @param {Object} opts.update - Update payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  // eslint-disable-next-line no-shadow
   function update(_ref6) {
     var jwtToken = _ref6.jwtToken,
         token = _ref6.token,
@@ -74,6 +155,16 @@ function promosFactory(_ref) {
     });
   }
 
+  /**
+   * 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
+   * @param {string} opts.promoId - Promo id
+   * @param {Object} opts.operations - Patch operations
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function patch(_ref7) {
     var jwtToken = _ref7.jwtToken,
         token = _ref7.token,
@@ -89,6 +180,16 @@ function promosFactory(_ref) {
     });
   }
 
+  /**
+   * 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
+   * @param {string} opts.promoId - Promo id
+   * @param {Object} opts.rule - Rule payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function addRule(_ref8) {
     var jwtToken = _ref8.jwtToken,
         token = _ref8.token,
@@ -104,6 +205,17 @@ function promosFactory(_ref) {
     });
   }
 
+  /**
+   * 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
+   * @param {string} opts.promoId - Promo id
+   * @param {string} opts.ruleId - Rule id
+   * @param {Object} opts.rule - Rule payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function updateRule(_ref9) {
     var jwtToken = _ref9.jwtToken,
         token = _ref9.token,