btrz-api-client 8.29.0 → 8.31.0

package/lib/endpoints/sales/voucher.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 parameters for GET /vouchers/{internalId} (btrz-api-sales getSpec).
+ * @typedef {Object} VoucherGetQuery
+ * @property {string} [firstName] - First name of the customer
+ * @property {string} [lastName] - Last name of the customer
+ * @property {string} [cartId] - Validates if voucher applies to any item in the cart; overrides productType, from, to, fareTypes
+ * @property {string} [productType] - Product type of the voucher
+ * @property {string} [from] - Station "from" to validate if voucher has routes
+ * @property {string} [to] - Station "to" to validate if voucher has routes
+ * @property {string} [fareTypes] - (DEPRECATED) Validates if voucher has one fare; use fareIds instead
+ * @property {string} [fareIds] - Validates if voucher has one fare ID
+ * @property {string} [displayCurrencyCode] - Display currency code for multi-currency accounts
+ */
+
+/**
+ * Options object passed to get(). The client builds the URL from voucher.number and voucher.cartId, firstName, lastName, displayCurrencyCode.
+ * @typedef {Object} VoucherGetOptionsVoucher
+ * @property {string} number - Voucher internal ID (path param internalId)
+ * @property {string} [cartId] - Sent as query cartId
+ * @property {string} [firstName] - Sent as query firstName
+ * @property {string} [lastName] - Sent as query lastName
+ * @property {string} [displayCurrencyCode] - Sent as query displayCurrencyCode
+ */
+
+/**
+ * Factory for voucher GET API (btrz-api-sales). GET /vouchers/{internalId}.
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
+
+
 function voucherFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /vouchers/:number - get voucher by internal id (number). Query params from API: firstName, lastName, cartId, productType, from, to, fareTypes, fareIds, displayCurrencyCode.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {VoucherGetOptionsVoucher} opts.voucher - Voucher identifier and query fields: number (internalId), cartId, firstName, lastName, displayCurrencyCode
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>} response.data is the Voucher (200); 400 Cart invalid, 401 Unauthorized, 404 Voucher not found
+   */
   function get(_ref2) {
     var token = _ref2.token,
         voucher = _ref2.voucher,

package/lib/endpoints/seatmaps/access-ticket.js

@@ -1,13 +1,29 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for seatmaps access ticket API.
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function }}
+ */
+
+
 function accessTicketFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
-
+  /**
+   * POST /access-ticket - create access ticket.
+   * @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 create(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,

package/lib/endpoints/seatmaps/seat.js

@@ -1,13 +1,30 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for seatmaps seat API.
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ update: function }}
+ */
+
+
 function seatFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
-
+  /**
+   * POST /seat - update seat.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.params] - Query/request params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,

package/lib/endpoints/uploads/files.js

@@ -2,14 +2,32 @@
 
 var _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; };
 
-var _require = require("./../endpoints_helpers"),
+/* eslint-disable max-len */
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for upload files API (btrz-api-uploads).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ upload: function }}
+ */
+
+
 function filesFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
-
+  /**
+   * POST /files - upload file.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {import("form-data")} opts.formData - Form data with file
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function upload(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,

package/lib/endpoints/uploads/images.js

@@ -2,14 +2,32 @@
 
 var _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; };
 
-var _require = require("./../endpoints_helpers"),
+/* eslint-disable max-len */
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for upload images API (btrz-api-uploads).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function }}
+ */
+
+
 function imagesFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
-
+  /**
+   * POST /images - upload image.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {import("form-data")} opts.formData - Form data with image
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,

package/lib/endpoints/webhooks/events.js

@@ -1,13 +1,37 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /events (webhooks). Client merges opts.context into query.
+ * @typedef {Object} WebhookEventsListQuery
+ * @property {string} [context] - Context filter (merged from opts.context by client)
+ */
+
+/**
+ * Factory for webhook events API (btrz-api-notifications).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function }}
+ */
+
+
 function eventsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
-
+  /**
+   * GET /events - list webhook events. Query is merged with context (opts.context).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.context] - Context filter (merged into query)
+   * @param {WebhookEventsListQuery} [opts.query] - Additional query params (merged with context)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,

package/lib/endpoints/webhooks/subscriptions.js

@@ -1,13 +1,37 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /subscriptions (webhooks). Client merges opts.context into query.
+ * @typedef {Object} WebhookSubscriptionsListQuery
+ * @property {string} [context] - Context filter (merged from opts.context by client)
+ */
+
+/**
+ * Factory for webhook subscriptions API (btrz-api-notifications).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, getById: function, create: function, put: function, deleteById: function }}
+ */
+
+
 function subscriptionsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
