btrz-api-client 8.28.0 → 8.30.0

package/lib/endpoints/accounts/users.js

@@ -1,12 +1,31 @@
 "use strict";
 
+/* eslint-disable max-len */
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for users API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, getV2: function, all: function, create: function, login: function, update: function, createOrUpdateMany: function, impersonate: function, startMfa: function, confirmMfa: function, disableMfa: function, sequences: { get: function, all: function, create: function, update: function, transfer: function } }}
+ */
+
+
 function usersFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /user/:id - get a user by id (legacy).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - User id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get() {
     var _ref2 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
         token = _ref2.token,
@@ -20,6 +39,15 @@ function usersFactory(_ref) {
     });
   }
 
+  /**
+   * GET /users/:id - get a user by id (v2).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - User id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function getV2() {
     var _ref3 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
         token = _ref3.token,
@@ -33,6 +61,15 @@ function usersFactory(_ref) {
     });
   }
 
+  /**
+   * GET /users - list users.
+   * @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(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -47,6 +84,16 @@ function usersFactory(_ref) {
     });
   }
 
+  /**
+   * POST /users - login (create session).
+   * @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.data - Login payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function login(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,
@@ -64,7 +111,16 @@ function usersFactory(_ref) {
     });
   }
 
-  // Deprecated. Use login instead.
+  /**
+   * @deprecated Use login instead. POST /users - create user (alias for login).
+   * @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.data - User data
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref6) {
     var token = _ref6.token,
         jwtToken = _ref6.jwtToken,
@@ -76,6 +132,16 @@ function usersFactory(_ref) {
     return login({ token: token, jwtToken: jwtToken, query: query, data: data, headers: headers });
   }
 
+  /**
+   * PUT /users/:userId - update a user.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.userId - User id (ObjectId)
+   * @param {Object} opts.user - User payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref7) {
     var token = _ref7.token,
         jwtToken = _ref7.jwtToken,
@@ -91,6 +157,15 @@ function usersFactory(_ref) {
     });
   }
 
+  /**
+   * POST /users/import - create or update many users.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Array} opts.users - Array of user objects
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function createOrUpdateMany(_ref8) {
     var token = _ref8.token,
         jwtToken = _ref8.jwtToken,
@@ -105,6 +180,15 @@ function usersFactory(_ref) {
     });
   }
 
+  /**
+   * POST /users/impersonate - start impersonation session.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.offlineUserId - Offline user id to impersonate
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function impersonate(_ref9) {
     var token = _ref9.token,
         jwtToken = _ref9.jwtToken,
@@ -119,6 +203,15 @@ function usersFactory(_ref) {
     });
   }
 
+  /**
+   * POST /users/:userId/mfa - start MFA setup.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.userId - User id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function startMfa(_ref10) {
     var token = _ref10.token,
         jwtToken = _ref10.jwtToken,
@@ -132,6 +225,16 @@ function usersFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /users/:userId/mfa - confirm MFA with TOTP token.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.userId - User id (ObjectId)
+   * @param {string} opts.totpToken - TOTP token from authenticator app
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function confirmMfa(_ref11) {
     var token = _ref11.token,
         jwtToken = _ref11.jwtToken,
@@ -147,6 +250,15 @@ function usersFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /users/:userId/mfa - disable MFA for user.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.userId - User id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function disableMfa(_ref12) {
     var token = _ref12.token,
         jwtToken = _ref12.jwtToken,
@@ -161,6 +273,16 @@ function usersFactory(_ref) {
   }
 
   var sequences = {
+    /**
+     * GET /users/:userId/sequences/:sequenceId - get a sequence.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.userId - User id (ObjectId)
+     * @param {string} opts.sequenceId - Sequence id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref13) {
       var token = _ref13.token,
           jwtToken = _ref13.jwtToken,
@@ -173,6 +295,17 @@ function usersFactory(_ref) {
         headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     },
+
+    /**
+     * GET /users/:userId/sequences - list sequences for user.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.userId - User id (ObjectId)
+     * @param {Object} [opts.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     all: function all(_ref14) {
       var token = _ref14.token,
           jwtToken = _ref14.jwtToken,
@@ -187,6 +320,17 @@ function usersFactory(_ref) {
         headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     },
+
+    /**
+     * POST /users/:userId/sequences - create a sequence.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.userId - User id (ObjectId)
+     * @param {Object} opts.sequence - Sequence payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create: function create(_ref15) {
       var jwtToken = _ref15.jwtToken,
           token = _ref15.token,
@@ -201,6 +345,18 @@ function usersFactory(_ref) {
         data: sequence
       });
     },
+
+    /**
+     * PUT /users/:userId/sequences/:sequenceId - update a sequence.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.userId - User id (ObjectId)
+     * @param {string} opts.sequenceId - Sequence id (ObjectId)
+     * @param {Object} opts.sequence - Sequence payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update: function update(_ref16) {
       var jwtToken = _ref16.jwtToken,
           token = _ref16.token,
@@ -216,6 +372,18 @@ function usersFactory(_ref) {
         data: sequence
       });
     },
+
+    /**
+     * PATCH /users/:userId/sequences/:sequenceId - transfer sequence to another user.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.userId - User id (ObjectId)
+     * @param {string} opts.sequenceId - Sequence id (ObjectId)
+     * @param {string} opts.newUserId - Target user id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     transfer: function transfer(_ref17) {
       var jwtToken = _ref17.jwtToken,
           token = _ref17.token,

package/lib/endpoints/accounts/websales-config.js

@@ -1,13 +1,31 @@
 "use strict";
 
 /* eslint-disable import/extensions */
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for websales-config 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 websalesConfigFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /websales-config - get websales config (list when no id).
+   * @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,
@@ -22,6 +40,16 @@ function websalesConfigFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /websales-config/:websalesConfigId - update websales config.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.websalesConfigId - Websales config id (ObjectId)
+   * @param {Object} opts.websalesConfig - Config 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/btrzpay/cardpointe.js

