btrz-api-client 8.28.0 → 8.30.0

package/src/endpoints/operations/waitlists.js

@@ -1,6 +1,32 @@
-const {authorizationHeaders} = require("../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("../endpoints_helpers.js");
 
+/**
+ * Query params for GET /waitlists (btrz-api-operations getSpec).
+ * @typedef {Object} WaitlistsListQuery
+ * @property {number} [page] - Page number to return (20 records per page)
+ * @property {string} [originId] - Filter by origin id (24 hex chars)
+ * @property {string} [destinationId] - Filter by destination id (24 hex chars)
+ * @property {string} [dateOfTravelStr] - Filter by date of travel (YYYY-MM-DD)
+ */
+
+/**
+ * Factory for waitlists API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} waitlists API methods
+ */
 function waitlistsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /waitlists - list waitlists.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {WaitlistsListQuery} [opts.query] - page, originId, destinationId, dateOfTravelStr
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>} GetWaitlistsResponse; 400 INVALID_ORIGIN_ID, INVALID_DESTINATION_ID, INVALID_DATE_OF_TRAVEL_STR
+   */
   function all({token, jwtToken, query, headers}) {
     return client({
       url: "/waitlists",
@@ -9,6 +35,15 @@ function waitlistsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /waitlists/:waitlistId - get waitlist by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.waitlistId - Waitlist id (ObjectId)
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, jwtToken, waitlistId, headers}) {
     return client({
       url: `/waitlists/${waitlistId}`,
@@ -17,19 +52,37 @@ function waitlistsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
-  function remove({ token, jwtToken, waitlistId, headers }) {
+  /**
+   * DELETE /waitlists/:waitlistId - remove waitlist.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.waitlistId - Waitlist id (ObjectId)
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function remove({token, jwtToken, waitlistId, headers}) {
     return client({
       url: `/waitlists/${waitlistId}`,
       method: "delete",
-      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider, headers })
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
-  function create({ token, jwtToken, data, headers }) {  
+  /**
+   * POST /waitlists - create waitlist.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.data - Waitlist payload
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function create({token, jwtToken, data, headers}) {
     return client({
       url: "/waitlists",
       method: "post",
-      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider, headers }),
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
       data
     });
   }

package/src/endpoints/ratality/auth.js

@@ -1,4 +1,18 @@
+/**
+ * Factory for Ratality auth API.
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function }}
+ */
 function authFactory({client}) {
+  /**
+   * POST /authenticate - authenticate.
+   * @param {Object} opts
+   * @param {Object} opts.data - Request body
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({
     data,
     headers

package/src/endpoints/ratality/clients.js

@@ -2,7 +2,23 @@ const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for Ratality clients API.
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @param {string} deps.version - API version path
+ * @returns {{ create: function, get: function }}
+ */
 function clientsFactory({client, version}) {
+  /**
+   * POST /:version/client - create client.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.data - Request body
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({
     jwtToken,
     data,
@@ -16,6 +32,13 @@ function clientsFactory({client, version}) {
     });
   }
 
+  /**
+   * GET /:version/client - get client.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.clientId - Client id (sent as header)
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({
     jwtToken, clientId
   }) {

package/src/endpoints/ratality/integrations.js

@@ -2,7 +2,22 @@ const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for Ratality integrations API.
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @param {string} deps.version - API version path
+ * @returns {{ get: function, create: function, remove: function }}
+ */
 function integrationsFactory({client, version}) {
+  /**
+   * GET /:version/client/integrations - get client integrations.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.clientId - Client id (sent as header)
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({
     jwtToken, clientId
   }) {
@@ -13,6 +28,14 @@ function integrationsFactory({client, version}) {
     });
   }
 
+  /**
+   * POST /:version/client/integrations - create integration.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.clientId - Client id (sent as header)
+   * @param {Object} opts.data - Request body
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({
     jwtToken, clientId, data
   }) {
@@ -24,6 +47,14 @@ function integrationsFactory({client, version}) {
     });
   }
 
+  /**
+   * DELETE /:version/client/integrations/:integrationType - remove integration.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.clientId - Client id (sent as header)
+   * @param {string} opts.integrationType - Integration type
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({
     jwtToken, clientId, integrationType
   }) {

package/src/endpoints/reports/custom-reports.js

@@ -1,16 +1,49 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function customReportsFactory({ client, internalAuthTokenProvider }) {
-  function create({token, customReport, jwtToken, headers }) {
+/**
+ * Query params for GET /custom-reports (btrz-api-reports). Documented from client; backend may support pagination/filters.
+ * @typedef {Object} CustomReportsListQuery
+ * @property {number} [page] - Page (if supported)
+ * @property {number} [recordsPerPage] - Records per page (if supported)
+ */
+
+/**
+ * Factory for custom reports API (btrz-api-reports).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function, all: function, remove: function }}
+ */
+function customReportsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * POST /custom-reports - create custom report.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.customReport - Custom report payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function create({token, customReport, jwtToken, headers}) {
     return client({
       url: "/custom-reports",
       method: "post",
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-      data: { customReport }
+      data: {customReport}
     });
   }
 
-  function all({token, jwtToken, query = {}, headers }) {
+  /**
+   * GET /custom-reports - list custom reports.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {CustomReportsListQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function all({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/custom-reports",
       params: query,
@@ -18,6 +51,15 @@ function customReportsFactory({ client, internalAuthTokenProvider }) {
     });
   }
 
+  /**
+   * DELETE /custom-reports/:customReportId - remove custom report.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.customReportId - Custom report id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({token, jwtToken, customReportId, headers}) {
     return client({
       url: `/custom-reports/${customReportId}`,

package/src/endpoints/reports/email.js

@@ -1,6 +1,23 @@
+/* eslint-disable max-len */
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for report email API (btrz-api-reports).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ post: function }}
+ */
 function reportEmailFactory({client, internalAuthTokenProvider}) {
+  /**
+   * POST /email - send report email.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.report - Report payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function post({token, jwtToken, report, headers}) {
     return client({
       url: "/email",

package/src/endpoints/reports/report-types.js

@@ -1,15 +1,41 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function reportTypesFactory({ client, internalAuthTokenProvider }) {
-
-  function get({ token, jwtToken, id, headers }) {
+/**
+ * Factory for report types API (btrz-api-reports).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, getByName: function }}
+ */
+function reportTypesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /types/:id - get report type by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Report type id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function get({token, jwtToken, id, headers}) {
     return client({
       url: `/types/${id}`,
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
-  function getByName({ token, jwtToken, name, headers }) { //deprecated
+  /**
+   * GET /types?name=:name - get report type by name.
+   * @deprecated Prefer get by id
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.name - Report type name
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function getByName({token, jwtToken, name, headers}) {
     return client({
       url: `/types?name=${name}`,
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})

package/src/endpoints/reports/trip-manifests.js

@@ -1,7 +1,31 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function tripManifestsFactory({ client, internalAuthTokenProvider }) {
-  function all({token, jwtToken, query = {}, headers }) {
+/**
+ * Query params for GET /trip-manifests (btrz-api-reports). Documented from client; backend may support pagination/filters.
+ * @typedef {Object} TripManifestsListQuery
+ * @property {number} [page] - Page (if supported)
+ * @property {number} [recordsPerPage] - Records per page (if supported)
+ */
+
+/**
+ * Factory for trip manifests reports API (btrz-api-reports).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function }}
+ */
+function tripManifestsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /trip-manifests - list trip manifests.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {TripManifestsListQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function all({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/trip-manifests",
       params: query,

package/src/endpoints/sales/bundles.js

@@ -1,9 +1,29 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function bundlesFactory({ client, internalAuthTokenProvider }) {
+/**
+ * @typedef {Object} BundlesListQuery
+ * @property {string} [providerId] - Provider account ID
+ */
 
-  function all({ token, query = {}, headers }) {
-    return client.get(`/bundles`, {
+/**
+ * Factory for bundles API (btrz-api-sales).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function }}
+ */
+function bundlesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /bundles - list bundles.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {BundlesListQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function all({token, query = {}, headers}) {
+    return client.get("/bundles", {
       params: query,
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
     });

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

@@ -1,9 +1,31 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function cartPromoFactory({ client, internalAuthTokenProvider }) {
+/**
+ * @typedef {Object} CartPromoQuery
+ * @property {string} [providerId] - Provider account ID
+ */
 
-  function create({ token, jwtToken, cartId, query = {}, headers }) {
-    return client({ 
+/**
+ * Factory for cart promos API (btrz-api-sales).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function, remove: function }}
+ */
+function cartPromoFactory({client, internalAuthTokenProvider}) {
+  /**
+   * POST /cart/:cartId/promos - add promo to cart.
+   * @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>}
+   */
+  function create({token, jwtToken, cartId, query = {}, headers}) {
+    return client({
       url: `/cart/${cartId}/promos`,
       method: "post",
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
@@ -11,7 +33,17 @@ function cartPromoFactory({ client, internalAuthTokenProvider }) {
     });
   }
 
-  function remove({ token, jwtToken, cartId, query = {}, headers }) {
+  /**
+   * DELETE /cart/:cartId - remove cart promo.
+   * @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>}
+   */
+  function remove({token, jwtToken, cartId, query = {}, headers}) {
     return client({
       url: `/cart/${cartId}`,
       method: "delete",
@@ -20,10 +52,10 @@ function cartPromoFactory({ client, internalAuthTokenProvider }) {
     });
   }
 
-  return { 
+  return {
     create,
     remove
   };
 }
 
-module.exports = cartPromoFactory;
+module.exports = cartPromoFactory;