btrz-api-client 8.28.0 → 8.30.0

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

@@ -1,6 +1,22 @@
 const {authorizationHeaders} = require("../endpoints_helpers.js");
 
+/**
+ * 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({client, 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({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/station-classes",
@@ -10,6 +26,16 @@ function stationClassFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({token, jwtToken, stationClassId, query = {}, headers}) {
     return client({
       url: `/station-classes/${stationClassId}`,
@@ -19,6 +45,16 @@ function stationClassFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({token, jwtToken, stationClassId, data, headers}) {
     return client({
       url: `/station-classes/${stationClassId}`,
@@ -28,6 +64,15 @@ function stationClassFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({token, jwtToken, stationClassId, headers}) {
     return client({
       url: `/station-classes/${stationClassId}`,
@@ -36,6 +81,15 @@ function stationClassFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({token, jwtToken, data, headers}) {
     return client({
       url: "/station-classes",

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

@@ -2,7 +2,28 @@ const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * @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({client, 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({token, query = {}, headers}) {
     return client({
       url: "/station-groups",

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

@@ -2,7 +2,28 @@ const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
+/**
+ * @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({client, 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({token, query = {}, headers}) {
     return client({
       url: "/stations/provinces",

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

@@ -2,7 +2,28 @@ const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * @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({client, 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({token, query = {}, headers}) {
     return client.get("/stations/zones", {
       params: query,

package/src/endpoints/inventory/stations.js

@@ -1,12 +1,42 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * @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({client, 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({token, id, headers}) {
     return client.get(`/stations/${id}`, {
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
     });
   }
 
+  /**
+   * 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({token, query = {}, headers}) {
     return client.get("/stations", {
       params: query,
@@ -14,6 +44,15 @@ function stationsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({token, jwtToken, data, headers}) {
     return client({
       url: "/stations",
@@ -25,12 +64,22 @@ function stationsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
-  function update({ token, jwtToken, stationId, station, headers}) {
+  /**
+   * 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({token, jwtToken, stationId, station, headers}) {
     return client({
-      url: "/station/" + stationId,
+      url: `/station/${stationId}`,
       method: "put",
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-      data: { station }
+      data: {station}
     });
   }
 

package/src/endpoints/inventory/taxes.js

@@ -1,7 +1,27 @@
-const {authorizationHeaders} = require("../endpoints_helpers");
+const {authorizationHeaders} = require("../endpoints_helpers.js");
 
-function taxesFactory({client, internalAuthTokenProvider}) {
+/**
+ * @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({client, 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({token, query = {}, headers}) {
     return client.get("/taxes", {
       params: query,
@@ -9,6 +29,16 @@ function taxesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({taxId, token, query = {}, headers}) {
     return client.get(`/taxes/${taxId}`, {
       params: query,
@@ -16,6 +46,15 @@ function taxesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({jwtToken, tax, token, headers}) {
     return client({
       url: "/taxes",
@@ -25,6 +64,16 @@ function taxesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({jwtToken, token, taxId, tax, headers}) {
     return client({
       url: `/taxes/${taxId}`,
@@ -34,7 +83,17 @@ function taxesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /** @type {{ create: function, update: function, get: function, all: function, delete: function }} */
   const 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({jwtToken, token, taxException, headers}) {
       return client({
         url: "/taxes/exceptions",
@@ -43,6 +102,16 @@ function taxesFactory({client, internalAuthTokenProvider}) {
         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({jwtToken, token, taxExceptionId, taxException, headers}) {
       return client({
         url: `/taxes/exceptions/${taxExceptionId}`,
@@ -51,12 +120,30 @@ function taxesFactory({client, internalAuthTokenProvider}) {
         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({jwtToken, token, taxExceptionId, headers}) {
       return client({
         url: `/taxes/exceptions/${taxExceptionId}`,
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, 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({jwtToken, token, query = {}, headers}) {
       return client({
         url: "/taxes/exceptions",
@@ -64,6 +151,15 @@ function taxesFactory({client, internalAuthTokenProvider}) {
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, 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({jwtToken, token, taxExceptionId, headers}) {
       return client({
         url: `/taxes/exceptions/${taxExceptionId}`,

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

@@ -1,8 +1,29 @@
 const {
   authorizationHeaders
-} = require("./../endpoints_helpers");
+} = require("./../endpoints_helpers.js");
 
+/**
+ * @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({client, 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({
     token,
     jwtToken,
@@ -15,12 +36,30 @@ function travelRoutesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({travelRouteId, jwtToken, token, headers}) {
     return client.get(`/travel-routes/${travelRouteId}`, {
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
+  /**
+   * 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({jwtToken, token, travelRoute, headers}) {
     return client({
       url: "/travel-routes",
@@ -32,6 +71,16 @@ function travelRoutesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({jwtToken, token, travelRouteId, travelRoute, headers}) {
     return client({
       url: `/travel-routes/${travelRouteId}`,

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

@@ -1,6 +1,26 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * 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({client, 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({token, query = {}, headers}) {
     return client.get("/traveller-card-providers/types", {
       params: query,

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

@@ -1,14 +1,44 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * 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({client, 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({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/traveller-card-providers",
       params: query,
-      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
+  /**
+   * 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({token, jwtToken, travellerCardProvider, headers}) {
     return client({
       url: "/traveller-card-providers",
@@ -18,6 +48,16 @@ function travellerCardProvidersFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({jwtToken, token, travellerCardProviderId, travellerCardProvider, headers}) {
     return client({
       url: `/traveller-card-providers/${travellerCardProviderId}`,
@@ -27,6 +67,15 @@ function travellerCardProvidersFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({token, travellerCardProviderId, jwtToken, headers}) {
     return client({
       url: `/traveller-card-providers/${travellerCardProviderId}`,