@gofynd/fdk-client-javascript 1.0.1 → 1.0.2

package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts

@@ -7,129 +7,155 @@ declare class Catalog {
      * @param {Object} arg - Arg object.
      * @param {string} arg.id - A `id` is a unique identifier for a particular
      *   detail. Pass the `id` of the keywords which you want to retrieve.
+     * @returns {Promise<GetSearchWordsDetailResponse>} - Success response
      * @summary: Get a Search Keywords Details
      * @description: Get the details of a words by its `id`. If successful, returns a Collection resource in the response body specified in `GetSearchWordsDetailResponseSchema`
      */
     getSearchKeywords({ id }?: {
         id: string;
-    }): Promise<any>;
+    }): Promise<GetSearchWordsDetailResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id - A `id` is a unique identifier for a particular
      *   detail. Pass the `id` of the keywords which you want to delete.
      * @param {CreateSearchKeyword} arg.body
+     * @returns {Promise<GetSearchWordsData>} - Success response
      * @summary: Update Search Keyword
      * @description: Update Search Keyword by its id. On successful request, returns the updated collection
      */
     updateSearchKeywords({ id, body }?: {
         id: string;
         body: CreateSearchKeyword;
-    }): Promise<any>;
+    }): Promise<GetSearchWordsData>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id - A `id` is a unique identifier for a particular
      *   detail. Pass the `id` of the keywords which you want to delete.
+     * @returns {Promise<DeleteResponse>} - Success response
      * @summary: Delete a Search Keywords
      * @description: Delete a keywords by it's id. Returns an object that tells whether the keywords was deleted successfully
      */
     deleteSearchKeywords({ id }?: {
         id: string;
-    }): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @summary: List all Search Custom Keyword Listing
-     * @description: Custom Search Keyword allows you to map conditions with keywords to give you the ultimate results
-     */
-    getAllSearchKeyword({}?: any): Promise<any>;
+    }): Promise<DeleteResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {CreateSearchKeyword} arg.body
+     * @returns {Promise<GetSearchWordsData>} - Success response
      * @summary: Add a Custom Search Keywords
      * @description: Create a Custom Search Keywords. See `CreateSearchKeywordSchema` for the list of attributes needed to create a mapping and /collections/query-options for the available options to create a rule. On successful request, returns a paginated list of collections specified in `CreateSearchKeywordSchema`
      */
     createCustomKeyword({ body }?: {
         body: CreateSearchKeyword;
-    }): Promise<any>;
+    }): Promise<GetSearchWordsData>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @returns {Promise<GetSearchWordsResponse>} - Success response
+     * @summary: List all Search Custom Keyword Listing
+     * @description: Custom Search Keyword allows you to map conditions with keywords to give you the ultimate results
+     */
+    getAllSearchKeyword({}?: any): Promise<GetSearchWordsResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id - A `id` is a unique identifier for a particular
      *   detail. Pass the `id` of the keywords which you want to retrieve.
+     * @returns {Promise<GetAutocompleteWordsResponse>} - Success response
      * @summary: Get a Autocomplete Keywords Details
      * @description: Get the details of a words by its `id`. If successful, returns a keywords resource in the response body specified in `GetAutocompleteWordsResponseSchema`
      */
     getAutocompleteKeywordDetail({ id }?: {
         id: string;
-    }): Promise<any>;
+    }): Promise<GetAutocompleteWordsResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id - A `id` is a unique identifier for a particular
      *   detail. Pass the `id` of the keywords which you want to delete.
      * @param {CreateAutocompleteKeyword} arg.body
+     * @returns {Promise<GetAutocompleteWordsResponse>} - Success response
      * @summary: Create & Update Autocomplete Keyword
      * @description: Update a mapping by it's id. On successful request, returns the updated Keyword mapping
      */
     updateAutocompleteKeyword({ id, body }?: {
         id: string;
         body: CreateAutocompleteKeyword;
-    }): Promise<any>;
+    }): Promise<GetAutocompleteWordsResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id - A `id` is a unique identifier for a particular
      *   detail. Pass the `id` of the keywords which you want to delete.
