@gofynd/fdk-client-javascript 1.6.3 → 3.0.0-beta.1

package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts

@@ -1,17 +1,76 @@
 export = CommunicationPlatformValidator;
 /**
  * @typedef GetSystemNotificationsParam
- * @property {number} [pageNo]
- * @property {number} [pageSize]
+ * @property {number} [pageNo] - Current page no
+ * @property {number} [pageSize] - Current request items count
+ * @property {string} [sort] - To sort based on created_at
+ * @property {string} [query] - To search based on plain text
+ */
+/**
+ * @typedef SenByCompanyCommunicationAsynchronouslyParam
+ * @property {string} xApplicationId - Application id
+ * @property {CommunicationPlatformModel.EngineRequest} body
+ */
+/**
+ * @typedef SendByCompanyCommunicationInstantlyParam
+ * @property {string} xApplicationId - Application id
+ * @property {CommunicationPlatformModel.EngineRequest} body
+ */
+/**
+ * @typedef SendByCompanyCommunicationSynchronouslyParam
+ * @property {string} xApplicationId - Application id
+ * @property {CommunicationPlatformModel.EngineRequest} body
  */
 declare class CommunicationPlatformValidator {
     /** @returns {GetSystemNotificationsParam} */
     static getSystemNotifications(): GetSystemNotificationsParam;
+    /** @returns {SenByCompanyCommunicationAsynchronouslyParam} */
+    static senByCompanyCommunicationAsynchronously(): SenByCompanyCommunicationAsynchronouslyParam;
+    /** @returns {SendByCompanyCommunicationInstantlyParam} */
+    static sendByCompanyCommunicationInstantly(): SendByCompanyCommunicationInstantlyParam;
+    /** @returns {SendByCompanyCommunicationSynchronouslyParam} */
+    static sendByCompanyCommunicationSynchronously(): SendByCompanyCommunicationSynchronouslyParam;
 }
 declare namespace CommunicationPlatformValidator {
-    export { GetSystemNotificationsParam };
+    export { GetSystemNotificationsParam, SenByCompanyCommunicationAsynchronouslyParam, SendByCompanyCommunicationInstantlyParam, SendByCompanyCommunicationSynchronouslyParam };
 }
 type GetSystemNotificationsParam = {
+    /**
+     * - Current page no
+     */
     pageNo?: number;
+    /**
+     * - Current request items count
+     */
     pageSize?: number;
+    /**
+     * - To sort based on created_at
+     */
+    sort?: string;
+    /**
+     * - To search based on plain text
+     */
+    query?: string;
+};
+type SenByCompanyCommunicationAsynchronouslyParam = {
+    /**
+     * - Application id
+     */
+    xApplicationId: string;
+    body: CommunicationPlatformModel.EngineRequest;
+};
+type SendByCompanyCommunicationInstantlyParam = {
+    /**
+     * - Application id
+     */
+    xApplicationId: string;
+    body: CommunicationPlatformModel.EngineRequest;
+};
+type SendByCompanyCommunicationSynchronouslyParam = {
+    /**
+     * - Application id
+     */
+    xApplicationId: string;
+    body: CommunicationPlatformModel.EngineRequest;
 };
+import CommunicationPlatformModel = require("./CommunicationPlatformModel");

package/sdk/platform/Communication/CommunicationPlatformValidator.js

@@ -4,8 +4,28 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
 
 /**
  * @typedef GetSystemNotificationsParam
- * @property {number} [pageNo]
- * @property {number} [pageSize]
+ * @property {number} [pageNo] - Current page no
+ * @property {number} [pageSize] - Current request items count
+ * @property {string} [sort] - To sort based on created_at
+ * @property {string} [query] - To search based on plain text
+ */
+
+/**
+ * @typedef SenByCompanyCommunicationAsynchronouslyParam
+ * @property {string} xApplicationId - Application id
+ * @property {CommunicationPlatformModel.EngineRequest} body
+ */
+
+/**
+ * @typedef SendByCompanyCommunicationInstantlyParam
+ * @property {string} xApplicationId - Application id
+ * @property {CommunicationPlatformModel.EngineRequest} body
+ */
+
+/**
+ * @typedef SendByCompanyCommunicationSynchronouslyParam
+ * @property {string} xApplicationId - Application id
+ * @property {CommunicationPlatformModel.EngineRequest} body
  */
 
 class CommunicationPlatformValidator {
@@ -14,6 +34,32 @@ class CommunicationPlatformValidator {
     return Joi.object({
       pageNo: Joi.number(),
       pageSize: Joi.number(),
+      sort: Joi.string().allow(""),
+      query: Joi.string().allow(""),
+    }).required();
+  }
+
+  /** @returns {SenByCompanyCommunicationAsynchronouslyParam} */
+  static senByCompanyCommunicationAsynchronously() {
+    return Joi.object({
+      xApplicationId: Joi.string().allow("").required(),
+      body: CommunicationPlatformModel.EngineRequest().required(),
+    }).required();
+  }
+
+  /** @returns {SendByCompanyCommunicationInstantlyParam} */
+  static sendByCompanyCommunicationInstantly() {
+    return Joi.object({
+      xApplicationId: Joi.string().allow("").required(),
+      body: CommunicationPlatformModel.EngineRequest().required(),
+    }).required();
+  }
+
+  /** @returns {SendByCompanyCommunicationSynchronouslyParam} */
+  static sendByCompanyCommunicationSynchronously() {
+    return Joi.object({
+      xApplicationId: Joi.string().allow("").required(),
+      body: CommunicationPlatformModel.EngineRequest().required(),
     }).required();
   }
 }

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

