@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

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

@@ -1,4 +1,17 @@
-export = CommunicationValidator;
-declare class CommunicationValidator {
-    static getSystemNotifications(): any;
+export = CommunicationPlatformValidator;
+/**
+ * @typedef GetSystemNotificationsParam
+ * @property {number} [pageNo]
+ * @property {number} [pageSize]
+ */
+declare class CommunicationPlatformValidator {
+    /** @returns {GetSystemNotificationsParam} */
+    static getSystemNotifications(): GetSystemNotificationsParam;
 }
+declare namespace CommunicationPlatformValidator {
+    export { GetSystemNotificationsParam };
+}
+type GetSystemNotificationsParam = {
+    pageNo?: number;
+    pageSize?: number;
+};

package/sdk/platform/Communication/CommunicationPlatformValidator.js

@@ -1,7 +1,15 @@
 const Joi = require("joi");
 
-const CommunicationModel = require("./CommunicationPlatformModel");
-class CommunicationValidator {
+const CommunicationPlatformModel = require("./CommunicationPlatformModel");
+
+/**
+ * @typedef GetSystemNotificationsParam
+ * @property {number} [pageNo]
+ * @property {number} [pageSize]
+ */
+
+class CommunicationPlatformValidator {
+  /** @returns {GetSystemNotificationsParam} */
   static getSystemNotifications() {
     return Joi.object({
       pageNo: Joi.number(),
@@ -10,4 +18,4 @@ class CommunicationValidator {
   }
 }
 
-module.exports = CommunicationValidator;
+module.exports = CommunicationPlatformValidator;

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

@@ -3,143 +3,133 @@ declare class CompanyProfile {
     constructor(config: any);
     config: any;
     /**
-     * @param {Object} arg - Arg object.
-     * @returns {Promise<GetCompanyProfileSerializerResponse>} - Success response
+     * @param {CompanyProfilePlatformValidator.CbsOnboardGetParam} arg - Arg object
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<CompanyProfilePlatformModel.GetCompanyProfileSerializerResponse>}
+     *   - Success response
+     *
+     * @name cbsOnboardGet
      * @summary: Get company profile
-     * @description: This API allows to view the company profile of the seller account.
+     * @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({}?: any): Promise<GetCompanyProfileSerializerResponse>;
+    cbsOnboardGet({ headers }?: any): Promise<CompanyProfilePlatformModel.GetCompanyProfileSerializerResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {CreateUpdateBrandRequestSerializer} arg.body
-     * @returns {Promise<ProfileSuccessResponse>} - Success response
+     * @param {CompanyProfilePlatformValidator.CreateBrandParam} arg - Arg object
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
+     *   Success response
+     * @name createBrand
      * @summary: Create a Brand.
-     * @description: This API allows to create a brand associated to a company.
+     * @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 }?: {
-        body: CreateUpdateBrandRequestSerializer;
-    }): Promise<ProfileSuccessResponse>;
+    createBrand({ body }?: CompanyProfilePlatformValidator.CreateBrandParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {CompanyBrandPostRequestSerializer} arg.body
-     * @returns {Promise<ProfileSuccessResponse>} - Success response
+     * @param {CompanyProfilePlatformValidator.CreateCompanyBrandMappingParam} arg
+     *   - Arg object
+     *
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
+     *   Success response
+     * @name 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.
+     * @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 }?: {
-        body: CompanyBrandPostRequestSerializer;
-    }): Promise<ProfileSuccessResponse>;
+    createCompanyBrandMapping({ body }?: CompanyProfilePlatformValidator.CreateCompanyBrandMappingParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {LocationSerializer} arg.body
-     * @returns {Promise<ProfileSuccessResponse>} - Success response
+     * @param {CompanyProfilePlatformValidator.CreateLocationParam} arg - Arg object
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
+     *   Success response
+     * @name createLocation
      * @summary: Create a location associated to a company.
-     * @description: This API allows to edit 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 }?: {
-        body: LocationSerializer;
-    }): Promise<ProfileSuccessResponse>;
+    createLocation({ body }?: CompanyProfilePlatformValidator.CreateLocationParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {BulkLocationSerializer} arg.body
-     * @returns {Promise<ProfileSuccessResponse>} - Success response
+     * @param {CompanyProfilePlatformValidator.CreateLocationBulkParam} arg - Arg object
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
+     *   Success response
+     * @name createLocationBulk
      * @summary: Create a location asscoiated to a company in bulk.
-     * @description: This API allows to create a location associated to a company.
+     * @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 }?: {
-        body: BulkLocationSerializer;
-    }): Promise<ProfileSuccessResponse>;
+    createLocationBulk({ body }?: CompanyProfilePlatformValidator.CreateLocationBulkParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.brandId - Id of the brand to be viewed.
-     * @param {CreateUpdateBrandRequestSerializer} arg.body
-     * @returns {Promise<ProfileSuccessResponse>} - Success response
+     * @param {CompanyProfilePlatformValidator.EditBrandParam} arg - Arg object
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
+     *   Success response
+     * @name editBrand
      * @summary: Edit a brand.
-     * @description: This API allows to edit meta of 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 }?: {
-        brandId: string;
-        body: CreateUpdateBrandRequestSerializer;
-    }): Promise<ProfileSuccessResponse>;
+    editBrand({ brandId, body }?: CompanyProfilePlatformValidator.EditBrandParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.brandId - Id of the brand to be viewed.
-     * @returns {Promise<GetBrandResponseSerializer>} - Success response
+     * @param {CompanyProfilePlatformValidator.GetBrandParam} arg - Arg object
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<CompanyProfilePlatformModel.GetBrandResponseSerializer>}
+     *   - Success response
+     *
+     * @name getBrand
      * @summary: Get a single company brand.
-     * @description: This API helps to get data associated to a particular 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 }?: {
-        brandId: string;
-    }): Promise<GetBrandResponseSerializer>;
+    getBrand({ brandId }?: CompanyProfilePlatformValidator.GetBrandParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CompanyProfilePlatformModel.GetBrandResponseSerializer>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {number} [arg.pageNo] - The page number to navigate through the
-     *   given set of results
-     * @param {number} [arg.pageSize] - Number of items to retrieve in each
-     *   page. Default is 10.
-     * @param {string} [arg.q] - Search term for name.
-     * @returns {Promise<CompanyBrandListSerializer>} - Success response
+     * @param {CompanyProfilePlatformValidator.GetBrandsParam} arg - Arg object
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<CompanyProfilePlatformModel.CompanyBrandListSerializer>}
+     *   - Success response
+     *
+     * @name getBrands
      * @summary: Get brands associated to a company
-     * @description: This API helps to get view brands associated to a particular 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 }?: {
-        pageNo?: number;
-        pageSize?: number;
-        q?: string;
-    }): Promise<CompanyBrandListSerializer>;
+    getBrands({ pageNo, pageSize, q }?: CompanyProfilePlatformValidator.GetBrandsParam, { headers }?: import("../PlatformAPIClient").Options): 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.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;
+    }): Paginator<CompanyProfilePlatformModel.CompanyBrandListSerializer>;
     /**
-     * @param {Object} arg - Arg object.
-     * @returns {Promise<MetricsSerializer>} - Success response
+     * @param {CompanyProfilePlatformValidator.GetCompanyMetricsParam} arg - Arg object
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<CompanyProfilePlatformModel.MetricsSerializer>} -
+     *   Success response
+     * @name getCompanyMetrics
      * @summary: Get company metrics
-     * @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.
+     * @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({}?: any): Promise<MetricsSerializer>;
+    getCompanyMetrics({ headers }?: any): Promise<CompanyProfilePlatformModel.MetricsSerializer>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.locationId - Id of the location which you want to view.
-     * @returns {Promise<GetLocationSerializer>} - Success response
+     * @param {CompanyProfilePlatformValidator.GetLocationDetailParam} arg - Arg object
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<CompanyProfilePlatformModel.GetLocationSerializer>} -
+     *   Success response
+     * @name getLocationDetail
      * @summary: Get details of a specific location.
-     * @description: This API helps to get data associated to 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 }?: {
-        locationId: string;
-    }): Promise<GetLocationSerializer>;
+    getLocationDetail({ locationId }?: CompanyProfilePlatformValidator.GetLocationDetailParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CompanyProfilePlatformModel.GetLocationSerializer>;
     /**
-     * @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.pageNo] - The page number to navigate through the
-     *   given set of results
-     * @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.
-     * @returns {Promise<LocationListSerializer>} - Success response
+     * @param {CompanyProfilePlatformValidator.GetLocationsParam} arg - Arg object
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<CompanyProfilePlatformModel.LocationListSerializer>} -
+     *   Success response
+     * @name getLocations
      * @summary: Get list of locations
-     * @description: This API allows to view all the locations associated to a company.
+     * @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, }?: {
-        storeType?: string;
-        q?: string;
-        stage?: string;
-        pageNo?: number;
-        pageSize?: number;
-        locationIds?: number[];
-    }): Promise<LocationListSerializer>;
+    getLocations({ storeType, q, stage, pageNo, pageSize, locationIds }?: CompanyProfilePlatformValidator.GetLocationsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CompanyProfilePlatformModel.LocationListSerializer>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} [arg.storeType] - Helps to sort the location list on the
@@ -150,6 +140,7 @@ declare class CompanyProfile {
      * @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.
+     * @returns {Paginator<CompanyProfilePlatformModel.LocationListSerializer>}
      * @summary: Get list of locations
      * @description: This API allows to view all the locations associated to a company.
      */
@@ -159,28 +150,28 @@ declare class CompanyProfile {
         stage?: string;
         pageSize?: number;
         locationIds?: number[];
-    }): Paginator;
+    }): Paginator<CompanyProfilePlatformModel.LocationListSerializer>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {UpdateCompany} arg.body
-     * @returns {Promise<ProfileSuccessResponse>} - Success response
+     * @param {CompanyProfilePlatformValidator.UpdateCompanyParam} arg - Arg object
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
+     *   Success response
+     * @name updateCompany
      * @summary: Edit company profile
-     * @description: This API allows to edit the company profile of the seller account.
+     * @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 }?: {
-        body: UpdateCompany;
-    }): Promise<ProfileSuccessResponse>;
+    updateCompany({ body }?: CompanyProfilePlatformValidator.UpdateCompanyParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.locationId - Id of the location which you want to edit.
-     * @param {LocationSerializer} arg.body
-     * @returns {Promise<ProfileSuccessResponse>} - Success response
+     * @param {CompanyProfilePlatformValidator.UpdateLocationParam} arg - Arg object
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
+     *   Success response
+     * @name updateLocation
      * @summary: Edit a location asscoiated to a company.
-     * @description: This API allows to edit 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/updateLocation/).
      */
-    updateLocation({ locationId, body }?: {
-        locationId: string;
-        body: LocationSerializer;
-    }): Promise<ProfileSuccessResponse>;
+    updateLocation({ locationId, body }?: CompanyProfilePlatformValidator.UpdateLocationParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>;
 }
+import CompanyProfilePlatformModel = require("./CompanyProfilePlatformModel");
+import CompanyProfilePlatformValidator = require("./CompanyProfilePlatformValidator");
 import Paginator = require("../../common/Paginator");