+     * @returns {Promise<DeleteResponse>} - Success response
      * @summary: Delete a Autocomplete Keywords
      * @description: Delete a keywords by it's id. Returns an object that tells whether the keywords was deleted successfully
      */
     deleteAutocompleteKeyword({ id }?: {
         id: string;
-    }): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @summary: List all Autocomplete Keyword Listing
-     * @description: Custom Autocomplete Keyword allows you to map conditions with keywords to give you the ultimate results
-     */
-    getAutocompleteConfig({}?: any): Promise<any>;
+    }): Promise<DeleteResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {CreateAutocompleteKeyword} arg.body
+     * @returns {Promise<CreateAutocompleteWordsResponse>} - Success response
      * @summary: Add a Custom Autocomplete Keywords
      * @description: Create a Custom Autocomplete Keywords. See `CreateAutocompleteKeywordSchema` for the list of attributes needed to create a mapping and /collections/query-options for the available options to create a rule. On successful request, returns a paginated list of collections specified in `CreateAutocompleteKeywordSchema`
      */
     createCustomAutocompleteRule({ body }?: {
         body: CreateAutocompleteKeyword;
-    }): Promise<any>;
+    }): Promise<CreateAutocompleteWordsResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @returns {Promise<GetAutocompleteWordsResponse>} - Success response
+     * @summary: List all Autocomplete Keyword Listing
+     * @description: Custom Autocomplete Keyword allows you to map conditions with keywords to give you the ultimate results
+     */
+    getAutocompleteConfig({}?: any): Promise<GetAutocompleteWordsResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.itemId - Product id for a particular product.
+     * @returns {Promise<OwnerAppItemResponse>} - Success response
      * @summary: Get company application product data.
      * @description: Products are the core resource of an application. If successful, returns a Company Application Product resource in the response body depending upon filter sent.
      */
     getAppProduct({ itemId }?: {
         itemId: string;
-    }): Promise<any>;
+    }): Promise<OwnerAppItemResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.itemId - Product id for which the custom_meta is associated.
      * @param {ApplicationItemMeta} arg.body
+     * @returns {Promise<SuccessResponse1>} - Success response
      * @summary: Update a single custom meta.
      * @description: This API helps to update data associated to a item custom meta.
      */
     updateAppProduct({ itemId, body }?: {
         itemId: string;
         body: ApplicationItemMeta;
-    }): Promise<any>;
+    }): Promise<SuccessResponse1>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.configType - A `config_type` is an identifier that
      *   defines a specific type of configuration.
      * @param {string} [arg.templateSlug] - Get configuration list filtered by
      *   `template_slug` string. This is for the details and comparision groups.
