@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

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

@@ -1,16 +1,183 @@
-export = CompanyProfileValidator;
-declare class CompanyProfileValidator {
+export = CompanyProfilePlatformValidator;
+/** @typedef CbsOnboardGetParam */
+/**
+ * @typedef CreateBrandParam
+ * @property {CompanyProfilePlatformModel.CreateUpdateBrandRequestSerializer} body
+ */
+/**
+ * @typedef CreateCompanyBrandMappingParam
+ * @property {CompanyProfilePlatformModel.CompanyBrandPostRequestSerializer} body
+ */
+/**
+ * @typedef CreateLocationParam
+ * @property {CompanyProfilePlatformModel.LocationSerializer} body
+ */
+/**
+ * @typedef CreateLocationBulkParam
+ * @property {CompanyProfilePlatformModel.BulkLocationSerializer} body
+ */
+/**
+ * @typedef EditBrandParam
+ * @property {string} brandId - Id of the brand to be viewed.
+ * @property {CompanyProfilePlatformModel.CreateUpdateBrandRequestSerializer} body
+ */
+/**
+ * @typedef GetBrandParam
+ * @property {string} brandId - Id of the brand to be viewed.
+ */
+/**
+ * @typedef GetBrandsParam
+ * @property {number} [pageNo] - The page number to navigate through the given
+ *   set of results
+ * @property {number} [pageSize] - Number of items to retrieve in each page.
+ *   Default is 10.
+ * @property {string} [q] - Search term for name.
+ */
+/** @typedef GetCompanyMetricsParam */
+/**
+ * @typedef GetLocationDetailParam
+ * @property {string} locationId - Id of the location which you want to view.
+ */
+/**
+ * @typedef GetLocationsParam
+ * @property {string} [storeType] - Helps to sort the location list on the basis
+ *   of location type.
+ * @property {string} [q] - Query that is to be searched.
+ * @property {string} [stage] - To filter companies on basis of verified or
+ *   unverified companies.
+ * @property {number} [pageNo] - The page number to navigate through the given
+ *   set of results
+ * @property {number} [pageSize] - Number of items to retrieve in each page.
+ *   Default is 10.
+ * @property {number[]} [locationIds] - Helps to filter stores on the basis of uids.
+ */
+/**
+ * @typedef UpdateCompanyParam
+ * @property {CompanyProfilePlatformModel.UpdateCompany} body
+ */
+/**
+ * @typedef UpdateLocationParam
+ * @property {string} locationId - Id of the location which you want to edit.
+ * @property {CompanyProfilePlatformModel.LocationSerializer} body
+ */
+declare class CompanyProfilePlatformValidator {
+    /** @returns {CbsOnboardGetParam} */
     static cbsOnboardGet(): any;
-    static createBrand(): any;
-    static createCompanyBrandMapping(): any;
-    static createLocation(): any;
-    static createLocationBulk(): any;
-    static editBrand(): any;
-    static getBrand(): any;
-    static getBrands(): any;
+    /** @returns {CreateBrandParam} */
+    static createBrand(): CreateBrandParam;
+    /** @returns {CreateCompanyBrandMappingParam} */
+    static createCompanyBrandMapping(): CreateCompanyBrandMappingParam;
+    /** @returns {CreateLocationParam} */
+    static createLocation(): CreateLocationParam;
+    /** @returns {CreateLocationBulkParam} */
+    static createLocationBulk(): CreateLocationBulkParam;
+    /** @returns {EditBrandParam} */
+    static editBrand(): EditBrandParam;
+    /** @returns {GetBrandParam} */
+    static getBrand(): GetBrandParam;
+    /** @returns {GetBrandsParam} */
+    static getBrands(): GetBrandsParam;
+    /** @returns {GetCompanyMetricsParam} */
     static getCompanyMetrics(): any;
-    static getLocationDetail(): any;
-    static getLocations(): any;
-    static updateCompany(): any;
-    static updateLocation(): any;
+    /** @returns {GetLocationDetailParam} */
+    static getLocationDetail(): GetLocationDetailParam;
+    /** @returns {GetLocationsParam} */
+    static getLocations(): GetLocationsParam;
+    /** @returns {UpdateCompanyParam} */
+    static updateCompany(): UpdateCompanyParam;
+    /** @returns {UpdateLocationParam} */
+    static updateLocation(): UpdateLocationParam;
 }
+declare namespace CompanyProfilePlatformValidator {
+    export { CbsOnboardGetParam, CreateBrandParam, CreateCompanyBrandMappingParam, CreateLocationParam, CreateLocationBulkParam, EditBrandParam, GetBrandParam, GetBrandsParam, GetCompanyMetricsParam, GetLocationDetailParam, GetLocationsParam, UpdateCompanyParam, UpdateLocationParam };
+}
+type CreateBrandParam = {
+    body: CompanyProfilePlatformModel.CreateUpdateBrandRequestSerializer;
+};
+type CreateCompanyBrandMappingParam = {
+    body: CompanyProfilePlatformModel.CompanyBrandPostRequestSerializer;
+};
+type CreateLocationParam = {
+    body: CompanyProfilePlatformModel.LocationSerializer;
+};
+type CreateLocationBulkParam = {
+    body: CompanyProfilePlatformModel.BulkLocationSerializer;
+};
+type EditBrandParam = {
+    /**
+     * - Id of the brand to be viewed.
+     */
+    brandId: string;
+    body: CompanyProfilePlatformModel.CreateUpdateBrandRequestSerializer;
+};
+type GetBrandParam = {
+    /**
+     * - Id of the brand to be viewed.
+     */
+    brandId: string;
+};
+type GetBrandsParam = {
+    /**
+     * - The page number to navigate through the given
+     * set of results
+     */
+    pageNo?: number;
+    /**
+     * - Number of items to retrieve in each page.
+     * Default is 10.
+     */
+    pageSize?: number;
+    /**
+     * - Search term for name.
+     */
+    q?: string;
+};
+type GetLocationDetailParam = {
+    /**
+     * - Id of the location which you want to view.
+     */
+    locationId: string;
+};
+type GetLocationsParam = {
+    /**
+     * - Helps to sort the location list on the basis
+     * of location type.
+     */
+    storeType?: string;
+    /**
+     * - Query that is to be searched.
+     */
+    q?: string;
+    /**
+     * - To filter companies on basis of verified or
+     * unverified companies.
+     */
+    stage?: string;
+    /**
+     * - The page number to navigate through the given
+     * set of results
+     */
+    pageNo?: number;
+    /**
+     * - Number of items to retrieve in each page.
+     * Default is 10.
+     */
+    pageSize?: number;
+    /**
+     * - Helps to filter stores on the basis of uids.
+     */
+    locationIds?: number[];
+};
+type UpdateCompanyParam = {
+    body: CompanyProfilePlatformModel.UpdateCompany;
+};
+type UpdateLocationParam = {
+    /**
+     * - Id of the location which you want to edit.
+     */
+    locationId: string;
+    body: CompanyProfilePlatformModel.LocationSerializer;
+};
+type CbsOnboardGetParam = any;
+type GetCompanyMetricsParam = any;
+import CompanyProfilePlatformModel = require("./CompanyProfilePlatformModel");

package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js

@@ -1,48 +1,131 @@
 const Joi = require("joi");
 
-const CompanyProfileModel = require("./CompanyProfilePlatformModel");
-class CompanyProfileValidator {
+const CompanyProfilePlatformModel = require("./CompanyProfilePlatformModel");
+
+/** @typedef CbsOnboardGetParam */
+
+/**
+ * @typedef CreateBrandParam
+ * @property {CompanyProfilePlatformModel.CreateUpdateBrandRequestSerializer} body
+ */
+
+/**
+ * @typedef CreateCompanyBrandMappingParam
+ * @property {CompanyProfilePlatformModel.CompanyBrandPostRequestSerializer} body
+ */
+
+/**
+ * @typedef CreateLocationParam
+ * @property {CompanyProfilePlatformModel.LocationSerializer} body
+ */
+
+/**
+ * @typedef CreateLocationBulkParam
+ * @property {CompanyProfilePlatformModel.BulkLocationSerializer} body
+ */
+
+/**
+ * @typedef EditBrandParam
+ * @property {string} brandId - Id of the brand to be viewed.
+ * @property {CompanyProfilePlatformModel.CreateUpdateBrandRequestSerializer} body
+ */
+
+/**
+ * @typedef GetBrandParam
+ * @property {string} brandId - Id of the brand to be viewed.
+ */
+
+/**
+ * @typedef GetBrandsParam
+ * @property {number} [pageNo] - The page number to navigate through the given
+ *   set of results
+ * @property {number} [pageSize] - Number of items to retrieve in each page.
+ *   Default is 10.
+ * @property {string} [q] - Search term for name.
+ */
+
+/** @typedef GetCompanyMetricsParam */
+
+/**
+ * @typedef GetLocationDetailParam
+ * @property {string} locationId - Id of the location which you want to view.
+ */
+
+/**
+ * @typedef GetLocationsParam
+ * @property {string} [storeType] - Helps to sort the location list on the basis
+ *   of location type.
+ * @property {string} [q] - Query that is to be searched.
+ * @property {string} [stage] - To filter companies on basis of verified or
+ *   unverified companies.
+ * @property {number} [pageNo] - The page number to navigate through the given
+ *   set of results
+ * @property {number} [pageSize] - Number of items to retrieve in each page.
+ *   Default is 10.
+ * @property {number[]} [locationIds] - Helps to filter stores on the basis of uids.
+ */
+
+/**
+ * @typedef UpdateCompanyParam
+ * @property {CompanyProfilePlatformModel.UpdateCompany} body
+ */
+
+/**
+ * @typedef UpdateLocationParam
+ * @property {string} locationId - Id of the location which you want to edit.
+ * @property {CompanyProfilePlatformModel.LocationSerializer} body
+ */
+
+class CompanyProfilePlatformValidator {
+  /** @returns {CbsOnboardGetParam} */
   static cbsOnboardGet() {
     return Joi.object({}).required();
   }
 
+  /** @returns {CreateBrandParam} */
   static createBrand() {
     return Joi.object({
-      body: CompanyProfileModel.CreateUpdateBrandRequestSerializer().required(),
+      body: CompanyProfilePlatformModel.CreateUpdateBrandRequestSerializer().required(),
     }).required();
   }
 
+  /** @returns {CreateCompanyBrandMappingParam} */
   static createCompanyBrandMapping() {
     return Joi.object({
-      body: CompanyProfileModel.CompanyBrandPostRequestSerializer().required(),
+      body: CompanyProfilePlatformModel.CompanyBrandPostRequestSerializer().required(),
     }).required();
   }
 
+  /** @returns {CreateLocationParam} */
   static createLocation() {
     return Joi.object({
-      body: CompanyProfileModel.LocationSerializer().required(),
+      body: CompanyProfilePlatformModel.LocationSerializer().required(),
     }).required();
   }
 
+  /** @returns {CreateLocationBulkParam} */
   static createLocationBulk() {
     return Joi.object({
-      body: CompanyProfileModel.BulkLocationSerializer().required(),
+      body: CompanyProfilePlatformModel.BulkLocationSerializer().required(),
     }).required();
   }
 
+  /** @returns {EditBrandParam} */
   static editBrand() {
     return Joi.object({
       brandId: Joi.string().allow("").required(),
-      body: CompanyProfileModel.CreateUpdateBrandRequestSerializer().required(),
+      body: CompanyProfilePlatformModel.CreateUpdateBrandRequestSerializer().required(),
     }).required();
   }
 
+  /** @returns {GetBrandParam} */
   static getBrand() {
     return Joi.object({
       brandId: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetBrandsParam} */
   static getBrands() {
     return Joi.object({
       pageNo: Joi.number(),
@@ -51,16 +134,19 @@ class CompanyProfileValidator {
     }).required();
   }
 
+  /** @returns {GetCompanyMetricsParam} */
   static getCompanyMetrics() {
     return Joi.object({}).required();
   }
 
+  /** @returns {GetLocationDetailParam} */
   static getLocationDetail() {
     return Joi.object({
       locationId: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetLocationsParam} */
   static getLocations() {
     return Joi.object({
       storeType: Joi.string().allow(""),
@@ -72,18 +158,20 @@ class CompanyProfileValidator {
     }).required();
   }
 
+  /** @returns {UpdateCompanyParam} */
   static updateCompany() {
     return Joi.object({
-      body: CompanyProfileModel.UpdateCompany().required(),
+      body: CompanyProfilePlatformModel.UpdateCompany().required(),
     }).required();
   }
 
+  /** @returns {UpdateLocationParam} */
   static updateLocation() {
     return Joi.object({
       locationId: Joi.string().allow("").required(),
-      body: CompanyProfileModel.LocationSerializer().required(),
+      body: CompanyProfilePlatformModel.LocationSerializer().required(),
     }).required();
   }
 }
 
-module.exports = CompanyProfileValidator;
+module.exports = CompanyProfilePlatformValidator;