dymo-api 1.2.17 → 1.2.19

package/dist/cjs/branches/private/functions/{isValidData → isValidDataRaw}/index.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isValidData = void 0;
+exports.isValidDataRaw = void 0;
 const basics_1 = require("../../../../utils/basics.cjs");
 /**
  * Validates the provided data using a secure verification endpoint.
@@ -14,7 +14,7 @@ const basics_1 = require("../../../../utils/basics.cjs");
  * @throws Will throw an error if the token is null, if none of the required fields are present in the data,
  *         or if an error occurs during the verification request.
  */
-const isValidData = async (axiosClient, data) => {
+const isValidDataRaw = async (axiosClient, data) => {
     if (!axiosClient.defaults.headers?.Authorization)
         throw (0, basics_1.customError)(3000, "Invalid private token.");
     if (!Object.keys(data).some((key) => ["url", "email", "phone", "domain", "creditCard", "ip", "wallet", "userAgent", "iban"].includes(key) && data.hasOwnProperty(key)))
@@ -30,4 +30,4 @@ const isValidData = async (axiosClient, data) => {
         throw (0, basics_1.customError)(5000, `Error ${statusCode}: ${errorMessage}. Details: ${errorDetails}`);
     }
 };
-exports.isValidData = isValidData;
+exports.isValidDataRaw = isValidDataRaw;

package/dist/cjs/branches/private/index.cjs

@@ -16,7 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./functions/extractWithTextly/index.cjs"), exports);
 __exportStar(require("./functions/getRandom/index.cjs"), exports);
-__exportStar(require("./functions/isValidData/index.cjs"), exports);
+__exportStar(require("./functions/isValidDataRaw/index.cjs"), exports);
 __exportStar(require("./functions/isValidEmail/index.cjs"), exports);
 __exportStar(require("./functions/protectReq/index.cjs"), exports);
 __exportStar(require("./functions/sendEmail/index.cjs"), exports);

package/dist/cjs/dymo-api.cjs

@@ -76,7 +76,7 @@ class DymoAPI {
             headers: {
                 "User-Agent": "DymoAPISDK/1.0.0",
                 "X-Dymo-SDK-Env": "Node",
-                "X-Dymo-SDK-Version": "1.2.17"
+                "X-Dymo-SDK-Version": "1.2.18"
             }
         });
         // We set the authorization in the Axios client to make requests.
