@gofynd/fdk-client-javascript 1.3.11-beta.6 → 1.3.11-beta.8

package/sdk/application/Content/ContentApplicationModel.js

@@ -154,6 +154,38 @@ const Joi = require("joi");
  * @property {string} [start]
  */
 
+/**
+ * @typedef CustomFieldSchema
+ * @property {string} [_id]
+ * @property {string} [application_id]
+ * @property {string} [company_id]
+ * @property {string} [created_at]
+ * @property {string} [created_by]
+ * @property {string} [creator]
+ * @property {string} [definition_id]
+ * @property {boolean} [has_invalid_values]
+ * @property {Object[]} [invalid_value_errors]
+ * @property {boolean} [is_deleted]
+ * @property {string} [key]
+ * @property {boolean} [multi_value]
+ * @property {string} [namespace]
+ * @property {string} [resource]
+ * @property {string} [resource_id]
+ * @property {string} [type]
+ * @property {string} [updated_at]
+ * @property {CustomFieldValue[]} [value]
+ */
+
+/**
+ * @typedef CustomFieldsResponseByResourceIdSchema
+ * @property {CustomFieldSchema[]} [items]
+ */
+
+/**
+ * @typedef CustomFieldValue
+ * @property {Object} [value]
+ */
+
 /**
  * @typedef CustomMetaTag
  * @property {string} [_id]
@@ -161,6 +193,37 @@ const Joi = require("joi");
  * @property {string} [name]
  */
 
+/**
+ * @typedef CustomObjectByIdSchema
+ * @property {string} [_id]
+ * @property {CustomObjectListItemDefinationSchema} [definition]
+ * @property {string} [display_name]
+ * @property {CustomObjectFieldSchema[]} [fields]
+ * @property {Object[]} [references]
+ * @property {string} [status]
+ */
+
+/**
+ * @typedef CustomObjectFieldSchema
+ * @property {string} [_id]
+ * @property {string} [definition_id]
+ * @property {string} [key]
+ * @property {string} [type]
+ * @property {CustomObjectFieldValue[]} [value]
+ */
+
+/**
+ * @typedef CustomObjectFieldValue
+ * @property {Object} [value]
+ */
+
+/**
+ * @typedef CustomObjectListItemDefinationSchema
+ * @property {string} [_id]
+ * @property {string} [name]
+ * @property {string} [type]
+ */
+
 /**
  * @typedef DataLoaderSchema
  * @property {DataLoaderSourceSchema} [__source]
@@ -404,11 +467,21 @@ const Joi = require("joi");
 
 /**
  * @typedef SEO
+ * @property {SEObreadcrumb[]} [breadcrumb]
+ * @property {string} [canonical_url]
  * @property {string} [description]
  * @property {SEOImage} [image]
+ * @property {SEOMetaItem[]} [meta_tags]
+ * @property {SEOSitemap} [sitemap]
  * @property {string} [title]
  */
 
+/**
+ * @typedef SEObreadcrumb
+ * @property {Action} [action]
+ * @property {string} [url]
+ */
+
 /**
  * @typedef SeoComponent
  * @property {SeoSchema} [seo]
@@ -419,9 +492,22 @@ const Joi = require("joi");
  * @property {string} [url]
  */
 
+/**
+ * @typedef SEOMetaItem
+ * @property {SEOMetaItems[]} [items]
+ * @property {string} [title]
+ */
+
+/**
+ * @typedef SEOMetaItems
+ * @property {string} [key]
+ * @property {string} [value]
+ */
+
 /**
  * @typedef SeoSchema
  * @property {string} [_id]
+ * @property {string} [additonal_sitemap]
  * @property {string} [app]
  * @property {boolean} [cannonical_enabled]
  * @property {string} [created_at]
@@ -432,6 +518,30 @@ const Joi = require("joi");
  * @property {string} [updated_at]
  */
 
