oneentry 1.0.151 → 1.0.153

package/dist/users/usersApi.d.ts

@@ -24,6 +24,7 @@ export default class UsersApi extends AsyncModules implements IUsersApi {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization.
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/users/getUser getUser} documentation.
      */
     getUser(langCode?: string): Promise<IUserEntity | IError>;
     /**
@@ -100,6 +101,7 @@ export default class UsersApi extends AsyncModules implements IUsersApi {
      * @description This method updates the user's data. This method requires user authorization.
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      * @see For more information about {@link https://doc.oneentry.cloud/docs/forms/create-form registration forms}, see the documentation in the  {@link https://doc.oneentry.cloud/docs/forms/create-form forms configuration section}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/users/updateUser updateUser} documentation.
      */
     updateUser(body: IUserBody, langCode?: string): Promise<boolean | IError>;
     /**
@@ -109,6 +111,7 @@ export default class UsersApi extends AsyncModules implements IUsersApi {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method archives a user object (marks it for deletion). This method requires user authorization.
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/auth-provider/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/users/archiveUser archiveUser} documentation.
      */
     archiveUser(): Promise<boolean | IError>;
     /**
@@ -118,6 +121,7 @@ export default class UsersApi extends AsyncModules implements IUsersApi {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method deletes the user from the system. This method requires user authorization.
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/users/deleteUser deleteUser} documentation.
      */
     deleteUser(): Promise<boolean | IError>;
     /**
@@ -128,6 +132,7 @@ export default class UsersApi extends AsyncModules implements IUsersApi {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method adds an FCM token for sending push notifications. This method requires user authorization.
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/users/addFCMToken addFCMToken} documentation.
      */
     addFCMToken(token: string): Promise<boolean | IError>;
     /**
@@ -138,6 +143,7 @@ export default class UsersApi extends AsyncModules implements IUsersApi {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method deletes an existing FCM token. This method requires user authorization.
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/users/deleteFCMToken deleteFCMToken} documentation.
      */
     deleteFCMToken(token: string): Promise<boolean | IError>;
     /**
@@ -147,6 +153,7 @@ export default class UsersApi extends AsyncModules implements IUsersApi {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization (or a guest context).
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/users/getCart getCart} documentation.
      */
     getCart(): Promise<ICartResponse | IError>;
     /**
@@ -157,6 +164,7 @@ export default class UsersApi extends AsyncModules implements IUsersApi {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization (or a guest context).
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/users/setCart setCart} documentation.
      */
     setCart(body: ICartSet): Promise<ICartResponse | IError>;
     /**
@@ -167,6 +175,7 @@ export default class UsersApi extends AsyncModules implements IUsersApi {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization (or a guest context).
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/users/addCartItem addCartItem} documentation.
      */
     addCartItem(body: ICartAddItem): Promise<ICartResponse | IError>;
     /**
@@ -177,6 +186,7 @@ export default class UsersApi extends AsyncModules implements IUsersApi {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization (or a guest context).
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/users/removeCartItem removeCartItem} documentation.
      */
     removeCartItem(productId: number): Promise<ICartResponse | IError>;
     /**
@@ -186,6 +196,7 @@ export default class UsersApi extends AsyncModules implements IUsersApi {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization (or a guest context).
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/users/getWishlist getWishlist} documentation.
      */
     getWishlist(): Promise<IWishlistResponse | IError>;
     /**
@@ -196,6 +207,7 @@ export default class UsersApi extends AsyncModules implements IUsersApi {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization (or a guest context).
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/users/setWishlist setWishlist} documentation.
      */
     setWishlist(body: IWishlistSet): Promise<IWishlistResponse | IError>;
     /**
@@ -206,6 +218,7 @@ export default class UsersApi extends AsyncModules implements IUsersApi {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization (or a guest context).
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/users/addWishlistItem addWishlistItem} documentation.
      */
     addWishlistItem(body: IWishlistAddItem): Promise<IWishlistResponse | IError>;
     /**
@@ -216,6 +229,7 @@ export default class UsersApi extends AsyncModules implements IUsersApi {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization (or a guest context).
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/users/removeWishlistItem removeWishlistItem} documentation.
      */
     removeWishlistItem(productId: number): Promise<IWishlistResponse | IError>;
 }

package/dist/users/usersApi.js

