@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

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

@@ -26,231 +26,213 @@ declare class Content {
     _urls: {};
     updateUrls(urls: any): void;
     /**
-     * @param {Object} arg - Arg object.
-     * @returns {Promise<AnnouncementsResponseSchema>} - Success response
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<ContentApplicationModel.AnnouncementsResponseSchema>}
+     *   - Success response
+     *
+     * @name getAnnouncements
      * @summary: Get live announcements
-     * @description: Announcements are useful to highlight a message or information on top of a webpage. Use this API to retrieve live announcements. Get announcements on individual pages or for all pages.
+     * @description: Announcements are useful to highlight a message or information on top of a webpage. Use this API to retrieve live announcements. Get announcements on individual pages or for all pages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getAnnouncements/).
      */
-    getAnnouncements({}?: any): Promise<AnnouncementsResponseSchema>;
+    getAnnouncements({ headers }?: import("../ApplicationAPIClient").Options): Promise<ContentApplicationModel.AnnouncementsResponseSchema>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.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/.
-     * @param {string} [arg.rootId] - ID given to the HTML element
-     * @returns {Promise<BlogSchema>} - Success response
+     * @param {ContentApplicationValidator.GetBlogParam} arg - Arg object.
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<ContentApplicationModel.BlogSchema>} - Success response
+     * @name getBlog
      * @summary: Get a blog
-     * @description: Use this API to get the details of a blog using its slug. Details include the title, reading time, publish status, feature image, tags, author, etc.
+     * @description: Use this API to get the details of a blog using its slug. Details include the title, reading time, publish status, feature image, tags, author, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getBlog/).
      */
-    getBlog({ slug, rootId }?: {
-        slug: string;
-        rootId?: string;
-    }): Promise<BlogSchema>;
+    getBlog({ slug, rootId }?: ContentApplicationValidator.GetBlogParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<ContentApplicationModel.BlogSchema>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {number} [arg.pageNo] - The page number to navigate through the
-     *   given set of results. Default value is 1.
-     * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
-     * @returns {Promise<BlogGetResponse>} - Success response
+     * @param {ContentApplicationValidator.GetBlogsParam} arg - Arg object.
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<ContentApplicationModel.BlogGetResponse>} - Success response
+     * @name getBlogs
      * @summary: Get a list of blogs
-     * @description: Use this API to get all the blogs.
+     * @description: Use this API to get all the blogs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getBlogs/).
      */
-    getBlogs({ pageNo, pageSize }?: {
-        pageNo?: number;
-        pageSize?: number;
-    }): Promise<BlogGetResponse>;
+    getBlogs({ pageNo, pageSize }?: ContentApplicationValidator.GetBlogsParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<ContentApplicationModel.BlogGetResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
+     * @returns {Paginator<ContentApplicationModel.BlogGetResponse>}
      * @summary: Get a list of blogs
      * @description: Use this API to get all the blogs.
      */
     getBlogsPaginator({ pageSize }?: {
         pageSize?: number;
-    }): Paginator;
+    }): Paginator<ContentApplicationModel.BlogGetResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @returns {Promise<DataLoadersSchema>} - Success response
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<ContentApplicationModel.DataLoadersSchema>} - Success response
+     * @name getDataLoaders
      * @summary: Get the data loaders associated with an application
-     * @description: Use this API to get all selected data loaders of the application in the form of tags.
+     * @description: Use this API to get all selected data loaders of the application in the form of tags. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getDataLoaders/).
      */
-    getDataLoaders({}?: any): Promise<DataLoadersSchema>;
+    getDataLoaders({ headers }?: import("../ApplicationAPIClient").Options): Promise<ContentApplicationModel.DataLoadersSchema>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.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.
-     * @returns {Promise<FaqSchema>} - Success response
+     * @param {ContentApplicationValidator.GetFaqBySlugParam} arg - Arg object.
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<ContentApplicationModel.FaqSchema>} - Success response
+     * @name getFaqBySlug
      * @summary: Get an FAQ
-     * @description: Use this API to get a particular FAQ by its slug.
+     * @description: Use this API to get a particular FAQ by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqBySlug/).
      */
