@gofynd/fdk-client-javascript 1.0.1 → 1.0.3

package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts

@@ -1,16 +1,16 @@
 export = CompanyProfileValidator;
 declare class CompanyProfileValidator {
     static cbsOnboardGet(): any;
-    static updateCompany(): any;
-    static getCompanyMetrics(): any;
-    static getBrand(): any;
-    static editBrand(): any;
     static createBrand(): any;
-    static getBrands(): any;
     static createCompanyBrandMapping(): any;
-    static getLocations(): any;
     static createLocation(): any;
+    static createLocationBulk(): any;
+    static editBrand(): any;
+    static getBrand(): any;
+    static getBrands(): any;
+    static getCompanyMetrics(): any;
     static getLocationDetail(): any;
+    static getLocations(): any;
+    static updateCompany(): any;
     static updateLocation(): any;
-    static createLocationBulk(): any;
 }

package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js

@@ -6,19 +6,27 @@ class CompanyProfileValidator {
     return Joi.object({}).required();
   }
 
-  static updateCompany() {
+  static createBrand() {
     return Joi.object({
-      body: CompanyProfileModel.UpdateCompany().required(),
+      body: CompanyProfileModel.CreateUpdateBrandRequestSerializer().required(),
     }).required();
   }
 
-  static getCompanyMetrics() {
-    return Joi.object({}).required();
+  static createCompanyBrandMapping() {
+    return Joi.object({
+      body: CompanyProfileModel.CompanyBrandPostRequestSerializer().required(),
+    }).required();
   }
 
-  static getBrand() {
+  static createLocation() {
     return Joi.object({
-      brandId: Joi.string().allow("").required(),
+      body: CompanyProfileModel.LocationSerializer().required(),
+    }).required();
+  }
+
+  static createLocationBulk() {
+    return Joi.object({
+      body: CompanyProfileModel.BulkLocationSerializer().required(),
     }).required();
   }
 
@@ -29,9 +37,9 @@ class CompanyProfileValidator {
     }).required();
   }
 
-  static createBrand() {
+  static getBrand() {
     return Joi.object({
-      body: CompanyProfileModel.CreateUpdateBrandRequestSerializer().required(),
+      brandId: Joi.string().allow("").required(),
     }).required();
   }
 
@@ -43,9 +51,13 @@ class CompanyProfileValidator {
     }).required();
   }
 
-  static createCompanyBrandMapping() {
+  static getCompanyMetrics() {
+    return Joi.object({}).required();
+  }
+
+  static getLocationDetail() {
     return Joi.object({
-      body: CompanyProfileModel.CompanyBrandPostRequestSerializer().required(),
+      locationId: Joi.string().allow("").required(),
     }).required();
   }
 
@@ -60,15 +72,9 @@ class CompanyProfileValidator {
     }).required();
   }
 
-  static createLocation() {
-    return Joi.object({
-      body: CompanyProfileModel.LocationSerializer().required(),
-    }).required();
-  }
-
-  static getLocationDetail() {
+  static updateCompany() {
     return Joi.object({
-      locationId: Joi.string().allow("").required(),
+      body: CompanyProfileModel.UpdateCompany().required(),
     }).required();
   }
 
@@ -78,11 +84,5 @@ class CompanyProfileValidator {
       body: CompanyProfileModel.LocationSerializer().required(),
     }).required();
   }
-
-  static createLocationBulk() {
-    return Joi.object({
-      body: CompanyProfileModel.BulkLocationSerializer().required(),
-    }).required();
-  }
 }
 module.exports = CompanyProfileValidator;

package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts

