@gofynd/fdk-client-javascript 1.0.0 → 1.0.2

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

@@ -6,97 +6,109 @@ declare class Configuration {
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.platformType - Current platform name
+     * @returns {Promise<MobileAppConfiguration>} - Success response
      * @summary: Get latest build config
      * @description: Get latest build config
      */
     getBuildConfig({ platformType }?: {
         platformType: string;
-    }): Promise<any>;
+    }): Promise<MobileAppConfiguration>;
     /**
      * @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<any>;
+    }): Promise<MobileAppConfiguration>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.platformType - Current platform name
+     * @returns {Promise<BuildVersionHistory>} - Success response
      * @summary: Get previous build versions
      * @description: Get previous build versions
      */
     getPreviousVersions({ platformType }?: {
         platformType: string;
-    }): Promise<any>;
+    }): Promise<BuildVersionHistory>;
     /**
      * @param {Object} arg - Arg object.
+     * @returns {Promise<AppFeatureResponse>} - Success response
      * @summary: Get features of application
      * @description: Get features of application
      */
-    getAppFeatures({}?: any): Promise<any>;
+    getAppFeatures({}?: any): Promise<AppFeatureResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {AppFeatureRequest} arg.body
+     * @returns {Promise<AppFeature>} - Success response
      * @summary: Update features of application
      * @description: Update features of application
      */
     updateAppFeatures({ body }?: {
         body: AppFeatureRequest;
-    }): Promise<any>;
+    }): Promise<AppFeature>;
     /**
      * @param {Object} arg - Arg object.
+     * @returns {Promise<ApplicationDetail>} - Success response
      * @summary: Get basic application details
      * @description: Get basic application details like name
      */
-    getAppBasicDetails({}?: any): Promise<any>;
+    getAppBasicDetails({}?: any): Promise<ApplicationDetail>;
     /**
      * @param {Object} arg - Arg object.
      * @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
      */
     updateAppBasicDetails({ body }?: {
         body: ApplicationDetail;
-    }): Promise<any>;
+    }): Promise<ApplicationDetail>;
     /**
      * @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<any>;
+    getAppContactInfo({}?: any): Promise<ApplicationInformation>;
     /**
      * @param {Object} arg - Arg object.
      * @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<any>;
+    }): Promise<ApplicationInformation>;
     /**
      * @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
+     * @returns {Promise<TokenResponse>} - Success response
      * @summary: Add social tokens
      * @description: Add social tokens.
      */
     updateAppApiTokens({ body }?: {
         body: TokenResponse;
-    }): Promise<any>;
+    }): Promise<TokenResponse>;
     /**
      * @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 +116,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
@@ -124,13 +136,14 @@ declare class Configuration {
      * @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 +159,61 @@ declare class Configuration {
     }): Paginator;
     /**
      * @param {Object} arg - Arg object.
+     * @returns {Promise<ApplicationInventory>} - Success response
      * @summary: Get application configuration
      * @description: Get application configuration for various features and data
      */
-    getInventoryConfig({}?: any): Promise<any>;
+    getInventoryConfig({}?: any): Promise<ApplicationInventory>;
     /**
      * @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<any>;
+    }): Promise<ApplicationInventory>;
     /**
      * @param {Object} arg - Arg object.
      * @param {AppInventoryPartialUpdate} arg.body
+     * @returns {Promise<ApplicationInventory>} - Success response
      * @summary: Partially update application configuration
      * @description: Partially update application configuration for various features and data
      */
     partiallyUpdateInventoryConfig({ body }?: {
         body: AppInventoryPartialUpdate;
-    }): Promise<any>;
+    }): Promise<ApplicationInventory>;
     /**
      * @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<any>;
+    getAppCurrencyConfig({}?: any): Promise<AppSupportedCurrency>;
     /**
      * @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<any>;
+    }): Promise<AppSupportedCurrency>;
     /**
      * @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.
      */
-    getAppSupportedCurrency({}?: any): Promise<any>;
+    getAppSupportedCurrency({}?: any): Promise<AppCurrencyResponse>;
     /**
      * @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 +221,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
@@ -220,12 +240,13 @@ declare class Configuration {
     /**
      * @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<any>;
+    }): Promise<DeploymentMeta>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageNo] - The page number to navigate through the
@@ -233,6 +254,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 +262,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 +281,57 @@ declare class Configuration {
     }): Paginator;
     /**
      * @param {Object} arg - Arg object.
+     * @returns {Promise<DomainsResponse>} - Success response
      * @summary: Get attached domain list
      * @description: Get attached domain list.
      */
-    getDomains({}?: any): Promise<any>;
+    getDomains({}?: any): Promise<DomainsResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {DomainAddRequest} arg.body
+     * @returns {Promise<Domain>} - Success response
      * @summary: Add new domain to application
      * @description: Add new domain to application.
      */
     addDomain({ body }?: {
         body: DomainAddRequest;
-    }): Promise<any>;
+    }): Promise<Domain>;
     /**
      * @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
+     * @returns {Promise<DomainsResponse>} - Success response
      * @summary: Change domain type
      * @description: Change a domain to Primary or Shortlink domain
      */
     changeDomainType({ body }?: {
         body: UpdateDomainTypeRequest;
-    }): Promise<any>;
+    }): Promise<DomainsResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @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.
      */
     getDomainStatus({ body }?: {
         body: DomainStatusRequest;
-    }): Promise<any>;
+    }): Promise<DomainStatusResponse>;
     /**
      * @param {Object} arg - Arg object.
+     * @returns {Promise<Application>} - Success response
      * @summary: Get application data from id
      * @description: Get application data from id
      */
-    getApplicationById({}?: any): Promise<any>;
+    getApplicationById({}?: any): Promise<Application>;
 }
 import Paginator = require("../../common/Paginator");