@gofynd/fdk-client-javascript 1.1.6 → 1.3.0

package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts

@@ -1,7 +1,142 @@
-export = FileStorageValidator;
-declare class FileStorageValidator {
-    static appCompleteUpload(): any;
-    static appCopyFiles(): any;
-    static appStartUpload(): any;
-    static appbrowse(): any;
+export = FileStoragePlatformApplicationValidator;
+/**
+ * @typedef AppCompleteUploadParam
+ * @property {string} 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.
+ * @property {FileStoragePlatformModel.StartResponse} body
+ */
+/**
+ * @typedef AppCopyFilesParam
+ * @property {boolean} [sync] - Sync
+ * @property {FileStoragePlatformModel.CopyFiles} body
+ */
+/**
+ * @typedef AppStartUploadParam
+ * @property {string} 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.
+ * @property {FileStoragePlatformModel.StartRequest} body
+ */
+/**
+ * @typedef AppbrowseParam
+ * @property {string} 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.
+ * @property {number} [page] - Page no
+ * @property {number} [limit] - Limit
+ */
+/**
+ * @typedef GetDefaultHtmlTemplateParam
+ * @property {number} pdfTypeId
+ * @property {string} format
+ */
+/**
+ * @typedef GetDefaultPdfDataParam
+ * @property {number} pdfTypeId
+ */
+/**
+ * @typedef GetDefaultPdfTemplateParam
+ * @property {number} pdfTypeId
+ * @property {string} format
+ */
+/** @typedef GetPdfTypesParam */
+/**
+ * @typedef PreviewTemplateParam
+ * @property {FileStoragePlatformModel.pdfRender} body
+ */
+/**
+ * @typedef SaveHtmlTemplateParam
+ * @property {FileStoragePlatformModel.pdfConfig} body
+ */
+declare class FileStoragePlatformApplicationValidator {
+    /** @returns {AppCompleteUploadParam} */
+    static appCompleteUpload(): AppCompleteUploadParam;
+    /** @returns {AppCopyFilesParam} */
+    static appCopyFiles(): AppCopyFilesParam;
+    /** @returns {AppStartUploadParam} */
+    static appStartUpload(): AppStartUploadParam;
+    /** @returns {AppbrowseParam} */
+    static appbrowse(): AppbrowseParam;
+    /** @returns {GetDefaultHtmlTemplateParam} */
+    static getDefaultHtmlTemplate(): GetDefaultHtmlTemplateParam;
+    /** @returns {GetDefaultPdfDataParam} */
+    static getDefaultPdfData(): GetDefaultPdfDataParam;
+    /** @returns {GetDefaultPdfTemplateParam} */
+    static getDefaultPdfTemplate(): GetDefaultPdfTemplateParam;
+    /** @returns {GetPdfTypesParam} */
+    static getPdfTypes(): any;
+    /** @returns {PreviewTemplateParam} */
+    static previewTemplate(): PreviewTemplateParam;
+    /** @returns {SaveHtmlTemplateParam} */
+    static saveHtmlTemplate(): SaveHtmlTemplateParam;
 }
+declare namespace FileStoragePlatformApplicationValidator {
+    export { AppCompleteUploadParam, AppCopyFilesParam, AppStartUploadParam, AppbrowseParam, GetDefaultHtmlTemplateParam, GetDefaultPdfDataParam, GetDefaultPdfTemplateParam, GetPdfTypesParam, PreviewTemplateParam, SaveHtmlTemplateParam };
+}
+type AppCompleteUploadParam = {
+    /**
+     * - 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.
+     */
+    namespace: string;
+    body: FileStoragePlatformModel.StartResponse;
+};
+type AppCopyFilesParam = {
+    /**
+     * - Sync
+     */
+    sync?: boolean;
+    body: FileStoragePlatformModel.CopyFiles;
+};
+type AppStartUploadParam = {
+    /**
+     * - 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.
+     */
+    namespace: string;
+    body: FileStoragePlatformModel.StartRequest;
+};
+type AppbrowseParam = {
+    /**
+     * - 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.
+     */
+    namespace: string;
+    /**
+     * - Page no
+     */
+    page?: number;
+    /**
+     * - Limit
+     */
+    limit?: number;
+};
+type GetDefaultHtmlTemplateParam = {
+    pdfTypeId: number;
+    format: string;
+};
+type GetDefaultPdfDataParam = {
+    pdfTypeId: number;
+};
+type GetDefaultPdfTemplateParam = {
+    pdfTypeId: number;
+    format: string;
+};
+type PreviewTemplateParam = {
+    body: FileStoragePlatformModel.pdfRender;
+};
+type SaveHtmlTemplateParam = {
+    body: FileStoragePlatformModel.pdfConfig;
+};
+type GetPdfTypesParam = any;
+import FileStoragePlatformModel = require("./FileStoragePlatformModel");

package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js

@@ -1,38 +1,149 @@
 const Joi = require("joi");
 
-const FileStorageModel = require("./FileStoragePlatformModel");
-class FileStorageValidator {
+const FileStoragePlatformModel = require("./FileStoragePlatformModel");
+
+/**
+ * @typedef AppCompleteUploadParam
+ * @property {string} 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.
+ * @property {FileStoragePlatformModel.StartResponse} body
+ */
+
+/**
+ * @typedef AppCopyFilesParam
+ * @property {boolean} [sync] - Sync
+ * @property {FileStoragePlatformModel.CopyFiles} body
+ */
+
+/**
+ * @typedef AppStartUploadParam
+ * @property {string} 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.
+ * @property {FileStoragePlatformModel.StartRequest} body
+ */
+
+/**
+ * @typedef AppbrowseParam
+ * @property {string} 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.
+ * @property {number} [page] - Page no
+ * @property {number} [limit] - Limit
+ */
+
+/**
+ * @typedef GetDefaultHtmlTemplateParam
+ * @property {number} pdfTypeId
+ * @property {string} format
+ */
+
+/**
+ * @typedef GetDefaultPdfDataParam
+ * @property {number} pdfTypeId
+ */
+
+/**
+ * @typedef GetDefaultPdfTemplateParam
+ * @property {number} pdfTypeId
+ * @property {string} format
+ */
+
+/** @typedef GetPdfTypesParam */
+
+/**
+ * @typedef PreviewTemplateParam
+ * @property {FileStoragePlatformModel.pdfRender} body
+ */
+
+/**
+ * @typedef SaveHtmlTemplateParam
+ * @property {FileStoragePlatformModel.pdfConfig} body
+ */
+
+class FileStoragePlatformApplicationValidator {
+  /** @returns {AppCompleteUploadParam} */
   static appCompleteUpload() {
     return Joi.object({
       namespace: Joi.string().allow("").required(),
 
-      body: FileStorageModel.StartResponse().required(),
+      body: FileStoragePlatformModel.StartResponse().required(),
     }).required();
   }
 
+  /** @returns {AppCopyFilesParam} */
   static appCopyFiles() {
     return Joi.object({
       sync: Joi.boolean(),
 
-      body: FileStorageModel.BulkRequest().required(),
+      body: FileStoragePlatformModel.CopyFiles().required(),
     }).required();
   }
 
+  /** @returns {AppStartUploadParam} */
   static appStartUpload() {
     return Joi.object({
       namespace: Joi.string().allow("").required(),
 
-      body: FileStorageModel.StartRequest().required(),
+      body: FileStoragePlatformModel.StartRequest().required(),
     }).required();
   }
 
+  /** @returns {AppbrowseParam} */
   static appbrowse() {
     return Joi.object({
       namespace: Joi.string().allow("").required(),
 
-      pageNo: Joi.number(),
+      page: Joi.number(),
+      limit: Joi.number(),
+    }).required();
+  }
+
+  /** @returns {GetDefaultHtmlTemplateParam} */
+  static getDefaultHtmlTemplate() {
+    return Joi.object({
+      pdfTypeId: Joi.number().required(),
+      format: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {GetDefaultPdfDataParam} */
+  static getDefaultPdfData() {
+    return Joi.object({
+      pdfTypeId: Joi.number().required(),
+    }).required();
+  }
+
+  /** @returns {GetDefaultPdfTemplateParam} */
+  static getDefaultPdfTemplate() {
+    return Joi.object({
+      pdfTypeId: Joi.number().required(),
+      format: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {GetPdfTypesParam} */
+  static getPdfTypes() {
+    return Joi.object({}).required();
+  }
+
+  /** @returns {PreviewTemplateParam} */
+  static previewTemplate() {
+    return Joi.object({
+      body: FileStoragePlatformModel.pdfRender().required(),
+    }).required();
+  }
+
+  /** @returns {SaveHtmlTemplateParam} */
+  static saveHtmlTemplate() {
+    return Joi.object({
+      body: FileStoragePlatformModel.pdfConfig().required(),
     }).required();
   }
 }
 
-module.exports = FileStorageValidator;
+module.exports = FileStoragePlatformApplicationValidator;

package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts

@@ -3,34 +3,21 @@ declare class FileStorage {
     constructor(config: any);
     config: any;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.namespace - Bucket name
-     * @param {number} [arg.pageNo] - Page no
-     * @returns {Promise<BrowseResponse>} - Success response
+     * @param {FileStoragePlatformValidator.BrowseParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<FileStoragePlatformModel.BrowseResponse>} - Success response
+     * @name browse
      * @summary: Browse Files
-     * @description: Browse Files
+     * @description: Browse Files - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/browse/).
      */
-    browse({ namespace, pageNo, }?: {
-        namespace: string;
-        pageNo?: number;
-    }): Promise<BrowseResponse>;
+    browse({ namespace, page, limit, requestHeaders }?: FileStoragePlatformValidator.BrowseParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.BrowseResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.namespace - Bucket name
-     * @summary: Browse Files
-     * @description: Browse Files
-     */
-    browsePaginator({ namespace }?: {
-        namespace: string;
-    }): Paginator;
-    /**
-     * @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 {FileStoragePlatformValidator.CompleteUploadParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<FileStoragePlatformModel.CompleteResponse>} - Success response
+     * @name completeUpload
      * @summary: This will complete the upload process. After successfully uploading file, you can call this operation to complete the upload process.
      * @description: Uploads an arbitrarily sized buffer or blob.
      *
@@ -50,51 +37,45 @@ declare class FileStorage {
      * ### Complete
      * After successfully upload, call `completeUpload` api to complete the upload process.
      * This operation will return the url for the uploaded file.
+     *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/completeUpload/).
      */
-    completeUpload({ namespace, body, }?: {
-        namespace: string;
-        body: StartResponse;
-    }): Promise<CompleteResponse>;
+    completeUpload({ namespace, body, requestHeaders }?: FileStoragePlatformValidator.CompleteUploadParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.CompleteResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {boolean} [arg.sync] - Sync
-     * @param {BulkRequest} arg.body
-     * @returns {Promise<BulkUploadResponse>} - Success response
+     * @param {FileStoragePlatformValidator.CopyFilesParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<FileStoragePlatformModel.BulkUploadSyncMode>} - Success response
+     * @name copyFiles
      * @summary: Copy Files
-     * @description: Copy Files
+     * @description: Copy Files - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/copyFiles/).
      */
-    copyFiles({ body, sync }?: {
-        sync?: boolean;
-        body: BulkRequest;
-    }): Promise<BulkUploadResponse>;
+    copyFiles({ body, sync, requestHeaders }?: FileStoragePlatformValidator.CopyFilesParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.BulkUploadSyncMode>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {SignUrlRequest} arg.body
-     * @returns {Promise<SignUrlResponse>} - Success response
+     * @param {FileStoragePlatformValidator.GetSignUrlsParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<FileStoragePlatformModel.SignUrlResponse>} - Success response
+     * @name getSignUrls
      * @summary: Gives signed urls to access private files
-     * @description: Describe here
+     * @description: Describe here - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getSignUrls/).
      */
-    getSignUrls({ body }?: {
-        body: SignUrlRequest;
-    }): Promise<SignUrlResponse>;
+    getSignUrls({ body, requestHeaders }?: FileStoragePlatformValidator.GetSignUrlsParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.SignUrlResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.url - Url
+     * @param {FileStoragePlatformValidator.ProxyParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<string>} - Success response
+     * @name proxy
      * @summary: Proxy
-     * @description: Proxy
+     * @description: Proxy - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/proxy/).
      */
-    proxy({ url }?: {
-        url: string;
-    }): Promise<string>;
+    proxy({ url, requestHeaders }?: FileStoragePlatformValidator.ProxyParam, { responseHeaders }?: object): Promise<string>;
     /**
-     * @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 {FileStoragePlatformValidator.StartUploadParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<FileStoragePlatformModel.StartResponse>} - Success response
+     * @name startUpload
      * @summary: This operation initiates upload and returns storage link which is valid for 30 Minutes. You can use that storage link to make subsequent upload request with file buffer or blob.
      * @description: Uploads an arbitrarily sized buffer or blob.
      *
@@ -114,11 +95,9 @@ declare class FileStorage {
      * ### Complete
      * After successfully upload, call `completeUpload` api to complete the upload process.
      * This operation will return the url for the uploaded file.
+     *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/startUpload/).
      */
-    startUpload({ namespace, body, }?: {
-        namespace: string;
-        body: StartRequest;
-    }): Promise<StartResponse>;
+    startUpload({ namespace, body, requestHeaders }?: FileStoragePlatformValidator.StartUploadParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.StartResponse>;
     /**
      * @param data
      * @param {string} file_name
@@ -136,4 +115,5 @@ declare class FileStorage {
         tags: any;
     }): Promise<any>;
 }
-import Paginator = require("../../common/Paginator");
+import FileStoragePlatformValidator = require("./FileStoragePlatformValidator");
+import FileStoragePlatformModel = require("./FileStoragePlatformModel");