+     * @returns {Promise<GetConfigMetadataResponse>} - Success response
      * @summary: Get configuration metadata details for catalog for admin panel
      * @description: Get the configuraion metadata details for catalog.
      */
     getConfigurationMetadata({ configType, templateSlug }?: {
         configType: string;
         templateSlug?: string;
-    }): Promise<any>;
+    }): Promise<GetConfigMetadataResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.configType - A `config_type` is a unique identifier
+     *   for a particular group configuration type.
+     * @param {AppConfigurationDetail} arg.body
+     * @returns {Promise<AppConfigurationDetail>} - Success response
+     * @summary: Create configuration for Group config types.
+     * @description: Create configuration for Group config types.
+     */
+    createGroupConfiguration({ configType, body }?: {
+        configType: string;
+        body: AppConfigurationDetail;
+    }): Promise<AppConfigurationDetail>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.configType - A `config_type` is an identifier that
@@ -141,6 +167,7 @@ declare class Catalog {
      * @param {string} [arg.search] - Get configuration list filtered by `search` string.
      * @param {string} [arg.templateSlug] - Get configuration list filtered by
      *   `template_slug` string. This is for the details and comparision groups.
+     * @returns {Promise<GetConfigResponse>} - Success response
      * @summary: Get the details of the application configured configurations of group config types.
      * @description: Get the details of the application configured configurations of group config types.
      */
@@ -150,19 +177,7 @@ declare class Catalog {
         pageSize?: number;
         search?: string;
         templateSlug?: string;
-    }): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.configType - A `config_type` is a unique identifier
-     *   for a particular group configuration type.
-     * @param {AppConfigurationDetail} arg.body
-     * @summary: Create configuration for Group config types.
-     * @description: Create configuration for Group config types.
-     */
-    createGroupConfiguration({ configType, body }?: {
-        configType: string;
-        body: AppConfigurationDetail;
-    }): Promise<any>;
+    }): Promise<GetConfigResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.configType - A `config_type` is a unique identifier
@@ -170,6 +185,7 @@ declare class Catalog {
      * @param {string} arg.groupSlug - A `group_slug` is a unique identifier of
      *   a particular configuration.
      * @param {AppConfigurationDetail} arg.body
+     * @returns {Promise<AppConfigurationDetail>} - Success response
      * @summary: Update the group configurations for the application.
      * @description: Update the group configurations for the application.
      */
@@ -177,20 +193,34 @@ declare class Catalog {
         configType: string;
         groupSlug: string;
         body: AppConfigurationDetail;
-    }): Promise<any>;
+    }): Promise<AppConfigurationDetail>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.configType - A `config_type` is a unique identifier
      *   for a particular group configuration type.
      * @param {string} arg.groupSlug - A `group_slug` is a unique identifier of
      *   a particular configuration.
+     * @returns {Promise<ConfigSuccessResponse>} - Success response
      * @summary: Delete configuration of the product config type of the application.
      * @description: Delete configuration of the product config type of the application.
      */
     deleteGroupConfiguration({ configType, groupSlug }?: {
         configType: string;
         groupSlug: string;
-    }): Promise<any>;
+    }): Promise<ConfigSuccessResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.configType - A `config_type` is a unique identifier
+     *   for a particular listing configuration type.
+     * @param {AppConfigurationsSort} arg.body
+     * @returns {Promise<AppConfigurationsSort>} - Success response
+     * @summary: Add configuration for listings
+     * @description: Add configuration for listing.
+     */
+    createListingConfiguration({ configType, body }?: {
+        configType: string;
+        body: AppConfigurationsSort;
+    }): Promise<AppConfigurationsSort>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.configType - A `config_type` is an identifier that
@@ -200,27 +230,16 @@ declare class Catalog {
      * @param {number} [arg.pageSize] - Number of items to retrieve in each
      *   page. Default is 12.
      * @param {string} [arg.search] - Get configuration list filtered by `search` string.
+     * @returns {Promise<GetConfigResponse>} - Success response
      * @summary: Get the details of the application configured configurations of listing config types.
      * @description: Get the details of the application configured configurations of listing config types.
      */
-    getListingConfigurations({ configType, pageNo, pageSize, search }?: {
+    getListingConfigurations({ configType, pageNo, pageSize, search, }?: {
         configType: string;
         pageNo?: number;
         pageSize?: number;
         search?: string;
-    }): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.configType - A `config_type` is a unique identifier
-     *   for a particular listing configuration type.
-     * @param {AppConfigurationsSort} arg.body
-     * @summary: Add configuration for listings
-     * @description: Add configuration for listing.
-     */
-    createListingConfiguration({ configType, body }?: {
-        configType: string;
-        body: AppConfigurationsSort;
-    }): Promise<any>;
+    }): Promise<GetConfigResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.configType - A `config_type` is a unique identifier
@@ -228,6 +247,7 @@ declare class Catalog {
      * @param {string} arg.configId - A `config_id` is a unique identifier of a
      *   particular configuration.
      * @param {AppConfigurationsSort} arg.body
+     * @returns {Promise<AppConfigurationsSort>} - Success response
      * @summary: Update configuration for listings
      * @description: Update configuration for listing.
      */
@@ -235,85 +255,104 @@ declare class Catalog {
         configType: string;
         configId: string;
         body: AppConfigurationsSort;
-    }): Promise<any>;
+    }): Promise<AppConfigurationsSort>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.configType - A `config_type` is a unique identifier
      *   for a particular listing configuration type.
      * @param {string} arg.configId - A `config_id` is a unique identifier of a
      *   particular configuration.