@@ -6,132 +6,130 @@ 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.GetCompanyProfileSerializerResponseSchema>}
+     * @returns {Promise<CompanyProfilePlatformModel.GetCompanyProfileSerializerResponse>}
      *   - 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: This API allows to view the company profile of the seller account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/cbsOnboardGet/).
      */
-    cbsOnboardGet({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.GetCompanyProfileSerializerResponseSchema>;
+    cbsOnboardGet({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.GetCompanyProfileSerializerResponse>;
     /**
      * @param {CompanyProfilePlatformValidator.CreateBrandParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>}
-     *   - Success response
-     *
+     * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
+     *   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/).
+     * @summary: Create a Brand.
+     * @description: This API allows to create a brand associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createBrand/).
      */
-    createBrand({ body, requestHeaders }?: CompanyProfilePlatformValidator.CreateBrandParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>;
+    createBrand({ body, requestHeaders }?: CompanyProfilePlatformValidator.CreateBrandParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>;
     /**
      * @param {CompanyProfilePlatformValidator.CreateCompanyBrandMappingParam} arg
      *   - Arg object
      *
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>}
-     *   - Success response
-     *
+     * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
+     *   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/).
+     * @summary: Create a company brand mapping.
+     * @description: This API allows to create a company brand mapping, for a already existing brand in the system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createCompanyBrandMapping/).
      */
-    createCompanyBrandMapping({ body, requestHeaders }?: CompanyProfilePlatformValidator.CreateCompanyBrandMappingParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>;
+    createCompanyBrandMapping({ body, requestHeaders }?: CompanyProfilePlatformValidator.CreateCompanyBrandMappingParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>;
     /**
      * @param {CompanyProfilePlatformValidator.CreateLocationParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>}
-     *   - Success response
-     *
+     * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
+     *   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/).
+     * @summary: Create a location associated to a company.
+     * @description: This API allows to edit a location associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createLocation/).
      */
-    createLocation({ body, requestHeaders }?: CompanyProfilePlatformValidator.CreateLocationParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>;
+    createLocation({ body, requestHeaders }?: CompanyProfilePlatformValidator.CreateLocationParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>;
     /**
      * @param {CompanyProfilePlatformValidator.CreateLocationBulkParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>}
-     *   - Success response
-     *
+     * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
+     *   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/).
+     * @summary: Create a location asscoiated to a company in bulk.
+     * @description: This API allows to create a location associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createLocationBulk/).
      */
-    createLocationBulk({ body, requestHeaders }?: CompanyProfilePlatformValidator.CreateLocationBulkParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>;
+    createLocationBulk({ body, requestHeaders }?: CompanyProfilePlatformValidator.CreateLocationBulkParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>;
     /**
      * @param {CompanyProfilePlatformValidator.EditBrandParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>}
-     *   - Success response
-     *
+     * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
+     *   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/).
+     * @summary: Edit a brand.
+     * @description: This API allows to edit meta of a brand. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/editBrand/).
      */
-    editBrand({ brandId, body, requestHeaders }?: CompanyProfilePlatformValidator.EditBrandParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>;
+    editBrand({ brandId, body, requestHeaders }?: CompanyProfilePlatformValidator.EditBrandParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>;
     /**
      * @param {CompanyProfilePlatformValidator.GetBrandParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CompanyProfilePlatformModel.GetBrandResponseSchema>} -
-     *   Success response
+     * @returns {Promise<CompanyProfilePlatformModel.GetBrandResponseSerializer>}
+     *   - 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/).
+     * @summary: Get a single company brand.
+     * @description: This API helps to get data associated to a particular company brand. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getBrand/).
      */
-    getBrand({ brandId, requestHeaders }?: CompanyProfilePlatformValidator.GetBrandParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.GetBrandResponseSchema>;
+    getBrand({ brandId, requestHeaders }?: CompanyProfilePlatformValidator.GetBrandParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.GetBrandResponseSerializer>;
     /**
      * @param {CompanyProfilePlatformValidator.GetBrandsParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CompanyProfilePlatformModel.CompanyBrandListSchema>} -
-     *   Success response
+     * @returns {Promise<CompanyProfilePlatformModel.CompanyBrandListSerializer>}
+     *   - 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/).
+     * @summary: Get brands associated to a company
+     * @description: This API helps to get view brands associated to a particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getBrands/).
      */
-    getBrands({ pageNo, pageSize, q, requestHeaders }?: CompanyProfilePlatformValidator.GetBrandsParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.CompanyBrandListSchema>;
+    getBrands({ pageNo, pageSize, q, requestHeaders }?: CompanyProfilePlatformValidator.GetBrandsParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.CompanyBrandListSerializer>;
     /**
      * @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.CompanyBrandListSchema>}
-     * @summary: list company brands
-     * @description: Retrieve a list of available brands associated to a company.
+     * @returns {Paginator<CompanyProfilePlatformModel.CompanyBrandListSerializer>}
+     * @summary: Get brands associated to a company
+     * @description: This API helps to get view brands associated to a particular company.
      */
     getBrandsPaginator({ pageSize, q }?: {
         pageSize?: number;
         q?: string;
-    }): Paginator<CompanyProfilePlatformModel.CompanyBrandListSchema>;
+    }): Paginator<CompanyProfilePlatformModel.CompanyBrandListSerializer>;
     /**
      * @param {CompanyProfilePlatformValidator.GetCompanyMetricsParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CompanyProfilePlatformModel.MetricsSchema>} - Success response
+     * @returns {Promise<CompanyProfilePlatformModel.MetricsSerializer>} -
+     *   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: This API allows to view the company metrics, i.e. the status of its brand and stores. Also its allows to view the number of products, company documents & store documents which are verified and unverified. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getCompanyMetrics/).
      */
-    getCompanyMetrics({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.MetricsSchema>;
+    getCompanyMetrics({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.MetricsSerializer>;
     /**
      * @param {CompanyProfilePlatformValidator.GetLocationDetailParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CompanyProfilePlatformModel.GetLocationSchema>} -
+     * @returns {Promise<CompanyProfilePlatformModel.GetLocationSerializer>} -
      *   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/).
+     * @summary: Get details of a specific location.
+     * @description: This API helps to get data associated to a specific location. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getLocationDetail/).
      */
-    getLocationDetail({ locationId, requestHeaders }?: CompanyProfilePlatformValidator.GetLocationDetailParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.GetLocationSchema>;
+    getLocationDetail({ locationId, requestHeaders }?: CompanyProfilePlatformValidator.GetLocationDetailParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.GetLocationSerializer>;
     /**
      * @param {CompanyProfilePlatformValidator.GetLocationTagsParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -140,72 +138,43 @@ declare class CompanyProfile {
      *   - Success response
      *
      * @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/).
+     * @summary: Get tags associated with locations for a company.
+     * @description: This API fetches all the tags associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/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.LocationListSchema>} -
+     * @returns {Promise<CompanyProfilePlatformModel.LocationListSerializer>} -
      *   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/).
+     * @summary: Get list of locations
+     * @description: This API allows to view all the locations associated to a 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.LocationListSchema>;
-    /**
-     * @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.LocationListSchema>}
-     * @summary: Get company specific stores
-     * @description: Retrieve a list of locations associated with the company.
-     */
-    getLocationsPaginator({ storeType, q, stage, pageSize, locationIds, types, tags, }?: {
-        storeType?: string;
-        q?: string;
-        stage?: string;
-        pageSize?: number;
-        locationIds?: number[];
-        types?: string[];
-        tags?: string[];
-    }): Paginator<CompanyProfilePlatformModel.LocationListSchema>;
+    getLocations({ storeType, q, stage, pageNo, pageSize, locationIds, types, tags, requestHeaders, }?: CompanyProfilePlatformValidator.GetLocationsParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.LocationListSerializer>;
     /**
      * @param {CompanyProfilePlatformValidator.UpdateCompanyParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>}
-     *   - Success response
-     *
+     * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
+     *   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/).
+     * @summary: Edit company profile
+     * @description: This API allows to edit the company profile of the seller account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/updateCompany/).
      */
-    updateCompany({ body, requestHeaders }?: CompanyProfilePlatformValidator.UpdateCompanyParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>;
+    updateCompany({ body, requestHeaders }?: CompanyProfilePlatformValidator.UpdateCompanyParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>;
     /**
      * @param {CompanyProfilePlatformValidator.UpdateLocationParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>}
-     *   - Success response
-     *
+     * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
+     *   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/).
+     * @summary: Edit a location asscoiated to a company.
+     * @description: This API allows to edit a location associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/updateLocation/).
      */
-    updateLocation({ locationId, body, requestHeaders }?: CompanyProfilePlatformValidator.UpdateLocationParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponseSchema>;
+    updateLocation({ locationId, body, requestHeaders }?: CompanyProfilePlatformValidator.UpdateLocationParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>;
 }
 import CompanyProfilePlatformModel = require("./CompanyProfilePlatformModel");
 import CompanyProfilePlatformValidator = require("./CompanyProfilePlatformValidator");