btrz-api-client 8.29.0 → 8.31.0

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

@@ -1,13 +1,38 @@
 "use strict";
 
 /* eslint-disable import/extensions */
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /websales-config (btrz-api-accounts). See get-handler getSpec().
+ * @typedef {Object} WebsalesConfigListQuery
+ * @property {string} [domain] - Filter by domain
+ * @property {string} [providerId] - Provider id for websales-config (ObjectId)
+ */
+
+/**
+ * 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).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {WebsalesConfigListQuery} [opts.query] - Query params (domain, providerId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -22,6 +47,16 @@ function websalesConfigFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /websales-config/:websalesConfigId - update websales config. 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.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. 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,
@@ -20,6 +37,16 @@ function cardpointeTerminalsFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /cardpointe-terminals/:merchantId/:terminalId - remove terminal. 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.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. 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.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. 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.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. 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.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. 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.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. 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.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. 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.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. 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.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. 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.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. 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.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. 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.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,36 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /datalogic/payments (btrz-api-payments). See get-payments-handler getSpec().
+ * @typedef {Object} DatalogicPaymentsListQuery
+ * @property {string} [referenceNumber] - The payment reference number
+ */
+
+/**
+ * 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 {DatalogicPaymentsListQuery} [opts.query] - Query params (referenceNumber)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     all: function all(_ref2) {
       var token = _ref2.token,
           jwtToken = _ref2.jwtToken,
@@ -20,6 +44,17 @@ function datalogicFactory(_ref) {
         headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     },
+
+    /**
+     * POST /datalogic/payments/:referenceNumber - update Datalogic payment. 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.referenceNumber - Reference number
+     * @param {Object} [opts.data] - Request body
+     * @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,17 @@ function datalogicFactory(_ref) {
         headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     },
+
+    /**
+     * POST /datalogic/reverse/:referenceNumber - reverse Datalogic payment. 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.referenceNumber - Reference number
+     * @param {Object} [opts.data] - Request body
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     reverse: function reverse(_ref4) {
       var token = _ref4.token,
           jwtToken = _ref4.jwtToken,
@@ -57,6 +103,14 @@ function datalogicFactory(_ref) {
   };
 
   var referenceNumber = {
+    /**
+     * GET /datalogic/reference-number - get reference number. 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>}
+     */
     get: function get(_ref5) {
       var token = _ref5.token,
           jwtToken = _ref5.jwtToken,
@@ -71,6 +125,14 @@ function datalogicFactory(_ref) {
   };
 
   var authCode = {
+    /**
+     * GET /datalogic/auth-code - get auth code. 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>}
+     */
     get: function get(_ref6) {
       var token = _ref6.token,
           jwtToken = _ref6.jwtToken,

package/lib/endpoints/btrzpay/docs.js

@@ -1,8 +1,19 @@
 "use strict";
 
+/**
+ * Factory for API docs (btrz-api-payments).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
 function docsFactory(_ref) {
   var client = _ref.client;
 
+  /**
+   * GET /api-docs-v2 - get API docs.
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get() {
     return client.get("/api-docs-v2", {});
   }

package/lib/endpoints/btrzpay/oxxo.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 /oxxo/:token/payments (btrz-api-payments). See get-payments-handler getSpec().
+ * @typedef {Object} OxxoPaymentsListQuery
+ * @property {string} [referenceNumber] - Payment reference number
+ */
+
+/**
+ * Factory for OXXO API (btrz-api-payments).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ token: Object, payments: Object }}
+ */
+
+
 function oxxoFactory(_ref) {
   var client = _ref.client,
-      internalAuthTokenProvider = _ref.internalAuthTokenProvider;
+      _internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   var token = {
+    /**
+     * GET /oxxo/token - get OXXO token. API does not accept query params.
+     * @param {Object} opts
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {{ getToken: function(): string }} [opts.internalAuthTokenProvider]
+     * @param {Object} [opts.headers] - Optional request headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref2) {
       var jwtToken = _ref2.jwtToken,
           headers = _ref2.headers,
@@ -21,6 +44,16 @@ function oxxoFactory(_ref) {
   };
 
   var payments = {
+    /**
+     * GET /oxxo/:oxxoToken/payments - list OXXO payments.
+     * @param {Object} opts
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.oxxoToken - OXXO token
+     * @param {OxxoPaymentsListQuery} [opts.query] - Query params (referenceNumber)
+     * @param {{ getToken: function(): string }} [opts.internalAuthTokenProvider]
+     * @param {Object} [opts.headers] - Optional request headers
+     * @returns {Promise<import("axios").AxiosResponse>} GetOxxoPaymentsResponse; 400 ERROR_GETTING_PAYMENT_METHODS
+     */
     all: function all(_ref3) {
       var jwtToken = _ref3.jwtToken,
           headers = _ref3.headers,
@@ -34,6 +67,18 @@ function oxxoFactory(_ref) {
         headers: authorizationHeaders({ jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     },
+
+    /**
+     * POST /oxxo/:oxxoToken/payments/:referenceNumber - update OXXO payment. API does not accept query params.
+     * @param {Object} opts
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.oxxoToken - OXXO token
+     * @param {string} opts.referenceNumber - Payment reference number
+     * @param {Object} opts.data - Request body (PostOxxoPaymentsPayload)
+     * @param {{ getToken: function(): string }} [opts.internalAuthTokenProvider]
+     * @param {Object} [opts.headers] - Optional request headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update: function update(_ref4) {
       var jwtToken = _ref4.jwtToken,
           headers = _ref4.headers,
@@ -51,8 +96,21 @@ function oxxoFactory(_ref) {
         headers: authorizationHeaders({ jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     },
+
+    /**
+     * POST /oxxo/:oxxoToken/reverse/:referenceNumber - reverse OXXO payment. 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.oxxoToken - OXXO token
+     * @param {string} opts.referenceNumber - Payment reference number
+     * @param {Object} [opts.data] - Request body (PostOxxoReversePayload)
+     * @param {{ getToken: function(): string }} [opts.internalAuthTokenProvider]
+     * @param {Object} [opts.headers] - Optional request headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     reverse: function reverse(_ref5) {
-      var token = _ref5.token,
+      var authToken = _ref5.token,
           jwtToken = _ref5.jwtToken,
           headers = _ref5.headers,
           query = _ref5.query,
@@ -66,7 +124,7 @@ function oxxoFactory(_ref) {
         method: "post",
         params: query,
         data: data,
-        headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+        headers: authorizationHeaders({ token: authToken, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     }
   };