@@ -5,98 +5,44 @@ declare class Configuration {
     applicationId: any;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.platformType - Current platform name
-     * @summary: Get latest build config
-     * @description: Get latest build config
-     */
-    getBuildConfig({ platformType }?: {
-        platformType: string;
-    }): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.platformType - Current platform name
-     * @param {MobileAppConfigRequest} arg.body
-     * @summary: Update build config for next build
-     * @description: Update build config for next build
-     */
-    updateBuildConfig({ platformType, body }?: {
-        platformType: string;
-        body: MobileAppConfigRequest;
-    }): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.platformType - Current platform name
-     * @summary: Get previous build versions
-     * @description: Get previous build versions
-     */
-    getPreviousVersions({ platformType }?: {
-        platformType: string;
-    }): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @summary: Get features of application
-     * @description: Get features of application
-     */
-    getAppFeatures({}?: any): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {AppFeatureRequest} arg.body
-     * @summary: Update features of application
-     * @description: Update features of application
-     */
-    updateAppFeatures({ body }?: {
-        body: AppFeatureRequest;
-    }): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @summary: Get basic application details
-     * @description: Get basic application details like name
-     */
-    getAppBasicDetails({}?: any): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {ApplicationDetail} arg.body
-     * @summary: Add or update application's basic details
-     * @description: Add or update application's basic details
-     */
-    updateAppBasicDetails({ body }?: {
-        body: ApplicationDetail;
-    }): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @summary: Get application information
-     * @description: Get Application Current Information. This includes information about social links, address and contact information of company/seller/brand of the application.
+     * @param {DomainAddRequest} arg.body
+     * @returns {Promise<Domain>} - Success response
+     * @summary: Add new domain to application
+     * @description: Add new domain to application.
      */
-    getAppContactInfo({}?: any): Promise<any>;
+    addDomain({ body }?: {
+        body: DomainAddRequest;
+    }): Promise<Domain>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {ApplicationInformation} arg.body
-     * @summary: Get application information
-     * @description: Save Application Current Information. This includes information about social links, address and contact information of an application.
+     * @param {UpdateDomainTypeRequest} arg.body
+     * @returns {Promise<DomainsResponse>} - Success response
+     * @summary: Change domain type
+     * @description: Change a domain to Primary or Shortlink domain
      */
-    updateAppContactInfo({ body }?: {
-        body: ApplicationInformation;
-    }): Promise<any>;
+    changeDomainType({ body }?: {
+        body: UpdateDomainTypeRequest;
+    }): Promise<DomainsResponse>;
     /**
      * @param {Object} arg - Arg object.
+     * @returns {Promise<TokenResponse>} - Success response
      * @summary: Get social tokens
      * @description: Get social tokens.
      */
-    getAppApiTokens({}?: any): Promise<any>;
+    getAppApiTokens({}?: any): Promise<TokenResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {TokenResponse} arg.body
-     * @summary: Add social tokens
-     * @description: Add social tokens.
+     * @returns {Promise<ApplicationDetail>} - Success response
+     * @summary: Get basic application details
+     * @description: Get basic application details like name
      */
-    updateAppApiTokens({ body }?: {
-        body: TokenResponse;
-    }): Promise<any>;
+    getAppBasicDetails({}?: any): Promise<ApplicationDetail>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.uid] - Uid of companies to be fetched
      * @param {number} [arg.pageNo] - Current page no
      * @param {number} [arg.pageSize] - Current request items count
+     * @returns {Promise<CompaniesResponse>} - Success response
      * @summary: Application inventory enabled companies
      * @description: Application inventory enabled companies.
      */
@@ -104,7 +50,7 @@ declare class Configuration {
         uid?: number;
         pageNo?: number;
         pageSize?: number;
-    }): Promise<any>;
+    }): Promise<CompaniesResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.companyId - Current company id
@@ -120,17 +66,39 @@ declare class Configuration {
         uid?: number;
         pageSize?: number;
     }): Paginator;
+    /**
+     * @param {Object} arg - Arg object.
+     * @returns {Promise<ApplicationInformation>} - Success response
+     * @summary: Get application information
+     * @description: Get Application Current Information. This includes information about social links, address and contact information of company/seller/brand of the application.
+     */
+    getAppContactInfo({}?: any): Promise<ApplicationInformation>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @returns {Promise<AppSupportedCurrency>} - Success response
+     * @summary: Get application enabled currency list
+     * @description: Get application enabled currency list
+     */
+    getAppCurrencyConfig({}?: any): Promise<AppSupportedCurrency>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @returns {Promise<AppFeatureResponse>} - Success response
+     * @summary: Get features of application
+     * @description: Get features of application
+     */
+    getAppFeatures({}?: any): Promise<AppFeatureResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageNo] - Current page no
      * @param {number} [arg.pageSize] - Current request items count
+     * @returns {Promise<StoresResponse>} - Success response
      * @summary: Application inventory enabled stores
      * @description: Application inventory enabled stores.
      */
     getAppStores({ pageNo, pageSize }?: {
         pageNo?: number;
         pageSize?: number;
-    }): Promise<any>;
+    }): Promise<StoresResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.companyId - Current company id
@@ -146,54 +114,58 @@ declare class Configuration {
     }): Paginator;
     /**
      * @param {Object} arg - Arg object.
-     * @summary: Get application configuration
-     * @description: Get application configuration for various features and data
+     * @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.
      */
