@gofynd/fdk-client-javascript 1.0.0 → 1.0.2

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

@@ -5,17 +5,19 @@ declare class Configuration {
     /**
      * @param {Object} arg - Arg object.
      * @param {CreateApplicationRequest} arg.body
+     * @returns {Promise<CreateAppResponse>} - Success response
      * @summary: Create application
      * @description: Create new application
      */
     createApplication({ body }?: {
         body: CreateApplicationRequest;
-    }): Promise<any>;
+    }): Promise<CreateAppResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageNo] -
      * @param {number} [arg.pageSize] -
      * @param {string} [arg.q] - Url encoded object used as mongodb query
+     * @returns {Promise<ApplicationsResponse>} - Success response
      * @summary: Get list of application under company
      * @description: Get list of application under company
      */
@@ -23,7 +25,7 @@ declare class Configuration {
         pageNo?: number;
         pageSize?: number;
         q?: string;
-    }): Promise<any>;
+    }): Promise<ApplicationsResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageSize] -
@@ -37,39 +39,43 @@ declare class Configuration {
     }): Paginator;
     /**
      * @param {Object} arg - Arg object.
+     * @returns {Promise<CurrenciesResponse>} - Success response
      * @summary: Get all currencies
      * @description: Get all currencies
      */
-    getCurrencies({}?: any): Promise<any>;
+    getCurrencies({}?: any): Promise<CurrenciesResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {DomainSuggestionsRequest} arg.body
+     * @returns {Promise<DomainSuggestionsResponse>} - Success response
      * @summary: Check domain availibility before linking to application
      * @description: Check domain availibility before linking to application. Also sends domain suggestions with similar to queried domain. \ Custom domain search is currently powered by GoDaddy provider.
      */
     getDomainAvailibility({ body }?: {
         body: DomainSuggestionsRequest;
-    }): Promise<any>;
+    }): Promise<DomainSuggestionsResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} arg.id - Integration id
+     * @returns {Promise<Integration>} - Success response
      * @summary: Get integration data
      * @description: Get integration data
      */
     getIntegrationById({ id }?: {
         id: number;
-    }): Promise<any>;
+    }): Promise<Integration>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageNo] - Current page no
      * @param {number} [arg.pageSize] - Current request items count
+     * @returns {Promise<GetIntegrationsOptInsResponse>} - Success response
      * @summary: Get all available integration opt-ins
      * @description: Get all available integration opt-ins
      */
     getAvailableOptIns({ pageNo, pageSize }?: {
         pageNo?: number;
         pageSize?: number;
-    }): Promise<any>;
+    }): Promise<GetIntegrationsOptInsResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageSize] - Current request items count
@@ -85,6 +91,7 @@ declare class Configuration {
      * @param {number} arg.uid - Integration level uid
      * @param {number} [arg.pageNo] - Current page no
      * @param {number} [arg.pageSize] - Current request items count
+     * @returns {Promise<GetIntegrationsOptInsResponse>} - Success response
      * @summary: Get company/store level integration opt-ins
      * @description: Get company/store level integration opt-ins
      */
@@ -93,7 +100,7 @@ declare class Configuration {
         uid: number;
         pageNo?: number;
         pageSize?: number;
-    }): Promise<any>;
+    }): Promise<GetIntegrationsOptInsResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.level - Integration level
@@ -113,6 +120,7 @@ declare class Configuration {
      * @param {string} arg.level - Integration level
      * @param {boolean} [arg.opted] - Filter on opted stores
      * @param {boolean} [arg.checkPermission] - Filter on if permissions are present
+     * @returns {Promise<IntegrationConfigResponse>} - Success response
      * @summary: Get integration level config
      * @description: Get integration/integration-opt-in level config
      */
@@ -121,12 +129,13 @@ declare class Configuration {
         level: string;
         opted?: boolean;
         checkPermission?: boolean;
-    }): Promise<any>;
+    }): Promise<IntegrationConfigResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id - Integration id
      * @param {string} arg.level - Integration level
      * @param {UpdateIntegrationLevelRequest} arg.body
+     * @returns {Promise<IntegrationLevel>} - Success response
      * @summary: Update a store level opt-in for integration
      * @description: Update a store level opt-in for integration
      */