+/**
+ * @typedef SeoSchemaComponent
+ * @property {SEOSchemaMarkupTemplate[]} [items]
+ */
+
+/**
+ * @typedef SEOSchemaMarkupTemplate
+ * @property {boolean} [active]
+ * @property {string} [application]
+ * @property {string} [created_at]
+ * @property {string} [description]
+ * @property {string} [id]
+ * @property {string} [page_type]
+ * @property {string} [schema]
+ * @property {string} [title]
+ * @property {string} [updated_at]
+ */
+
+/**
+ * @typedef SEOSitemap
+ * @property {string} [frequency]
+ * @property {number} [priority]
+ */
+
 /**
  * @typedef SlideshowGetResponse
  * @property {SlideshowSchema[]} [items]
@@ -747,6 +857,44 @@ class ContentApplicationModel {
     });
   }
 
+  /** @returns {CustomFieldSchema} */
+  static CustomFieldSchema() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+      application_id: Joi.string().allow(""),
+      company_id: Joi.string().allow(""),
+      created_at: Joi.string().allow(""),
+      created_by: Joi.string().allow(""),
+      creator: Joi.string().allow(""),
+      definition_id: Joi.string().allow(""),
+      has_invalid_values: Joi.boolean(),
+      invalid_value_errors: Joi.array().items(Joi.any()),
+      is_deleted: Joi.boolean(),
+      key: Joi.string().allow(""),
+      multi_value: Joi.boolean(),
+      namespace: Joi.string().allow(""),
+      resource: Joi.string().allow(""),
+      resource_id: Joi.string().allow(""),
+      type: Joi.string().allow(""),
+      updated_at: Joi.string().allow(""),
+      value: Joi.array().items(ContentApplicationModel.CustomFieldValue()),
+    });
+  }
+
+  /** @returns {CustomFieldsResponseByResourceIdSchema} */
+  static CustomFieldsResponseByResourceIdSchema() {
+    return Joi.object({
+      items: Joi.array().items(ContentApplicationModel.CustomFieldSchema()),
+    });
+  }
+
+  /** @returns {CustomFieldValue} */
+  static CustomFieldValue() {
+    return Joi.object({
+      value: Joi.any(),
+    });
+  }
+
   /** @returns {CustomMetaTag} */
   static CustomMetaTag() {
     return Joi.object({
@@ -756,6 +904,49 @@ class ContentApplicationModel {
     });
   }
 
+  /** @returns {CustomObjectByIdSchema} */
+  static CustomObjectByIdSchema() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+      definition: ContentApplicationModel.CustomObjectListItemDefinationSchema(),
+      display_name: Joi.string().allow(""),
+      fields: Joi.array().items(
+        ContentApplicationModel.CustomObjectFieldSchema()
+      ),
+      references: Joi.array().items(Joi.any()),
+      status: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {CustomObjectFieldSchema} */
+  static CustomObjectFieldSchema() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+      definition_id: Joi.string().allow(""),
+      key: Joi.string().allow(""),
+      type: Joi.string().allow(""),
+      value: Joi.array().items(
+        ContentApplicationModel.CustomObjectFieldValue()
+      ),
+    });
+  }
+
+  /** @returns {CustomObjectFieldValue} */
+  static CustomObjectFieldValue() {
+    return Joi.object({
+      value: Joi.any(),
+    });
+  }
+
+  /** @returns {CustomObjectListItemDefinationSchema} */
+  static CustomObjectListItemDefinationSchema() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+      name: Joi.string().allow(""),
+      type: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {DataLoaderSchema} */
   static DataLoaderSchema() {
     return Joi.object({
@@ -1059,12 +1250,24 @@ class ContentApplicationModel {
   /** @returns {SEO} */
   static SEO() {
     return Joi.object({
+      breadcrumb: Joi.array().items(ContentApplicationModel.SEObreadcrumb()),
+      canonical_url: Joi.string().allow(""),
       description: Joi.string().allow(""),
       image: ContentApplicationModel.SEOImage(),
+      meta_tags: Joi.array().items(ContentApplicationModel.SEOMetaItem()),
+      sitemap: ContentApplicationModel.SEOSitemap(),
       title: Joi.string().allow(""),
     });
   }
 
+  /** @returns {SEObreadcrumb} */
+  static SEObreadcrumb() {
+    return Joi.object({
+      action: ContentApplicationModel.Action(),
+      url: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {SeoComponent} */
   static SeoComponent() {
     return Joi.object({
@@ -1079,10 +1282,27 @@ class ContentApplicationModel {
     });
   }
 
+  /** @returns {SEOMetaItem} */
+  static SEOMetaItem() {
+    return Joi.object({
+      items: Joi.array().items(ContentApplicationModel.SEOMetaItems()),
+      title: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {SEOMetaItems} */
+  static SEOMetaItems() {
+    return Joi.object({
+      key: Joi.string().allow(""),
+      value: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {SeoSchema} */
   static SeoSchema() {
     return Joi.object({
       _id: Joi.string().allow(""),
+      additonal_sitemap: Joi.string().allow(""),
       app: Joi.string().allow(""),
       cannonical_enabled: Joi.boolean(),
       created_at: Joi.string().allow(""),
@@ -1096,6 +1316,38 @@ class ContentApplicationModel {
     });
   }
 
+  /** @returns {SeoSchemaComponent} */
+  static SeoSchemaComponent() {
+    return Joi.object({
+      items: Joi.array().items(
+        ContentApplicationModel.SEOSchemaMarkupTemplate()
+      ),
+    });
+  }
+
+  /** @returns {SEOSchemaMarkupTemplate} */
+  static SEOSchemaMarkupTemplate() {
+    return Joi.object({
+      active: Joi.boolean(),
+      application: Joi.string().allow(""),
+      created_at: Joi.string().allow(""),
+      description: Joi.string().allow(""),
+      id: Joi.string().allow(""),
+      page_type: Joi.string().allow(""),
+      schema: Joi.string().allow(""),
+      title: Joi.string().allow(""),
+      updated_at: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {SEOSitemap} */
+  static SEOSitemap() {
+    return Joi.object({
+      frequency: Joi.string().allow(""),
+      priority: Joi.number(),
+    });
+  }
+
   /** @returns {SlideshowGetResponse} */
   static SlideshowGetResponse() {
     return Joi.object({

package/sdk/application/Content/ContentApplicationValidator.d.ts

@@ -13,6 +13,15 @@ export = ContentApplicationValidator;
  *   set of results. Default value is 1.
  * @property {number} [pageSize] - The number of items to retrieve in each page.
  */
+/**
+ * @typedef GetCustomFieldsParam
+ * @property {string} resource
+ * @property {string} resourceId
+ */
+/**
+ * @typedef GetCustomObjectParam
+ * @property {string} metaobjectId
+ */
 /** @typedef GetDataLoadersParam */
 /**
  * @typedef GetFaqBySlugParam
@@ -56,6 +65,12 @@ export = ContentApplicationValidator;
  * @property {number} [pageSize] - The number of items to retrieve in each page.
  */
 /** @typedef GetSEOConfigurationParam */
+/**
+ * @typedef GetSEOMarkupSchemasParam
+ * @property {string} [pageType] - The type of page against which schema
+ *   template was created
+ * @property {boolean} [active] - Boolean value for fetching seo schema.
+ */
 /**
  * @typedef GetSlideshowParam
  * @property {string} slug - A short, human-readable, URL-friendly identifier of
@@ -77,6 +92,10 @@ declare class ContentApplicationValidator {
     static getBlog(): GetBlogParam;
     /** @returns {GetBlogsParam} */
     static getBlogs(): GetBlogsParam;
+    /** @returns {GetCustomFieldsParam} */
+    static getCustomFields(): GetCustomFieldsParam;
+    /** @returns {GetCustomObjectParam} */
+    static getCustomObject(): GetCustomObjectParam;
     /** @returns {GetDataLoadersParam} */
     static getDataLoaders(): any;
     /** @returns {GetFaqBySlugParam} */
@@ -101,6 +120,8 @@ declare class ContentApplicationValidator {
     static getPages(): GetPagesParam;
     /** @returns {GetSEOConfigurationParam} */
     static getSEOConfiguration(): any;
+    /** @returns {GetSEOMarkupSchemasParam} */
+    static getSEOMarkupSchemas(): GetSEOMarkupSchemasParam;
     /** @returns {GetSlideshowParam} */
     static getSlideshow(): GetSlideshowParam;
     /** @returns {GetSlideshowsParam} */
@@ -111,7 +132,7 @@ declare class ContentApplicationValidator {
     static getTags(): any;
 }
 declare namespace ContentApplicationValidator {
-    export { GetAnnouncementsParam, GetBlogParam, GetBlogsParam, GetDataLoadersParam, GetFaqBySlugParam, GetFaqCategoriesParam, GetFaqCategoryBySlugParam, GetFaqsParam, GetFaqsByCategorySlugParam, GetLandingPageParam, GetLegalInformationParam, GetNavigationsParam, GetPageParam, GetPagesParam, GetSEOConfigurationParam, GetSlideshowParam, GetSlideshowsParam, GetSupportInformationParam, GetTagsParam };
+    export { GetAnnouncementsParam, GetBlogParam, GetBlogsParam, GetCustomFieldsParam, GetCustomObjectParam, GetDataLoadersParam, GetFaqBySlugParam, GetFaqCategoriesParam, GetFaqCategoryBySlugParam, GetFaqsParam, GetFaqsByCategorySlugParam, GetLandingPageParam, GetLegalInformationParam, GetNavigationsParam, GetPageParam, GetPagesParam, GetSEOConfigurationParam, GetSEOMarkupSchemasParam, GetSlideshowParam, GetSlideshowsParam, GetSupportInformationParam, GetTagsParam };
 }
 type GetBlogParam = {
     /**
@@ -136,6 +157,13 @@ type GetBlogsParam = {
      */
     pageSize?: number;
 };
+type GetCustomFieldsParam = {
+    resource: string;
+    resourceId: string;
+};
+type GetCustomObjectParam = {
+    metaobjectId: string;
+};
 type GetFaqBySlugParam = {
     /**
      * - A short, human-readable, URL-friendly identifier of
@@ -194,6 +222,17 @@ type GetPagesParam = {
      */
     pageSize?: number;
 };
+type GetSEOMarkupSchemasParam = {
+    /**
+     * - The type of page against which schema
+     * template was created
+     */
+    pageType?: string;
+    /**
+     * - Boolean value for fetching seo schema.
+     */
+    active?: boolean;
+};
 type GetSlideshowParam = {
     /**
      * - A short, human-readable, URL-friendly identifier of

package/sdk/application/Content/ContentApplicationValidator.js

@@ -19,6 +19,17 @@ const ContentApplicationModel = require("./ContentApplicationModel");
  * @property {number} [pageSize] - The number of items to retrieve in each page.
  */
 
+/**
+ * @typedef GetCustomFieldsParam
+ * @property {string} resource
+ * @property {string} resourceId
+ */
+
+/**
+ * @typedef GetCustomObjectParam
+ * @property {string} metaobjectId
+ */
+
 /** @typedef GetDataLoadersParam */
 
 /**
@@ -74,6 +85,13 @@ const ContentApplicationModel = require("./ContentApplicationModel");
 
 /** @typedef GetSEOConfigurationParam */
 
+/**
+ * @typedef GetSEOMarkupSchemasParam
+ * @property {string} [pageType] - The type of page against which schema
+ *   template was created
+ * @property {boolean} [active] - Boolean value for fetching seo schema.
+ */
+
 /**
  * @typedef GetSlideshowParam
  * @property {string} slug - A short, human-readable, URL-friendly identifier of
@@ -114,6 +132,21 @@ class ContentApplicationValidator {
     });
   }
 
+  /** @returns {GetCustomFieldsParam} */
+  static getCustomFields() {
+    return Joi.object({
+      resource: Joi.string().allow("").required(),
+      resourceId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {GetCustomObjectParam} */
+  static getCustomObject() {
+    return Joi.object({
+      metaobjectId: Joi.string().allow("").required(),
+    }).required();
+  }
+
   /** @returns {GetDataLoadersParam} */
   static getDataLoaders() {
     return Joi.object({});
@@ -189,6 +222,14 @@ class ContentApplicationValidator {
     return Joi.object({});
   }
 
+  /** @returns {GetSEOMarkupSchemasParam} */
+  static getSEOMarkupSchemas() {
+    return Joi.object({
+      pageType: Joi.string().allow(""),
+      active: Joi.boolean(),
+    });
+  }
+
   /** @returns {GetSlideshowParam} */
   static getSlideshow() {
     return Joi.object({

package/sdk/application/Logistic/LogisticApplicationClient.d.ts

@@ -4,10 +4,16 @@ declare class Logistic {
     _conf: any;
     _relativeUrls: {
         getAllCountries: string;
+        getCountries: string;
+        getCountry: string;
+        getLocalities: string;
+        getLocality: string;
+        getLocations: string;
         getOptimalLocations: string;
         getPincodeCity: string;
         getPincodeZones: string;
         getTatProduct: string;
+        validateAddress: string;
     };
     _urls: {};
     updateUrls(urls: any): void;
@@ -21,6 +27,56 @@ declare class Logistic {
      * @description: Get all countries - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getAllCountries/).
      */
     getAllCountries({ requestHeaders }?: any, { responseHeaders }?: object): Promise<LogisticApplicationModel.CountryListResponse>;
+    /**
+     * @param {LogisticApplicationValidator.GetCountriesParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<LogisticApplicationModel.GetCountries>} - Success response
+     * @name getCountries
+     * @summary: Get all countries and associated data.
+     * @description: Retrieve of all countries. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getCountries/).
+     */
+    getCountries({ onboarding, pageNo, pageSize, q, requestHeaders }?: LogisticApplicationValidator.GetCountriesParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.GetCountries>;
+    /**
+     * @param {LogisticApplicationValidator.GetCountryParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<LogisticApplicationModel.GetCountry>} - Success response
+     * @name getCountry
+     * @summary: Get single country and associated data.
+     * @description: Retrieve data for a single country and address format. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getCountry/).
+     */
+    getCountry({ countryIsoCode, requestHeaders }?: LogisticApplicationValidator.GetCountryParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.GetCountry>;
+    /**
+     * @param {LogisticApplicationValidator.GetLocalitiesParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<LogisticApplicationModel.GetLocalities>} - Success response
+     * @name getLocalities
+     * @summary: Get Localities.
+     * @description: Get Localities data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getLocalities/).
+     */
+    getLocalities({ localityType, country, state, city, pageNo, pageSize, q, requestHeaders, }?: LogisticApplicationValidator.GetLocalitiesParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.GetLocalities>;
+    /**
+     * @param {LogisticApplicationValidator.GetLocalityParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<LogisticApplicationModel.GetLocality>} - Success response
+     * @name getLocality
+     * @summary: Get Locality API
+     * @description: Get Locality data - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getLocality/).
+     */
+    getLocality({ localityType, localityValue, country, state, city, requestHeaders }?: LogisticApplicationValidator.GetLocalityParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.GetLocality>;
+    /**
+     * @param {LogisticApplicationValidator.GetLocationsParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<LogisticApplicationModel.GetStoreResponse>} - Success response
+     * @name getLocations
+     * @summary: GET locations from the Pincode.
+     * @description: This API returns store from the Pincode View. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getLocations/).
+     */
+    getLocations({ xApplicationId, xApplicationData, country, state, city, pincode, sector, pageNo, pageSize, requestHeaders, }?: LogisticApplicationValidator.GetLocationsParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.GetStoreResponse>;
     /**
      * @param {LogisticApplicationValidator.GetOptimalLocationsParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -64,6 +120,17 @@ declare class Logistic {
      * @description: Get TAT data - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getTatProduct/).
      */
     getTatProduct({ body, requestHeaders }?: LogisticApplicationValidator.GetTatProductParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.TATViewResponse>;
+    /**
+     * @param {LogisticApplicationValidator.ValidateAddressParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<LogisticApplicationModel.ValidateAddressRequest>} -
+     *   Success response
+     * @name validateAddress
+     * @summary: Validate given address wrt template
+     * @description: Validate given address wrt template - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/validateAddress/).
+     */
+    validateAddress({ countryIsoCode, templateName, body, requestHeaders }?: LogisticApplicationValidator.ValidateAddressParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.ValidateAddressRequest>;
 }
 import LogisticApplicationModel = require("./LogisticApplicationModel");
 import LogisticApplicationValidator = require("./LogisticApplicationValidator");