-
+  /**
+   * GET /subscriptions - list webhook subscriptions. Query is merged with context (opts.context).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.context] - Context filter (merged into query)
+   * @param {WebhookSubscriptionsListQuery} [opts.query] - Additional query params (merged with context)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -25,6 +49,15 @@ function subscriptionsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /subscriptions/:id - get subscription by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Subscription id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function getById(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -38,6 +71,15 @@ function subscriptionsFactory(_ref) {
     });
   }
 
+  /**
+   * POST /subscriptions - create webhook subscription.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.subscription - Subscription payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -52,6 +94,16 @@ function subscriptionsFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /subscriptions/:id - update subscription.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Subscription id
+   * @param {Object} opts.subscription - Subscription payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function put(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,
@@ -67,6 +119,15 @@ function subscriptionsFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /subscriptions/:id - delete subscription by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Subscription id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function deleteById(_ref6) {
     var token = _ref6.token,
         jwtToken = _ref6.jwtToken,

package/lib/endpoints/webhooks/undelivered.js

@@ -1,13 +1,38 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+/* eslint-disable max-len */
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /undelivered (btrz-api-notifications). context can also be passed via opts.context and is merged into query.
+ * @typedef {Object} WebhookUndeliveredListQuery
+ * @property {string} [context] - Context filter (also accepted as opts.context)
+ */
+
+/**
+ * Factory for undelivered webhooks API (btrz-api-notifications).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, getById: function, patch: function, resend: function, resendAll: function, deleteById: function, deleteAll: function }}
+ */
+
+
 function undeliveredFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
-
+  /**
+   * GET /undelivered - list undelivered webhooks.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.context] - Context filter (merged into query)
+   * @param {WebhookUndeliveredListQuery} [opts.query] - Optional query params (context merged from opts.context)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -25,6 +50,15 @@ function undeliveredFactory(_ref) {
     });
   }
 
+  /**
+   * GET /undelivered/:id - get undelivered webhook by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Undelivered id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function getById(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -38,6 +72,15 @@ function undeliveredFactory(_ref) {
     });
   }
 
+  /**
+   * PATCH /undelivered - patch undelivered.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.operation - Patch operation
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function patch(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -52,6 +95,15 @@ function undeliveredFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /undelivered/:id/retry - resend undelivered webhook.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Undelivered id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function resend(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,
@@ -65,6 +117,14 @@ function undeliveredFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /undelivered/retry-all - resend all undelivered webhooks.
+   * @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 resendAll(_ref6) {
     var token = _ref6.token,
         jwtToken = _ref6.jwtToken,
@@ -77,6 +137,15 @@ function undeliveredFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /undelivered/:id - delete undelivered webhook by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Undelivered id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function deleteById(_ref7) {
     var token = _ref7.token,
         jwtToken = _ref7.jwtToken,
@@ -90,6 +159,14 @@ function undeliveredFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /undelivered/batch-all - delete all undelivered webhooks.
+   * @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 deleteAll(_ref8) {
     var token = _ref8.token,
         jwtToken = _ref8.jwtToken,

package/lib/endpoints/webhooks/webhooks.js

@@ -1,13 +1,30 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for webhooks emit API (btrz-api-notifications).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ emit: function }}
+ */
+
+
 function webhooksFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
-
+  /**
+   * POST /emit - emit webhook.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.webhook - Webhook payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function emit(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,

package/lib/productionDefaults.js

@@ -1,5 +1,9 @@
 "use strict";
 
+/**
+ * Default options for createApiClient when no options are passed.
+ * @type {{ baseURL: string, timeout: number, baseURLOverride: { inventory: function(string): string, trips: function(string): string } }}
+ */
 module.exports = {
   baseURL: "https://api.betterez.com",
   timeout: 15000,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "btrz-api-client",
-  "version": "8.29.0",
+  "version": "8.31.0",
   "description": "Api client for Betterez endpoints",
   "main": "index.js",
   "scripts": {
@@ -9,11 +9,9 @@
     "test:integration": "mocha --recursive -r test-integration/ports.js  test-integration/",
     "browserify": "browserify lib/client.js --standalone BtrzApiClient -p tinyify -o lib/client-standalone-min.js",
     "commit-transpile": "git add lib/ && (git diff-index --quiet HEAD || git commit -m \"transpiled src\")",
-    "commit-types": "git add types/ && (git diff-index --quiet HEAD || git commit -m \"generated types from src\")",
     "pretranspile": "rm -rf lib/",
-    "types": "npx -p typescript tsc src/**.js --declaration --allowJs --emitDeclarationOnly --outDir types",
     "transpile": "babel --presets es2015 -d lib/ src/",
-    "preversion": "npm test && npm run transpile && npm run browserify && npm run types && npm run commit-transpile && npm run commit-types",
+    "preversion": "npm test && npm run transpile && npm run browserify && npm run commit-transpile",
     "postversion": "git push origin master && git push --tags",
     "version": "git tag $1"
   },
@@ -32,7 +30,7 @@
     "babel-cli": "^6.26.0",
     "babel-plugin-transform-object-rest-spread": "^6.26.0",
     "babel-preset-es2015": "^6.24.1",
-    "browserify": "^17.0.0",
+    "browserify": "^17.0.1",
     "chai": "^4.3.8",
     "confusing-browser-globals": "^1.0.11",
     "eslint": "7.32.0",
@@ -41,9 +39,9 @@
     "eslint-plugin-import": "^2.20.1",
     "eslint-plugin-mocha": "^5.3.0",
     "form-data": "^3.0.0",
-    "mocha": "^10.2.0",
+    "mocha": "11.7.5",
     "tinyify": "^4.0.0",
-    "uuid": "^9.0.0"
+    "uuid": "13.0.0"
   },
   "dependencies": {
     "axios": "^0.27.2",