@@ -134,12 +143,13 @@ declare class Configuration {
         id: string;
         level: string;
         body: UpdateIntegrationLevelRequest;
-    }): Promise<any>;
+    }): Promise<IntegrationLevel>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id - Integration id
      * @param {string} arg.level - Integration level
      * @param {number} arg.uid - Integration level uid
+     * @returns {Promise<IntegrationLevel>} - Success response
      * @summary: Get level data for integration
      * @description: Get level data for integration
      */
@@ -147,13 +157,14 @@ declare class Configuration {
         id: string;
         level: string;
         uid: number;
-    }): Promise<any>;
+    }): Promise<IntegrationLevel>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id - Integration id
      * @param {string} arg.level - Integration level
      * @param {number} arg.uid - Integration level uid
      * @param {IntegrationLevel} arg.body
+     * @returns {Promise<IntegrationLevel>} - Success response
      * @summary: Update a store level opt-in for integration
      * @description: Update a store level opt-in for integration
      */
@@ -162,12 +173,13 @@ declare class Configuration {
         level: string;
         uid: number;
         body: IntegrationLevel;
-    }): Promise<any>;
+    }): Promise<IntegrationLevel>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id - Integration id
      * @param {string} arg.level - Integration level
      * @param {number} arg.uid - Integration level uid
+     * @returns {Promise<OptedStoreIntegration>} - Success response
      * @summary: Check store has active integration
      * @description: API checks if a store is already opted in any other integrations
      */
@@ -175,21 +187,23 @@ declare class Configuration {
         id: string;
         level: string;
         uid: number;
-    }): Promise<any>;
+    }): Promise<OptedStoreIntegration>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} [arg.q] - Search text for brand name
+     * @returns {Promise<BrandsByCompanyResponse>} - Success response
      * @summary: Get brands by company
      * @description: Get brands by company
      */
     getBrandsByCompany({ q }?: {
         q?: string;
-    }): Promise<any>;
+    }): Promise<BrandsByCompanyResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageNo] - Current page no
      * @param {number} [arg.pageSize] - Current request items count
      * @param {CompanyByBrandsRequest} arg.body
+     * @returns {Promise<CompanyByBrandsResponse>} - Success response
      * @summary: Get company by brand uids
      * @description: Get company by brand uids
      */
@@ -197,7 +211,7 @@ declare class Configuration {
         pageNo?: number;
         pageSize?: number;
         body: CompanyByBrandsRequest;
-    }): Promise<any>;
+    }): Promise<CompanyByBrandsResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageSize] - Current request items count
@@ -214,6 +228,7 @@ declare class Configuration {
      * @param {number} [arg.pageNo] - Current page no
      * @param {number} [arg.pageSize] - Current request items count
      * @param {StoreByBrandsRequest} arg.body
+     * @returns {Promise<StoreByBrandsResponse>} - Success response
      * @summary: Get stores by brand uids
      * @description: Get stores by brand uids
      */
@@ -221,7 +236,7 @@ declare class Configuration {
         pageNo?: number;
         pageSize?: number;
         body: StoreByBrandsRequest;
-    }): Promise<any>;
+    }): Promise<StoreByBrandsResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageSize] - Current request items count
@@ -237,13 +252,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<OtherSellerApplications>} - Success response
      * @summary: Get other seller applications
      * @description: Get other seller applications who has opted current company as inventory
      */
     getOtherSellerApplications({ pageNo, pageSize }?: {
         pageNo?: number;
         pageSize?: number;
-    }): Promise<any>;
+    }): Promise<OtherSellerApplications>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageSize] - Current request items count
@@ -256,22 +272,24 @@ declare class Configuration {
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id - Application Id
+     * @returns {Promise<OptedApplicationResponse>} - Success response
      * @summary: Get other seller applications
      * @description: Get other seller application
      */
     getOtherSellerApplicationById({ id }?: {
         id: string;
-    }): Promise<any>;
+    }): Promise<OptedApplicationResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id - Application Id
      * @param {OptOutInventory} arg.body
+     * @returns {Promise<SuccessMessageResponse>} - Success response
      * @summary: Opt out company or store from other seller application
      * @description: Opt out company or store from other seller application
      */
     optOutFromApplication({ id, body }?: {
         id: string;
         body: OptOutInventory;
-    }): Promise<any>;
+    }): Promise<SuccessMessageResponse>;
 }
 import Paginator = require("../../common/Paginator");