-    getInventoryConfig({}?: any): Promise<any>;
+    getAppSupportedCurrency({}?: any): Promise<AppCurrencyResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {ApplicationInventory} arg.body
-     * @summary: Update application configuration
-     * @description: Update application configuration for various features and data
+     * @returns {Promise<Application>} - Success response
+     * @summary: Get application data from id
+     * @description: Get application data from id
      */
-    updateInventoryConfig({ body }?: {
-        body: ApplicationInventory;
-    }): Promise<any>;
+    getApplicationById({}?: any): Promise<Application>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {AppInventoryPartialUpdate} arg.body
-     * @summary: Partially update application configuration
-     * @description: Partially update application configuration for various features and data
+     * @param {string} arg.platformType - Current platform name
+     * @returns {Promise<MobileAppConfiguration>} - Success response
+     * @summary: Get latest build config
+     * @description: Get latest build config
      */
-    partiallyUpdateInventoryConfig({ body }?: {
-        body: AppInventoryPartialUpdate;
-    }): Promise<any>;
+    getBuildConfig({ platformType }?: {
+        platformType: string;
+    }): Promise<MobileAppConfiguration>;
     /**
      * @param {Object} arg - Arg object.
-     * @summary: Get application enabled currency list
-     * @description: Get application enabled currency list
+     * @param {DomainStatusRequest} arg.body
+     * @returns {Promise<DomainStatusResponse>} - Success response
+     * @summary: Get domain connected status.
+     * @description: Get domain connected status. Check if domain is live and mapped to appropriate IP to fynd servers.
      */
-    getAppCurrencyConfig({}?: any): Promise<any>;
+    getDomainStatus({ body }?: {
+        body: DomainStatusRequest;
+    }): Promise<DomainStatusResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {AppSupportedCurrency} arg.body
-     * @summary: Add initial application supported currency
-     * @description: Add initial application supported currency for various features and data. Default INR will be enabled.
+     * @returns {Promise<DomainsResponse>} - Success response
+     * @summary: Get attached domain list
+     * @description: Get attached domain list.
      */
-    updateAppCurrencyConfig({ body }?: {
-        body: AppSupportedCurrency;
-    }): Promise<any>;
+    getDomains({}?: any): Promise<DomainsResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @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<ApplicationInventory>} - Success response
+     * @summary: Get application configuration
+     * @description: Get application configuration for various features and data
      */
-    getAppSupportedCurrency({}?: any): Promise<any>;
+    getInventoryConfig({}?: any): Promise<ApplicationInventory>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageNo] - Current page no
      * @param {number} [arg.pageSize] - Current request items count
      * @param {FilterOrderingStoreRequest} arg.body
+     * @returns {Promise<OrderingStores>} - Success response
      * @summary: Get ordering store by filter
      * @description: Get ordering store by filter
      */
@@ -201,7 +173,7 @@ declare class Configuration {
         pageNo?: number;
         pageSize?: number;
         body: FilterOrderingStoreRequest;
-    }): Promise<any>;
+    }): Promise<OrderingStores>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.companyId - Current company id
@@ -219,13 +191,14 @@ declare class Configuration {
     }): Paginator;
     /**
      * @param {Object} arg - Arg object.
-     * @param {OrderingStoreConfig} arg.body
-     * @summary: Add/Update ordering store config
-     * @description: Add/Update ordering store config.
+     * @param {string} arg.platformType - Current platform name
+     * @returns {Promise<BuildVersionHistory>} - Success response
+     * @summary: Get previous build versions
+     * @description: Get previous build versions
      */
-    updateOrderingStoreConfig({ body }?: {
-        body: OrderingStoreConfig;
-    }): Promise<any>;
+    getPreviousVersions({ platformType }?: {
+        platformType: string;
+    }): Promise<BuildVersionHistory>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageNo] - The page number to navigate through the
@@ -233,6 +206,7 @@ declare class Configuration {
      * @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<OrderingStoresResponse>} - Success response
      * @summary: Get deployment stores
      * @description: Use this API to retrieve the details of all stores access given to the staff member (the selling locations where the application will be utilized for placing orders).
      */
@@ -240,7 +214,7 @@ declare class Configuration {
         pageNo?: number;
         pageSize?: number;
         q?: string;
-    }): Promise<any>;
+    }): Promise<OrderingStoresResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.companyId - Current company id
@@ -259,51 +233,115 @@ declare class Configuration {
     }): Paginator;
     /**
      * @param {Object} arg - Arg object.
-     * @summary: Get attached domain list
-     * @description: Get attached domain list.
+     * @param {AppFeatureRequest} arg.body
+     * @returns {Promise<AppFeature>} - Success response
+     * @summary: Update features of application
+     * @description: Update features of application
      */
