@gofynd/fdk-client-javascript 1.4.15-beta.1 → 1.4.15-beta.11

package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js

@@ -155,11 +155,25 @@ const Joi = require("joi");
  * @property {string[]} tags
  */
 
+/**
+ * @typedef ZoneMappingDetailType
+ * @property {string} country - Uid for the country.
+ * @property {ZoneMappingRegions[]} [regions] - List of regions with its details.
+ */
+
 /**
  * @typedef ZoneMappingType
  * @property {string} country
- * @property {string[]} [pincode]
- * @property {string[]} [state]
+ * @property {string[]} regions
+ */
+
+/**
+ * @typedef ZoneMappingRegions
+ * @property {string} [display_name] - Name of the region that is in proper casing.
+ * @property {string[]} [parent_id]
+ * @property {string} [parent_uid] - Unique identifier for that regions parent.
+ * @property {string} [sub_type] - What type does the region belong to.
+ * @property {string} [uid] - Unique identifier for that region.
  */
 
 /**
@@ -174,7 +188,6 @@ const Joi = require("joi");
  * @property {number[]} store_ids
  * @property {string} region_type
  * @property {ZoneMappingType[]} mapping
- * @property {string} [assignment_preference]
  */
 
 /**
@@ -201,7 +214,6 @@ const Joi = require("joi");
  * @property {number[]} store_ids
  * @property {string} [region_type]
  * @property {ZoneMappingType[]} mapping
- * @property {string} [assignment_preference]
  * @property {number} stores_count
  */
 
@@ -221,9 +233,7 @@ const Joi = require("joi");
  * @property {ZoneProductTypes} product
  * @property {number[]} store_ids
  * @property {string} region_type
- * @property {ZoneMappingType[]} mapping
- * @property {string} [assignment_preference]
- * @property {number} stores_count
+ * @property {ZoneMappingDetailType[]} mapping - Country to region mapping for the zone.
  */
 
 /**
@@ -234,9 +244,9 @@ const Joi = require("joi");
  * @property {boolean} is_active
  * @property {GetZoneDataViewChannels[]} channels
  * @property {number[]} store_ids
+ * @property {ZoneProductTypes} product
  * @property {string} region_type
  * @property {ZoneMappingType[]} mapping
- * @property {string} [assignment_preference]
  */
 
 /**
@@ -261,7 +271,6 @@ const Joi = require("joi");
  * @property {string} slug
  * @property {boolean} is_active
  * @property {number[]} store_ids
- * @property {string} assignment_preference
  */
 
 /**
@@ -1365,12 +1374,32 @@ class ServiceabilityPlatformModel {
     });
   }
 
+  /** @returns {ZoneMappingDetailType} */
+  static ZoneMappingDetailType() {
+    return Joi.object({
+      country: Joi.string().allow("").required(),
+      regions: Joi.array().items(
+        ServiceabilityPlatformModel.ZoneMappingRegions()
+      ),
+    });
+  }
+
   /** @returns {ZoneMappingType} */
   static ZoneMappingType() {
     return Joi.object({
       country: Joi.string().allow("").required(),
-      pincode: Joi.array().items(Joi.string().allow("")),
-      state: Joi.array().items(Joi.string().allow("")),
+      regions: Joi.array().items(Joi.string().allow("")).required(),
+    });
+  }
+
+  /** @returns {ZoneMappingRegions} */
+  static ZoneMappingRegions() {
+    return Joi.object({
+      display_name: Joi.string().allow(""),
+      parent_id: Joi.array().items(Joi.string().allow("")),
+      parent_uid: Joi.string().allow(""),
+      sub_type: Joi.string().allow(""),
+      uid: Joi.string().allow(""),
     });
   }
 
@@ -1391,7 +1420,6 @@ class ServiceabilityPlatformModel {
       mapping: Joi.array()
         .items(ServiceabilityPlatformModel.ZoneMappingType())
         .required(),
-      assignment_preference: Joi.string().allow(""),
     });
   }
 