+     * @returns {Promise<ConfigSuccessResponse>} - Success response
      * @summary: Delete configuration for listings
      * @description: Delete configuration for listing.
      */
     deleteListingConfiguration({ configType, configId }?: {
         configType: string;
         configId: string;
-    }): Promise<any>;
+    }): Promise<ConfigSuccessResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {AllowSingleRequest} arg.body
+     * @returns {Promise<ConfigSuccessResponse>} - Success response
      * @summary: Update allow single flag for filters of the application.
      * @description: Update allow single flag for filters of the application.
      */
     updateAllowSingle({ body }?: {
         body: AllowSingleRequest;
-    }): Promise<any>;
+    }): Promise<ConfigSuccessResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {DefaultKeyRequest} arg.body
+     * @returns {Promise<ConfigSuccessResponse>} - Success response
      * @summary: Update the default sort key configuration for the application.
      * @description: Update the default sort key configuration for the application.
      */
     updateDefaultSort({ body }?: {
         body: DefaultKeyRequest;
-    }): Promise<any>;
+    }): Promise<ConfigSuccessResponse>;
     /**
      * @param {Object} arg - Arg object.
+     * @returns {Promise<GetCatalogConfigurationMetaData>} - Success response
      * @summary: Get configuration meta  details for catalog for admin panel
      * @description: configuration meta  details for catalog.
      */
-    getCatalogConfiguration({}?: any): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @summary: Get configured details for catalog
-     * @description: configured details for catalog.
-     */
-    getConfigurations({}?: any): Promise<any>;
+    getCatalogConfiguration({}?: any): Promise<GetCatalogConfigurationMetaData>;
     /**
      * @param {Object} arg - Arg object.
      * @param {AppConfiguration} arg.body
+     * @returns {Promise<GetAppCatalogConfiguration>} - Success response
      * @summary: Add configuration for products & listings
      * @description: Add configuration for products & listing.
      */
     createConfigurationProductListing({ body }?: {
         body: AppConfiguration;
-    }): Promise<any>;
+    }): Promise<GetAppCatalogConfiguration>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.type - Type can be brands, categories etc.
+     * @returns {Promise<GetAppCatalogConfiguration>} - Success response
      * @summary: Get configured details for catalog
      * @description: configured details for catalog.
      */
-    getConfigurationByType({ type }?: {
-        type: string;
-    }): Promise<any>;
+    getConfigurations({}?: any): Promise<GetAppCatalogConfiguration>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.type - Type can be brands, categories etc.
      * @param {AppConfiguration} arg.body
+     * @returns {Promise<GetAppCatalogConfiguration>} - Success response
      * @summary: Add configuration for categories and brands
      * @description: Add configuration for categories & brands.
      */
     createConfigurationByType({ type, body }?: {
         type: string;
         body: AppConfiguration;
-    }): Promise<any>;
+    }): Promise<GetAppCatalogConfiguration>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.type - Type can be brands, categories etc.
+     * @returns {Promise<GetAppCatalogEntityConfiguration>} - Success response
+     * @summary: Get configured details for catalog
+     * @description: configured details for catalog.
+     */
+    getConfigurationByType({ type }?: {
+        type: string;
+    }): Promise<GetAppCatalogEntityConfiguration>;
     /**
      * @param {Object} arg - Arg object.
+     * @returns {Promise<GetCollectionQueryOptionResponse>} - Success response
      * @summary: Get query filters to configure a collection
      * @description: Get query filters to configure a collection
      */