@@ -28,6 +28,7 @@ class UsersApi extends asyncModules_1.default {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization.
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/users/getUser getUser} documentation.
      */
     async getUser(langCode = this.state.lang) {
         const result = await this._fetchGet(`/me?langCode=${langCode}`);
@@ -109,6 +110,7 @@ class UsersApi extends asyncModules_1.default {
      * @description This method updates the user's data. This method requires user authorization.
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      * @see For more information about {@link https://doc.oneentry.cloud/docs/forms/create-form registration forms}, see the documentation in the  {@link https://doc.oneentry.cloud/docs/forms/create-form forms configuration section}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/users/updateUser updateUser} documentation.
      */
     async updateUser(body, langCode = this.state.lang) {
         if (!('langCode' in body))
@@ -124,6 +126,7 @@ class UsersApi extends asyncModules_1.default {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method archives a user object (marks it for deletion). This method requires user authorization.
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/auth-provider/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/users/archiveUser archiveUser} documentation.
      */
     async archiveUser() {
         const result = await this._fetchDelete('/me');
@@ -136,6 +139,7 @@ class UsersApi extends asyncModules_1.default {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method deletes the user from the system. This method requires user authorization.
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/users/deleteUser deleteUser} documentation.
      */
     async deleteUser() {
         const result = await this._fetchDelete('/me/account');
@@ -149,6 +153,7 @@ class UsersApi extends asyncModules_1.default {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method adds an FCM token for sending push notifications. This method requires user authorization.
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/users/addFCMToken addFCMToken} documentation.
      */
     async addFCMToken(token) {
         const result = await this._fetchPost(`/me/fcm-token/${token}`);
@@ -162,6 +167,7 @@ class UsersApi extends asyncModules_1.default {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method deletes an existing FCM token. This method requires user authorization.
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/users/deleteFCMToken deleteFCMToken} documentation.
      */
     async deleteFCMToken(token) {
         const result = await this._fetchDelete(`/me/fcm-token/${token}`);
@@ -174,6 +180,7 @@ class UsersApi extends asyncModules_1.default {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization (or a guest context).
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/users/getCart getCart} documentation.
      */
     async getCart() {
         const result = await this._fetchGet('/me/cart');
@@ -188,6 +195,7 @@ class UsersApi extends asyncModules_1.default {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization (or a guest context).
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/users/setCart setCart} documentation.
      */
     async setCart(body) {
         const result = await this._fetchPut('/me/cart', body);
@@ -202,6 +210,7 @@ class UsersApi extends asyncModules_1.default {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization (or a guest context).
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/users/addCartItem addCartItem} documentation.
      */
     async addCartItem(body) {
         const result = await this._fetchPost('/me/cart/items', body);
@@ -216,6 +225,7 @@ class UsersApi extends asyncModules_1.default {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization (or a guest context).
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/users/removeCartItem removeCartItem} documentation.
      */
     async removeCartItem(productId) {
         const result = await this._fetchDelete(`/me/cart/items/${productId}`);
@@ -229,6 +239,7 @@ class UsersApi extends asyncModules_1.default {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization (or a guest context).
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/users/getWishlist getWishlist} documentation.
      */
     async getWishlist() {
         const result = await this._fetchGet('/me/wishlist');
@@ -243,6 +254,7 @@ class UsersApi extends asyncModules_1.default {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization (or a guest context).
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/users/setWishlist setWishlist} documentation.
      */
     async setWishlist(body) {
         const result = await this._fetchPut('/me/wishlist', body);
@@ -257,6 +269,7 @@ class UsersApi extends asyncModules_1.default {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization (or a guest context).
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/users/addWishlistItem addWishlistItem} documentation.
      */
     async addWishlistItem(body) {
         const result = await this._fetchPost('/me/wishlist/items', body);
@@ -271,6 +284,7 @@ class UsersApi extends asyncModules_1.default {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization (or a guest context).
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/users/removeWishlistItem removeWishlistItem} documentation.
      */
     async removeWishlistItem(productId) {
         const result = await this._fetchDelete(`/me/wishlist/items/${productId}`);

package/dist/web-socket/wsApi.d.ts

@@ -19,7 +19,7 @@ export default class WsApi extends AsyncModules implements IWS {
      * @handleName connect
      * @returns {Socket} Returns a Socket instance.
      * @description Creates an instance of an object Socket.io with a connection. This method requires user authorization.
-     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/web-socket/connect connect} documentation.
      */
     connect(): Socket;
 }

package/dist/web-socket/wsApi.js

@@ -23,7 +23,7 @@ class WsApi extends asyncModules_1.default {
      * @handleName connect
      * @returns {Socket} Returns a Socket instance.
      * @description Creates an instance of an object Socket.io with a connection. This method requires user authorization.
-     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/web-socket/connect connect} documentation.
      */
     connect() {
         if (!this.state.accessToken) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oneentry",
-  "version": "1.0.151",
+  "version": "1.0.153",
   "description": "OneEntry NPM package",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",