@@ -1428,7 +1456,6 @@ class ServiceabilityPlatformModel {
       mapping: Joi.array()
         .items(ServiceabilityPlatformModel.ZoneMappingType())
         .required(),
-      assignment_preference: Joi.string().allow(""),
       stores_count: Joi.number().required(),
     });
   }
@@ -1455,10 +1482,8 @@ class ServiceabilityPlatformModel {
       store_ids: Joi.array().items(Joi.number()).required(),
       region_type: Joi.string().allow("").required(),
       mapping: Joi.array()
-        .items(ServiceabilityPlatformModel.ZoneMappingType())
+        .items(ServiceabilityPlatformModel.ZoneMappingDetailType())
         .required(),
-      assignment_preference: Joi.string().allow(""),
-      stores_count: Joi.number().required(),
     });
   }
 
@@ -1473,11 +1498,11 @@ class ServiceabilityPlatformModel {
         .items(ServiceabilityPlatformModel.GetZoneDataViewChannels())
         .required(),
       store_ids: Joi.array().items(Joi.number()).required(),
+      product: ServiceabilityPlatformModel.ZoneProductTypes().required(),
       region_type: Joi.string().allow("").required(),
       mapping: Joi.array()
         .items(ServiceabilityPlatformModel.ZoneMappingType())
         .required(),
-      assignment_preference: Joi.string().allow(""),
     });
   }
 
@@ -1508,7 +1533,6 @@ class ServiceabilityPlatformModel {
       slug: Joi.string().allow("").required(),
       is_active: Joi.boolean().required(),
       store_ids: Joi.array().items(Joi.number()).required(),
-      assignment_preference: Joi.string().allow("").required(),
     });
   }
 

package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts

@@ -112,7 +112,7 @@ export = ServiceabilityPlatformValidator;
  * @property {number} [pageNo] - Index of the item to start returning with
  * @property {number} [pageSize] - Determines the items to be displayed in a page
  * @property {boolean} [isActive] - Status of Zone (either active or inactive)
- * @property {string} [channelId] - Zones filtered by an application
+ * @property {string} [applicationIds] - Zones filtered by applications
  * @property {string} [q] - Search with name as a free text
  * @property {string} [countryIsoCode] - ISO2 code of the country
  * @property {string} [state] - State name
