@gofynd/fdk-client-javascript 1.0.1 → 1.0.3

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

@@ -1,31 +1,32 @@
 export = ConfigurationValidator;
 declare class ConfigurationValidator {
-    static getBuildConfig(): any;
-    static updateBuildConfig(): any;
-    static getPreviousVersions(): any;
-    static getAppFeatures(): any;
-    static updateAppFeatures(): any;
-    static getAppBasicDetails(): any;
-    static updateAppBasicDetails(): any;
-    static getAppContactInfo(): any;
-    static updateAppContactInfo(): any;
+    static addDomain(): any;
+    static changeDomainType(): any;
     static getAppApiTokens(): any;
-    static updateAppApiTokens(): any;
+    static getAppBasicDetails(): any;
     static getAppCompanies(): any;
-    static getAppStores(): any;
-    static getInventoryConfig(): any;
-    static updateInventoryConfig(): any;
-    static partiallyUpdateInventoryConfig(): any;
+    static getAppContactInfo(): any;
     static getAppCurrencyConfig(): any;
-    static updateAppCurrencyConfig(): any;
+    static getAppFeatures(): any;
+    static getAppStores(): any;
     static getAppSupportedCurrency(): any;
+    static getApplicationById(): any;
+    static getBuildConfig(): any;
+    static getDomainStatus(): any;
+    static getDomains(): any;
+    static getInventoryConfig(): any;
     static getOrderingStoresByFilter(): any;
-    static updateOrderingStoreConfig(): any;
+    static getPreviousVersions(): any;
     static getStaffOrderingStores(): any;
-    static getDomains(): any;
-    static addDomain(): any;
+    static modifyAppFeatures(): any;
+    static partiallyUpdateInventoryConfig(): any;
     static removeDomainById(): any;
-    static changeDomainType(): any;
-    static getDomainStatus(): any;
-    static getApplicationById(): any;
+    static updateAppApiTokens(): any;
+    static updateAppBasicDetails(): any;
+    static updateAppContactInfo(): any;
+    static updateAppCurrencyConfig(): any;
+    static updateAppFeatures(): any;
+    static updateBuildConfig(): any;
+    static updateInventoryConfig(): any;
+    static updateOrderingStoreConfig(): any;
 }

package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js