-    getFaqBySlug({ slug }?: {
-        slug: string;
-    }): Promise<FaqSchema>;
+    getFaqBySlug({ slug }?: ContentApplicationValidator.GetFaqBySlugParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<ContentApplicationModel.FaqSchema>;
     /**
-     * @param {Object} arg - Arg object.
-     * @returns {Promise<GetFaqCategoriesSchema>} - Success response
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<ContentApplicationModel.GetFaqCategoriesSchema>} -
+     *   Success response
+     * @name getFaqCategories
      * @summary: Get a list of FAQ categories
-     * @description: FAQs can be divided into categories. Use this API to get a list of FAQ categories.
+     * @description: FAQs can be divided into categories. Use this API to get a list of FAQ categories. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqCategories/).
      */
-    getFaqCategories({}?: any): Promise<GetFaqCategoriesSchema>;
+    getFaqCategories({ headers }?: import("../ApplicationAPIClient").Options): Promise<ContentApplicationModel.GetFaqCategoriesSchema>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.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.
-     * @returns {Promise<GetFaqCategoryBySlugSchema>} - Success response
+     * @param {ContentApplicationValidator.GetFaqCategoryBySlugParam} arg - Arg object.
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<ContentApplicationModel.GetFaqCategoryBySlugSchema>} -
+     *   Success response
+     * @name getFaqCategoryBySlug
      * @summary: Get the FAQ category
-     * @description: FAQs can be divided into categories. Use this API to get the category to which an FAQ belongs.
+     * @description: FAQs can be divided into categories. Use this API to get the category to which an FAQ belongs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqCategoryBySlug/).
      */
-    getFaqCategoryBySlug({ slug }?: {
-        slug: string;
-    }): Promise<GetFaqCategoryBySlugSchema>;
+    getFaqCategoryBySlug({ slug }?: ContentApplicationValidator.GetFaqCategoryBySlugParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<ContentApplicationModel.GetFaqCategoryBySlugSchema>;
     /**
-     * @param {Object} arg - Arg object.
-     * @returns {Promise<FaqResponseSchema>} - Success response
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<ContentApplicationModel.FaqResponseSchema>} - Success response
+     * @name getFaqs
      * @summary: Get a list of FAQs
-     * @description: Use this API to get a list of frequently asked questions. Users will benefit from it when facing any issue with the website.
+     * @description: Use this API to get a list of frequently asked questions. Users will benefit from it when facing any issue with the website. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqs/).
      */
-    getFaqs({}?: any): Promise<FaqResponseSchema>;
+    getFaqs({ headers }?: import("../ApplicationAPIClient").Options): Promise<ContentApplicationModel.FaqResponseSchema>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.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.
-     * @returns {Promise<GetFaqSchema>} - Success response
+     * @param {ContentApplicationValidator.GetFaqsByCategorySlugParam} arg - Arg object.
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<ContentApplicationModel.GetFaqSchema>} - Success response
+     * @name getFaqsByCategorySlug
      * @summary: Get FAQs using the slug of FAQ category
-     * @description: FAQs can be divided into categories. Use this API to get all the FAQs belonging to a category by using the category slug.
+     * @description: FAQs can be divided into categories. Use this API to get all the FAQs belonging to a category by using the category slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqsByCategorySlug/).
      */