@@ -451,9 +451,9 @@ type GetZonesParam = {
      */
     isActive?: boolean;
     /**
-     * - Zones filtered by an application
+     * - Zones filtered by applications
      */
-    channelId?: string;
+    applicationIds?: string;
     /**
      * - Search with name as a free text
      */

package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js

@@ -134,7 +134,7 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
  * @property {number} [pageNo] - Index of the item to start returning with
  * @property {number} [pageSize] - Determines the items to be displayed in a page
  * @property {boolean} [isActive] - Status of Zone (either active or inactive)
- * @property {string} [channelId] - Zones filtered by an application
+ * @property {string} [applicationIds] - Zones filtered by applications
  * @property {string} [q] - Search with name as a free text
  * @property {string} [countryIsoCode] - ISO2 code of the country
  * @property {string} [state] - State name
@@ -354,7 +354,7 @@ class ServiceabilityPlatformValidator {
       pageNo: Joi.number(),
       pageSize: Joi.number(),
       isActive: Joi.boolean(),
-      channelId: Joi.string().allow(""),
+      applicationIds: Joi.string().allow(""),
       q: Joi.string().allow(""),
       countryIsoCode: Joi.string().allow(""),
       state: Joi.string().allow(""),

package/sdk/platform/Theme/ThemePlatformModel.d.ts

@@ -379,16 +379,7 @@ export = ThemePlatformModel;
  */
 /**
  * @typedef GlobalSchema
- * @property {Prop[]} [props]
- */
-/**
- * @typedef Prop
- * @property {string} [type] - The type of the property
- * @property {string} [category] - The category of the property
- * @property {string} [value] - The value of the property
- * @property {string} [id] - The ID of the property
- * @property {string} [label] - The label of the property
- * @property {string} [info] - Additional information about the property
+ * @property {Object[]} [props]
  */
 /**
  * @typedef Assets
@@ -590,7 +581,7 @@ export = ThemePlatformModel;
 declare class ThemePlatformModel {
 }
 declare namespace ThemePlatformModel {
-    export { GetExtensionSectionRes, ExtensionSection, PropExtension, AssetsExtension, ThemeReq, CompanyThemeSchema, MarketplaceThemeId, CompanyThemeMeta, ThemePayment, ThemeImages, AvailablePageSchema, AvailablePageSectionMetaAttributes, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, Action, AvailablePageSeo, AvailablePageSchemaSections, AvailablePagePredicate, AvailablePageScreenPredicate, AvailablePageUserPredicate, AvailablePageRoutePredicate, AvailablePagePlatformPredicate, AvailablePageSchedulePredicate, AllAvailablePageSchema, AddThemeRequestSchema, FontsSchema, BlitzkriegApiErrorSchema, BlitzkriegInternalServerErrorSchema, FontsSchemaItems, FontsSchemaItemsFiles, ThemesSchema, ThemeUpgradableResponse, UpdateThemeNameRequestBody, UpdateThemeRequestBody, Font, FontVariants, FontVariant, Config, ThemeConfiguration, OverlayPopup, DividerStrokeHighlight, UserAlerts, OrderTracking, ThemeConfigListPage, ThemeConfigListPageSettingsProps, CustomConfig, ThemeMeta, Release, Images, CustomProps, GlobalSchema, Prop, Assets, UMDJs, CommonJS, CSS, SectionItem, Preset, Page, Section, Block, Predicate, Screen, ThemeUserSchema, Route, SectionProps, SectionPreset, BlockProps, TextProp, CheckboxProp, RangeProp, ImagePickerProp, UrlProp, ThemeVersions, DummyResponse, AppliedThemes, CompanyPrivateTheme, ActionPage, PageType };
+    export { GetExtensionSectionRes, ExtensionSection, PropExtension, AssetsExtension, ThemeReq, CompanyThemeSchema, MarketplaceThemeId, CompanyThemeMeta, ThemePayment, ThemeImages, AvailablePageSchema, AvailablePageSectionMetaAttributes, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, Action, AvailablePageSeo, AvailablePageSchemaSections, AvailablePagePredicate, AvailablePageScreenPredicate, AvailablePageUserPredicate, AvailablePageRoutePredicate, AvailablePagePlatformPredicate, AvailablePageSchedulePredicate, AllAvailablePageSchema, AddThemeRequestSchema, FontsSchema, BlitzkriegApiErrorSchema, BlitzkriegInternalServerErrorSchema, FontsSchemaItems, FontsSchemaItemsFiles, ThemesSchema, ThemeUpgradableResponse, UpdateThemeNameRequestBody, UpdateThemeRequestBody, Font, FontVariants, FontVariant, Config, ThemeConfiguration, OverlayPopup, DividerStrokeHighlight, UserAlerts, OrderTracking, ThemeConfigListPage, ThemeConfigListPageSettingsProps, CustomConfig, ThemeMeta, Release, Images, CustomProps, GlobalSchema, Assets, UMDJs, CommonJS, CSS, SectionItem, Preset, Page, Section, Block, Predicate, Screen, ThemeUserSchema, Route, SectionProps, SectionPreset, BlockProps, TextProp, CheckboxProp, RangeProp, ImagePickerProp, UrlProp, ThemeVersions, DummyResponse, AppliedThemes, CompanyPrivateTheme, ActionPage, PageType };
 }
 /** @returns {GetExtensionSectionRes} */
 declare function GetExtensionSectionRes(): GetExtensionSectionRes;
@@ -1286,35 +1277,7 @@ type CustomProps = {
 /** @returns {GlobalSchema} */
 declare function GlobalSchema(): GlobalSchema;
 type GlobalSchema = {
-    props?: Prop[];
-};
-/** @returns {Prop} */
-declare function Prop(): Prop;
-type Prop = {
-    /**
-     * - The type of the property
-     */
-    type?: string;
-    /**
-     * - The category of the property
-     */
-    category?: string;
-    /**
-     * - The value of the property
-     */
-    value?: string;
-    /**
-     * - The ID of the property
-     */
-    id?: string;
-    /**
-     * - The label of the property
-     */
-    label?: string;
-    /**
-     * - Additional information about the property
-     */
-    info?: string;
+    props?: any[];
 };
 /** @returns {Assets} */
 declare function Assets(): Assets;

package/sdk/platform/Theme/ThemePlatformModel.js

@@ -432,17 +432,7 @@ const Joi = require("joi");
 
 /**
  * @typedef GlobalSchema
- * @property {Prop[]} [props]
- */
-
-/**
- * @typedef Prop
- * @property {string} [type] - The type of the property
- * @property {string} [category] - The category of the property
- * @property {string} [value] - The value of the property
- * @property {string} [id] - The ID of the property
- * @property {string} [label] - The label of the property
- * @property {string} [info] - Additional information about the property
+ * @property {Object[]} [props]
  */
 
 /**
@@ -1206,19 +1196,7 @@ class ThemePlatformModel {
   /** @returns {GlobalSchema} */
   static GlobalSchema() {
     return Joi.object({
-      props: Joi.array().items(ThemePlatformModel.Prop()),
-    });
-  }
-
-  /** @returns {Prop} */
-  static Prop() {
-    return Joi.object({
-      type: Joi.string().allow(""),
-      category: Joi.string().allow(""),
-      value: Joi.string().allow(""),
-      id: Joi.string().allow(""),
-      label: Joi.string().allow(""),
-      info: Joi.string().allow(""),
+      props: Joi.array().items(Joi.any()),
     });
   }
 

package/sdk/public/Configuration/ConfigurationPublicClient.js

@@ -1,14 +1,17 @@
-const PublicAPIClient = require("../PublicAPIClient");
 const {
   FDKClientValidationError,
   FDKResponseValidationError,
 } = require("../../common/FDKError");
+
+const PublicAPIClient = require("../PublicAPIClient");
 const constructUrl = require("../constructUrl");
 const Paginator = require("../../common/Paginator");
+const { validateRequiredParams } = require("../../common/Validator");
+
 const ConfigurationPublicValidator = require("./ConfigurationPublicValidator");
 const ConfigurationPublicModel = require("./ConfigurationPublicModel");
-const { Logger } = require("./../../common/Logger");
 const Joi = require("joi");
+const { Logger } = require("./../../common/Logger");
 
 class Configuration {
   constructor(_conf) {

package/sdk/public/Content/ContentPublicClient.d.ts

@@ -16,7 +16,7 @@ declare class Content {
      * @summary: Get credentials to power chat support systems
      * @description: Get credentials for support system - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/content/getCredentialsByEntity/).
      */
-    getCredentialsByEntity({ entity, requestHeaders }?: ContentPublicValidator.GetCredentialsByEntityParam, { responseHeaders }?: object): Promise<ContentPublicModel.CredentialsSchema>;
+    getCredentialsByEntity({ entity, requestHeaders }?: ContentPublicValidator.GetCredentialsByEntityParam, { responseHeaders }?: object, ...args: any[]): Promise<ContentPublicModel.CredentialsSchema>;
 }
 import ContentPublicValidator = require("./ContentPublicValidator");
 import ContentPublicModel = require("./ContentPublicModel");

package/sdk/public/Content/ContentPublicClient.js

@@ -1,14 +1,17 @@
-const PublicAPIClient = require("../PublicAPIClient");
 const {
   FDKClientValidationError,
   FDKResponseValidationError,
 } = require("../../common/FDKError");
+
+const PublicAPIClient = require("../PublicAPIClient");
 const constructUrl = require("../constructUrl");
 const Paginator = require("../../common/Paginator");
+const { validateRequiredParams } = require("../../common/Validator");
+
 const ContentPublicValidator = require("./ContentPublicValidator");
 const ContentPublicModel = require("./ContentPublicModel");
-const { Logger } = require("./../../common/Logger");
 const Joi = require("joi");
+const { Logger } = require("./../../common/Logger");
 
 class Content {
   constructor(_conf) {
@@ -45,6 +48,15 @@ class Content {
     { entity, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
+    const errors = validateRequiredParams(arguments[0], ["entity"]);
+    if (errors.length > 0) {
+      const error = new FDKClientValidationError({
+        message: "Missing required field",
+        details: errors,
+      });
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
     const { error } = ContentPublicValidator.getCredentialsByEntity().validate(
       { entity },
       { abortEarly: false, allowUnknown: true }

package/sdk/public/Partner/PartnerPublicClient.d.ts

@@ -16,7 +16,7 @@ declare class Partner {
      * @summary: Get panel extension details
      * @description: Retrieve detailed information about panel extensions in the public server setup. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/partner/getPanelExtensionDetails/).
      */
-    getPanelExtensionDetails({ slug, requestHeaders }?: PartnerPublicValidator.GetPanelExtensionDetailsParam, { responseHeaders }?: object): Promise<PartnerPublicModel.ExtensionUsingSlug>;
+    getPanelExtensionDetails({ slug, requestHeaders }?: PartnerPublicValidator.GetPanelExtensionDetailsParam, { responseHeaders }?: object, ...args: any[]): Promise<PartnerPublicModel.ExtensionUsingSlug>;
 }
 import PartnerPublicValidator = require("./PartnerPublicValidator");
 import PartnerPublicModel = require("./PartnerPublicModel");

package/sdk/public/Partner/PartnerPublicClient.js

@@ -1,14 +1,17 @@
-const PublicAPIClient = require("../PublicAPIClient");
 const {
   FDKClientValidationError,
   FDKResponseValidationError,
 } = require("../../common/FDKError");
+
+const PublicAPIClient = require("../PublicAPIClient");
 const constructUrl = require("../constructUrl");
 const Paginator = require("../../common/Paginator");
+const { validateRequiredParams } = require("../../common/Validator");
+
 const PartnerPublicValidator = require("./PartnerPublicValidator");
 const PartnerPublicModel = require("./PartnerPublicModel");
-const { Logger } = require("./../../common/Logger");
 const Joi = require("joi");
+const { Logger } = require("./../../common/Logger");
 
 class Partner {
   constructor(_conf) {
@@ -46,6 +49,15 @@ class Partner {
     { slug, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
+    const errors = validateRequiredParams(arguments[0], ["slug"]);
+    if (errors.length > 0) {
+      const error = new FDKClientValidationError({
+        message: "Missing required field",
+        details: errors,
+      });
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
     const {
       error,
     } = PartnerPublicValidator.getPanelExtensionDetails().validate(

package/sdk/public/Webhook/WebhookPublicClient.js

@@ -1,14 +1,17 @@
-const PublicAPIClient = require("../PublicAPIClient");
 const {
   FDKClientValidationError,
   FDKResponseValidationError,
 } = require("../../common/FDKError");
+
+const PublicAPIClient = require("../PublicAPIClient");
 const constructUrl = require("../constructUrl");
 const Paginator = require("../../common/Paginator");
+const { validateRequiredParams } = require("../../common/Validator");
+
 const WebhookPublicValidator = require("./WebhookPublicValidator");
 const WebhookPublicModel = require("./WebhookPublicModel");
-const { Logger } = require("./../../common/Logger");
 const Joi = require("joi");
+const { Logger } = require("./../../common/Logger");
 
 class Webhook {
   constructor(_conf) {