btrz-api-client 8.29.0 → 8.31.0

package/lib/endpoints/inventory/taxes.js

@@ -1,13 +1,36 @@
 "use strict";
 
-var _require = require("../endpoints_helpers"),
+var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /taxes (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} TaxesQuery
+ * @property {string} [providerIds] - The id of the providers to get taxes for
+ */
+
+/**
+ * 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 (providerIds)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,
@@ -20,6 +43,15 @@ function taxesFactory(_ref) {
     });
   }
 
+  /**
+   * GET /taxes/:taxId - get tax 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.taxId - Tax id (ObjectId format)
+   * @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,15 @@ 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 {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     all: function all(_ref9) {
       var jwtToken = _ref9.jwtToken,
           token = _ref9.token,
@@ -114,6 +205,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,37 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /travel-routes (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} TravelRoutesQuery
+ * @property {number} [page] - The page number to retrieve (positive integer)
+ * @property {string} [externalId] - The external id of the travel route
+ */
+
+/**
+ * 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 (page, externalId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -20,6 +45,15 @@ function travelRoutesFactory(_ref) {
     });
   }
 
+  /**
+   * GET /travel-routes/:travelRouteId - get travel route 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.travelRouteId - Travel route id (ObjectId format)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var travelRouteId = _ref3.travelRouteId,
         jwtToken = _ref3.jwtToken,
@@ -31,6 +65,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 +90,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,28 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @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,29 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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. 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>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -21,6 +38,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 +61,16 @@ function travellerCardProvidersFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /traveller-card-providers/:travellerCardProviderId - update traveller card provider. API does not accept query params.
+   * @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 +86,15 @@ function travellerCardProvidersFactory(_ref) {
     });
   }
 
+  /**
+   * GET /traveller-card-providers/:travellerCardProviderId - get traveller card provider by id. API does not accept query params.
+   * @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,

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

@@ -1,12 +1,36 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /traveller-card-types (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} TravellerCardTypesListQuery
+ * @property {string} [providerIds] - Provider ids to get traveller card types for
+ */
+
+/**
+ * Factory for traveller-card-types 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, remove: function }}
+ */
+
+
 function travellerCardTypesFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /traveller-card-types - list traveller card types.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {TravellerCardTypesListQuery} [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,
@@ -21,6 +45,15 @@ function travellerCardTypesFactory(_ref) {
     });
   }
 
+  /**
+   * POST /traveller-card-types - create traveller card type. 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.travellerCardType - Traveller card type payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -35,6 +68,16 @@ function travellerCardTypesFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /traveller-card-types/:travellerCardTypeId - update traveller card type. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.travellerCardTypeId - Traveller card type id
+   * @param {Object} opts.travellerCardType - Traveller card type payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref4) {
     var jwtToken = _ref4.jwtToken,
         token = _ref4.token,
@@ -50,6 +93,15 @@ function travellerCardTypesFactory(_ref) {
     });
   }
 
+  /**
+   * GET /traveller-card-types/:travellerCardTypeId - get traveller card type by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.travellerCardTypeId - Traveller card type 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,
         travellerCardTypeId = _ref5.travellerCardTypeId,
@@ -63,6 +115,15 @@ function travellerCardTypesFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /traveller-card-types/:travellerCardTypeId - remove traveller card type. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.travellerCardTypeId - Traveller card type id
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove(_ref6) {
     var token = _ref6.token,
         travellerCardTypeId = _ref6.travellerCardTypeId,

package/lib/endpoints/inventory/trips.js

@@ -1,12 +1,29 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for trips API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function }}
+ */
+
+
 function tripsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /trips - list trips. API source of truth in btrz-api-inventory-trips; query not documented here.
+   * @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>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -21,6 +38,14 @@ function tripsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /trip/:id - get trip by id. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.id - Trip id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var token = _ref3.token,
         id = _ref3.id,

package/lib/endpoints/inventory/vehicle-types.js

@@ -3,18 +3,26 @@
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for vehicle-types API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function }}
+ */
+
+
 function vehicleTypesFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET all vehicle types (e.g. Bus, Shuttle, Van, Train, Ferry, Tram).
-   * Used when configuring schedule vehicle type or displaying vehicle type in trips/manifests.
+   * GET /vehicle-types - list vehicle types (e.g. Bus, Shuttle, Van, Train, Ferry, Tram).
    * @param {Object} opts
-   * @param {string} opts.token - API key token
-   * @param {Object} [opts.query] - Optional query params
-   * @param {Object} [opts.headers] - Optional request headers
-   * @returns {Promise<{data: {vehicleTypes: Array<{_id: string, name: string}>}}>}
+   * @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>}
    */
   function all(_ref2) {
     var token = _ref2.token,