@gofynd/fdk-client-javascript 1.2.0 → 1.3.1-beta.1

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

@@ -7,6 +7,7 @@ declare class FileStorage {
      * @param {FileStoragePlatformApplicationValidator.AppCompleteUploadParam} arg
      *   - Arg object
      *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<FileStoragePlatformModel.CompleteResponse>} - Success response
      * @name appCompleteUpload
@@ -31,20 +32,22 @@ declare class FileStorage {
      * This operation will return the url for the uploaded file.
      *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/appCompleteUpload/).
      */
-    appCompleteUpload({ namespace, body }?: FileStoragePlatformApplicationValidator.AppCompleteUploadParam, { headers }?: import("../PlatformAPIClient").Options): Promise<FileStoragePlatformModel.CompleteResponse>;
+    appCompleteUpload({ namespace, body, requestHeaders }?: FileStoragePlatformApplicationValidator.AppCompleteUploadParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.CompleteResponse>;
     /**
      * @param {FileStoragePlatformApplicationValidator.AppCopyFilesParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<FileStoragePlatformModel.BulkUploadResponse>} - Success response
+     * @returns {Promise<FileStoragePlatformModel.BulkUploadSyncMode>} - Success response
      * @name appCopyFiles
      * @summary: Copy Files
      * @description: Copy Files - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/appCopyFiles/).
      */
-    appCopyFiles({ body, sync }?: FileStoragePlatformApplicationValidator.AppCopyFilesParam, { headers }?: import("../PlatformAPIClient").Options): Promise<FileStoragePlatformModel.BulkUploadResponse>;
+    appCopyFiles({ body, sync, requestHeaders }?: FileStoragePlatformApplicationValidator.AppCopyFilesParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.BulkUploadSyncMode>;
     /**
      * @param {FileStoragePlatformApplicationValidator.AppStartUploadParam} arg
      *   - Arg object
      *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<FileStoragePlatformModel.StartResponse>} - Success response
      * @name appStartUpload
@@ -69,30 +72,94 @@ declare class FileStorage {
      * This operation will return the url for the uploaded file.
      *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/appStartUpload/).
      */
-    appStartUpload({ namespace, body }?: FileStoragePlatformApplicationValidator.AppStartUploadParam, { headers }?: import("../PlatformAPIClient").Options): Promise<FileStoragePlatformModel.StartResponse>;
+    appStartUpload({ namespace, body, requestHeaders }?: FileStoragePlatformApplicationValidator.AppStartUploadParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.StartResponse>;
     /**
      * @param {FileStoragePlatformApplicationValidator.AppbrowseParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<FileStoragePlatformModel.BrowseResponse>} - Success response
      * @name appbrowse
      * @summary: Browse Files
      * @description: Browse Files - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/appbrowse/).
      */
-    appbrowse({ namespace, pageNo }?: FileStoragePlatformApplicationValidator.AppbrowseParam, { headers }?: import("../PlatformAPIClient").Options): Promise<FileStoragePlatformModel.BrowseResponse>;
+    appbrowse({ namespace, page, limit, requestHeaders }?: FileStoragePlatformApplicationValidator.AppbrowseParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.BrowseResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.namespace - Bucket name
-     * @param {number} arg.companyId - Company_id
-     * @param {number} arg.applicationId - Application_id
-     * @returns {Paginator<FileStoragePlatformModel.BrowseResponse>}
-     * @summary: Browse Files
-     * @description: Browse Files
+     * @param {FileStoragePlatformApplicationValidator.GetDefaultHtmlTemplateParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<FileStoragePlatformModel.PdfConfigSuccess[]>} - Success response
+     * @name getDefaultHtmlTemplate
+     * @summary: Get html template for sales channel
+     * @description: Get default html template for invoice or label - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getDefaultHtmlTemplate/).
+     */
+    getDefaultHtmlTemplate({ pdfTypeId, format, requestHeaders }?: FileStoragePlatformApplicationValidator.GetDefaultHtmlTemplateParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.PdfConfigSuccess[]>;
+    /**
+     * @param {FileStoragePlatformApplicationValidator.GetDefaultPdfDataParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<FileStoragePlatformModel.DummyTemplateDataItems[]>} -
+     *   Success response
+     * @name getDefaultPdfData
+     * @summary: Get Dummy pdf data for invoice or label
+     * @description: Get Dummy pdf data for invoice or label - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getDefaultPdfData/).
+     */
+    getDefaultPdfData({ pdfTypeId, requestHeaders }?: FileStoragePlatformApplicationValidator.GetDefaultPdfDataParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.DummyTemplateDataItems[]>;
+    /**
+     * @param {FileStoragePlatformApplicationValidator.GetDefaultPdfTemplateParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<
+     *   FileStoragePlatformModel.PdfDefaultTemplateSuccess[]
+     * >}
+     *   - Success response
+     *
+     * @name getDefaultPdfTemplate
+     * @summary: Default html template
+     * @description: Get default html template data for invoice or label - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getDefaultPdfTemplate/).
+     */
+    getDefaultPdfTemplate({ pdfTypeId, format, requestHeaders }?: FileStoragePlatformApplicationValidator.GetDefaultPdfTemplateParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.PdfDefaultTemplateSuccess[]>;
+    /**
+     * @param {FileStoragePlatformApplicationValidator.GetPdfTypesParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<FileStoragePlatformModel.InvoiceTypesResponse[]>} -
+     *   Success response
+     * @name getPdfTypes
+     * @summary: Get all the supported invoice pdf types
+     * @description: Get all the supported invoice pdf types such as Invoice, Label, Deliver challan - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getPdfTypes/).
+     */
+    getPdfTypes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<FileStoragePlatformModel.InvoiceTypesResponse[]>;
+    /**
+     * @param {FileStoragePlatformApplicationValidator.PreviewTemplateParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<string>} - Success response
+     * @name previewTemplate
+     * @summary: Preview HTML template
+     * @description: Rendered HTML template with dummy json data - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/previewTemplate/).
+     */
+    previewTemplate({ body, requestHeaders }?: FileStoragePlatformApplicationValidator.PreviewTemplateParam, { responseHeaders }?: object): Promise<string>;
+    /**
+     * @param {FileStoragePlatformApplicationValidator.SaveHtmlTemplateParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<FileStoragePlatformModel.PdfConfigSaveSuccess[]>} -
+     *   Success response
+     * @name saveHtmlTemplate
+     * @summary: Update html template for invoice or label
+     * @description: Update html template for invoice such as Invoice, Label, Deliver challan - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/saveHtmlTemplate/).
      */
-    appbrowsePaginator({ namespace, companyId, applicationId }?: {
-        namespace: string;
-        companyId: number;
-        applicationId: number;
-    }): Paginator<FileStoragePlatformModel.BrowseResponse>;
+    saveHtmlTemplate({ body, requestHeaders }?: FileStoragePlatformApplicationValidator.SaveHtmlTemplateParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.PdfConfigSaveSuccess[]>;
     /**
      * @param data
      * @param {string} file_name
@@ -112,4 +179,3 @@ declare class FileStorage {
 }
 import FileStoragePlatformApplicationValidator = require("./FileStoragePlatformApplicationValidator");
 import FileStoragePlatformModel = require("./FileStoragePlatformModel");
-import Paginator = require("../../common/Paginator");