@gofynd/fdk-client-javascript 1.4.14 → 1.4.15-beta.10

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

@@ -1,290 +0,0 @@
-export = ContentApplicationValidator;
-/** @typedef GetAnnouncementsParam */
-/**
- * @typedef GetBlogParam
- * @property {string} slug - A short, human-readable, URL-friendly identifier of
- *   a blog. You can get slug value from the endpoint
- *   /service/application/content/v1.0/blogs/.
- * @property {string} [rootId] - ID given to the HTML element.
- * @property {boolean} [preview] - Boolean value to get the preview for the blogs.
- */
-/**
- * @typedef GetBlogsParam
- * @property {number} [pageNo] - The page number to navigate through the given
- *   set of results. Default value is 1. .
- * @property {number} [pageSize] - The number of items to retrieve in each page.
- * @property {string} [tags] - Blogs retrieve based on the list of tags passed.
- * @property {string} [search] - Blogs retrieve based on the title.
- */
-/**
- * @typedef GetCustomFieldsByResourceIdParam
- * @property {string} resource - This is the name of resource for which you want
- *   to fetch custom fields eg. product, collection, customer etc.
- * @property {string} resourceSlug - This is the resource id for which custom
- *   fields created
- */
-/**
- * @typedef GetCustomObjectBySlugParam
- * @property {string} definitionSlug
- * @property {string} slug
- */
-/** @typedef GetDataLoadersParam */
-/**
- * @typedef GetFaqBySlugParam
- * @property {string} slug - A short, human-readable, URL-friendly identifier of
- *   an FAQ. You can get slug value from the endpoint
- *   /service/application/content/v1.0/faq.
- */
-/** @typedef GetFaqCategoriesParam */
-/**
- * @typedef GetFaqCategoryBySlugParam
- * @property {string} slug - A short, human-readable, URL-friendly identifier of
- *   an FAQ category. You can get slug value from the endpoint
- *   /service/application/content/v1.0/faq/categories.
- */
-/** @typedef GetFaqsParam */
-/**
- * @typedef GetFaqsByCategorySlugParam
- * @property {string} slug - A short, human-readable, URL-friendly identifier of
- *   an FAQ category. You can get slug value from the endpoint
- *   /service/application/content/v1.0/faq/categories.
- */
-/** @typedef GetLandingPageParam */
-/** @typedef GetLegalInformationParam */
-/**
- * @typedef GetNavigationsParam
- * @property {number} [pageNo] - The page number to navigate through the given
- *   set of results. Default value is 1. .
- * @property {number} [pageSize] - The number of items to retrieve in each page.
- */
-/**
- * @typedef GetPageParam
- * @property {string} slug - A short, human-readable, URL-friendly identifier of
- *   a page. You can get slug value from the endpoint
- *   /service/application/content/v2.0/pages/.
- * @property {string} [rootId] - ID given to the HTML element.
- */
-/**
- * @typedef GetPagesParam
- * @property {number} [pageNo] - The page number to navigate through the given
- *   set of results. Default value is 1. .
- * @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
- *   a slideshow. You can get slug value from the endpoint
- *   /service/application/content/v1.0/slideshow/.
- */
-/**
- * @typedef GetSlideshowsParam
- * @property {number} [pageNo] - The page number to navigate through the given
- *   set of results. Default value is 1. .
- * @property {number} [pageSize] - The number of items to retrieve in each page.
- */
-/** @typedef GetSupportInformationParam */
-/** @typedef GetTagsParam */
-declare class ContentApplicationValidator {
-    /** @returns {GetAnnouncementsParam} */
-    static getAnnouncements(): any;
-    /** @returns {GetBlogParam} */
-    static getBlog(): GetBlogParam;
-    /** @returns {GetBlogsParam} */
-    static getBlogs(): GetBlogsParam;
-    /** @returns {GetCustomFieldsByResourceIdParam} */
-    static getCustomFieldsByResourceId(): GetCustomFieldsByResourceIdParam;
-    /** @returns {GetCustomObjectBySlugParam} */
-    static getCustomObjectBySlug(): GetCustomObjectBySlugParam;
-    /** @returns {GetDataLoadersParam} */
-    static getDataLoaders(): any;
-    /** @returns {GetFaqBySlugParam} */
-    static getFaqBySlug(): GetFaqBySlugParam;
-    /** @returns {GetFaqCategoriesParam} */
-    static getFaqCategories(): any;
-    /** @returns {GetFaqCategoryBySlugParam} */
-    static getFaqCategoryBySlug(): GetFaqCategoryBySlugParam;
-    /** @returns {GetFaqsParam} */
-    static getFaqs(): any;
-    /** @returns {GetFaqsByCategorySlugParam} */
-    static getFaqsByCategorySlug(): GetFaqsByCategorySlugParam;
-    /** @returns {GetLandingPageParam} */
-    static getLandingPage(): any;
-    /** @returns {GetLegalInformationParam} */
-    static getLegalInformation(): any;
-    /** @returns {GetNavigationsParam} */
-    static getNavigations(): GetNavigationsParam;
-    /** @returns {GetPageParam} */
-    static getPage(): GetPageParam;
-    /** @returns {GetPagesParam} */
-    static getPages(): GetPagesParam;
-    /** @returns {GetSEOConfigurationParam} */
-    static getSEOConfiguration(): any;
-    /** @returns {GetSEOMarkupSchemasParam} */
-    static getSEOMarkupSchemas(): GetSEOMarkupSchemasParam;
-    /** @returns {GetSlideshowParam} */
-    static getSlideshow(): GetSlideshowParam;
-    /** @returns {GetSlideshowsParam} */
-    static getSlideshows(): GetSlideshowsParam;
-    /** @returns {GetSupportInformationParam} */
-    static getSupportInformation(): any;
-    /** @returns {GetTagsParam} */
-    static getTags(): any;
-}
-declare namespace ContentApplicationValidator {
-    export { GetAnnouncementsParam, GetBlogParam, GetBlogsParam, GetCustomFieldsByResourceIdParam, GetCustomObjectBySlugParam, GetDataLoadersParam, GetFaqBySlugParam, GetFaqCategoriesParam, GetFaqCategoryBySlugParam, GetFaqsParam, GetFaqsByCategorySlugParam, GetLandingPageParam, GetLegalInformationParam, GetNavigationsParam, GetPageParam, GetPagesParam, GetSEOConfigurationParam, GetSEOMarkupSchemasParam, GetSlideshowParam, GetSlideshowsParam, GetSupportInformationParam, GetTagsParam };
-}
-type GetBlogParam = {
-    /**
-     * - A short, human-readable, URL-friendly identifier of
-     * a blog. You can get slug value from the endpoint
-     * /service/application/content/v1.0/blogs/.
-     */
-    slug: string;
-    /**
-     * - ID given to the HTML element.
-     */
-    rootId?: string;
-    /**
-     * - Boolean value to get the preview for the blogs.
-     */
-    preview?: boolean;
-};
-type GetBlogsParam = {
-    /**
-     * - The page number to navigate through the given
-     * set of results. Default value is 1. .
-     */
-    pageNo?: number;
-    /**
-     * - The number of items to retrieve in each page.
-     */
-    pageSize?: number;
-    /**
-     * - Blogs retrieve based on the list of tags passed.
-     */
-    tags?: string;
-    /**
-     * - Blogs retrieve based on the title.
-     */
-    search?: string;
-};
-type GetCustomFieldsByResourceIdParam = {
-    /**
-     * - This is the name of resource for which you want
-     * to fetch custom fields eg. product, collection, customer etc.
-     */
-    resource: string;
-    /**
-     * - This is the resource id for which custom
-     * fields created
-     */
-    resourceSlug: string;
-};
-type GetCustomObjectBySlugParam = {
-    definitionSlug: string;
-    slug: string;
-};
-type GetFaqBySlugParam = {
-    /**
-     * - A short, human-readable, URL-friendly identifier of
-     * an FAQ. You can get slug value from the endpoint
-     * /service/application/content/v1.0/faq.
-     */
-    slug: string;
-};
-type GetFaqCategoryBySlugParam = {
-    /**
-     * - A short, human-readable, URL-friendly identifier of
-     * an FAQ category. You can get slug value from the endpoint
-     * /service/application/content/v1.0/faq/categories.
-     */
-    slug: string;
-};
-type GetFaqsByCategorySlugParam = {
-    /**
-     * - A short, human-readable, URL-friendly identifier of
-     * an FAQ category. You can get slug value from the endpoint
-     * /service/application/content/v1.0/faq/categories.
-     */
-    slug: string;
-};
-type GetNavigationsParam = {
-    /**
-     * - The page number to navigate through the given
-     * set of results. Default value is 1. .
-     */
-    pageNo?: number;
-    /**
-     * - The number of items to retrieve in each page.
-     */
-    pageSize?: number;
-};
-type GetPageParam = {
-    /**
-     * - A short, human-readable, URL-friendly identifier of
-     * a page. You can get slug value from the endpoint
-     * /service/application/content/v2.0/pages/.
-     */
-    slug: string;
-    /**
-     * - ID given to the HTML element.
-     */
-    rootId?: string;
-};
-type GetPagesParam = {
-    /**
-     * - The page number to navigate through the given
-     * set of results. Default value is 1. .
-     */
-    pageNo?: number;
-    /**
-     * - The number of items to retrieve in each page.
-     */
-    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
-     * a slideshow. You can get slug value from the endpoint
-     * /service/application/content/v1.0/slideshow/.
-     */
-    slug: string;
-};
-type GetSlideshowsParam = {
-    /**
-     * - The page number to navigate through the given
-     * set of results. Default value is 1. .
-     */
-    pageNo?: number;
-    /**
-     * - The number of items to retrieve in each page.
-     */
-    pageSize?: number;
-};
-type GetAnnouncementsParam = any;
-type GetDataLoadersParam = any;
-type GetFaqCategoriesParam = any;
-type GetFaqsParam = any;
-type GetLandingPageParam = any;
-type GetLegalInformationParam = any;
-type GetSEOConfigurationParam = any;
-type GetSupportInformationParam = any;
-type GetTagsParam = any;

