@gofynd/fdk-client-javascript 1.1.6 → 1.3.0

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

@@ -1,22 +1,224 @@
-export = ContentValidator;
-declare class ContentValidator {
+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
+ */
+/**
+ * @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.
+ */
+/** @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 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;
-    static getBlog(): any;
-    static getBlogs(): any;
+    /** @returns {GetBlogParam} */
+    static getBlog(): GetBlogParam;
+    /** @returns {GetBlogsParam} */
+    static getBlogs(): GetBlogsParam;
+    /** @returns {GetDataLoadersParam} */
     static getDataLoaders(): any;
-    static getFaqBySlug(): any;
+    /** @returns {GetFaqBySlugParam} */
+    static getFaqBySlug(): GetFaqBySlugParam;
+    /** @returns {GetFaqCategoriesParam} */
     static getFaqCategories(): any;
-    static getFaqCategoryBySlug(): any;
+    /** @returns {GetFaqCategoryBySlugParam} */
+    static getFaqCategoryBySlug(): GetFaqCategoryBySlugParam;
+    /** @returns {GetFaqsParam} */
     static getFaqs(): any;
-    static getFaqsByCategorySlug(): any;
+    /** @returns {GetFaqsByCategorySlugParam} */
+    static getFaqsByCategorySlug(): GetFaqsByCategorySlugParam;
+    /** @returns {GetLandingPageParam} */
     static getLandingPage(): any;
+    /** @returns {GetLegalInformationParam} */
     static getLegalInformation(): any;
-    static getNavigations(): any;
-    static getPage(): any;
-    static getPages(): any;
+    /** @returns {GetNavigationsParam} */
+    static getNavigations(): GetNavigationsParam;
+    /** @returns {GetPageParam} */
+    static getPage(): GetPageParam;
+    /** @returns {GetPagesParam} */
+    static getPages(): GetPagesParam;
+    /** @returns {GetSEOConfigurationParam} */
     static getSEOConfiguration(): any;
-    static getSlideshow(): any;
-    static getSlideshows(): any;
+    /** @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, GetDataLoadersParam, GetFaqBySlugParam, GetFaqCategoriesParam, GetFaqCategoryBySlugParam, GetFaqsParam, GetFaqsByCategorySlugParam, GetLandingPageParam, GetLegalInformationParam, GetNavigationsParam, GetPageParam, GetPagesParam, GetSEOConfigurationParam, 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;
+};
+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;
+};
+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 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,11 +1,104 @@
 const Joi = require("joi");
 
-const ContentModel = require("./ContentApplicationModel");
-class ContentValidator {
+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
+ */
+
+/**
+ * @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.
+ */
+
+/** @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 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(),
@@ -13,6 +106,7 @@ class ContentValidator {
     }).required();
   }
 
+  /** @returns {GetBlogsParam} */
   static getBlogs() {
     return Joi.object({
       pageNo: Joi.number(),
@@ -20,44 +114,53 @@ class ContentValidator {
     });
   }
 
+  /** @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(),
@@ -65,6 +168,7 @@ class ContentValidator {
     });
   }
 
+  /** @returns {GetPageParam} */
   static getPage() {
     return Joi.object({
       slug: Joi.string().allow("").required(),
@@ -72,6 +176,7 @@ class ContentValidator {
     }).required();
   }
 
+  /** @returns {GetPagesParam} */
   static getPages() {
     return Joi.object({
       pageNo: Joi.number(),
@@ -79,16 +184,19 @@ class ContentValidator {
     });
   }
 
+  /** @returns {GetSEOConfigurationParam} */
   static getSEOConfiguration() {
     return Joi.object({});
   }
 
+  /** @returns {GetSlideshowParam} */
   static getSlideshow() {
     return Joi.object({
       slug: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetSlideshowsParam} */
   static getSlideshows() {
     return Joi.object({
       pageNo: Joi.number(),
@@ -96,13 +204,15 @@ class ContentValidator {
     });
   }
 
+  /** @returns {GetSupportInformationParam} */
   static getSupportInformation() {
     return Joi.object({});
   }
 
+  /** @returns {GetTagsParam} */
   static getTags() {
     return Joi.object({});
   }
 }
 
-module.exports = ContentValidator;
+module.exports = ContentApplicationValidator;

package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts

@@ -10,13 +10,11 @@ declare class FileStorage {
     _urls: {};
     updateUrls(urls: any): void;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.namespace - Segregation of different types of
-     *   files(products, orders, logistics etc), Required for validating the
-     *   data of the file being uploaded, decides where exactly the file will be
-     *   stored inside the storage bucket.
-     * @param {StartResponse} arg.body
-     * @returns {Promise<CompleteResponse>} - Success response
+     * @param {FileStorageApplicationValidator.CompleteUploadParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<FileStorageApplicationModel.CompleteResponse>} - Success response
+     * @name completeUpload
      * @summary: Completes the upload process. After successfully uploading a file, call this API to finish the upload process.
      * @description: Use this API to perform the third step of uploading (i.e. **Complete**) an arbitrarily sized buffer or blob.
      *
@@ -36,29 +34,25 @@ declare class FileStorage {
      * ### Complete
      * After successfully upload, call the `completeUpload` API to finish the upload process.
      * This operation will return the URL of the uploaded file.
+     *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/completeUpload/).
      */
-    completeUpload({ namespace, body }?: {
-        namespace: string;
-        body: StartResponse;
-    }): Promise<CompleteResponse>;
+    completeUpload({ namespace, body, requestHeaders }?: FileStorageApplicationValidator.CompleteUploadParam, { responseHeaders }?: object): Promise<FileStorageApplicationModel.CompleteResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {SignUrlRequest} arg.body
-     * @returns {Promise<SignUrlResponse>} - Success response
+     * @param {FileStorageApplicationValidator.SignUrlsParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<FileStorageApplicationModel.SignUrlResponse>} - Success response
+     * @name signUrls
      * @summary: Explain here
-     * @description: Describe here
+     * @description: Describe here - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/signUrls/).
      */
-    signUrls({ body }?: {
-        body: SignUrlRequest;
-    }): Promise<SignUrlResponse>;
+    signUrls({ body, requestHeaders }?: FileStorageApplicationValidator.SignUrlsParam, { responseHeaders }?: object): Promise<FileStorageApplicationModel.SignUrlResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.namespace - Segregation of different types of
-     *   files(products, orders, logistics etc), Required for validating the
-     *   data of the file being uploaded, decides where exactly the file will be
-     *   stored inside the storage bucket.
-     * @param {StartRequest} arg.body
-     * @returns {Promise<StartResponse>} - Success response
+     * @param {FileStorageApplicationValidator.StartUploadParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<FileStorageApplicationModel.StartResponse>} - Success response
+     * @name startUpload
      * @summary: Initiates an upload and returns a storage link that is valid for 30 minutes. You can use the storage link to make subsequent upload request with file buffer or blob.
      * @description: Use this API to perform the first step of uploading (i.e. **Start**) an arbitrarily sized buffer or blob.
      *
@@ -78,11 +72,9 @@ declare class FileStorage {
      * ### Complete
      * After successfully upload, call the `completeUpload` API to finish the upload process.
      * This operation will return the URL of the uploaded file.
+     *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/startUpload/).
      */
-    startUpload({ namespace, body }?: {
-        namespace: string;
-        body: StartRequest;
-    }): Promise<StartResponse>;
+    startUpload({ namespace, body, requestHeaders }?: FileStorageApplicationValidator.StartUploadParam, { responseHeaders }?: object): Promise<FileStorageApplicationModel.StartResponse>;
     /**
      * @param data
      * @param {string} file_name
@@ -100,3 +92,5 @@ declare class FileStorage {
         tags: any;
     }): Promise<any>;
 }
+import FileStorageApplicationValidator = require("./FileStorageApplicationValidator");
+import FileStorageApplicationModel = require("./FileStorageApplicationModel");