@@ -91,6 +91,7 @@ class DymoAPI {
      * This method requires either the root API key or the API key to be set.
      * If neither is set, it will throw an error.
      *
+     * @deprecated Use `isValidDataRaw` instead. This feature will be modified soon.
      * @param {Object} data - The data to be validated.
      * @param {string} [data.url] - Optional URL to be validated.
      * @param {string} [data.email] - Optional email address to be validated.
@@ -108,7 +109,33 @@ class DymoAPI {
      * [Documentation](https://docs.tpeoficial.com/docs/dymo-api/private/data-verifier)
      */
     async isValidData(data) {
-        return await PrivateAPI.isValidData(this.axiosClient, data);
+        return await PrivateAPI.isValidDataRaw(this.axiosClient, data);
+    }
+    ;
+    /**
+     * Validates the given data against the configured validation settings.
+     *
+     * This method requires either the root API key or the API key to be set.
+     * If neither is set, it will throw an error.
+     *
+     * @param {Object} data - The data to be validated.
+     * @param {string} [data.url] - Optional URL to be validated.
+     * @param {string} [data.email] - Optional email address to be validated.
+     * @param {Interfaces.PhoneData} [data.phone] - Optional phone number data to be validated.
+     * @param {string} [data.domain] - Optional domain name to be validated.
+     * @param {string|Interfaces.CreditCardData} [data.creditCard] - Optional credit card number or data to be validated.
+     * @param {string} [data.ip] - Optional IP address to be validated.
+     * @param {string} [data.wallet] - Optional wallet address to be validated.
+     * @param {string} [data.userAgent] - Optional user agent string to be validated.
+     * @param {string} [data.iban] - Optional IBAN to be validated.
+     * @param {Interfaces.VerifyPlugins[]} [data.plugins] - Optional array of verification plugins to be used.
+     * @returns {Promise<Interfaces.DataValidationAnalysis>} A promise that resolves to the response from the server.
+     * @throws Will throw an error if there is an issue with the validation process.
+     *
+     * [Documentation](https://docs.tpeoficial.com/docs/dymo-api/private/data-verifier)
+     */
+    async isValidDataRaw(data) {
+        return await PrivateAPI.isValidDataRaw(this.axiosClient, data);
     }
     ;
     /**

package/dist/esm/branches/private/functions/{isValidData → isValidDataRaw}/index.js

@@ -11,7 +11,7 @@ import { customError } from "../../../../utils/basics.js";
  * @throws Will throw an error if the token is null, if none of the required fields are present in the data,
  *         or if an error occurs during the verification request.
  */
-export const isValidData = async (axiosClient, data) => {
+export const isValidDataRaw = async (axiosClient, data) => {
     if (!axiosClient.defaults.headers?.Authorization)
         throw customError(3000, "Invalid private token.");
     if (!Object.keys(data).some((key) => ["url", "email", "phone", "domain", "creditCard", "ip", "wallet", "userAgent", "iban"].includes(key) && data.hasOwnProperty(key)))

package/dist/esm/branches/private/index.js

@@ -1,6 +1,6 @@
 export * from "./functions/extractWithTextly";
 export * from "./functions/getRandom";
-export * from "./functions/isValidData";
+export * from "./functions/isValidDataRaw";
 export * from "./functions/isValidEmail";
 export * from "./functions/protectReq";
 export * from "./functions/sendEmail";

package/dist/esm/dymo-api.js

@@ -38,7 +38,7 @@ class DymoAPI {
             headers: {
                 "User-Agent": "DymoAPISDK/1.0.0",
                 "X-Dymo-SDK-Env": "Node",
-                "X-Dymo-SDK-Version": "1.2.17"
+                "X-Dymo-SDK-Version": "1.2.18"
             }
         });
         // We set the authorization in the Axios client to make requests.
@@ -53,6 +53,7 @@ class DymoAPI {
      * This method requires either the root API key or the API key to be set.
      * If neither is set, it will throw an error.
      *
+     * @deprecated Use `isValidDataRaw` instead. This feature will be modified soon.
      * @param {Object} data - The data to be validated.
      * @param {string} [data.url] - Optional URL to be validated.
      * @param {string} [data.email] - Optional email address to be validated.
@@ -70,7 +71,33 @@ class DymoAPI {
      * [Documentation](https://docs.tpeoficial.com/docs/dymo-api/private/data-verifier)
      */
     async isValidData(data) {
-        return await PrivateAPI.isValidData(this.axiosClient, data);
+        return await PrivateAPI.isValidDataRaw(this.axiosClient, data);
+    }
+    ;
+    /**
+     * Validates the given data against the configured validation settings.
+     *
+     * This method requires either the root API key or the API key to be set.
+     * If neither is set, it will throw an error.
+     *
+     * @param {Object} data - The data to be validated.
+     * @param {string} [data.url] - Optional URL to be validated.
+     * @param {string} [data.email] - Optional email address to be validated.
+     * @param {Interfaces.PhoneData} [data.phone] - Optional phone number data to be validated.
+     * @param {string} [data.domain] - Optional domain name to be validated.
+     * @param {string|Interfaces.CreditCardData} [data.creditCard] - Optional credit card number or data to be validated.
+     * @param {string} [data.ip] - Optional IP address to be validated.
+     * @param {string} [data.wallet] - Optional wallet address to be validated.
+     * @param {string} [data.userAgent] - Optional user agent string to be validated.
+     * @param {string} [data.iban] - Optional IBAN to be validated.
+     * @param {Interfaces.VerifyPlugins[]} [data.plugins] - Optional array of verification plugins to be used.
+     * @returns {Promise<Interfaces.DataValidationAnalysis>} A promise that resolves to the response from the server.
+     * @throws Will throw an error if there is an issue with the validation process.
+     *
+     * [Documentation](https://docs.tpeoficial.com/docs/dymo-api/private/data-verifier)
+     */
+    async isValidDataRaw(data) {
+        return await PrivateAPI.isValidDataRaw(this.axiosClient, data);
     }
     ;
     /**

package/dist/types/branches/private/functions/{isValidData → isValidDataRaw}/index.d.ts

@@ -12,4 +12,4 @@ import * as Interfaces from "../../../../lib/types/interfaces";
  * @throws Will throw an error if the token is null, if none of the required fields are present in the data,
  *         or if an error occurs during the verification request.
  */
-export declare const isValidData: (axiosClient: AxiosInstance, data: Interfaces.Validator) => Promise<any>;
+export declare const isValidDataRaw: (axiosClient: AxiosInstance, data: Interfaces.Validator) => Promise<any>;

package/dist/types/branches/private/index.d.ts

@@ -1,6 +1,6 @@
 export * from "./functions/extractWithTextly";
 export * from "./functions/getRandom";
-export * from "./functions/isValidData";
+export * from "./functions/isValidDataRaw";
 export * from "./functions/isValidEmail";
 export * from "./functions/protectReq";
 export * from "./functions/sendEmail";

package/dist/types/dymo-api.d.ts

@@ -36,6 +36,7 @@ declare class DymoAPI {
      * This method requires either the root API key or the API key to be set.
      * If neither is set, it will throw an error.
      *
+     * @deprecated Use `isValidDataRaw` instead. This feature will be modified soon.
      * @param {Object} data - The data to be validated.
      * @param {string} [data.url] - Optional URL to be validated.
      * @param {string} [data.email] - Optional email address to be validated.
@@ -53,6 +54,29 @@ declare class DymoAPI {
      * [Documentation](https://docs.tpeoficial.com/docs/dymo-api/private/data-verifier)
      */
     isValidData(data: Interfaces.Validator): Promise<Interfaces.DataValidationAnalysis>;
+    /**
+     * Validates the given data against the configured validation settings.
+     *
+     * This method requires either the root API key or the API key to be set.
+     * If neither is set, it will throw an error.
+     *
+     * @param {Object} data - The data to be validated.
+     * @param {string} [data.url] - Optional URL to be validated.
+     * @param {string} [data.email] - Optional email address to be validated.
+     * @param {Interfaces.PhoneData} [data.phone] - Optional phone number data to be validated.
+     * @param {string} [data.domain] - Optional domain name to be validated.
+     * @param {string|Interfaces.CreditCardData} [data.creditCard] - Optional credit card number or data to be validated.
+     * @param {string} [data.ip] - Optional IP address to be validated.
+     * @param {string} [data.wallet] - Optional wallet address to be validated.
+     * @param {string} [data.userAgent] - Optional user agent string to be validated.
+     * @param {string} [data.iban] - Optional IBAN to be validated.
+     * @param {Interfaces.VerifyPlugins[]} [data.plugins] - Optional array of verification plugins to be used.
+     * @returns {Promise<Interfaces.DataValidationAnalysis>} A promise that resolves to the response from the server.
+     * @throws Will throw an error if there is an issue with the validation process.
+     *
+     * [Documentation](https://docs.tpeoficial.com/docs/dymo-api/private/data-verifier)
+     */
+    isValidDataRaw(data: Interfaces.Validator): Promise<Interfaces.DataValidationAnalysis>;
     /**
      * Validates the given email against the configured rules.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dymo-api",
-  "version": "1.2.17",
+  "version": "1.2.19",
   "description": "Flow system for Dymo API.",
   "main": "dist/cjs/dymo-api.js",
   "module": "dist/esm/dymo-api.js",