btrz-api-client 8.29.0 → 8.30.0

package/lib/endpoints/inventory/station-classes.js

@@ -3,10 +3,28 @@
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for station-classes API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, update: function, remove: function, create: function }}
+ */
+
+
 function stationClassFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /station-classes - list station classes.
+   * @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>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -22,6 +40,16 @@ function stationClassFactory(_ref) {
     });
   }
 
+  /**
+   * GET /station-classes/:stationClassId - get station class by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.stationClassId - Station class id
+   * @param {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -38,6 +66,16 @@ function stationClassFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /station-classes/:stationClassId - update station class.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.stationClassId - Station class id
+   * @param {Object} opts.data - Station class payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -53,6 +91,15 @@ function stationClassFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /station-classes/:stationClassId - remove station class.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.stationClassId - Station class id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,
@@ -66,6 +113,15 @@ function stationClassFactory(_ref) {
     });
   }
 
+  /**
+   * POST /station-classes - create station class.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.data - Station class payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref6) {
     var token = _ref6.token,
         jwtToken = _ref6.jwtToken,

package/lib/endpoints/inventory/station-groups.js

@@ -3,10 +3,33 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @typedef {Object} StationGroupsQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * Factory for station-groups API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function }}
+ */
+
+
 function stationGroupsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /station-groups - list station groups.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {StationGroupsQuery} [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,

package/lib/endpoints/inventory/stations-provinces.js

@@ -3,10 +3,33 @@
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @typedef {Object} StationsProvincesQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * Factory for stations/provinces API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function }}
+ */
+
+
 function stationsProvincesFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /stations/provinces - list station provinces.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {StationsProvincesQuery} [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,

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

@@ -3,10 +3,33 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @typedef {Object} StationsZonesQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * Factory for stations/zones API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
+
+
 function stationsZonesFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /stations/zones - get station zones.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {StationsZonesQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,

package/lib/endpoints/inventory/stations.js

@@ -1,12 +1,35 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @typedef {Object} StationsQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * Factory for stations API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, all: function, create: function, update: function }}
+ */
+
+
 function stationsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /stations/:id - get station by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Station id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref2) {
     var token = _ref2.token,
         id = _ref2.id,
@@ -17,6 +40,15 @@ function stationsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /stations - list stations.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {StationsQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref3) {
     var token = _ref3.token,
         _ref3$query = _ref3.query,
@@ -29,6 +61,15 @@ function stationsFactory(_ref) {
     });
   }
 
+  /**
+   * POST /stations - create station.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.data - Station payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -45,6 +86,16 @@ function stationsFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /station/:stationId - update station.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.stationId - Station id
+   * @param {Object} opts.station - Station payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,

package/lib/endpoints/inventory/taxes.js

@@ -1,13 +1,35 @@
 "use strict";
 
-var _require = require("../endpoints_helpers"),
+var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @typedef {Object} TaxesQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * Factory for taxes 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, exceptions: object }}
+ */
+
+
 function taxesFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