-    getQueryFilters({}?: any): Promise<any>;
+    getQueryFilters({}?: any): Promise<GetCollectionQueryOptionResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {CreateCollection} arg.body
+     * @returns {Promise<CollectionCreateResponse>} - Success response
+     * @summary: Add a Collection
+     * @description: Create a collection. See `CreateCollectionRequestSchema` for the list of attributes needed to create a collection and collections/query-options for the available options to create a collection. On successful request, returns a paginated list of collections specified in `CollectionCreateResponse`
+     */
+    createCollection({ body }?: {
+        body: CreateCollection;
+    }): Promise<CollectionCreateResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} [arg.q] - Get collection list filtered by q string,
@@ -327,6 +366,7 @@ declare class Catalog {
      *   given set of results.
      * @param {number} [arg.pageSize] - Number of items to retrieve in each
      *   page. Default is 12.
+     * @returns {Promise<GetCollectionListingResponse>} - Success response
      * @summary: List all the collections
      * @description: A Collection allows you to organize your products into hierarchical groups. For example, a dress might be in the category _Clothing_, the individual product might also be in the collection _Summer_. On successful request, returns all the collections as specified in `CollectionListingSchema`
      */
@@ -338,47 +378,53 @@ declare class Catalog {
         isActive?: boolean;
         pageNo?: number;
         pageSize?: number;
-    }): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {CreateCollection} arg.body
-     * @summary: Add a Collection
-     * @description: Create a collection. See `CreateCollectionRequestSchema` for the list of attributes needed to create a collection and collections/query-options for the available options to create a collection. On successful request, returns a paginated list of collections specified in `CollectionCreateResponse`
-     */
-    createCollection({ body }?: {
-        body: CreateCollection;
-    }): Promise<any>;
+    }): Promise<GetCollectionListingResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.slug - A `slug` is a human readable, URL friendly
      *   unique identifier of an object. Pass the `slug` of the collection which
      *   you want to retrieve.
+     * @returns {Promise<CollectionDetailResponse>} - Success response
      * @summary: Get a particular collection
      * @description: Get the details of a collection by its `slug`. If successful, returns a Collection resource in the response body specified in `CollectionDetailResponse`
      */
     getCollectionDetail({ slug }?: {
         slug: string;
-    }): Promise<any>;
+    }): Promise<CollectionDetailResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id - A `id` is a unique identifier of a collection.
      * @param {UpdateCollection} arg.body
