@emilgroup/customer-sdk-node 1.40.0 → 1.41.0

package/dist/base.d.ts

@@ -55,19 +55,17 @@ export declare class BaseAPI {
     private username?;
     private password?;
     private isCustomerToken;
-    private permissions?;
     constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
     initialize(env?: Environment): Promise<void>;
     private loadCredentials;
     private readConfigFile;
     private readEnvVariables;
     selectEnvironment(env: Environment): void;
-    getPermissions(): Array<string>;
     authorize(username: string, password: string): Promise<void>;
     initiateAuthorization(username: string, password: string, tenantSlug: string): Promise<AxiosResponse<InitiateAuthResponseClass>>;
     respondToAuthorizationChallenge(respondToAuthChallengeRequestDto: RespondToAuthChallengeRequestDto): Promise<AxiosResponse<RespondToAuthChallengeClass>>;
-    refreshTokenTenant(): Promise<LoginClass>;
-    refreshTokenCustomer(): Promise<LoginClass>;
+    refreshTokenTenant(): Promise<string>;
+    refreshTokenCustomer(): Promise<string>;
     private extractRefreshToken;
     private attachInterceptor;
 }

package/dist/base.js

@@ -243,14 +243,11 @@ var BaseAPI = /** @class */ (function () {
     BaseAPI.prototype.selectEnvironment = function (env) {
         this.configuration.basePath = env;
     };
-    BaseAPI.prototype.getPermissions = function () {
-        return this.permissions.split(',');
-    };
     BaseAPI.prototype.authorize = function (username, password) {
         return __awaiter(this, void 0, void 0, function () {
-            var options, response, _a, accessToken, permissions, refreshToken;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
+            var options, response, accessToken, refreshToken;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
                     case 0:
                         options = {
                             method: 'POST',
@@ -264,11 +261,10 @@ var BaseAPI = /** @class */ (function () {
                         };
                         return [4 /*yield*/, axios_1.default.request(options)];
                     case 1:
-                        response = _b.sent();
-                        _a = response.data, accessToken = _a.accessToken, permissions = _a.permissions;
+                        response = _a.sent();
+                        accessToken = response.data.accessToken;
                         this.configuration.username = username;
                         this.configuration.accessToken = "Bearer ".concat(accessToken);
-                        this.permissions = permissions;
                         refreshToken = this.extractRefreshToken(response);
                         this.configuration.refreshToken = refreshToken;
                         return [2 /*return*/];
@@ -343,13 +339,13 @@ var BaseAPI = /** @class */ (function () {
     };
     BaseAPI.prototype.refreshTokenTenant = function () {
         return __awaiter(this, void 0, void 0, function () {
-            var _a, username, refreshToken, options, response;
+            var _a, username, refreshToken, options, accessToken;
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
                         _a = this.configuration, username = _a.username, refreshToken = _a.refreshToken;
                         if (!username || !refreshToken) {
-                            throw new Error('Failed to refresh token.');
+                            return [2 /*return*/, ''];
                         }
                         options = {
                             method: 'POST',
@@ -363,21 +359,21 @@ var BaseAPI = /** @class */ (function () {
                         };
                         return [4 /*yield*/, axios_1.default.request(options)];
                     case 1:
-                        response = _b.sent();
-                        return [2 /*return*/, response.data];
+                        accessToken = (_b.sent()).data.accessToken;
+                        return [2 /*return*/, accessToken];
                 }
             });
         });
     };
     BaseAPI.prototype.refreshTokenCustomer = function () {
         return __awaiter(this, void 0, void 0, function () {
-            var _a, username, refreshToken, tenantSlug, options, response;
+            var _a, username, refreshToken, tenantSlug, options, accessToken;
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
                         _a = this.configuration, username = _a.username, refreshToken = _a.refreshToken, tenantSlug = _a.tenantSlug;
                         if (!username || !refreshToken) {
-                            throw new Error('Failed to refresh token.');
+                            return [2 /*return*/, ''];
                         }
                         options = {
                             method: 'POST',
@@ -391,8 +387,8 @@ var BaseAPI = /** @class */ (function () {
                         };
                         return [4 /*yield*/, axios_1.default.request(options)];
                     case 1:
-                        response = _b.sent();
-                        return [2 /*return*/, response.data];
+                        accessToken = (_b.sent()).data.accessToken;
+                        return [2 /*return*/, accessToken];
                 }
             });
         });
@@ -409,38 +405,35 @@ var BaseAPI = /** @class */ (function () {
         axios.interceptors.response.use(function (res) {
             return res;
         }, function (err) { return __awaiter(_this, void 0, void 0, function () {
-            var originalConfig, tokenString, permissions, accessToken, _error_1, tokenString, permissions, accessToken, _error_2;
-            var _a, _b, _c, _d;
-            return __generator(this, function (_e) {
-                switch (_e.label) {
+            var originalConfig, tokenString, accessToken, _error_1, tokenString, accessToken, _error_2;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
                     case 0:
                         originalConfig = err.config;
                         if (!err.response) return [3 /*break*/, 8];
                         if (!(err.response.status === 401 && !originalConfig._retry)) return [3 /*break*/, 7];
                         originalConfig._retry = true;
-                        _e.label = 1;
+                        _a.label = 1;
                     case 1:
-                        _e.trys.push([1, 6, , 7]);
+                        _a.trys.push([1, 6, , 7]);
                         tokenString = void 0;
-                        permissions = void 0;
                         if (!this.isCustomerToken) return [3 /*break*/, 3];
                         return [4 /*yield*/, this.refreshTokenCustomer()];
                     case 2:
-                        (_a = _e.sent(), tokenString = _a.accessToken, permissions = _a.permissions);
+                        tokenString = _a.sent();
                         return [3 /*break*/, 5];
                     case 3: return [4 /*yield*/, this.refreshTokenTenant()];
                     case 4:
-                        (_b = _e.sent(), tokenString = _b.accessToken, permissions = _b.permissions);
-                        _e.label = 5;
+                        tokenString = _a.sent();
+                        _a.label = 5;
                     case 5:
                         accessToken = "Bearer ".concat(tokenString);
-                        this.permissions = permissions;
                         delete originalConfig.headers['Authorization'];
                         originalConfig.headers['Authorization'] = accessToken;
                         this.configuration.accessToken = accessToken;
                         return [2 /*return*/, axios(originalConfig)];
                     case 6:
-                        _error_1 = _e.sent();
+                        _error_1 = _a.sent();
                         if (_error_1.response && _error_1.response.data) {
                             return [2 /*return*/, Promise.reject(_error_1.response.data)];
                         }
@@ -456,29 +449,27 @@ var BaseAPI = /** @class */ (function () {
                             && originalConfig.headers.hasOwnProperty('Authorization')
                             && _retry_count < 4)) return [3 /*break*/, 15];
                         _retry_count++;
-                        _e.label = 9;
+                        _a.label = 9;
                     case 9:
-                        _e.trys.push([9, 14, , 15]);
+                        _a.trys.push([9, 14, , 15]);
                         tokenString = void 0;
-                        permissions = void 0;
                         if (!this.isCustomerToken) return [3 /*break*/, 11];
                         return [4 /*yield*/, this.refreshTokenCustomer()];
                     case 10:
-                        (_c = _e.sent(), tokenString = _c.accessToken, permissions = _c.permissions);
+                        tokenString = _a.sent();
                         return [3 /*break*/, 13];
                     case 11: return [4 /*yield*/, this.refreshTokenTenant()];
                     case 12:
-                        (_d = _e.sent(), tokenString = _d.accessToken, permissions = _d.permissions);
-                        _e.label = 13;
+                        tokenString = _a.sent();
+                        _a.label = 13;
                     case 13:
                         accessToken = "Bearer ".concat(tokenString);
-                        this.permissions = permissions;
                         _retry = true;
                         originalConfig.headers['Authorization'] = accessToken;
                         this.configuration.accessToken = accessToken;
                         return [2 /*return*/, axios.request(__assign({}, originalConfig))];
                     case 14:
-                        _error_2 = _e.sent();
+                        _error_2 = _a.sent();
                         if (_error_2.response && _error_2.response.data) {
                             return [2 /*return*/, Promise.reject(_error_2.response.data)];
                         }

package/dist/models/card-details-dto.d.ts

@@ -0,0 +1,42 @@
+/**
+ * EMIL CustomerService
+ * The EMIL CustomerService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CardDetailsDto
+ */
+export interface CardDetailsDto {
+    /**
+     *
+     * @type {string}
+     * @memberof CardDetailsDto
+     */
+    'encryptedCardNumber': string;
+    /**
+     *
+     * @type {string}
+     * @memberof CardDetailsDto
+     */
+    'encryptedExpiryMonth': string;
+    /**
+     *
+     * @type {string}
+     * @memberof CardDetailsDto
+     */
+    'encryptedExpiryYear': string;
+    /**
+     *
+     * @type {string}
+     * @memberof CardDetailsDto
+     */
+    'encryptedSecurityCode': string;
+}

package/dist/models/card-details-dto.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CustomerService
+ * The EMIL CustomerService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/complete-adyen-payment-setup-request-dto.d.ts

@@ -0,0 +1,80 @@
+/**
+ * EMIL CustomerService
+ * The EMIL CustomerService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { CardDetailsDto } from './card-details-dto';
+import { SepaDirectDto } from './sepa-direct-dto';
+/**
+ *
+ * @export
+ * @interface CompleteAdyenPaymentSetupRequestDto
+ */
+export interface CompleteAdyenPaymentSetupRequestDto {
+    /**
+     * Unique identifier for the shopper on Adyen.
+     * @type {string}
+     * @memberof CompleteAdyenPaymentSetupRequestDto
+     */
+    'shopperReference': string;
+    /**
+     * The payment method type on Adyen.
+     * @type {string}
+     * @memberof CompleteAdyenPaymentSetupRequestDto
+     */
+    'paymentMethodType': string;
+    /**
+     * Unique identifier of the lead that this object belongs to.
+     * @type {string}
+     * @memberof CompleteAdyenPaymentSetupRequestDto
+     */
+    'leadCode'?: string;
+    /**
+     * The account\'s type.
+     * @type {string}
+     * @memberof CompleteAdyenPaymentSetupRequestDto
+     */
+    'accountType': string;
+    /**
+     * The accounts holder\'s first name.
+     * @type {string}
+     * @memberof CompleteAdyenPaymentSetupRequestDto
+     */
+    'firstName'?: string;
+    /**
+     * The account holder\'s last name.
+     * @type {string}
+     * @memberof CompleteAdyenPaymentSetupRequestDto
+     */
+    'lastName'?: string;
+    /**
+     * The account\'s company name.
+     * @type {string}
+     * @memberof CompleteAdyenPaymentSetupRequestDto
+     */
+    'companyName'?: string;
+    /**
+     * The account\'s email address
+     * @type {string}
+     * @memberof CompleteAdyenPaymentSetupRequestDto
+     */
+    'email': string;
+    /**
+     *
+     * @type {CardDetailsDto}
+     * @memberof CompleteAdyenPaymentSetupRequestDto
+     */
+    'cardDetails'?: CardDetailsDto;
+    /**
+     *
+     * @type {SepaDirectDto}
+     * @memberof CompleteAdyenPaymentSetupRequestDto
+     */
+    'sepaDetails'?: SepaDirectDto;
+}

package/dist/models/complete-adyen-payment-setup-request-dto.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CustomerService
+ * The EMIL CustomerService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/complete-payment-setup-psp-request.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { CompleteAdyenPaymentSetupRequestDto } from './complete-adyen-payment-setup-request-dto';
 import { CompleteBraintreePaymentSetupRequestDto } from './complete-braintree-payment-setup-request-dto';
 import { CompleteStripePaymentSetupRequestDto } from './complete-stripe-payment-setup-request-dto';
 /**
@@ -17,6 +18,12 @@ import { CompleteStripePaymentSetupRequestDto } from './complete-stripe-payment-
  * @interface CompletePaymentSetupPspRequest
  */
 export interface CompletePaymentSetupPspRequest {
+    /**
+     * Product slug.
+     * @type {string}
+     * @memberof CompletePaymentSetupPspRequest
+     */
+    'productSlug'?: string;
     /**
      *
      * @type {CompleteStripePaymentSetupRequestDto}
@@ -29,4 +36,10 @@ export interface CompletePaymentSetupPspRequest {
      * @memberof CompletePaymentSetupPspRequest
      */
     'braintree'?: CompleteBraintreePaymentSetupRequestDto;
+    /**
+     *
+     * @type {CompleteAdyenPaymentSetupRequestDto}
+     * @memberof CompletePaymentSetupPspRequest
+     */
+    'adyen'?: CompleteAdyenPaymentSetupRequestDto;
 }

package/dist/models/complete-payment-setup-response-class.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { PaymentMethodClass } from './payment-method-class';
 /**
  *
  * @export
@@ -17,8 +18,8 @@
 export interface CompletePaymentSetupResponseClass {
     /**
      * Payment method saved in the DB.
-     * @type {object}
+     * @type {PaymentMethodClass}
      * @memberof CompletePaymentSetupResponseClass
      */
-    'paymentMethod': object;
+    'paymentMethod': PaymentMethodClass;
 }

package/dist/models/index.d.ts

@@ -1,10 +1,12 @@
 export * from './account-class';
 export * from './account-policy-class';
 export * from './authentication-result-class';
+export * from './card-details-dto';
 export * from './change-customer-email-request-dto';
 export * from './change-password-request-dto';
 export * from './change-password-response-class';
 export * from './claim-class';
+export * from './complete-adyen-payment-setup-request-dto';
 export * from './complete-braintree-payment-setup-request-dto';
 export * from './complete-payment-setup-psp-request';
 export * from './complete-payment-setup-response-class';
@@ -31,9 +33,11 @@ export * from './get-lead-response-class';
 export * from './get-policy-response-class';
 export * from './get-product-response-class';
 export * from './grpc-update-lead-request-dto';
+export * from './initiate-adyen-payment-setup-response-class';
 export * from './initiate-auth-request-dto';
 export * from './initiate-auth-response-class';
 export * from './initiate-braintree-payment-setup-response-class';
+export * from './initiate-payment-setup-request-dto';
 export * from './initiate-payment-setup-response-class';
 export * from './initiate-stripe-payment-setup-response-class';
 export * from './inline-response200';
@@ -54,6 +58,7 @@ export * from './list-leads-response-class';
 export * from './list-policies-response-class';
 export * from './list-products-response-class';
 export * from './partner-link-class';
+export * from './payment-method-class';
 export * from './policy-class';
 export * from './policy-object-class';
 export * from './policy-object-dto';
@@ -71,6 +76,7 @@ export * from './request-policy-update-response-class';
 export * from './reset-password-by-customer-request-dto';
 export * from './respond-to-auth-challenge-class';
 export * from './respond-to-auth-challenge-request-dto';
+export * from './sepa-direct-dto';
 export * from './sepa-dto';
 export * from './shared-customer-policy-object-request-dto';
 export * from './shared-invoice-item-class';

package/dist/models/index.js

@@ -17,10 +17,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./account-class"), exports);
 __exportStar(require("./account-policy-class"), exports);
 __exportStar(require("./authentication-result-class"), exports);
+__exportStar(require("./card-details-dto"), exports);
 __exportStar(require("./change-customer-email-request-dto"), exports);
 __exportStar(require("./change-password-request-dto"), exports);
 __exportStar(require("./change-password-response-class"), exports);
 __exportStar(require("./claim-class"), exports);
+__exportStar(require("./complete-adyen-payment-setup-request-dto"), exports);
 __exportStar(require("./complete-braintree-payment-setup-request-dto"), exports);
 __exportStar(require("./complete-payment-setup-psp-request"), exports);
 __exportStar(require("./complete-payment-setup-response-class"), exports);
@@ -47,9 +49,11 @@ __exportStar(require("./get-lead-response-class"), exports);
 __exportStar(require("./get-policy-response-class"), exports);
 __exportStar(require("./get-product-response-class"), exports);
 __exportStar(require("./grpc-update-lead-request-dto"), exports);
+__exportStar(require("./initiate-adyen-payment-setup-response-class"), exports);
 __exportStar(require("./initiate-auth-request-dto"), exports);
 __exportStar(require("./initiate-auth-response-class"), exports);
 __exportStar(require("./initiate-braintree-payment-setup-response-class"), exports);
+__exportStar(require("./initiate-payment-setup-request-dto"), exports);
 __exportStar(require("./initiate-payment-setup-response-class"), exports);
 __exportStar(require("./initiate-stripe-payment-setup-response-class"), exports);
 __exportStar(require("./inline-response200"), exports);
@@ -70,6 +74,7 @@ __exportStar(require("./list-leads-response-class"), exports);
 __exportStar(require("./list-policies-response-class"), exports);
 __exportStar(require("./list-products-response-class"), exports);
 __exportStar(require("./partner-link-class"), exports);
+__exportStar(require("./payment-method-class"), exports);
 __exportStar(require("./policy-class"), exports);
 __exportStar(require("./policy-object-class"), exports);
 __exportStar(require("./policy-object-dto"), exports);
@@ -87,6 +92,7 @@ __exportStar(require("./request-policy-update-response-class"), exports);
 __exportStar(require("./reset-password-by-customer-request-dto"), exports);
 __exportStar(require("./respond-to-auth-challenge-class"), exports);
 __exportStar(require("./respond-to-auth-challenge-request-dto"), exports);
+__exportStar(require("./sepa-direct-dto"), exports);
 __exportStar(require("./sepa-dto"), exports);
 __exportStar(require("./shared-customer-policy-object-request-dto"), exports);
 __exportStar(require("./shared-invoice-item-class"), exports);

package/dist/models/initiate-adyen-payment-setup-response-class.d.ts

@@ -0,0 +1,42 @@
+/**
+ * EMIL CustomerService
+ * The EMIL CustomerService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface InitiateAdyenPaymentSetupResponseClass
+ */
+export interface InitiateAdyenPaymentSetupResponseClass {
+    /**
+     * The client key associated with the Adyen account.
+     * @type {string}
+     * @memberof InitiateAdyenPaymentSetupResponseClass
+     */
+    'clientKey': string;
+    /**
+     * A unique reference for the shopper.
+     * @type {string}
+     * @memberof InitiateAdyenPaymentSetupResponseClass
+     */
+    'shopperReference': string;
+    /**
+     * The environment in which the payment request is being made (e.g., \"TEST\" or \"LIVE\").
+     * @type {string}
+     * @memberof InitiateAdyenPaymentSetupResponseClass
+     */
+    'environment': string;
+    /**
+     * The country code associated with the shopper\'s payment details.
+     * @type {string}
+     * @memberof InitiateAdyenPaymentSetupResponseClass
+     */
+    'country': string;
+}

package/dist/models/initiate-adyen-payment-setup-response-class.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CustomerService
+ * The EMIL CustomerService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/initiate-payment-setup-request-dto.d.ts

@@ -0,0 +1,30 @@
+/**
+ * EMIL CustomerService
+ * The EMIL CustomerService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface InitiatePaymentSetupRequestDto
+ */
+export interface InitiatePaymentSetupRequestDto {
+    /**
+     * Customer code.
+     * @type {string}
+     * @memberof InitiatePaymentSetupRequestDto
+     */
+    'customerCode': string;
+    /**
+     * Product slug.
+     * @type {string}
+     * @memberof InitiatePaymentSetupRequestDto
+     */
+    'productSlug'?: string;
+}

package/dist/models/initiate-payment-setup-request-dto.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CustomerService
+ * The EMIL CustomerService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/initiate-payment-setup-response-class.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { InitiateAdyenPaymentSetupResponseClass } from './initiate-adyen-payment-setup-response-class';
 import { InitiateBraintreePaymentSetupResponseClass } from './initiate-braintree-payment-setup-response-class';
 import { InitiateStripePaymentSetupResponseClass } from './initiate-stripe-payment-setup-response-class';
 /**
@@ -29,4 +30,10 @@ export interface InitiatePaymentSetupResponseClass {
      * @memberof InitiatePaymentSetupResponseClass
      */
     'braintree': InitiateBraintreePaymentSetupResponseClass;
+    /**
+     * Adyen response after generating client token.
+     * @type {InitiateAdyenPaymentSetupResponseClass}
+     * @memberof InitiatePaymentSetupResponseClass
+     */
+    'adyen': InitiateAdyenPaymentSetupResponseClass;
 }

package/dist/models/lead-class.d.ts

@@ -84,7 +84,7 @@ export interface LeadClass {
      */
     'premiumOverride'?: PremiumOverrideRequestClass;
     /**
-     * A slug is a human-readable, unique identifier, used to identify a resource      instead of a less human-readable identifier like an id.
+     * A slug is a human-readable, unique identifier, used to identify a resource     instead of a less human-readable identifier like an id.
      * @type {string}
      * @memberof LeadClass
      */