-
+  /**
+   * GET /taxes - list taxes.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {TaxesQuery} [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 +42,16 @@ function taxesFactory(_ref) {
     });
   }
 
+  /**
+   * GET /taxes/:taxId - get tax by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.taxId - Tax id
+   * @param {TaxesQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var taxId = _ref3.taxId,
         token = _ref3.token,
@@ -33,6 +65,15 @@ function taxesFactory(_ref) {
     });
   }
 
+  /**
+   * POST /taxes - create tax.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.tax - Tax payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var jwtToken = _ref4.jwtToken,
         tax = _ref4.tax,
@@ -47,6 +88,16 @@ function taxesFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /taxes/:taxId - update tax.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.taxId - Tax id
+   * @param {Object} opts.tax - Tax payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref5) {
     var jwtToken = _ref5.jwtToken,
         token = _ref5.token,
@@ -62,7 +113,17 @@ function taxesFactory(_ref) {
     });
   }
 
+  /** @type {{ create: function, update: function, get: function, all: function, delete: function }} */
   var exceptions = {
+    /**
+     * POST /taxes/exceptions - create tax exception.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {Object} opts.taxException - Tax exception payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create: function create(_ref6) {
       var jwtToken = _ref6.jwtToken,
           token = _ref6.token,
@@ -76,6 +137,17 @@ function taxesFactory(_ref) {
         data: taxException
       });
     },
+
+    /**
+     * PUT /taxes/exceptions/:taxExceptionId - update tax exception.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.taxExceptionId - Tax exception id
+     * @param {Object} opts.taxException - Tax exception payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update: function update(_ref7) {
       var jwtToken = _ref7.jwtToken,
           token = _ref7.token,
@@ -90,6 +162,16 @@ function taxesFactory(_ref) {
         data: taxException
       });
     },
+
+    /**
+     * GET /taxes/exceptions/:taxExceptionId - get tax exception.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.taxExceptionId - Tax exception id
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref8) {
       var jwtToken = _ref8.jwtToken,
           token = _ref8.token,
@@ -101,6 +183,16 @@ function taxesFactory(_ref) {
         headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     },
+
+    /**
+     * GET /taxes/exceptions - list tax exceptions.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {TaxesQuery} [opts.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     all: function all(_ref9) {
       var jwtToken = _ref9.jwtToken,
           token = _ref9.token,
@@ -114,6 +206,16 @@ function taxesFactory(_ref) {
         headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     },
+
+    /**
+     * DELETE /taxes/exceptions/:taxExceptionId - delete tax exception.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.taxExceptionId - Tax exception id
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     delete: function _delete(_ref10) {
       var jwtToken = _ref10.jwtToken,
           token = _ref10.token,

package/lib/endpoints/inventory/travel-routes.js

@@ -1,12 +1,35 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @typedef {Object} TravelRoutesQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * Factory for travel-routes 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 }}
+ */
+
+
 function travelRoutesFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /travel-routes - list travel routes.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {TravelRoutesQuery} [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 +43,15 @@ function travelRoutesFactory(_ref) {
     });
   }
 
+  /**
+   * GET /travel-routes/:travelRouteId - get travel route by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.travelRouteId - Travel route id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var travelRouteId = _ref3.travelRouteId,
         jwtToken = _ref3.jwtToken,
@@ -31,6 +63,15 @@ function travelRoutesFactory(_ref) {
     });
   }
 
+  /**
+   * POST /travel-routes - create travel route.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.travelRoute - Travel route payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var jwtToken = _ref4.jwtToken,
         token = _ref4.token,
@@ -47,6 +88,16 @@ function travelRoutesFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /travel-routes/:travelRouteId - update travel route.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.travelRouteId - Travel route id
+   * @param {Object} opts.travelRoute - Travel route payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref5) {
     var jwtToken = _ref5.jwtToken,
         token = _ref5.token,

package/lib/endpoints/inventory/traveller-card-providers-types.js

@@ -1,12 +1,34 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for traveller-card-providers-types endpoints (btrz-api-inventory). Forwarded to API as-is.
+ * @typedef {Object} InventoryTravellerCardProvidersTypesQuery
+ */
+
+/**
+ * Factory for traveller-card-providers types API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function }}
+ */
+
+
 function travellerCardProvidersTypesFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /traveller-card-providers/types - list traveller card provider types.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {InventoryTravellerCardProvidersTypesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,

package/lib/endpoints/inventory/traveller-card-providers.js

@@ -1,12 +1,35 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /traveller-card-providers (btrz-api-inventory). Forwarded to API as-is.
+ * @typedef {Object} InventoryTravellerCardProvidersListQuery
+ */
+
+/**
+ * Factory for traveller-card-providers API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, create: function, update: function, get: function }}
+ */
+
+
 function travellerCardProvidersFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /traveller-card-providers - list traveller card providers.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {InventoryTravellerCardProvidersListQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -21,6 +44,15 @@ function travellerCardProvidersFactory(_ref) {
     });
   }
 
+  /**
+   * POST /traveller-card-providers - create traveller card provider.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.travellerCardProvider - Traveller card provider payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -35,6 +67,16 @@ function travellerCardProvidersFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /traveller-card-providers/:travellerCardProviderId - update traveller card provider.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.travellerCardProviderId - Traveller card provider id
+   * @param {Object} opts.travellerCardProvider - Traveller card provider payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref4) {
     var jwtToken = _ref4.jwtToken,
         token = _ref4.token,
@@ -50,6 +92,15 @@ function travellerCardProvidersFactory(_ref) {
     });
   }
 
+  /**
+   * GET /traveller-card-providers/:travellerCardProviderId - get traveller card provider by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.travellerCardProviderId - Traveller card provider id
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref5) {
     var token = _ref5.token,
         travellerCardProviderId = _ref5.travellerCardProviderId,