btrz-api-client 8.28.0 → 8.30.0

package/lib/endpoints/accounts/images.js

@@ -4,10 +4,28 @@
 var _require = require("./../endpoints_helpers"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for images API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, create: function, remove: function }}
+ */
+
+
 function ImagesFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /images - list images.
+   * @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 ImagesFactory(_ref) {
     });
   }
 
+  /**
+   * GET /images/:imageId - get an image.
+   * @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 {string} opts.imageId - Image id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -37,6 +65,15 @@ function ImagesFactory(_ref) {
     });
   }
 
+  /**
+   * POST /images - create an image.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.image - Image payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var jwtToken = _ref4.jwtToken,
         token = _ref4.token,
@@ -47,13 +84,23 @@ function ImagesFactory(_ref) {
       url: "/images",
       method: "post",
       headers: authorizationHeaders({
-        token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers }),
+        token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers
+      }),
       data: {
         image: image
       }
     });
   }
 
+  /**
+   * DELETE /images/:imageId - remove an image.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.imageId - Image id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove(_ref5) {
     var imageId = _ref5.imageId,
         token = _ref5.token,

package/lib/endpoints/accounts/interline.js

@@ -3,11 +3,29 @@
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for interline API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ invitations: object, consumers: object, providers: object, network: object, remove: function }}
+ */
+
+
 function interlineFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   var invitations = {
+    /**
+     * GET /interline/invitations - list interline invitations.
+     * @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>}
+     */
     all: function all(_ref2) {
       var token = _ref2.token,
           jwtToken = _ref2.jwtToken,
@@ -21,6 +39,15 @@ function interlineFactory(_ref) {
         headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     },
+
+    /**
+     * GET /interline/invitations/:invitationId - get an invitation.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} opts.invitationId - Invitation id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref3) {
       var token = _ref3.token,
           invitationId = _ref3.invitationId,
@@ -30,6 +57,16 @@ function interlineFactory(_ref) {
         headers: authorizationHeaders({ token: token, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     },
+
+    /**
+     * POST /interline/invitations - create an invitation.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {Object} opts.data - Invitation payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create: function create(_ref4) {
       var data = _ref4.data,
           token = _ref4.token,
@@ -43,6 +80,17 @@ function interlineFactory(_ref) {
         data: data
       });
     },
+
+    /**
+     * PUT /interline/invitations/:invitationId - update an invitation.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.invitationId - Invitation id (ObjectId)
+     * @param {Object} opts.data - Invitation payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update: function update(_ref5) {
       var invitationId = _ref5.invitationId,
           data = _ref5.data,
@@ -60,6 +108,15 @@ function interlineFactory(_ref) {
   };
 
   var consumers = {
+    /**
+     * GET /interline/consumers - list interline consumers.
+     * @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>}
+     */
     all: function all(_ref6) {
       var token = _ref6.token,
           jwtToken = _ref6.jwtToken,
@@ -76,6 +133,15 @@ function interlineFactory(_ref) {
   };
 
   var providers = {
+    /**
+     * GET /interline/providers - list interline providers.
+     * @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>}
+     */
     all: function all(_ref7) {
       var token = _ref7.token,
           jwtToken = _ref7.jwtToken,
@@ -92,6 +158,14 @@ function interlineFactory(_ref) {
   };
 
   var network = {
+    /**
+     * GET /interline/:interlineId/network - get interline network.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} opts.interlineId - Interline id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref8) {
       var token = _ref8.token,
           interlineId = _ref8.interlineId,
@@ -101,6 +175,17 @@ function interlineFactory(_ref) {
         headers: authorizationHeaders({ token: token, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     },
+
+    /**
+     * PUT /interline/:interlineId/network - update interline network.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.interlineId - Interline id (ObjectId)
+     * @param {Object} opts.data - Network payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update: function update(_ref9) {
       var interlineId = _ref9.interlineId,
           data = _ref9.data,
@@ -122,6 +207,15 @@ function interlineFactory(_ref) {
     consumers: consumers,
     providers: providers,
     network: network,
+    /**
+     * DELETE /interline/:interlineId - remove an interline.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.interlineId - Interline id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     remove: function remove(_ref10) {
       var interlineId = _ref10.interlineId,
           token = _ref10.token,

package/lib/endpoints/accounts/journey-prices-settings.js

@@ -3,10 +3,27 @@
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for journey-prices-settings API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, update: function }}
+ */
+
+
 function journeyPricesSettingsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /journey-prices-settings - get journey prices settings.
+   * @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 get(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -18,6 +35,15 @@ function journeyPricesSettingsFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /journey-prices-settings - update journey prices settings.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.journeyPricesSettings - Settings payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,

package/lib/endpoints/accounts/lexicons.js

@@ -1,12 +1,31 @@
 "use strict";
 
+/* eslint-disable max-len */
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for lexicons API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, create: function, createOrUpdateMany: function, updateMany: function, getByText: function, suggestions: { list: function, getById: function, update: function, delete: function, create: function } }}
+ */
+
+
 function lexiconsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET lexicons/buscompany - list lexicons for bus company context.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.context - Context (e.g. buscompany)
+   * @param {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         context = _ref2.context,
@@ -23,6 +42,15 @@ function lexiconsFactory(_ref) {
     });
   }
 
+  /**
+   * POST /lexicons - create lexicon entries.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Array} opts.lexiconEntries - Entries to create
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -39,6 +67,15 @@ function lexiconsFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /lexicons - create or update many lexicon entries.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Array} opts.entries - Entries to create or update
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function createOrUpdateMany(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -57,6 +94,15 @@ function lexiconsFactory(_ref) {
     });
   }
 
+  /**
+   * PATCH /lexicons - update many lexicon entries.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Array} opts.updates - Updates to apply
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function updateMany(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,

package/lib/endpoints/accounts/market-pricing-settings.js

@@ -3,10 +3,27 @@
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for market-pricing-settings API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, update: function }}
+ */
+
+
 function marketPricingSettingsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /market-pricing-settings - get market pricing settings.
+   * @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 get(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -18,6 +35,15 @@ function marketPricingSettingsFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /market-pricing-settings - update market pricing settings.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.marketPricingSettings - Settings payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,

package/lib/endpoints/accounts/multiproduct-sales-settings.js

@@ -3,10 +3,27 @@
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for multiproduct-sales-settings API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, update: function }}
+ */
+
+
 function multiproductSalesSettingsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /multiproduct-sales-settings - get multiproduct sales settings.
+   * @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 get(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -18,6 +35,15 @@ function multiproductSalesSettingsFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /multiproduct-sales-settings - update multiproduct sales settings.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.data - Settings payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,

package/lib/endpoints/accounts/network.js

@@ -1,13 +1,32 @@
 "use strict";
 
+/* eslint-disable max-len */
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for network API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ agencies: { all: function, get: function, update: function, create: function, removeProduct: function, removeFare: function } }}
+ */
+
+
 function networkFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   var agencies = {
+    /**
+     * GET /network/agencies - list agencies.
+     * @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>}
+     */
     all: function all(_ref2) {
       var token = _ref2.token,
           jwtToken = _ref2.jwtToken,
@@ -21,6 +40,16 @@ function networkFactory(_ref) {
         headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     },
+
+    /**
+     * GET /network/agencies/:sellerId - get an agency by seller id.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} opts.sellerId - Seller/agency id (ObjectId)
+     * @param {Object} [opts.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref3) {
       var token = _ref3.token,
           query = _ref3.query,
@@ -33,6 +62,18 @@ function networkFactory(_ref) {
         headers: authorizationHeaders({ token: token, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     },
+
+    /**
+     * PUT /network/agencies/:sellerId - update an agency.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.sellerId - Seller/agency id (ObjectId)
+     * @param {Object} opts.agency - Agency payload
+     * @param {Object} [opts.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update: function update(_ref4) {
       var jwtToken = _ref4.jwtToken,
           token = _ref4.token,
@@ -53,6 +94,16 @@ function networkFactory(_ref) {
         params: query
       });
     },
+
+    /**
+     * POST /network/agencies - create an agency.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {Object} opts.agency - Agency payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create: function create(_ref5) {
       var jwtToken = _ref5.jwtToken,
           token = _ref5.token,
@@ -70,6 +121,16 @@ function networkFactory(_ref) {
         }
       });
     },
+
+    /**
+     * PUT /network/agencies/remove-product - remove product from agency.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.productId - Product id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     removeProduct: function removeProduct(_ref6) {
       var token = _ref6.token,
           jwtToken = _ref6.jwtToken,
@@ -87,6 +148,16 @@ function networkFactory(_ref) {
         }
       });
     },
+
+    /**
+     * PUT /network/agencies/remove-fare - remove fare from agency.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.fareId - Fare id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     removeFare: function removeFare(_ref7) {
       var token = _ref7.token,
           jwtToken = _ref7.jwtToken,

package/lib/endpoints/accounts/operation-settings.js

@@ -3,10 +3,28 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for operation-settings API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, update: function }}
+ */
+
+
 function operationSettingsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /operation-settings - get operation settings.
+   * @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 get(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -20,6 +38,15 @@ function operationSettingsFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /operation-settings - update operation settings.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.operationSettings - Settings payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref3) {
     var jwtToken = _ref3.jwtToken,
         token = _ref3.token,