@@ -3,10 +3,27 @@
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for Cardpointe terminals API (btrz-api-payments).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, remove: function, readCard: Object, ping: Object }}
+ */
+
+
 function cardpointeTerminalsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /cardpointe-terminals - list Cardpointe terminals.
+   * @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,
@@ -20,6 +37,16 @@ function cardpointeTerminalsFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /cardpointe-terminals/:merchantId/:terminalId - remove terminal.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.merchantId - Merchant id
+   * @param {string} opts.terminalId - Terminal id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -35,6 +62,15 @@ function cardpointeTerminalsFactory(_ref) {
   }
 
   var readCard = {
+    /**
+     * GET /cardpointe-terminals/read-card/:readCardResultId - get read card result.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.readCardResultId - Read card result id
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref4) {
       var token = _ref4.token,
           jwtToken = _ref4.jwtToken,
@@ -46,6 +82,17 @@ function cardpointeTerminalsFactory(_ref) {
         headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     },
+
+    /**
+     * POST /cardpointe-terminals/read-card - create read card.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {Object} opts.readCard - Read card payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
+    // eslint-disable-next-line no-shadow
     create: function create(_ref5) {
       var token = _ref5.token,
           jwtToken = _ref5.jwtToken,
@@ -62,6 +109,16 @@ function cardpointeTerminalsFactory(_ref) {
   };
 
   var ping = {
+    /**
+     * POST /cardpointe-terminals/ping - create ping.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {Object} opts.ping - Ping payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
+    // eslint-disable-next-line no-shadow
     create: function create(_ref6) {
       var token = _ref6.token,
           jwtToken = _ref6.jwtToken,

package/lib/endpoints/btrzpay/customerCards.js

@@ -1,13 +1,32 @@
 "use strict";
 
-var _require = require("../endpoints_helpers"),
+var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for customer cards API (btrz-api-payments).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, all: function, create: function, remove: function }}
+ */
+
+
 function customerCardsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
-
+  /**
+   * GET /payment-methods/:paymentMethodId/customers/:customerId/cards/:customerCardId - get card.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.paymentMethodId - Payment method id
+   * @param {string} opts.customerId - Customer id
+   * @param {string} opts.customerCardId - Customer card id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -22,6 +41,16 @@ function customerCardsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /payment-methods/:paymentMethodId/customers/:customerId/cards - list cards.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.paymentMethodId - Payment method id
+   * @param {string} opts.customerId - Customer id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -35,6 +64,17 @@ function customerCardsFactory(_ref) {
     });
   }
 
+  /**
+   * POST /payment-methods/:paymentMethodId/customers/:customerId/cards - create card.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.paymentMethodId - Payment method id
+   * @param {string} opts.customerId - Customer id
+   * @param {Object} opts.customerCard - Customer card payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -51,6 +91,17 @@ function customerCardsFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /payment-methods/:paymentMethodId/customers/:customerId/cards/:customerCardId - remove card.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.paymentMethodId - Payment method id
+   * @param {string} opts.customerId - Customer id
+   * @param {string} opts.customerCardId - Customer card id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,

package/lib/endpoints/btrzpay/customers.js

@@ -1,12 +1,31 @@
 "use strict";
 
-var _require = require("../endpoints_helpers"),
+var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for payment-method customers API (btrz-api-payments).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, create: function, remove: function }}
+ */
+
+
 function customersFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /payment-methods/:paymentMethodId/customers/:customerId - get customer.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.paymentMethodId - Payment method id
+   * @param {string} opts.customerId - Customer id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -20,6 +39,16 @@ function customersFactory(_ref) {
     });
   }
 
