@gofynd/fdk-client-javascript 1.4.8-beta.3 → 1.4.8

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

@@ -5,24 +5,25 @@ export = ContentApplicationValidator;
  * @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 {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.
+ *   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 GetCustomFieldsParam
- * @property {string} resource
- * @property {string} resourceId
+ * @property {string} resource - This is the name of resource for which you want
+ *   to fetch custom fields eg. product, collection, customer etc.
+ * @property {string} resourceId - This is the resource id for which custom fields created
  */
 /**
  * @typedef GetCustomObjectParam
- * @property {string} metaobjectId
+ * @property {string} metaobjectId - This is meta object id
  */
 /** @typedef GetDataLoadersParam */
 /**
@@ -50,7 +51,7 @@ export = ContentApplicationValidator;
 /**
  * @typedef GetNavigationsParam
  * @property {number} [pageNo] - The page number to navigate through the given
- *   set of results. Default value is 1.
+ *   set of results. Default value is 1. .
  * @property {number} [pageSize] - The number of items to retrieve in each page.
  */
 /**
@@ -58,19 +59,19 @@ export = ContentApplicationValidator;
  * @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
+ * @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.
+ *   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
+ *   template was created.
  * @property {boolean} [active] - Boolean value for fetching seo schema.
  */
 /**
@@ -82,7 +83,7 @@ export = ContentApplicationValidator;
 /**
  * @typedef GetSlideshowsParam
  * @property {number} [pageNo] - The page number to navigate through the given
- *   set of results. Default value is 1.
+ *   set of results. Default value is 1. .
  * @property {number} [pageSize] - The number of items to retrieve in each page.
  */
 /** @typedef GetSupportInformationParam */
@@ -144,14 +145,14 @@ type GetBlogParam = {
      */
     slug: string;
     /**
-     * - ID given to the HTML element
+     * - 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.
+     * set of results. Default value is 1. .
      */
     pageNo?: number;
     /**
@@ -168,10 +169,20 @@ type GetBlogsParam = {
     search?: string;
 };
 type GetCustomFieldsParam = {
+    /**
+     * - 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
+     */
     resourceId: string;
 };
 type GetCustomObjectParam = {
+    /**
+     * - This is meta object id
+     */
     metaobjectId: string;
 };
 type GetFaqBySlugParam = {
@@ -201,7 +212,7 @@ type GetFaqsByCategorySlugParam = {
 type GetNavigationsParam = {
     /**
      * - The page number to navigate through the given
-     * set of results. Default value is 1.
+     * set of results. Default value is 1. .
      */
     pageNo?: number;
     /**
@@ -217,14 +228,14 @@ type GetPageParam = {
      */
     slug: string;
     /**
-     * - ID given to the HTML element
+     * - 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.
+     * set of results. Default value is 1. .
      */
     pageNo?: number;
     /**
@@ -235,7 +246,7 @@ type GetPagesParam = {
 type GetSEOMarkupSchemasParam = {
     /**
      * - The type of page against which schema
-     * template was created
+     * template was created.
      */
     pageType?: string;
     /**
@@ -254,7 +265,7 @@ type GetSlideshowParam = {
 type GetSlideshowsParam = {
     /**
      * - The page number to navigate through the given
-     * set of results. Default value is 1.
+     * set of results. Default value is 1. .
      */
     pageNo?: number;
     /**

package/sdk/application/Content/ContentApplicationValidator.js

@@ -9,13 +9,13 @@ const ContentApplicationModel = require("./ContentApplicationModel");
  * @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 {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.
+ *   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.
@@ -23,13 +23,14 @@ const ContentApplicationModel = require("./ContentApplicationModel");
 
 /**
  * @typedef GetCustomFieldsParam
- * @property {string} resource
- * @property {string} resourceId
+ * @property {string} resource - This is the name of resource for which you want
+ *   to fetch custom fields eg. product, collection, customer etc.
+ * @property {string} resourceId - This is the resource id for which custom fields created
  */
 
 /**
  * @typedef GetCustomObjectParam
- * @property {string} metaobjectId
+ * @property {string} metaobjectId - This is meta object id
  */
 
 /** @typedef GetDataLoadersParam */
@@ -66,7 +67,7 @@ const ContentApplicationModel = require("./ContentApplicationModel");
 /**
  * @typedef GetNavigationsParam
  * @property {number} [pageNo] - The page number to navigate through the given
- *   set of results. Default value is 1.
+ *   set of results. Default value is 1. .
  * @property {number} [pageSize] - The number of items to retrieve in each page.
  */
 
@@ -75,13 +76,13 @@ const ContentApplicationModel = require("./ContentApplicationModel");
  * @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
+ * @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.
+ *   set of results. Default value is 1. .
  * @property {number} [pageSize] - The number of items to retrieve in each page.
  */
 
@@ -90,7 +91,7 @@ const ContentApplicationModel = require("./ContentApplicationModel");
 /**
  * @typedef GetSEOMarkupSchemasParam
  * @property {string} [pageType] - The type of page against which schema
- *   template was created
+ *   template was created.
  * @property {boolean} [active] - Boolean value for fetching seo schema.
  */
 
@@ -104,7 +105,7 @@ const ContentApplicationModel = require("./ContentApplicationModel");
 /**
  * @typedef GetSlideshowsParam
  * @property {number} [pageNo] - The page number to navigate through the given
- *   set of results. Default value is 1.
+ *   set of results. Default value is 1. .
  * @property {number} [pageSize] - The number of items to retrieve in each page.
  */
 

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

@@ -16,7 +16,7 @@ declare class FileStorage {
      * @returns {Promise<FileStorageApplicationModel.CompleteResponse>} - Success response
      * @name completeUpload
      * @summary: Complete file upload
-     * @description: Complete the file upload and store the file details such as name, size, content type, and namespace to maintain integrity within the system's database - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/completeUpload/).
+     * @description: Complete the file upload and store the file details such as name, size, content type, and namespace to maintain integrity within the system's database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/completeUpload/).
      */
     completeUpload({ namespace, body, requestHeaders }?: FileStorageApplicationValidator.CompleteUploadParam, { responseHeaders }?: object): Promise<FileStorageApplicationModel.CompleteResponse>;
     /**
@@ -35,8 +35,8 @@ declare class FileStorage {
      * @param {import("../ApplicationAPIClient").Options} - Options
      * @returns {Promise<FileStorageApplicationModel.StartResponse>} - Success response
      * @name startUpload
-     * @summary: Initiate file upload
-     * @description: Get a signed url for uploading a file - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/startUpload/).
+     * @summary: Initiates file upload
+     * @description: Starts the process of uploading a file to storage location, and returns a signed url in response. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/startUpload/).
      */
     startUpload({ namespace, body, requestHeaders }?: FileStorageApplicationValidator.StartUploadParam, { responseHeaders }?: object): Promise<FileStorageApplicationModel.StartResponse>;
     /**

package/sdk/application/FileStorage/FileStorageApplicationClient.js

@@ -44,7 +44,7 @@ class FileStorage {
    * @returns {Promise<FileStorageApplicationModel.CompleteResponse>} - Success response
    * @name completeUpload
    * @summary: Complete file upload
-   * @description: Complete the file upload and store the file details such as name, size, content type, and namespace to maintain integrity within the system's database - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/completeUpload/).
+   * @description: Complete the file upload and store the file details such as name, size, content type, and namespace to maintain integrity within the system's database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/completeUpload/).
    */
   async completeUpload(
     { namespace, body, requestHeaders } = { requestHeaders: {} },
@@ -199,8 +199,8 @@ class FileStorage {
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<FileStorageApplicationModel.StartResponse>} - Success response
    * @name startUpload
-   * @summary: Initiate file upload
-   * @description: Get a signed url for uploading a file - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/startUpload/).
+   * @summary: Initiates file upload
+   * @description: Starts the process of uploading a file to storage location, and returns a signed url in response. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/startUpload/).
    */
   async startUpload(
     { namespace, body, requestHeaders } = { requestHeaders: {} },

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

@@ -1,75 +1,77 @@
 export = FileStorageApplicationModel;
 /**
  * @typedef CDN
- * @property {string} url
- * @property {string} absolute_url
- * @property {string} relative_url
+ * @property {string} url - The CDN URL for accessing the file.
+ * @property {string} absolute_url - The absolute URL of the file.
+ * @property {string} relative_url - The relative URL of the file.
  */
 /**
  * @typedef Upload
- * @property {number} expiry
- * @property {string} url
+ * @property {number} expiry - The expiration time for the signed URL.
+ * @property {string} url - The signed URL for uploading the file.
  */
 /**
  * @typedef StartResponse
- * @property {string} file_name
- * @property {string} file_path
- * @property {string} content_type
- * @property {string} [method]
- * @property {string} namespace
- * @property {string} operation
- * @property {number} size
+ * @property {string} file_name - The name of the file that was uploaded.
+ * @property {string} file_path - The path to the file in the storage location.
+ * @property {string} content_type - The content type of the file.
+ * @property {string} [method] - The HTTP method to be used for uploading the file.
+ * @property {string} namespace - The namespace associated with the file.
+ * @property {string} operation - The operation to be performed on the storage service.
+ * @property {number} size - The size of the file in bytes.
  * @property {Upload} upload
  * @property {CDN} cdn
- * @property {string[]} [tags]
+ * @property {string[]} [tags] - Tags associated with the file.
  */
 /**
  * @typedef Params
- * @property {string} [subpath] - The subpath for the file.
+ * @property {string} [subpath] - Specifies a particular directory or location
+ *   within the storage structure where the file should be placed or is located.
  */
 /**
  * @typedef StartRequest
- * @property {string} file_name
- * @property {string} content_type
- * @property {number} size
- * @property {string[]} [tags]
+ * @property {string} file_name - The name of the file to be uploaded.
+ * @property {string} content_type - The name of the file to be uploaded.
+ * @property {number} size - The size of the file in bytes.
+ * @property {string[]} [tags] - Tags associated with the file.
  * @property {Params} [params]
  */
 /**
  * @typedef CreatedBy
- * @property {string} [username]
+ * @property {string} [username] - The username of the user who created the file.
  */
 /**
  * @typedef CompleteResponse
- * @property {string} _id
- * @property {string} file_name
- * @property {string} file_path
- * @property {string} content_type
- * @property {string} namespace
- * @property {string} operation
- * @property {number} size
+ * @property {string} _id - The unique identifier of the uploaded file.
+ * @property {string} file_name - The name of the file that was uploaded.
+ * @property {string} file_path - The path to the file in the storage location.
+ * @property {string} content_type - The content type of the file.
+ * @property {string} namespace - The namespace associated with the file.
+ * @property {string} operation - The operation performed on the storage service.
+ * @property {number} size - The size of the file in bytes.
  * @property {Upload} upload
  * @property {CDN} cdn
- * @property {boolean} success
- * @property {string[]} [tags]
- * @property {string} created_on
- * @property {string} modified_on
+ * @property {boolean} success - The success status of the upload operation.
+ * @property {string[]} [tags] - Tags associated with the file.
+ * @property {string} created_on - The timestamp when the file was created.
+ * @property {string} modified_on - The timestamp when the file was last modified.
  * @property {CreatedBy} [created_by]
  */
 /**
  * @typedef Urls
- * @property {string} url
- * @property {string} signed_url
- * @property {number} expiry
+ * @property {string} url - This is the original asset URL provided in the
+ *   request. This is the URL for which a signed URL has been generated.
+ * @property {string} signed_url - Generated signed URL.
+ * @property {number} expiry - The expiration time for the signed URL.
  */
 /**
  * @typedef SignUrlResponse
- * @property {Urls[]} urls
+ * @property {Urls[]} urls - Signed URL object.
  */
 /**
  * @typedef SignUrlRequest
- * @property {number} expiry
- * @property {string[]} urls
+ * @property {number} expiry - The expiration time for the signed URL.
+ * @property {string[]} urls - List of asset URLs to be signed. .
  */
 declare class FileStorageApplicationModel {
 }
@@ -79,85 +81,192 @@ declare namespace FileStorageApplicationModel {
 /** @returns {CDN} */
 declare function CDN(): CDN;
 type CDN = {
+    /**
+     * - The CDN URL for accessing the file.
+     */
     url: string;
+    /**
+     * - The absolute URL of the file.
+     */
     absolute_url: string;
+    /**
+     * - The relative URL of the file.
+     */
     relative_url: string;
 };
 /** @returns {Upload} */
 declare function Upload(): Upload;
 type Upload = {
+    /**
+     * - The expiration time for the signed URL.
+     */
     expiry: number;
+    /**
+     * - The signed URL for uploading the file.
+     */
     url: string;
 };
 /** @returns {StartResponse} */
 declare function StartResponse(): StartResponse;
 type StartResponse = {
+    /**
+     * - The name of the file that was uploaded.
+     */
     file_name: string;
+    /**
+     * - The path to the file in the storage location.
+     */
     file_path: string;
+    /**
+     * - The content type of the file.
+     */
     content_type: string;
+    /**
+     * - The HTTP method to be used for uploading the file.
+     */
     method?: string;
+    /**
+     * - The namespace associated with the file.
+     */
     namespace: string;
+    /**
+     * - The operation to be performed on the storage service.
+     */
     operation: string;
+    /**
+     * - The size of the file in bytes.
+     */
     size: number;
     upload: Upload;
     cdn: CDN;
+    /**
+     * - Tags associated with the file.
+     */
     tags?: string[];
 };
 /** @returns {Params} */
 declare function Params(): Params;
 type Params = {
     /**
-     * - The subpath for the file.
+     * - Specifies a particular directory or location
+     * within the storage structure where the file should be placed or is located.
      */
     subpath?: string;
 };
 /** @returns {StartRequest} */
 declare function StartRequest(): StartRequest;
 type StartRequest = {
+    /**
+     * - The name of the file to be uploaded.
+     */
     file_name: string;
+    /**
+     * - The name of the file to be uploaded.
+     */
     content_type: string;
+    /**
+     * - The size of the file in bytes.
+     */
     size: number;
+    /**
+     * - Tags associated with the file.
+     */
     tags?: string[];
     params?: Params;
 };
 /** @returns {CreatedBy} */
 declare function CreatedBy(): CreatedBy;
 type CreatedBy = {
+    /**
+     * - The username of the user who created the file.
+     */
     username?: string;
 };
 /** @returns {CompleteResponse} */
 declare function CompleteResponse(): CompleteResponse;
 type CompleteResponse = {
+    /**
+     * - The unique identifier of the uploaded file.
+     */
     _id: string;
+    /**
+     * - The name of the file that was uploaded.
+     */
     file_name: string;
+    /**
+     * - The path to the file in the storage location.
+     */
     file_path: string;
+    /**
+     * - The content type of the file.
+     */
     content_type: string;
+    /**
+     * - The namespace associated with the file.
+     */
     namespace: string;
+    /**
+     * - The operation performed on the storage service.
+     */
     operation: string;
+    /**
+     * - The size of the file in bytes.
+     */
     size: number;
     upload: Upload;
     cdn: CDN;
+    /**
+     * - The success status of the upload operation.
+     */
     success: boolean;
+    /**
+     * - Tags associated with the file.
+     */
     tags?: string[];
+    /**
+     * - The timestamp when the file was created.
+     */
     created_on: string;
+    /**
+     * - The timestamp when the file was last modified.
+     */
     modified_on: string;
     created_by?: CreatedBy;
 };
 /** @returns {Urls} */
 declare function Urls(): Urls;
 type Urls = {
+    /**
+     * - This is the original asset URL provided in the
+     * request. This is the URL for which a signed URL has been generated.
+     */
     url: string;
+    /**
+     * - Generated signed URL.
+     */
     signed_url: string;
+    /**
+     * - The expiration time for the signed URL.
+     */
     expiry: number;
 };
 /** @returns {SignUrlResponse} */
 declare function SignUrlResponse(): SignUrlResponse;
 type SignUrlResponse = {
+    /**
+     * - Signed URL object.
+     */
     urls: Urls[];
 };
 /** @returns {SignUrlRequest} */
 declare function SignUrlRequest(): SignUrlRequest;
 type SignUrlRequest = {
+    /**
+     * - The expiration time for the signed URL.
+     */
     expiry: number;
+    /**
+     * - List of asset URLs to be signed. .
+     */
     urls: string[];
 };