+     * @returns {Promise<UpdateCollection>} - Success response
      * @summary: Update a collection
      * @description: Update a collection by it's id. On successful request, returns the updated collection
      */
     updateCollection({ id, body }?: {
         id: string;
         body: UpdateCollection;
-    }): Promise<any>;
+    }): Promise<UpdateCollection>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id - A `id` is a unique identifier of a collection.
+     * @returns {Promise<DeleteResponse>} - Success response
      * @summary: Delete a Collection
      * @description: Delete a collection by it's id. Returns an object that tells whether the collection was deleted successfully
      */
     deleteCollection({ id }?: {
         id: string;
-    }): Promise<any>;
+    }): Promise<DeleteResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id - A `id` is a unique identifier of a collection.
+     * @param {CollectionItemUpdate} arg.body
+     * @returns {Promise<UpdatedResponse>} - Success response
+     * @summary: Add items to a collection
+     * @description: Adds items to a collection specified by its `id`. See `CollectionItemRequest` for the list of attributes needed to add items to an collection.
+     */
+    addCollectionItems({ id, body }?: {
+        id: string;
+        body: CollectionItemUpdate;
+    }): Promise<UpdatedResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id - A `id` is a unique identifier of a collection.
@@ -388,6 +434,7 @@ declare class Catalog {
      *   which should be sent back to make pagination work.
      * @param {number} [arg.pageSize] - Number of items to retrieve in each
      *   page. Default is 12.
+     * @returns {Promise<GetCollectionItemsResponse>} - Success response
      * @summary: Get the items for a collection
      * @description: Get items from a collection specified by its `id`.
      */
@@ -396,27 +443,17 @@ declare class Catalog {
         sortOn?: string;
         pageId?: string;
         pageSize?: number;
-    }): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.id - A `id` is a unique identifier of a collection.
-     * @param {CollectionItemRequest} arg.body
-     * @summary: Add items to a collection
-     * @description: Adds items to a collection specified by its `id`. See `CollectionItemRequest` for the list of attributes needed to add items to an collection.
-     */
-    addCollectionItems({ id, body }?: {
-        id: string;
-        body: CollectionItemRequest;
-    }): Promise<any>;
+    }): Promise<GetCollectionItemsResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} [arg.brand] - Brand slug
+     * @returns {Promise<CatalogInsightResponse>} - Success response
      * @summary: Analytics data of catalog and inventory.
      * @description: Catalog Insights api returns the count of catalog related data like products, brands, departments and categories that have been made live as per configuration of the app.
      */
     getCatalogInsights({ brand }?: {
         brand?: string;
-    }): Promise<any>;
+    }): Promise<CatalogInsightResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} arg.itemId - Item code of the product of which size is to be get.
@@ -428,6 +465,7 @@ declare class Catalog {
      *   page. Default is 12.
      * @param {string} [arg.q] - Search with help of store code.
      * @param {number[]} [arg.locationIds] - Search by store ids.
+     * @returns {Promise<InventorySellerIdentifierResponsePaginated>} - Success response
      * @summary: Get Inventory for company
      * @description: This API allows get Inventory data for particular company grouped by size and store.
      */
@@ -438,7 +476,7 @@ declare class Catalog {
         pageSize?: number;
         q?: string;
         locationIds?: number[];
-    }): Promise<any>;
+    }): Promise<InventorySellerIdentifierResponsePaginated>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} [arg.department] - The name of the department. Use this
@@ -453,16 +491,17 @@ declare class Catalog {
      *   to search brands by brand name.
      * @param {number[]} [arg.brandId] - Helps to sort the brands list on the
      *   basis of uid list.
+     * @returns {Promise<BrandListingResponse>} - Success response
      * @summary: List all the brands
      * @description: A brand is the name under which a product is being sold. Use this API to list all the brands. You can pass optionally filter the brands by the department. If successful, returns a paginated list of brands specified in `BrandListingResponse`
      */
-    getApplicationBrands({ department, pageNo, pageSize, q, brandId }?: {
+    getApplicationBrands({ department, pageNo, pageSize, q, brandId, }?: {
         department?: string;
         pageNo?: number;
         pageSize?: number;
         q?: string;
         brandId?: number[];
-    }): Promise<any>;
+    }): Promise<BrandListingResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.companyId - A `company_id` is a unique identifier for
@@ -492,22 +531,24 @@ declare class Catalog {
     }): Paginator;
     /**
      * @param {Object} arg - Arg object.
+     * @returns {Promise<DepartmentResponse>} - Success response
      * @summary: List all the departments
      * @description: Departments are a way to categorise similar products. A product can lie in multiple departments. For example, a skirt can below to the 'Women's Fashion' Department while a handbag can lie in 'Women's Accessories' Department. Use this API to list all the departments. If successful, returns the list of departments specified in `DepartmentResponse`
      */