-    getDomains({}?: any): Promise<any>;
+    modifyAppFeatures({ body }?: {
+        body: AppFeatureRequest;
+    }): Promise<AppFeature>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {DomainAddRequest} arg.body
-     * @summary: Add new domain to application
-     * @description: Add new domain to application.
+     * @param {AppInventoryPartialUpdate} arg.body
+     * @returns {Promise<ApplicationInventory>} - Success response
+     * @summary: Partially update application configuration
+     * @description: Partially update application configuration for various features and data
      */
-    addDomain({ body }?: {
-        body: DomainAddRequest;
-    }): Promise<any>;
+    partiallyUpdateInventoryConfig({ body }?: {
+        body: AppInventoryPartialUpdate;
+    }): Promise<ApplicationInventory>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id - Domain _id
+     * @returns {Promise<SuccessMessageResponse>} - Success response
      * @summary: Remove attached domain
      * @description: Remove attached domain.
      */
     removeDomainById({ id }?: {
         id: string;
-    }): Promise<any>;
+    }): Promise<SuccessMessageResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {UpdateDomainTypeRequest} arg.body
-     * @summary: Change domain type
-     * @description: Change a domain to Primary or Shortlink domain
+     * @param {TokenResponse} arg.body
+     * @returns {Promise<TokenResponse>} - Success response
+     * @summary: Add social tokens
+     * @description: Add social tokens.
      */
-    changeDomainType({ body }?: {
-        body: UpdateDomainTypeRequest;
-    }): Promise<any>;
+    updateAppApiTokens({ body }?: {
+        body: TokenResponse;
+    }): Promise<TokenResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {DomainStatusRequest} arg.body
-     * @summary: Get domain connected status.
-     * @description: Get domain connected status. Check if domain is live and mapped to appropriate IP to fynd servers.
+     * @param {ApplicationDetail} arg.body
+     * @returns {Promise<ApplicationDetail>} - Success response
+     * @summary: Add or update application's basic details
+     * @description: Add or update application's basic details
      */
-    getDomainStatus({ body }?: {
-        body: DomainStatusRequest;
-    }): Promise<any>;
+    updateAppBasicDetails({ body }?: {
+        body: ApplicationDetail;
+    }): Promise<ApplicationDetail>;
     /**
      * @param {Object} arg - Arg object.
-     * @summary: Get application data from id
-     * @description: Get application data from id
+     * @param {ApplicationInformation} arg.body
+     * @returns {Promise<ApplicationInformation>} - Success response
+     * @summary: Get application information
+     * @description: Save Application Current Information. This includes information about social links, address and contact information of an application.
+     */
+    updateAppContactInfo({ body }?: {
+        body: ApplicationInformation;
+    }): Promise<ApplicationInformation>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {AppSupportedCurrency} arg.body
+     * @returns {Promise<AppSupportedCurrency>} - Success response
+     * @summary: Add initial application supported currency
+     * @description: Add initial application supported currency for various features and data. Default INR will be enabled.
+     */
+    updateAppCurrencyConfig({ body }?: {
+        body: AppSupportedCurrency;
+    }): Promise<AppSupportedCurrency>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {AppFeatureRequest} arg.body
+     * @returns {Promise<AppFeature>} - Success response
+     * @summary: Update features of application
+     * @description: Update features of application
      */
-    getApplicationById({}?: any): Promise<any>;
+    updateAppFeatures({ body }?: {
+        body: AppFeatureRequest;
+    }): Promise<AppFeature>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.platformType - Current platform name
+     * @param {MobileAppConfigRequest} arg.body
+     * @returns {Promise<MobileAppConfiguration>} - Success response
+     * @summary: Update build config for next build
+     * @description: Update build config for next build
+     */
+    updateBuildConfig({ platformType, body }?: {
+        platformType: string;
+        body: MobileAppConfigRequest;
+    }): Promise<MobileAppConfiguration>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {ApplicationInventory} arg.body
+     * @returns {Promise<ApplicationInventory>} - Success response
+     * @summary: Update application configuration
+     * @description: Update application configuration for various features and data
+     */
+    updateInventoryConfig({ body }?: {
+        body: ApplicationInventory;
+    }): Promise<ApplicationInventory>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {OrderingStoreConfig} arg.body
+     * @returns {Promise<DeploymentMeta>} - Success response
+     * @summary: Add/Update ordering store config
+     * @description: Add/Update ordering store config.
+     */
+    updateOrderingStoreConfig({ body }?: {
+        body: OrderingStoreConfig;
+    }): Promise<DeploymentMeta>;
 }
 import Paginator = require("../../common/Paginator");