-    getFaqsByCategorySlug({ slug }?: {
-        slug: string;
-    }): Promise<GetFaqSchema>;
+    getFaqsByCategorySlug({ slug }?: ContentApplicationValidator.GetFaqsByCategorySlugParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<ContentApplicationModel.GetFaqSchema>;
     /**
-     * @param {Object} arg - Arg object.
-     * @returns {Promise<LandingPageSchema>} - Success response
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<ContentApplicationModel.LandingPageSchema>} - Success response
+     * @name getLandingPage
      * @summary: Get the landing page
-     * @description: Landing page is the first page that a prospect lands upon while visiting a website. Use this API to fetch the details of a landing page.
+     * @description: Landing page is the first page that a prospect lands upon while visiting a website. Use this API to fetch the details of a landing page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getLandingPage/).
      */
-    getLandingPage({}?: any): Promise<LandingPageSchema>;
+    getLandingPage({ headers }?: import("../ApplicationAPIClient").Options): Promise<ContentApplicationModel.LandingPageSchema>;
     /**
-     * @param {Object} arg - Arg object.
-     * @returns {Promise<ApplicationLegal>} - Success response
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<ContentApplicationModel.ApplicationLegal>} - Success response
+     * @name getLegalInformation
      * @summary: Get legal information
-     * @description: Use this API to get the legal information of an application, which includes Privacy Policy, Terms and Conditions, Shipping Policy and FAQs regarding the usage of the application.
+     * @description: Use this API to get the legal information of an application, which includes Privacy Policy, Terms and Conditions, Shipping Policy and FAQs regarding the usage of the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getLegalInformation/).
      */
-    getLegalInformation({}?: any): Promise<ApplicationLegal>;
+    getLegalInformation({ headers }?: import("../ApplicationAPIClient").Options): Promise<ContentApplicationModel.ApplicationLegal>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {number} [arg.pageNo] - The page number to navigate through the
-     *   given set of results. Default value is 1.
-     * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
-     * @returns {Promise<NavigationGetResponse>} - Success response
+     * @param {ContentApplicationValidator.GetNavigationsParam} arg - Arg object.
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<ContentApplicationModel.NavigationGetResponse>} -
+     *   Success response
+     * @name getNavigations
      * @summary: Get the navigation
-     * @description: Use this API to fetch the navigations details which includes the items of the navigation pane. It also shows the links and sub-navigations.
+     * @description: Use this API to fetch the navigations details which includes the items of the navigation pane. It also shows the links and sub-navigations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getNavigations/).
      */
-    getNavigations({ pageNo, pageSize }?: {
-        pageNo?: number;
-        pageSize?: number;
-    }): Promise<NavigationGetResponse>;
+    getNavigations({ pageNo, pageSize }?: ContentApplicationValidator.GetNavigationsParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<ContentApplicationModel.NavigationGetResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
+     * @returns {Paginator<ContentApplicationModel.NavigationGetResponse>}
      * @summary: Get the navigation
      * @description: Use this API to fetch the navigations details which includes the items of the navigation pane. It also shows the links and sub-navigations.
      */
     getNavigationsPaginator({ pageSize }?: {
         pageSize?: number;
-    }): Paginator;
+    }): Paginator<ContentApplicationModel.NavigationGetResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.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/.
-     * @param {string} [arg.rootId] - ID given to the HTML element
-     * @returns {Promise<PageSchema>} - Success response
+     * @param {ContentApplicationValidator.GetPageParam} arg - Arg object.
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<ContentApplicationModel.PageSchema>} - Success response
+     * @name getPage
      * @summary: Get a page
-     * @description: Use this API to get the details of a page using its slug. Details include the title, seo, publish status, feature image, tags, meta, etc.
+     * @description: Use this API to get the details of a page using its slug. Details include the title, seo, publish status, feature image, tags, meta, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getPage/).
      */
-    getPage({ slug, rootId }?: {
-        slug: string;
-        rootId?: string;
-    }): Promise<PageSchema>;
+    getPage({ slug, rootId }?: ContentApplicationValidator.GetPageParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<ContentApplicationModel.PageSchema>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {number} [arg.pageNo] - The page number to navigate through the
-     *   given set of results. Default value is 1.
-     * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
-     * @returns {Promise<PageGetResponse>} - Success response
+     * @param {ContentApplicationValidator.GetPagesParam} arg - Arg object.
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<ContentApplicationModel.PageGetResponse>} - Success response
+     * @name getPages
      * @summary: Get all pages
-     * @description: Use this API to get a list of pages.
+     * @description: Use this API to get a list of pages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getPages/).
      */
-    getPages({ pageNo, pageSize }?: {
-        pageNo?: number;
-        pageSize?: number;
-    }): Promise<PageGetResponse>;
+    getPages({ pageNo, pageSize }?: ContentApplicationValidator.GetPagesParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<ContentApplicationModel.PageGetResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
+     * @returns {Paginator<ContentApplicationModel.PageGetResponse>}
      * @summary: Get all pages
      * @description: Use this API to get a list of pages.
      */
     getPagesPaginator({ pageSize }?: {
         pageSize?: number;
-    }): Paginator;
+    }): Paginator<ContentApplicationModel.PageGetResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @returns {Promise<SeoComponent>} - Success response
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<ContentApplicationModel.SeoComponent>} - Success response
+     * @name getSEOConfiguration
      * @summary: Get the SEO of an application