-    getDepartments({}?: any): Promise<any>;
+    getDepartments({}?: any): Promise<DepartmentResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} [arg.department] - The name of the department. Use this
      *   parameter to filter products by a particular department. See below the
      *   list of available departments. You can retrieve available departments
      *   from the **v1.0/departments/** API
+     * @returns {Promise<CategoryListingResponse>} - Success response
      * @summary: List all the categories
      * @description: List all the categories. You can optionally pass filter the brands by the department. If successful, returns a paginated list of brands specified in `CategoryListingResponse`
      */
     getCategories({ department }?: {
         department?: string;
-    }): Promise<any>;
+    }): Promise<CategoryListingResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} [arg.q] - The search query. This can be a partial or
@@ -534,6 +575,7 @@ declare class Catalog {
      * @param {string} [arg.pageType] - For pagination type should be cursor or
      *   number. Default is cursor.
      * @param {number[]} [arg.itemIds] - Item Ids of product
+     * @returns {Promise<ApplicationProductListingResponse>} - Success response
      * @summary: List the products
      * @description: List all the products associated with a brand, collection or category in a requested sort order. The API additionally supports arbitrary search queries that may refer the name of any product, brand, category or collection. If successful, returns a paginated list of products specified in `ApplicationProductListingResponse`
      */
@@ -548,7 +590,7 @@ declare class Catalog {
         pageNo?: number;
         pageType?: string;
         itemIds?: number[];
-    }): Promise<any>;
+    }): Promise<ApplicationProductListingResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.companyId - A `company_id` is a unique identifier for
@@ -592,12 +634,13 @@ declare class Catalog {
      * @param {string} arg.slug - The unique identifier of a product. i.e;
      *   `slug` of a product. You can retrieve these from the APIs that list
      *   products like **v1.0/products/**
+     * @returns {Promise<ProductDetail>} - Success response
      * @summary: Get a product
      * @description: Products are the core resource of an application. Products can be associated by categories, collections, brands and more. This API retrieves the product specified by the given **slug**. If successful, returns a Product resource in the response body specified in `ProductDetail`
      */
     getProductDetailBySlug({ slug }?: {
         slug: string;
-    }): Promise<any>;
+    }): Promise<ProductDetail>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number[]} [arg.brandIds] - Get multiple products filtered by Brand Ids
@@ -611,6 +654,7 @@ declare class Catalog {
      * @param {number} [arg.pageSize] - Number of items to retrieve in each
      *   page. Default is 10.
      * @param {string} [arg.q] - Search with Item Code, Name, Slug or Identifier.
+     * @returns {Promise<ProductListingResponse>} - Success response
      * @summary: Get applicationwise products
      * @description: Products are the core resource of an application. Products can be associated by categories, collections, brands and more. If successful, returns a Product resource in the response body specified in `ApplicationProductListingResponseDatabasePowered`
      */
@@ -622,7 +666,7 @@ declare class Catalog {
         pageNo?: number;
         pageSize?: number;
         q?: string;
-    }): Promise<any>;
+    }): Promise<ProductListingResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number[]} [arg.itemIds] - The Item Id of the product.
@@ -633,6 +677,7 @@ declare class Catalog {
      * @param {string} [arg.timestamp] - Timestamp in UTC format (2020-07-23T10:27:50Z)
      * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
      * @param {string} [arg.pageId] - Page ID to retrieve next set of results.
+     * @returns {Promise<InventoryStockResponse>} - Success response
      * @summary: Get the stock of a product
      * @description: Retrieve the available Inventory of the products. Use this API to get the Inventory status of products with the filters of timestamp, store_ids, brand_ids, item_id - Items - Pagination
      */
@@ -644,7 +689,7 @@ declare class Catalog {
         timestamp?: string;
         pageSize?: number;
         pageId?: string;
-    }): Promise<any>;
+    }): Promise<InventoryStockResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} [arg.storeType] - Helps to sort the location list on the
@@ -658,6 +703,7 @@ declare class Catalog {
      *   given set of results
      * @param {number} [arg.pageSize] - Number of items to retrieve in each
      *   page. Default is 20.
+     * @returns {Promise<LocationListSerializer>} - Success response
      * @summary: Get list of locations
      * @description: This API allows to view all the locations asscoiated to a application.
      */
@@ -668,7 +714,7 @@ declare class Catalog {
         stage?: string;
         pageNo?: number;
         pageSize?: number;
-    }): Promise<any>;
+    }): Promise<LocationListSerializer>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.companyId - Id of the company whose locations are to fetched
@@ -703,6 +749,7 @@ declare class Catalog {
      *   page. Default is 12.
      * @param {string} [arg.q] - Search query with brand name.Use this parameter
      *   to search brands by brand name.
+     * @returns {Promise<BrandListingResponse>} - Success response
      * @summary: List all the brands for the application
      * @description: A brand is the name under which a product is being sold. Use this API to list all the brands. You can pass optionally filter the brands by the department. If successful, returns a paginated list of brands specified in `BrandListingResponse`
      */
@@ -710,7 +757,7 @@ declare class Catalog {
         pageNo?: number;
         pageSize?: number;
         q?: string;
-    }): Promise<any>;
+    }): Promise<BrandListingResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.companyId - A `company_id` is a unique identifier for
@@ -734,13 +781,14 @@ declare class Catalog {
      * @param {Object} arg - Arg object.
      * @param {string} arg.brandUid - Brand id for which the custom_json is associated.
      * @param {ApplicationBrandJson} arg.body
+     * @returns {Promise<SuccessResponse1>} - Success response
      * @summary: Update a single custom json.
      * @description: This API helps to update data associated to a item custom meta.
      */
     updateAppBrand({ brandUid, body }?: {
         brandUid: string;
         body: ApplicationBrandJson;
-    }): Promise<any>;
+    }): Promise<SuccessResponse1>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.departmentId] - A `department_id` is a unique
@@ -751,15 +799,16 @@ declare class Catalog {
      *   page. Default is 12.
      * @param {string} [arg.q] - Search query with brand name.Use this parameter
      *   to search brands by brand name.
+     * @returns {Promise<BrandListingResponse>} - Success response
      * @summary: List all the brands for the application
      * @description: A brand is the name under which a product is being sold. Use this API to list all the brands. You can pass optionally filter the brands by the department. If successful, returns a paginated list of brands specified in `BrandListingResponse`
      */
-    getApplicationCategoryListing({ departmentId, pageNo, pageSize, q }?: {
+    getApplicationCategoryListing({ departmentId, pageNo, pageSize, q, }?: {
         departmentId?: number;
         pageNo?: number;
         pageSize?: number;
         q?: string;
-    }): Promise<any>;
+    }): Promise<BrandListingResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.companyId - A `company_id` is a unique identifier for
@@ -787,13 +836,14 @@ declare class Catalog {
      * @param {string} arg.categoryUid - Category id for which the custom_json
      *   is associated.
      * @param {ApplicationCategoryJson} arg.body
+     * @returns {Promise<SuccessResponse1>} - Success response
      * @summary: Update a single custom json.
      * @description: This API helps to update data associated to a item custom meta.
      */
     updateAppCategory({ categoryUid, body }?: {
         categoryUid: string;
         body: ApplicationCategoryJson;
-    }): Promise<any>;
+    }): Promise<SuccessResponse1>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageNo] - The page number to navigate through the
@@ -802,6 +852,7 @@ declare class Catalog {
      *   page. Default is 12.
      * @param {string} [arg.q] - Search query with brand name.Use this parameter
      *   to search department by name.
+     * @returns {Promise<ApplicationDepartmentListingResponse>} - Success response
      * @summary: List all the departments for the application
      * @description: Departments are a way to categorise similar products. A product can lie in multiple departments. For example, a skirt can below to the 'Women's Fashion' Department while a handbag can lie in 'Women's Accessories' Department. Use this API to list all the application departments. If successful, returns the list of departments specified in `ApplicationDepartmentListingResponse`
      */
@@ -809,7 +860,7 @@ declare class Catalog {
         pageNo?: number;
         pageSize?: number;
         q?: string;
-    }): Promise<any>;
+    }): Promise<ApplicationDepartmentListingResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.companyId - A `company_id` is a unique identifier for
@@ -834,23 +885,25 @@ declare class Catalog {
      * @param {string} arg.departmentUid - Department id for which the
      *   custom_json is associated.
      * @param {ApplicationDepartmentJson} arg.body
+     * @returns {Promise<SuccessResponse1>} - Success response
      * @summary: Update a single custom json.
      * @description: This API helps to update data associated to a item custom meta.
      */
     updateAppDepartment({ departmentUid, body }?: {
         departmentUid: string;
         body: ApplicationDepartmentJson;
-    }): Promise<any>;
+    }): Promise<SuccessResponse1>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.storeUid - Store id for which the custom_json is associated.
      * @param {ApplicationStoreJson} arg.body
+     * @returns {Promise<SuccessResponse1>} - Success response
      * @summary: Update a single custom json.
      * @description: This API helps to update data associated to a item custom meta.
      */
     updateAppLocation({ storeUid, body }?: {
         storeUid: string;
         body: ApplicationStoreJson;
-    }): Promise<any>;
+    }): Promise<SuccessResponse1>;
 }
 import Paginator = require("../../common/Paginator");