@gofynd/fdk-client-javascript 1.0.1 → 1.0.3

package/sdk/application/Communication/CommunicationApplicationModel.js

@@ -1,143 +1,98 @@
 const Joi = require("joi");
 
 class CommunicationModel {
-  static CommunicationConsentReq() {
+  static BadRequestSchema() {
     return Joi.object({
-      response: Joi.string().allow(""),
-
-      action: Joi.string().allow(""),
-
-      channel: Joi.string().allow(""),
+      message: Joi.string().allow(""),
+      status: Joi.string().allow(""),
     });
   }
-
-  static CommunicationConsentRes() {
+  static CommunicationConsent() {
     return Joi.object({
       app_id: Joi.string().allow(""),
-
-      user_id: Joi.string().allow(""),
-
       channels: CommunicationModel.CommunicationConsentChannels(),
+      user_id: Joi.string().allow(""),
+    });
+  }
+  static CommunicationConsentChannels() {
+    return Joi.object({
+      email: CommunicationModel.CommunicationConsentChannelsEmail(),
+      sms: CommunicationModel.CommunicationConsentChannelsSms(),
+      whatsapp: CommunicationModel.CommunicationConsentChannelsWhatsapp(),
     });
   }
-
   static CommunicationConsentChannelsEmail() {
     return Joi.object({
-      response: Joi.string().allow(""),
-
       display_name: Joi.string().allow(""),
+      response: Joi.string().allow(""),
     });
   }
-
   static CommunicationConsentChannelsSms() {
     return Joi.object({
-      response: Joi.string().allow(""),
-
       display_name: Joi.string().allow(""),
+      response: Joi.string().allow(""),
     });
   }
-
   static CommunicationConsentChannelsWhatsapp() {
     return Joi.object({
-      response: Joi.string().allow(""),
-
-      display_name: Joi.string().allow(""),
-
       country_code: Joi.string().allow(""),
-
+      display_name: Joi.string().allow(""),
       phone_number: Joi.string().allow(""),
+      response: Joi.string().allow(""),
     });
   }
-
-  static CommunicationConsentChannels() {
+  static CommunicationConsentReq() {
     return Joi.object({
-      email: CommunicationModel.CommunicationConsentChannelsEmail(),
-
-      sms: CommunicationModel.CommunicationConsentChannelsSms(),
-
-      whatsapp: CommunicationModel.CommunicationConsentChannelsWhatsapp(),
+      action: Joi.string().allow(""),
+      channel: Joi.string().allow(""),
+      response: Joi.string().allow(""),
     });
   }
-
-  static CommunicationConsent() {
+  static CommunicationConsentRes() {
     return Joi.object({
       app_id: Joi.string().allow(""),
-
-      user_id: Joi.string().allow(""),
-
       channels: CommunicationModel.CommunicationConsentChannels(),
+      user_id: Joi.string().allow(""),
     });
   }
-
-  static BadRequestSchema() {
+  static NotFound() {
     return Joi.object({
-      status: Joi.string().allow(""),
-
       message: Joi.string().allow(""),
     });
   }
-
-  static NotFound() {
+  static Page() {
     return Joi.object({
-      message: Joi.string().allow(""),
+      current: Joi.number(),
+      has_next: Joi.boolean(),
+      has_previous: Joi.boolean(),
+      item_total: Joi.number(),
+      next_id: Joi.string().allow(""),
+      size: Joi.number(),
+      type: Joi.string().allow("").required(),
     });
   }
-
   static PushtokenReq() {
     return Joi.object({
       action: Joi.string().allow(""),
-
       bundle_identifier: Joi.string().allow(""),
-
       push_token: Joi.string().allow(""),
-
-      unique_device_id: Joi.string().allow(""),
-
       type: Joi.string().allow(""),
+      unique_device_id: Joi.string().allow(""),
     });
   }
-
   static PushtokenRes() {
     return Joi.object({
       _id: Joi.string().allow(""),
-
+      application_id: Joi.string().allow(""),
       bundle_identifier: Joi.string().allow(""),
-
+      created_at: Joi.string().allow(""),
+      expired_at: Joi.string().allow(""),
+      platform: Joi.string().allow(""),
       push_token: Joi.string().allow(""),
-
-      unique_device_id: Joi.string().allow(""),
-
       type: Joi.string().allow(""),
-
-      platform: Joi.string().allow(""),
-
-      application_id: Joi.string().allow(""),
-
-      user_id: Joi.string().allow(""),
-
-      created_at: Joi.string().allow(""),
-
+      unique_device_id: Joi.string().allow(""),
       updated_at: Joi.string().allow(""),
-
-      expired_at: Joi.string().allow(""),
-    });
-  }
-
-  static Page() {
-    return Joi.object({
-      item_total: Joi.number(),
-
-      next_id: Joi.string().allow(""),
-
-      has_previous: Joi.boolean(),
-
-      has_next: Joi.boolean(),
-
-      current: Joi.number(),
-
-      type: Joi.string().allow("").required(),
-
-      size: Joi.number(),
+      user_id: Joi.string().allow(""),
     });
   }
 }

package/sdk/application/Communication/CommunicationApplicationValidator.d.ts

@@ -1,6 +1,6 @@
 export = CommunicationValidator;
 declare class CommunicationValidator {
     static getCommunicationConsent(): any;
-    static upsertCommunicationConsent(): any;
     static upsertAppPushtoken(): any;
+    static upsertCommunicationConsent(): any;
 }

package/sdk/application/Communication/CommunicationApplicationValidator.js

@@ -6,15 +6,15 @@ class CommunicationValidator {
     return Joi.object({});
   }
 
-  static upsertCommunicationConsent() {
+  static upsertAppPushtoken() {
     return Joi.object({
-      body: CommunicationModel.CommunicationConsentReq().required(),
+      body: CommunicationModel.PushtokenReq().required(),
     }).required();
   }
 
-  static upsertAppPushtoken() {
+  static upsertCommunicationConsent() {
     return Joi.object({
-      body: CommunicationModel.PushtokenReq().required(),
+      body: CommunicationModel.CommunicationConsentReq().required(),
     }).required();
   }
 }

package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts

@@ -3,98 +3,102 @@ declare class Configuration {
     constructor(_conf: any);
     _conf: any;
     _relativeUrls: {
+        getAppCurrencies: string;
+        getAppStaffList: string;
+        getAppStaffs: string;
         getApplication: string;
-        getOwnerInfo: string;
         getBasicDetails: string;
-        getIntegrationTokens: string;
-        getOrderingStores: string;
-        getStoreDetailById: string;
-        getFeatures: string;
         getContactInfo: string;
         getCurrencies: string;
         getCurrencyById: string;
-        getAppCurrencies: string;
+        getFeatures: string;
+        getIntegrationTokens: string;
         getLanguages: string;
         getOrderingStoreCookie: string;
+        getOrderingStores: string;
+        getOwnerInfo: string;
+        getStoreDetailById: string;
         removeOrderingStoreCookie: string;
-        getAppStaffList: string;
-        getAppStaffs: string;
     };
     _urls: {};
     updateUrls(urls: any): void;
     /**
      * @param {Object} arg - Arg object.
-     * @returns {Promise<Application>} - Success response
-     * @summary: Get current application details
-     * @description: Use this API to get the current application details which includes configurations that indicate the status of the website, domain, ID, tokens, images, etc.
-     */
-    getApplication({}?: any): Promise<Application>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @returns {Promise<ApplicationAboutResponse>} - Success response
-     * @summary: Get application, owner and seller information
-     * @description: Use this API to get the current application details which includes channel name, description, banner, logo, favicon, domain details, etc. This API also retrieves the seller and owner information such as address, email address, and phone number.
-     */
-    getOwnerInfo({}?: any): Promise<ApplicationAboutResponse>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @returns {Promise<ApplicationDetail>} - Success response
-     * @summary: Get basic application details
-     * @description: Use this API to retrieve only the basic details of the application which includes channel name, description, banner, logo, favicon, domain details, etc.
-     */
-    getBasicDetails({}?: any): Promise<ApplicationDetail>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @returns {Promise<AppTokenResponse>} - Success response
-     * @summary: Get integration tokens
-     * @description: Use this API to retrieve the tokens used while integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map and Facebook. **Note** - Token values are encrypted with AES encryption using a secret key. Kindly reach out to the developers for obtaining the secret key.
+     * @returns {Promise<AppCurrencyResponse>} - Success response
+     * @summary: Get currencies enabled in the application
+     * @description: Use this API to get a list of currencies allowed in the current application. Moreover, get the name, code, symbol, and the decimal digits of the currencies.
      */
-    getIntegrationTokens({}?: any): Promise<AppTokenResponse>;
+    getAppCurrencies({}?: any): Promise<AppCurrencyResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {number} [arg.pageNo] - The page number to navigate through the
-     *   given set of results. Default value is 1.
-     * @param {number} [arg.pageSize] - The number of items to retrieve in each
-     *   page. Default value is 10.
-     * @param {string} [arg.q] - Store code or name of the ordering store.
-     * @returns {Promise<OrderingStores>} - Success response
-     * @summary: Get deployment stores
-     * @description: Use this API to retrieve the details of all the deployment stores (the selling locations where the application will be utilized for placing orders).
+     * @param {number} [arg.pageNo] -
+     * @param {number} [arg.pageSize] -
+     * @param {boolean} [arg.orderIncent] - This is a boolean value. Select
+     *   `true` to retrieve the staff members eligible for getting incentives on orders.
+     * @param {number} [arg.orderingStore] - ID of the ordering store. Helps in
+     *   retrieving staff members working at a particular ordering store.
+     * @param {string} [arg.user] - Mongo ID of the staff. Helps in retrieving
+     *   the details of a particular staff member.
+     * @returns {Promise<AppStaffListResponse>} - Success response
+     * @summary: Get a list of staff.
+     * @description: Use this API to get a list of staff including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the application.
      */
-    getOrderingStores({ pageNo, pageSize, q }?: {
+    getAppStaffList({ pageNo, pageSize, orderIncent, orderingStore, user, }?: {
         pageNo?: number;
         pageSize?: number;
-        q?: string;
-    }): Promise<OrderingStores>;
+        orderIncent?: boolean;
+        orderingStore?: number;
+        user?: string;
+    }): Promise<AppStaffListResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {number} [arg.pageSize] - The number of items to retrieve in each
-     *   page. Default value is 10.
-     * @param {string} [arg.q] - Store code or name of the ordering store.
-     * @summary: Get deployment stores
-     * @description: Use this API to retrieve the details of all the deployment stores (the selling locations where the application will be utilized for placing orders).
+     * @param {number} [arg.pageSize] -
+     * @param {boolean} [arg.orderIncent] - This is a boolean value. Select
+     *   `true` to retrieve the staff members eligible for getting incentives on orders.
+     * @param {number} [arg.orderingStore] - ID of the ordering store. Helps in
+     *   retrieving staff members working at a particular ordering store.
+     * @param {string} [arg.user] - Mongo ID of the staff. Helps in retrieving
+     *   the details of a particular staff member.
+     * @summary: Get a list of staff.
+     * @description: Use this API to get a list of staff including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the application.
      */
-    getOrderingStoresPaginator({ pageSize, q }?: {
+    getAppStaffListPaginator({ pageSize, orderIncent, orderingStore, user, }?: {
         pageSize?: number;
-        q?: string;
+        orderIncent?: boolean;
+        orderingStore?: number;
+        user?: string;
     }): Paginator;
     /**
      * @param {Object} arg - Arg object.
-     * @param {number} arg.storeId - Store uid
-     * @returns {Promise<OrderingStore>} - Success response
-     * @summary: Get ordering store details
-     * @description: Use this API to retrieve the details of given stores uid (the selling locations where the application will be utilized for placing orders).
+     * @param {boolean} [arg.orderIncent] - This is a boolean value. Select
+     *   `true` to retrieve the staff members eligible for getting incentives on orders.
+     * @param {number} [arg.orderingStore] - ID of the ordering store. Helps in
+     *   retrieving staff members working at a particular ordering store.
+     * @param {string} [arg.user] - Mongo ID of the staff. Helps in retrieving
+     *   the details of a particular staff member.
+     * @returns {Promise<AppStaffResponse>} - Success response
+     * @summary: Get a list of staff.
+     * @description: Use this API to get a list of staff including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the application.
      */
-    getStoreDetailById({ storeId }?: {
-        storeId: number;
-    }): Promise<OrderingStore>;
+    getAppStaffs({ orderIncent, orderingStore, user }?: {
+        orderIncent?: boolean;
+        orderingStore?: number;
+        user?: string;
+    }): Promise<AppStaffResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @returns {Promise<AppFeatureResponse>} - Success response
-     * @summary: Get features of application
-     * @description: Use this API to retrieve the configuration of features such as product detail, landing page, options in the login/registration screen, communication opt-in, cart options and many more.
+     * @returns {Promise<Application>} - Success response
+     * @summary: Get current application details
+     * @description: Use this API to get the current application details which includes configurations that indicate the status of the website, domain, ID, tokens, images, etc.
      */
-    getFeatures({}?: any): Promise<AppFeatureResponse>;
+    getApplication({}?: any): Promise<Application>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @returns {Promise<ApplicationDetail>} - Success response
+     * @summary: Get basic application details
+     * @description: Use this API to retrieve only the basic details of the application which includes channel name, description, banner, logo, favicon, domain details, etc.
+     */
+    getBasicDetails({}?: any): Promise<ApplicationDetail>;
     /**
      * @param {Object} arg - Arg object.
      * @returns {Promise<ApplicationInformation>} - Success response
@@ -121,11 +125,18 @@ declare class Configuration {
     }): Promise<Currency>;
     /**
      * @param {Object} arg - Arg object.
-     * @returns {Promise<AppCurrencyResponse>} - Success response
-     * @summary: Get currencies enabled in the application
-     * @description: Use this API to get a list of currencies allowed in the current application. Moreover, get the name, code, symbol, and the decimal digits of the currencies.
+     * @returns {Promise<AppFeatureResponse>} - Success response
+     * @summary: Get features of application
+     * @description: Use this API to retrieve the configuration of features such as product detail, landing page, options in the login/registration screen, communication opt-in, cart options and many more.
      */
-    getAppCurrencies({}?: any): Promise<AppCurrencyResponse>;
+    getFeatures({}?: any): Promise<AppFeatureResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @returns {Promise<AppTokenResponse>} - Success response
+     * @summary: Get integration tokens
+     * @description: Use this API to retrieve the tokens used while integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map and Facebook. **Note** - Token values are encrypted with AES encryption using a secret key. Kindly reach out to the developers for obtaining the secret key.
+     */
+    getIntegrationTokens({}?: any): Promise<AppTokenResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @returns {Promise<LanguageResponse>} - Success response
@@ -145,66 +156,55 @@ declare class Configuration {
     }): Promise<SuccessMessageResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @returns {Promise<SuccessMessageResponse>} - Success response
-     * @summary: Unset the Ordering Store signed cookie.
-     * @description: Use this API to unset the Ordering Store cookie upon changing the sales channel, by its domain URL, in the Universal Fynd Store app.
-     */
-    removeOrderingStoreCookie({}?: any): Promise<SuccessMessageResponse>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {number} [arg.pageNo] -
-     * @param {number} [arg.pageSize] -
-     * @param {boolean} [arg.orderIncent] - This is a boolean value. Select
-     *   `true` to retrieve the staff members eligible for getting incentives on orders.
-     * @param {number} [arg.orderingStore] - ID of the ordering store. Helps in
-     *   retrieving staff members working at a particular ordering store.
-     * @param {string} [arg.user] - Mongo ID of the staff. Helps in retrieving
-     *   the details of a particular staff member.
-     * @returns {Promise<AppStaffListResponse>} - Success response
-     * @summary: Get a list of staff.
-     * @description: Use this API to get a list of staff including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the application.
+     * @param {number} [arg.pageNo] - The page number to navigate through the
+     *   given set of results. Default value is 1.
+     * @param {number} [arg.pageSize] - The number of items to retrieve in each
+     *   page. Default value is 10.
+     * @param {string} [arg.q] - Store code or name of the ordering store.
+     * @returns {Promise<OrderingStores>} - Success response
+     * @summary: Get deployment stores
+     * @description: Use this API to retrieve the details of all the deployment stores (the selling locations where the application will be utilized for placing orders).
      */
-    getAppStaffList({ pageNo, pageSize, orderIncent, orderingStore, user }?: {
+    getOrderingStores({ pageNo, pageSize, q }?: {
         pageNo?: number;
         pageSize?: number;
-        orderIncent?: boolean;
-        orderingStore?: number;
-        user?: string;
-    }): Promise<AppStaffListResponse>;
+        q?: string;
+    }): Promise<OrderingStores>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {number} [arg.pageSize] -
-     * @param {boolean} [arg.orderIncent] - This is a boolean value. Select
-     *   `true` to retrieve the staff members eligible for getting incentives on orders.
-     * @param {number} [arg.orderingStore] - ID of the ordering store. Helps in
-     *   retrieving staff members working at a particular ordering store.
-     * @param {string} [arg.user] - Mongo ID of the staff. Helps in retrieving
-     *   the details of a particular staff member.
-     * @summary: Get a list of staff.
-     * @description: Use this API to get a list of staff including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the application.
+     * @param {number} [arg.pageSize] - The number of items to retrieve in each
+     *   page. Default value is 10.
+     * @param {string} [arg.q] - Store code or name of the ordering store.
+     * @summary: Get deployment stores
+     * @description: Use this API to retrieve the details of all the deployment stores (the selling locations where the application will be utilized for placing orders).
      */
-    getAppStaffListPaginator({ pageSize, orderIncent, orderingStore, user, }?: {
+    getOrderingStoresPaginator({ pageSize, q }?: {
         pageSize?: number;
-        orderIncent?: boolean;
-        orderingStore?: number;
-        user?: string;
+        q?: string;
     }): Paginator;
     /**
      * @param {Object} arg - Arg object.
-     * @param {boolean} [arg.orderIncent] - This is a boolean value. Select
-     *   `true` to retrieve the staff members eligible for getting incentives on orders.
-     * @param {number} [arg.orderingStore] - ID of the ordering store. Helps in
-     *   retrieving staff members working at a particular ordering store.
-     * @param {string} [arg.user] - Mongo ID of the staff. Helps in retrieving
-     *   the details of a particular staff member.
-     * @returns {Promise<AppStaffResponse>} - Success response
-     * @summary: Get a list of staff.
-     * @description: Use this API to get a list of staff including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the application.
+     * @returns {Promise<ApplicationAboutResponse>} - Success response
+     * @summary: Get application, owner and seller information
+     * @description: Use this API to get the current application details which includes channel name, description, banner, logo, favicon, domain details, etc. This API also retrieves the seller and owner information such as address, email address, and phone number.
      */
-    getAppStaffs({ orderIncent, orderingStore, user }?: {
-        orderIncent?: boolean;
-        orderingStore?: number;
-        user?: string;
-    }): Promise<AppStaffResponse>;
+    getOwnerInfo({}?: any): Promise<ApplicationAboutResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} arg.storeId - Store uid
+     * @returns {Promise<OrderingStore>} - Success response
+     * @summary: Get ordering store details
+     * @description: Use this API to retrieve the details of given stores uid (the selling locations where the application will be utilized for placing orders).
+     */
+    getStoreDetailById({ storeId }?: {
+        storeId: number;
+    }): Promise<OrderingStore>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @returns {Promise<SuccessMessageResponse>} - Success response
+     * @summary: Unset the Ordering Store signed cookie.
+     * @description: Use this API to unset the Ordering Store cookie upon changing the sales channel, by its domain URL, in the Universal Fynd Store app.
+     */
+    removeOrderingStoreCookie({}?: any): Promise<SuccessMessageResponse>;
 }
 import Paginator = require("../../common/Paginator");