oneentry 1.0.123 → 1.0.124

package/dist/pages/pagesApi.js

@@ -18,9 +18,14 @@ class PageApi extends asyncModules_1.default {
     /**
      * Get all top-level page objects.
      *
-     * @param {string} [langCode] - Default language code, using the current state if not provided
+     * @handleName getRootPages
      *
-     * @returns Returns all created pages without parents as an array of PageEntity objects or an empty array [] (if there is no data)
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {IPagesEntity[]} Returns all created pages without parents as an array of PageEntity objects or an empty array [] (if there is no data)
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description
      */
     async getRootPages(langCode = this.state.lang) {
         // Fetch data from the server using a GET request to retrieve root pages for the specified language code
@@ -33,9 +38,14 @@ class PageApi extends asyncModules_1.default {
     /**
      * Get all page objects with product information as an array.
      *
-     * @param {string} [langCode] - Default language code, using the current state if not provided
+     * @handleName getPages
+     *
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {IPagesEntity[]} Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data).
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      *
-     * @returns Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data)
+     * @description Get all page objects with product information as an array.
      */
     async getPages(langCode = this.state.lang) {
         // Fetch data from the server using a GET request to retrieve all pages for the specified language code
@@ -48,10 +58,15 @@ class PageApi extends asyncModules_1.default {
     /**
      * Get page object with information about forms, blocks, menus, linked to the page.
      *
-     * @param {number} [id] - The unique identifier of the page to be fetched
-     * @param {string} [langCode] - Default language code, using the current state if not provided
+     * @handleName getPageById
      *
-     * @returns Returns PageEntity object
+     * @param {number} id - The unique identifier of the page to be fetched. Example: 1.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {IPagesEntity} Returns PageEntity object
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description Get page object with information about forms, blocks, menus, linked to the page.
      */
     async getPageById(id, langCode = this.state.lang) {
         // Fetch data from the server using a GET request to retrieve page details by ID and language code
@@ -64,10 +79,15 @@ class PageApi extends asyncModules_1.default {
     /**
      * Get page object with information about forms, blocks, menus, linked to the page by URL.
      *
-     * @param {string} [url] - Page URL
-     * @param {string} [langCode] - lang code
+     * @handleName getPageByUrl
+     *
+     * @param {string} url - Page URL. Example: "about".
+     * @param {string} [langCode] - Language code. Default: "en_US".
      *
-     * @returns Returns PageEntity object
+     * @return {IPagesEntity} Returns PageEntity object
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description Get page object with information about forms, blocks, menus, linked to the page by URL.
      */
     async getPageByUrl(url, langCode = this.state.lang) {
         // Fetch data from the server using a GET request with the specified URL and language code
@@ -80,10 +100,15 @@ class PageApi extends asyncModules_1.default {
     /**
      * Get child pages object with information as an array.
      *
-     * @param {string} [url] - The URL of the parent page for which child pages are to be fetched
-     * @param {string} [langCode] - Required parameter langCode. Default language code, using the current state if not provided
+     * @handleName getChildPagesByParentUrl
+     *
+     * @param {string} url - The URL of the parent page for which child pages are to be fetched. Example: "about/our-team".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {IPagesEntity} Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data) for the selected parent
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      *
-     * @returns Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data) for the selected parent
+     * @description Get child pages object with information as an array.
      */
     async getChildPagesByParentUrl(url, langCode = this.state.lang) {
         // Fetch data from the server using a GET request to retrieve child pages for the specified parent URL and language code
@@ -96,10 +121,15 @@ class PageApi extends asyncModules_1.default {
     /**
      * Get all blocks by page url.
      *
-     * @param {string} [url] - Page URL
-     * @param {string} [langCode] - lang code
+     * @handleName getBlocksByPageUrl
      *
-     * @returns Returns all blocks as an array of PositionBlock objects or an empty array [] (if there is no data) for the selected parent
+     * @param {string} url - Page URL. Example: "about".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {IPositionBlock[]} Returns all blocks as an array of PositionBlock objects or an empty array [] (if there is no data) for the selected parent
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description Get all blocks by page url.
      */
     async getBlocksByPageUrl(url, langCode = this.state.lang) {
         const response = await this._fetchGet(`/${url}/blocks?langCode=${langCode}`);
@@ -183,10 +213,15 @@ class PageApi extends asyncModules_1.default {
     /**
      * Get all forms by page url.
      *
-     * @param {string} [url] - The URL of the page for which forms are to be fetched
-     * @param {string} [langCode] - Default language code, using the current state if not provided
+     * @handleName getFormsByPageUrl
+     *
+     * @param {string} url - The URL of the page for which forms are to be fetched. Example: "about".
+     * @param {string} [langCode] - Language code. Default: "en_US".
      *
-     * @returns Returns all forms as an array of PositionForm objects or an empty array [] (if there is no data) for the selected parent
+     * @return {IPositionForm[]} Returns all forms as an array of PositionForm objects or an empty array [] (if there is no data) for the selected parent
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description Get all forms by page url.
      */
     async getFormsByPageUrl(url, langCode = this.state.lang) {
         // Fetch data from the server using a GET request to retrieve forms for the specified page URL and language code
@@ -197,9 +232,14 @@ class PageApi extends asyncModules_1.default {
     /**
      * Get settings for the page.
      *
-     * @param {string} [url] - Page URL
+     * @handleName getConfigPageByUrl
+     *
+     * @param {string} url - Page URL. Example: "about".
      *
-     * @returns Returns a ConfigPage object with page display settings
+     * @return {IPageConfig} Returns a ConfigPage object with page display settings
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description Get settings for the page.
      */
     async getConfigPageByUrl(url) {
         // Fetch data from the server using a GET request to retrieve forms for the specified page URL and language code
@@ -210,10 +250,15 @@ class PageApi extends asyncModules_1.default {
     /**
      * Quick search for page objects with limited output.
      *
-     * @param {string} [name] - Text for searching page objects (search is performed on the title field of the localizeInfos object with the language taken into account)
-     * @param {string} [langCode] - Default language code, using the current state if not provided
+     * @handleName searchPage
+     *
+     * @param {string} name - Text for searching page objects (search is performed on the title field of the localizeInfos object with the language taken into account). Example: "About Us".
+     * @param {string} [langCode] - Language code. Default: "en_US".
      *
-     * @returns Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data)
+     * @return {IPagesEntity[]} Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data)
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description Quick search for page objects with limited output.
      */
     async searchPage(name, langCode = this.state.lang) {
         // Fetch data from the server using a GET request to perform a quick search by page name and language code
@@ -241,8 +286,15 @@ class PageApi extends asyncModules_1.default {
     }
     /**
      * Add template data to pages
-     * @param data
-     * @returns
+     *
+     * @handleName addTemplateToPages
+     *
+     * @param data - An array of page objects (IPagesEntity[]) to which template data will be added. Example: .
+     *
+     * @return - An array of page objects with template data added
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description Add template data to pages
      */
     async addTemplateToPages(data) {
         // Use Promise.all to handle an array of promises returned by mapping over 'data'
@@ -255,8 +307,15 @@ class PageApi extends asyncModules_1.default {
     }
     /**
      * Add template data to page by page templateIdentifier
-     * @param data - page object
-     * @returns
+     *
+     * @handleName addTemplateToPage
+     *
+     * @param data - An array of page objects (IPagesEntity[]) to which template data will be added. Example: .
+     *
+     * @return - An array of page objects with template data added
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description
      */
     async addTemplateToPage(data) {
         // Check if 'templateIdentifier' exists in 'data' and is not null or an empty string

package/dist/pages/pagesInterfaces.d.ts

@@ -1,6 +1,6 @@
 import type { AttributeType, IAttributes, IError, LangType, Types } from '../base/utils';
 /**
- * Represents an interface object of Pages Api.
+ * @interface IPageApi
  *
  * @property {function} getRootPages - Get all top-level page objects.
  * @property {function} getCatalogPages - Get all page objects with product information as an array.
@@ -11,33 +11,117 @@ import type { AttributeType, IAttributes, IError, LangType, Types } from '../bas
  * @property {function} getFormsByPageUrl - Get all forms by page url.
  * @property {function} getConfigPageByUrl - Get settings for the page.
  * @property {function} searchPage - Quick search for page objects with limited output.
+ *
+ * @description This interface defines methods for retrieving and managing pages in the system.
  */
 interface IPageApi {
+    /**
+     * Get all top-level page objects.
+     *
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {IPagesEntity[]} Returns all created pages without parents as an array of PageEntity objects or an empty array [] (if there is no data)
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     getRootPages(langCode?: LangType): Promise<Array<IPagesEntity> | IError>;
+    /**
+     * Get all page objects with product information as an array.
+     *
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {IPagesEntity[]} Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data).
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     getPages(langCode?: LangType): Promise<Array<IPagesEntity> | IError>;
+    /**
+     * Get page object with information about forms, blocks, menus, linked to the page.
+     *
+     * @param {number} id - The unique identifier of the page to be fetched. Example: 123.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {IPagesEntity} Returns PageEntity object
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     getPageById(id: number, langCode?: LangType): Promise<IPagesEntity | IError>;
+    /**
+     * Get page object with information about forms, blocks, menus, linked to the page by URL.
+     *
+     * @param {string} url - Page URL. Example: "about".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {IPagesEntity} Returns PageEntity object
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     getPageByUrl(url: string, langCode?: LangType): Promise<IPagesEntity | IError>;
+    /**
+     * Get child pages object with information as an array.
+     *
+     * @param {string} url - The URL of the parent page for which child pages are to be fetched. Example: "about".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {IPagesEntity} Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data) for the selected parent
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     getChildPagesByParentUrl(url: string, langCode?: LangType): Promise<Array<IPagesEntity> | IError>;
-    getFormsByPageUrl(url: string, langCode?: LangType): Promise<Array<IPositionForm> | IError>;
+    /**
+     * Get all blocks by page url.
+     *
+     * @param {string} url - Page URL. Example: "about".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {IPositionBlock[]} Returns all blocks as an array of PositionBlock objects or an empty array [] (if there is no data) for the selected parent
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     getBlocksByPageUrl(url: string, langCode?: LangType): Promise<Array<IPositionBlock> | IError>;
+    /**
+     * Get all forms by page url.
+     *
+     * @handleName getFormsByPageUrl
+     *
+     * @param {string} url - The URL of the page for which forms are to be fetched. Example: "about".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {IPositionForm[]} Returns all forms as an array of PositionForm objects or an empty array [] (if there is no data) for the selected parent
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description Get all forms by page url.
+     */
+    getFormsByPageUrl(url: string, langCode?: LangType): Promise<Array<IPositionForm> | IError>;
+    /**
+     * Get settings for the page.
+     *
+     * @param {string} url - Page URL. Example: "about".
+     *
+     * @return {IPageConfig} Returns a ConfigPage object with page display settings
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     getConfigPageByUrl(url: string): Promise<IPageConfig | IError>;
+    /**
+     * Quick search for page objects with limited output.
+     *
+     * @param {string} name - Text for searching page objects (search is performed on the title field of the localizeInfos object with the language taken into account). Example: "About Us".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {IPagesEntity[]} Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data)
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     searchPage(name: string, langCode?: LangType): Promise<Array<IPagesEntity> | IError>;
 }
 /**
- * Represents a config object.
+ * @interface IPageConfig
  *
- * @interface
  * @property {number} rowsPerPage - Number of lines per page.
  * @property {number} rowsPerPage - Number of products per page.
+ *
+ * @description This interface defines the configuration for pagination in pages, including the number of rows and products displayed per page.
  */
 interface IPageConfig {
     rowsPerPage: number | null;
     productsPerRow: number | null;
 }
 /**
- * Represents an object with various properties.
+ * @interface IPositionForm
  *
- * @interface
  * @property {number} id - The identifier of the object.
  * @property {number} version - The version number of the object.
  * @property {string} identifier - The textual identifier for the record field.
@@ -47,6 +131,8 @@ interface IPageConfig {
  * @property {Record<string, any>} localizeInfos - The name of the page, taking into account localization.
  * @property {object} processingData - Form data.
  * @property {number} position - The position of the object.
+ *
+ * @description This interface defines the structure of a position form entity, including its identifiers, attributes, and processing data.
  */
 interface IPositionForm {
     id: number;
@@ -60,19 +146,23 @@ interface IPositionForm {
     position: number;
 }
 /**
- * Represents an object with various properties.
+ * @interface IPositionBlock
  *
- * @interface
  * @property {number} id - The identifier of the object.
+ * @property {number} [quantity] - Quantity pages in block.
  * @property {number} version - The version number of the object.
- * @property {number} quantity - Quantity pages in block.
  * @property {string} identifier - The textual identifier for the record field.
  * @property {Record<string, any>} localizeInfos - The name of the page, taking into account localization.
  * @property {number} position - The position of the object.
  * @property {boolean} isSync - Indication of page indexing.
  * @property {AttributeType} attributeValues - Array of attribute values from the index (represented as a pair of user attribute id: attribute value).
- * @property {string} attributeSetIdentifier
+ * @property {string} attributeSetIdentifier - Set of attributes id.
+ * @property {boolean} isVisible - A sign of page visibility.
  * @property {Types} type - Page type.
+ * @property {string | null} templateIdentifier - User id of the linked template.
+ * @property {number} [countElementsPerRow] - Number of elements displayed per row in the block, if applicable.
+ *
+ * @description This interface defines the structure of a position block entity, including its identifiers, attributes, and visibility.
  */
 interface IPositionBlock {
     id: number;
@@ -90,24 +180,28 @@ interface IPositionBlock {
     countElementsPerRow?: number;
 }
 /**
- * Represents an object with various properties.
+ * @interface IPagesEntity
  *
- * @interface
- * @property {number} id - The identifier of the object.
- * @property {number} parentId - The id of the parent page, if it contains null, then it is the top-level page.
- * @property {Record<string, number>} config - Output settings for catalog pages.
- * @property {string} pageUrl - Unique page Url.
- * @property {number} depth - Page nesting depth relative to parentId.
- * @property {Record<string, any>} localizeInfos - The name of the page, taking into account localization.
- * @property {boolean} isVisible - A sign of page visibility.
- * @property {number} products - The number of products linked to the page.
  * @property {string} attributeSetIdentifier - Set of attributes id.
+ * @property {AttributeType} attributeValues - Array of attribute values from the index (represented as a pair of user attribute id: attribute value).
+ * @property {number} [childrenCount] - Children count.
+ * @property {Record<string, number>} [config] - Output settings for catalog pages.
+ * @property {number} depth - Page nesting depth relative to parentId.
+ * @property {number} id - The identifier of the object.
  * @property {boolean} isSync - Indication of page indexing.
+ * @property {boolean} isVisible - A sign of page visibility.
+ * @property {Record<string, any>} [forms] -
+ * @property {Record<string, any>} [blocks] -
+ * @property {Record<string, any>} localizeInfos - The name of the page, taking into account localization.
+ * @property {string} pageUrl - Unique page Url.
+ * @property {number} parentId - The id of the parent page, if it contains null, then it is the top-level page.
+ * @property {number} [position] - Item number (for sorting).
+ * @property {number} [products] - The number of products linked to the page.
  * @property {string} templateIdentifier - User id of the linked template.
- * @property {AttributeType} attributeValues - Array of attribute values from the index (represented as a pair of user attribute id: attribute value).
- * @property {number} position - Item number (for sorting).
  * @property {Types} type - Page type.
- * @property {number} childrenCount - Children count.
+ * @property {any} [template] - Template object.
+ *
+ * @description This interface defines the structure of a page entity, including its identifiers, attributes, and hierarchical relationships.
  */
 interface IPagesEntity {
     attributeSetIdentifier: string | null;

package/dist/payments/paymentsApi.d.ts

@@ -13,68 +13,102 @@ export default class PaymentsApi extends AsyncModules implements IPaymentsApi {
     /**
      * Get list of payment sessions.
      *
-     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
-     * @param {number} [offset] - Optional parameter for pagination, default is 0
-     * @param {number} [limit] - Optional parameter for pagination, default is 30
+     * @handleName getSessions
+     *
+     * @param {number} [offset] - Optional parameter for pagination. Default: 0.
+     * @param {number} [limit] - Optional parameter for pagination. Default: 30.
      *
-     * @returns Returns an array of SessionEntity objects.
+     * @return {ISessionsEntity} Returns an array of SessionEntity objects.
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     getSessions(offset?: number, limit?: number): Promise<ISessionsEntity | IError>;
     /**
      * Get a single payment session object by its identifier.
-     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      *
-     * @param {number} id - Identifier of the retrieved payment session object
+     * @handleName getSessionById
+     *
+     * @param {number} id - Identifier of the retrieved payment session object. Example: 12345.
      *
-     * @returns Returns a single payment session object.
+     * @return {ISessionEntity} Returns a single payment session object.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     getSessionById(id: number): Promise<ISessionEntity | IError>;
     /**
      * Get one payment session object by order identifier 🔐
      *
-     * @param id - order identifier
-     * @returns
+     * @handleName getSessionByOrderId
+     *
+     * @param {number} id - Order identifier. Example: 12345.
+     *
+     * @return {IAccountsEntity}
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description
      */
     getSessionByOrderId(id: number): Promise<IAccountsEntity | IError>;
     /**
      * Creation of payment session.
-     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      *
-     * @param {number} [orderId] - Order identifier
-     * @param {'session' | 'intent'} [type] - Session type
-     * @param {boolean} [automaticTaxEnabled] - Automatic calculation of the tax rate
+     * @handleName createSession
      *
-     * @returns Returns a single payment session object.
+     * @param {number} orderId - Order identifier. Example: 12345.
+     * @param {'session' | 'intent'} type - Session type. Possible values: 'session' or 'intent'. Example:  'session'.
+     * @param {boolean} [automaticTaxEnabled] - Automatic calculation of the tax rate. Default: false.
+     *
+     * @return {ICreateSessionEntity} Returns a single payment session object.
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     createSession(orderId: number, type: 'session' | 'intent', automaticTaxEnabled?: boolean): Promise<ICreateSessionEntity | IError>;
     /**
      * Get payment settings.
-     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      *
-     * @returns Returns object PaymentsConnected or null.
+     * @handleName getConnected
+     *
+     * @return {IConnectedEntity} Returns object PaymentsConnected or null.
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     getConnected(): Promise<IConnectedEntity | null | IError>;
     /**
      * Get all payment accounts as an array.
-     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      *
-     * @returns Returns all created payment accounts as an array of PaymentAccountEntity objects.
+     * @handleName getAccounts
+     *
+     * @return {IAccountsEntity} Returns all created payment accounts as an array of PaymentAccountEntity objects.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     getAccounts(): Promise<Array<IAccountsEntity> | IError>;
     /**
      * Get a single payment account object by its identifier.
+     *
+     * @handleName getAccountById
+     *
      * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      *
-     * @param {number} id - Identifier of the retrieved payment account object
+     * @param {number} id - Identifier of the retrieved payment account object. Example: 12345.
      *
-     * @returns Returns a single payment account object.
+     * @return {IAccountsEntity} Returns a single payment account object.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      */
     getAccountById(id: number): Promise<IAccountsEntity | IError>;
     /**
      * Webhook for Stripe.
-     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      *
-     * @returns Returns true (in case of successful execution) or false (in case of unsuccessful execution)
+     * @handleName webhookStripe
+     *
+     * @return {boolean} Returns true (in case of successful execution) or false (in case of unsuccessful execution)
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     webhookStripe(): Promise<boolean | IError>;
 }