-     * @description: Use this API to get the SEO details of an application, which includes a robot.txt, meta-tags and sitemap.
+     * @description: Use this API to get the SEO details of an application, which includes a robot.txt, meta-tags and sitemap. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSEOConfiguration/).
      */
-    getSEOConfiguration({}?: any): Promise<SeoComponent>;
+    getSEOConfiguration({ headers }?: import("../ApplicationAPIClient").Options): Promise<ContentApplicationModel.SeoComponent>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.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/.
-     * @returns {Promise<SlideshowSchema>} - Success response
+     * @param {ContentApplicationValidator.GetSlideshowParam} arg - Arg object.
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<ContentApplicationModel.SlideshowSchema>} - Success response
+     * @name getSlideshow
      * @summary: Get a slideshow
-     * @description: A slideshow is a group of images, videos or a combination of both that are shown on the website in the form of slides. Use this API to fetch a slideshow using its `slug`.
+     * @description: A slideshow is a group of images, videos or a combination of both that are shown on the website in the form of slides. Use this API to fetch a slideshow using its `slug`. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSlideshow/).
      */
-    getSlideshow({ slug }?: {
-        slug: string;
-    }): Promise<SlideshowSchema>;
+    getSlideshow({ slug }?: ContentApplicationValidator.GetSlideshowParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<ContentApplicationModel.SlideshowSchema>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {number} [arg.pageNo] - The page number to navigate through the
-     *   given set of results. Default value is 1.
-     * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
-     * @returns {Promise<SlideshowGetResponse>} - Success response
+     * @param {ContentApplicationValidator.GetSlideshowsParam} arg - Arg object.
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<ContentApplicationModel.SlideshowGetResponse>} - Success response
+     * @name getSlideshows
      * @summary: Get the slideshows
-     * @description: Use this API to get a list of slideshows along with their details.
+     * @description: Use this API to get a list of slideshows along with their details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSlideshows/).
      */
-    getSlideshows({ pageNo, pageSize }?: {
-        pageNo?: number;
-        pageSize?: number;
-    }): Promise<SlideshowGetResponse>;
+    getSlideshows({ pageNo, pageSize }?: ContentApplicationValidator.GetSlideshowsParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<ContentApplicationModel.SlideshowGetResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
+     * @returns {Paginator<ContentApplicationModel.SlideshowGetResponse>}
      * @summary: Get the slideshows
      * @description: Use this API to get a list of slideshows along with their details.
      */
     getSlideshowsPaginator({ pageSize }?: {
         pageSize?: number;
-    }): Paginator;
+    }): Paginator<ContentApplicationModel.SlideshowGetResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @returns {Promise<Support>} - Success response
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<ContentApplicationModel.Support>} - Success response
+     * @name getSupportInformation
      * @summary: Get the support information
-     * @description: Use this API to get contact details for customer support including emails and phone numbers.
+     * @description: Use this API to get contact details for customer support including emails and phone numbers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSupportInformation/).
      */
-    getSupportInformation({}?: any): Promise<Support>;
+    getSupportInformation({ headers }?: import("../ApplicationAPIClient").Options): Promise<ContentApplicationModel.Support>;
     /**
-     * @param {Object} arg - Arg object.
-     * @returns {Promise<TagsSchema>} - Success response
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<ContentApplicationModel.TagsSchema>} - Success response
+     * @name getTags
      * @summary: Get the tags associated with an application
-     * @description: Use this API to get all the CSS and JS injected in the application in the form of tags.
+     * @description: Use this API to get all the CSS and JS injected in the application in the form of tags. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getTags/).
      */
-    getTags({}?: any): Promise<TagsSchema>;
+    getTags({ headers }?: import("../ApplicationAPIClient").Options): Promise<ContentApplicationModel.TagsSchema>;
 }
+import ContentApplicationModel = require("./ContentApplicationModel");
+import ContentApplicationValidator = require("./ContentApplicationValidator");
 import Paginator = require("../../common/Paginator");