package/sdk/application/Content/ContentApplicationValidator.js

@@ -1,269 +0,0 @@
-const Joi = require("joi");
-
-const ContentApplicationModel = require("./ContentApplicationModel");
-
-/** @typedef GetAnnouncementsParam */
-
-/**
- * @typedef GetBlogParam
- * @property {string} slug - A short, human-readable, URL-friendly identifier of
- *   a blog. You can get slug value from the endpoint
- *   /service/application/content/v1.0/blogs/.
- * @property {string} [rootId] - ID given to the HTML element.
- * @property {boolean} [preview] - Boolean value to get the preview for the blogs.
- */
-
-/**
- * @typedef GetBlogsParam
- * @property {number} [pageNo] - The page number to navigate through the given
- *   set of results. Default value is 1. .
- * @property {number} [pageSize] - The number of items to retrieve in each page.
- * @property {string} [tags] - Blogs retrieve based on the list of tags passed.
- * @property {string} [search] - Blogs retrieve based on the title.
- */
-
-/**
- * @typedef GetCustomFieldsByResourceIdParam
- * @property {string} resource - This is the name of resource for which you want
- *   to fetch custom fields eg. product, collection, customer etc.
- * @property {string} resourceSlug - This is the resource id for which custom
- *   fields created
- */
-
-/**
- * @typedef GetCustomObjectBySlugParam
- * @property {string} definitionSlug
- * @property {string} slug
- */
-
-/** @typedef GetDataLoadersParam */
-
-/**
- * @typedef GetFaqBySlugParam
- * @property {string} slug - A short, human-readable, URL-friendly identifier of
- *   an FAQ. You can get slug value from the endpoint
- *   /service/application/content/v1.0/faq.
- */
-
-/** @typedef GetFaqCategoriesParam */
-
-/**
- * @typedef GetFaqCategoryBySlugParam
- * @property {string} slug - A short, human-readable, URL-friendly identifier of
- *   an FAQ category. You can get slug value from the endpoint
- *   /service/application/content/v1.0/faq/categories.
- */
-
-/** @typedef GetFaqsParam */
-
-/**
- * @typedef GetFaqsByCategorySlugParam
- * @property {string} slug - A short, human-readable, URL-friendly identifier of
- *   an FAQ category. You can get slug value from the endpoint
- *   /service/application/content/v1.0/faq/categories.
- */
-
-/** @typedef GetLandingPageParam */
-
-/** @typedef GetLegalInformationParam */
-
-/**
- * @typedef GetNavigationsParam
- * @property {number} [pageNo] - The page number to navigate through the given
- *   set of results. Default value is 1. .
- * @property {number} [pageSize] - The number of items to retrieve in each page.
- */
-
-/**
- * @typedef GetPageParam
- * @property {string} slug - A short, human-readable, URL-friendly identifier of
- *   a page. You can get slug value from the endpoint
- *   /service/application/content/v2.0/pages/.
- * @property {string} [rootId] - ID given to the HTML element.
- */
-
-/**
- * @typedef GetPagesParam
- * @property {number} [pageNo] - The page number to navigate through the given
- *   set of results. Default value is 1. .
- * @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
- *   a slideshow. You can get slug value from the endpoint
- *   /service/application/content/v1.0/slideshow/.
- */
-
-/**
- * @typedef GetSlideshowsParam
- * @property {number} [pageNo] - The page number to navigate through the given
- *   set of results. Default value is 1. .
- * @property {number} [pageSize] - The number of items to retrieve in each page.
- */
-
-/** @typedef GetSupportInformationParam */
-
-/** @typedef GetTagsParam */
-
-class ContentApplicationValidator {
-  /** @returns {GetAnnouncementsParam} */
-  static getAnnouncements() {
-    return Joi.object({});
-  }
-
-  /** @returns {GetBlogParam} */
-  static getBlog() {
-    return Joi.object({
-      slug: Joi.string().allow("").required(),
-      rootId: Joi.string().allow(""),
-      preview: Joi.boolean(),
-    }).required();
-  }
-
-  /** @returns {GetBlogsParam} */
-  static getBlogs() {
-    return Joi.object({
-      pageNo: Joi.number(),
-      pageSize: Joi.number(),
-      tags: Joi.string().allow(""),
-      search: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {GetCustomFieldsByResourceIdParam} */
-  static getCustomFieldsByResourceId() {
-    return Joi.object({
-      resource: Joi.string().allow("").required(),
-      resourceSlug: Joi.string().allow("").required(),
-    }).required();
-  }
-
-  /** @returns {GetCustomObjectBySlugParam} */
-  static getCustomObjectBySlug() {
-    return Joi.object({
-      definitionSlug: Joi.string().allow("").required(),
-      slug: Joi.string().allow("").required(),
-    }).required();
-  }
-
-  /** @returns {GetDataLoadersParam} */
-  static getDataLoaders() {
-    return Joi.object({});
-  }
-
-  /** @returns {GetFaqBySlugParam} */
-  static getFaqBySlug() {
-    return Joi.object({
-      slug: Joi.string().allow("").required(),
-    }).required();
-  }
-
-  /** @returns {GetFaqCategoriesParam} */
-  static getFaqCategories() {
-    return Joi.object({});
-  }
-
-  /** @returns {GetFaqCategoryBySlugParam} */
-  static getFaqCategoryBySlug() {
-    return Joi.object({
-      slug: Joi.string().allow("").required(),
-    }).required();
-  }
-
-  /** @returns {GetFaqsParam} */
-  static getFaqs() {
-    return Joi.object({});
-  }
-
-  /** @returns {GetFaqsByCategorySlugParam} */
-  static getFaqsByCategorySlug() {
-    return Joi.object({
-      slug: Joi.string().allow("").required(),
-    }).required();
-  }
-
-  /** @returns {GetLandingPageParam} */
-  static getLandingPage() {
-    return Joi.object({});
-  }
-
-  /** @returns {GetLegalInformationParam} */
-  static getLegalInformation() {
-    return Joi.object({});
-  }
-
-  /** @returns {GetNavigationsParam} */
-  static getNavigations() {
-    return Joi.object({
-      pageNo: Joi.number(),
-      pageSize: Joi.number(),
-    });
-  }
-
-  /** @returns {GetPageParam} */
-  static getPage() {
-    return Joi.object({
-      slug: Joi.string().allow("").required(),
-      rootId: Joi.string().allow(""),
-    }).required();
-  }
-
-  /** @returns {GetPagesParam} */
-  static getPages() {
-    return Joi.object({
-      pageNo: Joi.number(),
-      pageSize: Joi.number(),
-    });
-  }
-
-  /** @returns {GetSEOConfigurationParam} */
-  static getSEOConfiguration() {
-    return Joi.object({});
-  }
-
-  /** @returns {GetSEOMarkupSchemasParam} */
-  static getSEOMarkupSchemas() {
-    return Joi.object({
-      pageType: Joi.string().allow(""),
-      active: Joi.boolean(),
-    });
-  }
-
-  /** @returns {GetSlideshowParam} */
-  static getSlideshow() {
-    return Joi.object({
-      slug: Joi.string().allow("").required(),
-    }).required();
-  }
-
-  /** @returns {GetSlideshowsParam} */
-  static getSlideshows() {
-    return Joi.object({
-      pageNo: Joi.number(),
-      pageSize: Joi.number(),
-    });
-  }
-
-  /** @returns {GetSupportInformationParam} */
-  static getSupportInformation() {
-    return Joi.object({});
-  }
-
-  /** @returns {GetTagsParam} */
-  static getTags() {
-    return Joi.object({});
-  }
-}
-
-module.exports = ContentApplicationValidator;