@gofynd/fdk-client-javascript 1.4.15-beta.14 → 1.4.15-beta.15

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

@@ -6,130 +6,132 @@ declare class CompanyProfile {
      * @param {CompanyProfilePlatformValidator.CbsOnboardGetParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CompanyProfilePlatformModel.GetCompanyProfileSerializerResponse>}
+     * @returns {Promise<CompanyProfilePlatformModel.GetCompanyProfileSerializerResponseSchema>}
      *   - Success response
      *
      * @name cbsOnboardGet
      * @summary: Get company profile
-     * @description: View the company profile of the seller account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/cbsOnboardGet/).
+     * @description: View the company profile of the seller account. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/cbsOnboardGet/).
      */
-    cbsOnboardGet({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.GetCompanyProfileSerializerResponse>;
+    cbsOnboardGet({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.GetCompanyProfileSerializerResponseSchema>;
     /**
      * @param {CompanyProfilePlatformValidator.CreateBrandParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
-     *   Success response
+     * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>}
+     *   - Success response
+     *
      * @name createBrand
      * @summary: Create brand
-     * @description: Allows to create a brand associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createBrand/).
+     * @description: Allows to create a brand associated to a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/createBrand/).
      */
-    createBrand({ body, requestHeaders }?: CompanyProfilePlatformValidator.CreateBrandParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>;
+    createBrand({ body, requestHeaders }?: CompanyProfilePlatformValidator.CreateBrandParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>;
     /**
      * @param {CompanyProfilePlatformValidator.CreateCompanyBrandMappingParam} arg
      *   - Arg object
      *
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
-     *   Success response
+     * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>}
+     *   - Success response
+     *
      * @name createCompanyBrandMapping
      * @summary: Create company-brand mapping
-     * @description: Establish a mapping between a company and a brand. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createCompanyBrandMapping/).
+     * @description: Establish a mapping between a company and a brand. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/createCompanyBrandMapping/).
      */
-    createCompanyBrandMapping({ body, requestHeaders }?: CompanyProfilePlatformValidator.CreateCompanyBrandMappingParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>;
+    createCompanyBrandMapping({ body, requestHeaders }?: CompanyProfilePlatformValidator.CreateCompanyBrandMappingParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>;
     /**
      * @param {CompanyProfilePlatformValidator.CreateLocationParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
-     *   Success response
+     * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>}
+     *   - Success response
+     *
      * @name createLocation
      * @summary: Create company stores
-     * @description: Create a new location associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createLocation/).
+     * @description: Create a new location associated to a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/createLocation/).
      */
-    createLocation({ body, requestHeaders }?: CompanyProfilePlatformValidator.CreateLocationParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>;
+    createLocation({ body, requestHeaders }?: CompanyProfilePlatformValidator.CreateLocationParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>;
     /**
      * @param {CompanyProfilePlatformValidator.CreateLocationBulkParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
-     *   Success response
+     * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>}
+     *   - Success response
+     *
      * @name createLocationBulk
      * @summary: Bulk create company stores
-     * @description: Allows to create locations in bulk at once associated to a company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createLocationBulk/).
+     * @description: Allows to create locations in bulk at once associated to a company - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/createLocationBulk/).
      */
-    createLocationBulk({ body, requestHeaders }?: CompanyProfilePlatformValidator.CreateLocationBulkParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>;
+    createLocationBulk({ body, requestHeaders }?: CompanyProfilePlatformValidator.CreateLocationBulkParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>;
     /**
      * @param {CompanyProfilePlatformValidator.EditBrandParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
-     *   Success response
+     * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>}
+     *   - Success response
+     *
      * @name editBrand
      * @summary: update brand
-     * @description: Modify brand details and meta of a specific brand. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/editBrand/).
+     * @description: Modify brand details and meta of a specific brand. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/editBrand/).
      */
-    editBrand({ brandId, body, requestHeaders }?: CompanyProfilePlatformValidator.EditBrandParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>;
+    editBrand({ brandId, body, requestHeaders }?: CompanyProfilePlatformValidator.EditBrandParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>;
     /**
      * @param {CompanyProfilePlatformValidator.GetBrandParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CompanyProfilePlatformModel.GetBrandResponseSerializer>}
-     *   - Success response
-     *
+     * @returns {Promise<CompanyProfilePlatformModel.GetBrandResponseSchema>} -
+     *   Success response
      * @name getBrand
      * @summary: Get a brand
-     * @description: Retrieve detailed information about a specific brand associated to a particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getBrand/).
+     * @description: Retrieve detailed information about a specific brand associated to a particular company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/getBrand/).
      */
-    getBrand({ brandId, requestHeaders }?: CompanyProfilePlatformValidator.GetBrandParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.GetBrandResponseSerializer>;
+    getBrand({ brandId, requestHeaders }?: CompanyProfilePlatformValidator.GetBrandParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.GetBrandResponseSchema>;
     /**
      * @param {CompanyProfilePlatformValidator.GetBrandsParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CompanyProfilePlatformModel.CompanyBrandListSerializer>}
-     *   - Success response
-     *
+     * @returns {Promise<CompanyProfilePlatformModel.CompanyBrandListSchema>} -
+     *   Success response
      * @name getBrands
      * @summary: list company brands
-     * @description: Retrieve a list of available brands associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getBrands/).
+     * @description: Retrieve a list of available brands associated to a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/getBrands/).
      */
-    getBrands({ pageNo, pageSize, q, requestHeaders }?: CompanyProfilePlatformValidator.GetBrandsParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.CompanyBrandListSerializer>;
+    getBrands({ pageNo, pageSize, q, requestHeaders }?: CompanyProfilePlatformValidator.GetBrandsParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.CompanyBrandListSchema>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageSize] - Number of items to retrieve in each
      *   page. Default is 10.
      * @param {string} [arg.q] - Search term for name.
-     * @returns {Paginator<CompanyProfilePlatformModel.CompanyBrandListSerializer>}
+     * @returns {Paginator<CompanyProfilePlatformModel.CompanyBrandListSchema>}
      * @summary: list company brands
      * @description: Retrieve a list of available brands associated to a company.
      */
     getBrandsPaginator({ pageSize, q }?: {
         pageSize?: number;
         q?: string;
-    }): Paginator<CompanyProfilePlatformModel.CompanyBrandListSerializer>;
+    }): Paginator<CompanyProfilePlatformModel.CompanyBrandListSchema>;
     /**
      * @param {CompanyProfilePlatformValidator.GetCompanyMetricsParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CompanyProfilePlatformModel.MetricsSerializer>} -
-     *   Success response
+     * @returns {Promise<CompanyProfilePlatformModel.MetricsSchema>} - Success response
      * @name getCompanyMetrics
      * @summary: Get company metrics
-     * @description: Allows viewing company metrics, including brand and store status, as well as the number of verified and unverified products, company documents, and store documents. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getCompanyMetrics/).
+     * @description: Allows viewing company metrics, including brand and store status, as well as the number of verified and unverified products, company documents, and store documents. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/getCompanyMetrics/).
      */
-    getCompanyMetrics({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.MetricsSerializer>;
+    getCompanyMetrics({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.MetricsSchema>;
     /**
      * @param {CompanyProfilePlatformValidator.GetLocationDetailParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CompanyProfilePlatformModel.GetLocationSerializer>} -
+     * @returns {Promise<CompanyProfilePlatformModel.GetLocationSchema>} -
      *   Success response
      * @name getLocationDetail
      * @summary: Get company stores
-     * @description: Retrive detailed information about a specific location associated to a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getLocationDetail/).
+     * @description: Retrive detailed information about a specific location associated to a specific company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/getLocationDetail/).
      */
-    getLocationDetail({ locationId, requestHeaders }?: CompanyProfilePlatformValidator.GetLocationDetailParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.GetLocationSerializer>;
+    getLocationDetail({ locationId, requestHeaders }?: CompanyProfilePlatformValidator.GetLocationDetailParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.GetLocationSchema>;
     /**
      * @param {CompanyProfilePlatformValidator.GetLocationTagsParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -139,69 +141,44 @@ declare class CompanyProfile {
      *
      * @name getLocationTags
      * @summary: Get company store tags
-     * @description: Retrieve all the distinct tags associated to a company location. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getLocationTags/).
+     * @description: Retrieve all the distinct tags associated to a company location. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/getLocationTags/).
      */
     getLocationTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.StoreTagsResponseSchema>;
     /**
      * @param {CompanyProfilePlatformValidator.GetLocationsParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CompanyProfilePlatformModel.LocationListSerializer>} -
+     * @returns {Promise<CompanyProfilePlatformModel.LocationListSchema>} -
      *   Success response
      * @name getLocations
      * @summary: Get company specific stores
-     * @description: Retrieve a list of locations associated with the company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getLocations/).
-     */
-    getLocations({ storeType, q, stage, pageNo, pageSize, locationIds, types, tags, requestHeaders, }?: CompanyProfilePlatformValidator.GetLocationsParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.LocationListSerializer>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} [arg.storeType] - Helps to sort the location list on the
-     *   basis of location type.
-     * @param {string} [arg.q] - Query that is to be searched.
-     * @param {string} [arg.stage] - To filter companies on basis of verified or
-     *   unverified companies.
-     * @param {number} [arg.pageSize] - Number of items to retrieve in each
-     *   page. Default is 10.
-     * @param {number[]} [arg.locationIds] - Helps to filter stores on the basis of uids.
-     * @param {string[]} [arg.types] - Helps to get the location list on the
-     *   basis of multiple location type.
-     * @param {string[]} [arg.tags] - Helps to get the location list on the
-     *   basis of multiple location tag.
-     * @returns {Paginator<CompanyProfilePlatformModel.LocationListSerializer>}
-     * @summary: Get company specific stores
-     * @description: Retrieve a list of locations associated with the company.
+     * @description: Retrieve a list of locations associated with the company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/getLocations/).
      */
-    getLocationsPaginator({ storeType, q, stage, pageSize, locationIds, types, tags, }?: {
-        storeType?: string;
-        q?: string;
-        stage?: string;
-        pageSize?: number;
-        locationIds?: number[];
-        types?: string[];
-        tags?: string[];
-    }): Paginator<CompanyProfilePlatformModel.LocationListSerializer>;
+    getLocations({ storeType, q, stage, pageNo, pageSize, locationIds, types, tags, requestHeaders, }?: CompanyProfilePlatformValidator.GetLocationsParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.LocationListSchema>;
     /**
      * @param {CompanyProfilePlatformValidator.UpdateCompanyParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
-     *   Success response
+     * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>}
+     *   - Success response
+     *
      * @name updateCompany
      * @summary: Update company profile
-     * @description: Allows to edit the company profile of the seller account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/updateCompany/).
+     * @description: Allows to edit the company profile of the seller account. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/updateCompany/).
      */
-    updateCompany({ body, requestHeaders }?: CompanyProfilePlatformValidator.UpdateCompanyParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>;
+    updateCompany({ body, requestHeaders }?: CompanyProfilePlatformValidator.UpdateCompanyParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>;
     /**
      * @param {CompanyProfilePlatformValidator.UpdateLocationParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
-     *   Success response
+     * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>}
+     *   - Success response
+     *
      * @name updateLocation
      * @summary: Update company stores
-     * @description: Allows to edit a location associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/updateLocation/).
+     * @description: Allows to edit a location associated to a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/updateLocation/).
      */
-    updateLocation({ locationId, body, requestHeaders }?: CompanyProfilePlatformValidator.UpdateLocationParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>;
+    updateLocation({ locationId, body, requestHeaders }?: CompanyProfilePlatformValidator.UpdateLocationParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>;
 }
 import CompanyProfilePlatformModel = require("./CompanyProfilePlatformModel");
 import CompanyProfilePlatformValidator = require("./CompanyProfilePlatformValidator");