+  /**
+   * POST /payment-methods/:paymentMethodId/customers - create customer.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.paymentMethodId - Payment method id
+   * @param {Object} opts.customer - Customer payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -35,6 +64,16 @@ function customersFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /payment-methods/:paymentMethodId/customers/:customerId - remove customer.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.paymentMethodId - Payment method id
+   * @param {string} opts.customerId - Customer id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,

package/lib/endpoints/btrzpay/datalogic.js

@@ -1,12 +1,35 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @typedef {Object} DatalogicQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * Factory for Datalogic API (btrz-api-payments).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ payments: Object, referenceNumber: Object, authCode: Object }}
+ */
+
+
 function datalogicFactory(_ref) {
   var client = _ref.client;
 
   var payments = {
+    /**
+     * GET /datalogic/payments - list Datalogic payments.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {DatalogicQuery} [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,
@@ -20,6 +43,18 @@ function datalogicFactory(_ref) {
         headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     },
+
+    /**
+     * POST /datalogic/payments/:referenceNumber - update Datalogic payment.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.referenceNumber - Reference number
+     * @param {Object} [opts.data] - Request body
+     * @param {DatalogicQuery} [opts.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update: function update(_ref3) {
       var token = _ref3.token,
           jwtToken = _ref3.jwtToken,
@@ -37,6 +72,18 @@ function datalogicFactory(_ref) {
         headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     },
+
+    /**
+     * POST /datalogic/reverse/:referenceNumber - reverse Datalogic payment.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.referenceNumber - Reference number
+     * @param {Object} [opts.data] - Request body
+     * @param {DatalogicQuery} [opts.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     reverse: function reverse(_ref4) {
       var token = _ref4.token,
           jwtToken = _ref4.jwtToken,
@@ -57,6 +104,14 @@ function datalogicFactory(_ref) {
   };
 
   var referenceNumber = {
+    /**
+     * GET /datalogic/reference-number - get reference number.
+     * @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>}
+     */
     get: function get(_ref5) {
       var token = _ref5.token,
           jwtToken = _ref5.jwtToken,
@@ -71,6 +126,14 @@ function datalogicFactory(_ref) {
   };
 
   var authCode = {
+    /**
+     * GET /datalogic/auth-code - get auth code.
+     * @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>}
+     */
     get: function get(_ref6) {
       var token = _ref6.token,
           jwtToken = _ref6.jwtToken,