@@ -2,42 +2,31 @@ const Joi = require("joi");
 const ConfigurationModel = require("./ConfigurationPlatformModel");
 
 class ConfigurationValidator {
-  static getBuildConfig() {
-    return Joi.object({
-      platformType: Joi.string().allow("").required(),
-    }).required();
-  }
-
-  static updateBuildConfig() {
+  static addDomain() {
     return Joi.object({
-      platformType: Joi.string().allow("").required(),
-      body: ConfigurationModel.MobileAppConfigRequest().required(),
+      body: ConfigurationModel.DomainAddRequest().required(),
     }).required();
   }
 
-  static getPreviousVersions() {
+  static changeDomainType() {
     return Joi.object({
-      platformType: Joi.string().allow("").required(),
+      body: ConfigurationModel.UpdateDomainTypeRequest().required(),
     }).required();
   }
 
-  static getAppFeatures() {
+  static getAppApiTokens() {
     return Joi.object({}).required();
   }
 
-  static updateAppFeatures() {
-    return Joi.object({
-      body: ConfigurationModel.AppFeatureRequest().required(),
-    }).required();
-  }
-
   static getAppBasicDetails() {
     return Joi.object({}).required();
   }
 
-  static updateAppBasicDetails() {
+  static getAppCompanies() {
     return Joi.object({
-      body: ConfigurationModel.ApplicationDetail().required(),
+      uid: Joi.number(),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
     }).required();
   }
 
@@ -45,64 +34,46 @@ class ConfigurationValidator {
     return Joi.object({}).required();
   }
 
-  static updateAppContactInfo() {
-    return Joi.object({
-      body: ConfigurationModel.ApplicationInformation().required(),
-    }).required();
-  }
-
-  static getAppApiTokens() {
+  static getAppCurrencyConfig() {
     return Joi.object({}).required();
   }
 
-  static updateAppApiTokens() {
-    return Joi.object({
-      body: ConfigurationModel.TokenResponse().required(),
-    }).required();
+  static getAppFeatures() {
+    return Joi.object({}).required();
   }
 
-  static getAppCompanies() {
+  static getAppStores() {
     return Joi.object({
-      uid: Joi.number(),
       pageNo: Joi.number(),
       pageSize: Joi.number(),
     }).required();
   }
 
-  static getAppStores() {
-    return Joi.object({
-      pageNo: Joi.number(),
-      pageSize: Joi.number(),
-    }).required();
+  static getAppSupportedCurrency() {
+    return Joi.object({}).required();
   }
 
-  static getInventoryConfig() {
+  static getApplicationById() {
     return Joi.object({}).required();
   }
 
-  static updateInventoryConfig() {
+  static getBuildConfig() {
     return Joi.object({
-      body: ConfigurationModel.ApplicationInventory().required(),
+      platformType: Joi.string().allow("").required(),
     }).required();
   }
 
-  static partiallyUpdateInventoryConfig() {
+  static getDomainStatus() {
     return Joi.object({
-      body: ConfigurationModel.AppInventoryPartialUpdate().required(),
+      body: ConfigurationModel.DomainStatusRequest().required(),
     }).required();
   }
 
-  static getAppCurrencyConfig() {
+  static getDomains() {
     return Joi.object({}).required();
   }
 
-  static updateAppCurrencyConfig() {
-    return Joi.object({
-      body: ConfigurationModel.AppSupportedCurrency().required(),
-    }).required();
-  }
-
-  static getAppSupportedCurrency() {
+  static getInventoryConfig() {
     return Joi.object({}).required();
   }
 
@@ -114,9 +85,9 @@ class ConfigurationValidator {
     }).required();
   }
 
-  static updateOrderingStoreConfig() {
+  static getPreviousVersions() {
     return Joi.object({
-      body: ConfigurationModel.OrderingStoreConfig().required(),
+      platformType: Joi.string().allow("").required(),
     }).required();
   }
 
@@ -128,13 +99,15 @@ class ConfigurationValidator {
     }).required();
   }
 
-  static getDomains() {
-    return Joi.object({}).required();
+  static modifyAppFeatures() {
+    return Joi.object({
+      body: ConfigurationModel.AppFeatureRequest().required(),
+    }).required();
   }
 
-  static addDomain() {
+  static partiallyUpdateInventoryConfig() {
     return Joi.object({
-      body: ConfigurationModel.DomainAddRequest().required(),
+      body: ConfigurationModel.AppInventoryPartialUpdate().required(),
     }).required();
   }
 
@@ -144,20 +117,53 @@ class ConfigurationValidator {
     }).required();
   }
 
-  static changeDomainType() {
+  static updateAppApiTokens() {
     return Joi.object({
-      body: ConfigurationModel.UpdateDomainTypeRequest().required(),
+      body: ConfigurationModel.TokenResponse().required(),
     }).required();
   }
 
-  static getDomainStatus() {
+  static updateAppBasicDetails() {
     return Joi.object({
-      body: ConfigurationModel.DomainStatusRequest().required(),
+      body: ConfigurationModel.ApplicationDetail().required(),
     }).required();
   }
 
-  static getApplicationById() {
-    return Joi.object({}).required();
+  static updateAppContactInfo() {
+    return Joi.object({
+      body: ConfigurationModel.ApplicationInformation().required(),
+    }).required();
+  }
+
+  static updateAppCurrencyConfig() {
+    return Joi.object({
+      body: ConfigurationModel.AppSupportedCurrency().required(),
+    }).required();
+  }
+
+  static updateAppFeatures() {
+    return Joi.object({
+      body: ConfigurationModel.AppFeatureRequest().required(),
+    }).required();
+  }
+
+  static updateBuildConfig() {
+    return Joi.object({
+      platformType: Joi.string().allow("").required(),
+      body: ConfigurationModel.MobileAppConfigRequest().required(),
+    }).required();
+  }
+
+  static updateInventoryConfig() {
+    return Joi.object({
+      body: ConfigurationModel.ApplicationInventory().required(),
+    }).required();
+  }
+
+  static updateOrderingStoreConfig() {
+    return Joi.object({
+      body: ConfigurationModel.OrderingStoreConfig().required(),
+    }).required();
   }
 }
 

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] -
@@ -35,41 +37,18 @@ declare class Configuration {
         pageSize?: number;
         q?: string;
     }): Paginator;
-    /**
-     * @param {Object} arg - Arg object.
-     * @summary: Get all currencies
-     * @description: Get all currencies
-     */
-    getCurrencies({}?: any): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {DomainSuggestionsRequest} arg.body
-     * @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>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {number} arg.id - Integration id
-     * @summary: Get integration data
-     * @description: Get integration data
-     */
-    getIntegrationById({ id }?: {
-        id: number;
-    }): Promise<any>;
     /**
      * @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
@@ -81,65 +60,72 @@ declare class Configuration {
     }): Paginator;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.level - Integration level
-     * @param {number} arg.uid - Integration level uid
+     * @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<BrandsByCompanyResponse>;
+    /**
+     * @param {Object} arg - Arg object.
      * @param {number} [arg.pageNo] - Current page no
      * @param {number} [arg.pageSize] - Current request items count
-     * @summary: Get company/store level integration opt-ins
-     * @description: Get company/store level integration opt-ins
+     * @param {CompanyByBrandsRequest} arg.body
+     * @returns {Promise<CompanyByBrandsResponse>} - Success response
+     * @summary: Get company by brand uids
+     * @description: Get company by brand uids
      */
-    getSelectedOptIns({ level, uid, pageNo, pageSize }?: {
-        level: string;
-        uid: number;
+    getCompanyByBrands({ body, pageNo, pageSize }?: {
         pageNo?: number;
         pageSize?: number;
-    }): Promise<any>;
+        body: CompanyByBrandsRequest;
+    }): Promise<CompanyByBrandsResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.level - Integration level
-     * @param {number} arg.uid - Integration level uid
      * @param {number} [arg.pageSize] - Current request items count
-     * @summary: Get company/store level integration opt-ins
-     * @description: Get company/store level integration opt-ins
+     * @param {CompanyByBrandsRequest} arg.body
+     * @summary: Get company by brand uids
+     * @description: Get company by brand uids
      */
-    getSelectedOptInsPaginator({ level, uid, pageSize }?: {
-        level: string;
-        uid: number;
+    getCompanyByBrandsPaginator({ pageSize, body }?: {
         pageSize?: number;
+        body: CompanyByBrandsRequest;
     }): Paginator;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.id - Integration id
-     * @param {string} arg.level - Integration level
-     * @param {boolean} [arg.opted] - Filter on opted stores
-     * @param {boolean} [arg.checkPermission] - Filter on if permissions are present
-     * @summary: Get integration level config
-     * @description: Get integration/integration-opt-in level config
+     * @returns {Promise<CurrenciesResponse>} - Success response
+     * @summary: Get all currencies
+     * @description: Get all currencies
      */
-    getIntegrationLevelConfig({ id, level, opted, checkPermission }?: {
-        id: string;
-        level: string;
-        opted?: boolean;
-        checkPermission?: boolean;
-    }): Promise<any>;
+    getCurrencies({}?: any): Promise<CurrenciesResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.id - Integration id
-     * @param {string} arg.level - Integration level
-     * @param {UpdateIntegrationLevelRequest} arg.body
-     * @summary: Update a store level opt-in for integration
-     * @description: Update a store level opt-in for integration
+     * @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.
      */
-    updateLevelIntegration({ id, level, body }?: {
-        id: string;
-        level: string;
-        body: UpdateIntegrationLevelRequest;
-    }): Promise<any>;
+    getDomainAvailibility({ body }?: {
+        body: DomainSuggestionsRequest;
+    }): 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<Integration>;
     /**
      * @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,27 +133,29 @@ 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
-     * @summary: Update a store level opt-in for integration
-     * @description: Update a store level opt-in for integration
+     * @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
      */
-    updateLevelUidIntegration({ id, level, uid, body }?: {
+    getIntegrationLevelConfig({ id, level, opted, checkPermission }?: {
         id: string;
         level: string;
-        uid: number;
-        body: IntegrationLevel;
-    }): Promise<any>;
+        opted?: boolean;
+        checkPermission?: boolean;
+    }): Promise<IntegrationConfigResponse>;
     /**
      * @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,103 +163,133 @@ 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
-     * @summary: Get brands by company
-     * @description: Get brands by company
+     * @param {string} arg.id - Application Id
+     * @returns {Promise<OptedApplicationResponse>} - Success response
+     * @summary: Get other seller applications
+     * @description: Get other seller application
      */
-    getBrandsByCompany({ q }?: {
-        q?: string;
-    }): Promise<any>;
+    getOtherSellerApplicationById({ id }?: {
+        id: string;
+    }): Promise<OptedApplicationResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageNo] - Current page no
      * @param {number} [arg.pageSize] - Current request items count
-     * @param {CompanyByBrandsRequest} arg.body
-     * @summary: Get company by brand uids
-     * @description: Get company by brand uids
+     * @returns {Promise<OtherSellerApplications>} - Success response
+     * @summary: Get other seller applications
+     * @description: Get other seller applications who has opted current company as inventory
      */
-    getCompanyByBrands({ body, pageNo, pageSize }?: {
+    getOtherSellerApplications({ pageNo, pageSize }?: {
         pageNo?: number;
         pageSize?: number;
-        body: CompanyByBrandsRequest;
-    }): Promise<any>;
+    }): Promise<OtherSellerApplications>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageSize] - Current request items count
-     * @param {CompanyByBrandsRequest} arg.body
-     * @summary: Get company by brand uids
-     * @description: Get company by brand uids
+     * @summary: Get other seller applications
+     * @description: Get other seller applications who has opted current company as inventory
      */
-    getCompanyByBrandsPaginator({ pageSize, body }?: {
+    getOtherSellerApplicationsPaginator({ pageSize }?: {
         pageSize?: number;
-        body: CompanyByBrandsRequest;
     }): Paginator;
     /**
      * @param {Object} arg - Arg object.
+     * @param {string} arg.level - Integration level
+     * @param {number} arg.uid - Integration level uid
      * @param {number} [arg.pageNo] - Current page no
      * @param {number} [arg.pageSize] - Current request items count
-     * @param {StoreByBrandsRequest} arg.body
-     * @summary: Get stores by brand uids
-     * @description: Get stores by brand uids
+     * @returns {Promise<GetIntegrationsOptInsResponse>} - Success response
+     * @summary: Get company/store level integration opt-ins
+     * @description: Get company/store level integration opt-ins
      */
-    getStoreByBrands({ body, pageNo, pageSize }?: {
+    getSelectedOptIns({ level, uid, pageNo, pageSize }?: {
+        level: string;
+        uid: number;
         pageNo?: number;
         pageSize?: number;
-        body: StoreByBrandsRequest;
-    }): Promise<any>;
+    }): Promise<GetIntegrationsOptInsResponse>;
     /**
      * @param {Object} arg - Arg object.
+     * @param {string} arg.level - Integration level
+     * @param {number} arg.uid - Integration level uid
      * @param {number} [arg.pageSize] - Current request items count
-     * @param {StoreByBrandsRequest} arg.body
-     * @summary: Get stores by brand uids
-     * @description: Get stores by brand uids
+     * @summary: Get company/store level integration opt-ins
+     * @description: Get company/store level integration opt-ins
      */
-    getStoreByBrandsPaginator({ pageSize, body }?: {
+    getSelectedOptInsPaginator({ level, uid, pageSize }?: {
+        level: string;
+        uid: number;
         pageSize?: number;
-        body: StoreByBrandsRequest;
     }): Paginator;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageNo] - Current page no
      * @param {number} [arg.pageSize] - Current request items count
-     * @summary: Get other seller applications
-     * @description: Get other seller applications who has opted current company as inventory
+     * @param {StoreByBrandsRequest} arg.body
+     * @returns {Promise<StoreByBrandsResponse>} - Success response
+     * @summary: Get stores by brand uids
+     * @description: Get stores by brand uids
      */
-    getOtherSellerApplications({ pageNo, pageSize }?: {
+    getStoreByBrands({ body, pageNo, pageSize }?: {
         pageNo?: number;
         pageSize?: number;
-    }): Promise<any>;
+        body: StoreByBrandsRequest;
+    }): Promise<StoreByBrandsResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageSize] - Current request items count
-     * @summary: Get other seller applications
-     * @description: Get other seller applications who has opted current company as inventory
+     * @param {StoreByBrandsRequest} arg.body
+     * @summary: Get stores by brand uids
+     * @description: Get stores by brand uids
      */
-    getOtherSellerApplicationsPaginator({ pageSize }?: {
+    getStoreByBrandsPaginator({ pageSize, body }?: {
         pageSize?: number;
+        body: StoreByBrandsRequest;
     }): Paginator;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.id - Application Id
-     * @summary: Get other seller applications
-     * @description: Get other seller application
-     */
-    getOtherSellerApplicationById({ id }?: {
-        id: string;
-    }): Promise<any>;
     /**
      * @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>;
+    /**
+     * @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
+     */
+    updateLevelIntegration({ id, level, body }?: {
+        id: string;
+        level: string;
+        body: UpdateIntegrationLevelRequest;
+    }): 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
+     */
+    updateLevelUidIntegration({ id, level, uid, body }?: {
+        id: string;
+        level: string;
+        uid: number;
+        body: IntegrationLevel;
+    }): Promise<IntegrationLevel>;
 }
 import Paginator = require("../../common/Paginator");