@gofynd/fdk-client-javascript 3.1.0-beta.1 → 3.2.0

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

@@ -5,12 +5,7 @@ export = FileStoragePlatformApplicationValidator;
  *   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
+ * @property {FileStoragePlatformModel.FileUpload} body
  */
 /**
  * @typedef AppStartUploadParam
@@ -18,7 +13,7 @@ export = FileStoragePlatformApplicationValidator;
  *   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
+ * @property {FileStoragePlatformModel.FileUploadStart} body
  */
 /**
  * @typedef AppbrowseParam
@@ -41,99 +36,18 @@ export = FileStoragePlatformApplicationValidator;
  * @property {string} [search] - Search
  * @property {FileStoragePlatformModel.ExtensionSlug} body
  */
-/**
- * @typedef DeletePdfGeneratorConfigParam
- * @property {string} id
- */
-/**
- * @typedef FetchPdfDefaultTemplateByIdParam
- * @property {string} id
- */
-/**
- * @typedef FetchPdfTypeByIdParam
- * @property {string} id
- */
-/**
- * @typedef GeneratePaymentReceiptParam
- * @property {FileStoragePlatformModel.PaymentReceiptRequestBody} body
- */
-/**
- * @typedef GetConfigHtmlTemplateByIdParam
- * @property {string} id
- */
-/**
- * @typedef GetDefaultPdfDataParam
- * @property {number} pdfTypeId
- * @property {string} [countryCode]
- */
-/**
- * @typedef GetDefaultPdfTemplateParam
- * @property {number} pdfTypeId
- * @property {string} format
- * @property {string} [countryCode]
- */
-/**
- * @typedef GetHtmlTemplateConfigParam
- * @property {number} pdfTypeId
- * @property {string} format
- * @property {string} [countryCode]
- */
-/**
- * @typedef GetPdfPayloadByIdParam
- * @property {string} id
- */
-/**
- * @typedef GetPdfTypesParam
- * @property {string} [countryCode]
- * @property {boolean} storeOs
- */
-/**
- * @typedef SaveHtmlTemplateParam
- * @property {FileStoragePlatformModel.PdfConfig} body
- */
-/**
- * @typedef UpdateHtmlTemplateParam
- * @property {string} id
- * @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 {BrowsefilesParam} */
     static browsefiles(): BrowsefilesParam;
-    /** @returns {DeletePdfGeneratorConfigParam} */
-    static deletePdfGeneratorConfig(): DeletePdfGeneratorConfigParam;
-    /** @returns {FetchPdfDefaultTemplateByIdParam} */
-    static fetchPdfDefaultTemplateById(): FetchPdfDefaultTemplateByIdParam;
-    /** @returns {FetchPdfTypeByIdParam} */
-    static fetchPdfTypeById(): FetchPdfTypeByIdParam;
-    /** @returns {GeneratePaymentReceiptParam} */
-    static generatePaymentReceipt(): GeneratePaymentReceiptParam;
-    /** @returns {GetConfigHtmlTemplateByIdParam} */
-    static getConfigHtmlTemplateById(): GetConfigHtmlTemplateByIdParam;
-    /** @returns {GetDefaultPdfDataParam} */
-    static getDefaultPdfData(): GetDefaultPdfDataParam;
-    /** @returns {GetDefaultPdfTemplateParam} */
-    static getDefaultPdfTemplate(): GetDefaultPdfTemplateParam;
-    /** @returns {GetHtmlTemplateConfigParam} */
-    static getHtmlTemplateConfig(): GetHtmlTemplateConfigParam;
-    /** @returns {GetPdfPayloadByIdParam} */
-    static getPdfPayloadById(): GetPdfPayloadByIdParam;
-    /** @returns {GetPdfTypesParam} */
-    static getPdfTypes(): GetPdfTypesParam;
-    /** @returns {SaveHtmlTemplateParam} */
-    static saveHtmlTemplate(): SaveHtmlTemplateParam;
-    /** @returns {UpdateHtmlTemplateParam} */
-    static updateHtmlTemplate(): UpdateHtmlTemplateParam;
 }
 declare namespace FileStoragePlatformApplicationValidator {
-    export { AppCompleteUploadParam, AppCopyFilesParam, AppStartUploadParam, AppbrowseParam, BrowsefilesParam, DeletePdfGeneratorConfigParam, FetchPdfDefaultTemplateByIdParam, FetchPdfTypeByIdParam, GeneratePaymentReceiptParam, GetConfigHtmlTemplateByIdParam, GetDefaultPdfDataParam, GetDefaultPdfTemplateParam, GetHtmlTemplateConfigParam, GetPdfPayloadByIdParam, GetPdfTypesParam, SaveHtmlTemplateParam, UpdateHtmlTemplateParam };
+    export { AppCompleteUploadParam, AppStartUploadParam, AppbrowseParam, BrowsefilesParam };
 }
 type AppCompleteUploadParam = {
     /**
@@ -143,14 +57,7 @@ type AppCompleteUploadParam = {
      * inside the storage bucket.
      */
     namespace: string;
-    body: FileStoragePlatformModel.StartResponse;
-};
-type AppCopyFilesParam = {
-    /**
-     * - Sync
-     */
-    sync?: boolean;
-    body: FileStoragePlatformModel.CopyFiles;
+    body: FileStoragePlatformModel.FileUpload;
 };
 type AppStartUploadParam = {
     /**
@@ -160,7 +67,7 @@ type AppStartUploadParam = {
      * inside the storage bucket.
      */
     namespace: string;
-    body: FileStoragePlatformModel.StartRequest;
+    body: FileStoragePlatformModel.FileUploadStart;
 };
 type AppbrowseParam = {
     /**
@@ -205,47 +112,4 @@ type BrowsefilesParam = {
     search?: string;
     body: FileStoragePlatformModel.ExtensionSlug;
 };
-type DeletePdfGeneratorConfigParam = {
-    id: string;
-};
-type FetchPdfDefaultTemplateByIdParam = {
-    id: string;
-};
-type FetchPdfTypeByIdParam = {
-    id: string;
-};
-type GeneratePaymentReceiptParam = {
-    body: FileStoragePlatformModel.PaymentReceiptRequestBody;
-};
-type GetConfigHtmlTemplateByIdParam = {
-    id: string;
-};
-type GetDefaultPdfDataParam = {
-    pdfTypeId: number;
-    countryCode?: string;
-};
-type GetDefaultPdfTemplateParam = {
-    pdfTypeId: number;
-    format: string;
-    countryCode?: string;
-};
-type GetHtmlTemplateConfigParam = {
-    pdfTypeId: number;
-    format: string;
-    countryCode?: string;
-};
-type GetPdfPayloadByIdParam = {
-    id: string;
-};
-type GetPdfTypesParam = {
-    countryCode?: string;
-    storeOs: boolean;
-};
-type SaveHtmlTemplateParam = {
-    body: FileStoragePlatformModel.PdfConfig;
-};
-type UpdateHtmlTemplateParam = {
-    id: string;
-    body: FileStoragePlatformModel.PdfConfig;
-};
 import FileStoragePlatformModel = require("./FileStoragePlatformModel");

package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js

@@ -8,13 +8,7 @@ const FileStoragePlatformModel = require("./FileStoragePlatformModel");
  *   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
+ * @property {FileStoragePlatformModel.FileUpload} body
  */
 
 /**
@@ -23,7 +17,7 @@ const FileStoragePlatformModel = require("./FileStoragePlatformModel");
  *   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
+ * @property {FileStoragePlatformModel.FileUploadStart} body
  */
 
 /**
@@ -49,89 +43,13 @@ const FileStoragePlatformModel = require("./FileStoragePlatformModel");
  * @property {FileStoragePlatformModel.ExtensionSlug} body
  */
 
-/**
- * @typedef DeletePdfGeneratorConfigParam
- * @property {string} id
- */
-
-/**
- * @typedef FetchPdfDefaultTemplateByIdParam
- * @property {string} id
- */
-
-/**
- * @typedef FetchPdfTypeByIdParam
- * @property {string} id
- */
-
-/**
- * @typedef GeneratePaymentReceiptParam
- * @property {FileStoragePlatformModel.PaymentReceiptRequestBody} body
- */
-
-/**
- * @typedef GetConfigHtmlTemplateByIdParam
- * @property {string} id
- */
-
-/**
- * @typedef GetDefaultPdfDataParam
- * @property {number} pdfTypeId
- * @property {string} [countryCode]
- */
-
-/**
- * @typedef GetDefaultPdfTemplateParam
- * @property {number} pdfTypeId
- * @property {string} format
- * @property {string} [countryCode]
- */
-
-/**
- * @typedef GetHtmlTemplateConfigParam
- * @property {number} pdfTypeId
- * @property {string} format
- * @property {string} [countryCode]
- */
-
-/**
- * @typedef GetPdfPayloadByIdParam
- * @property {string} id
- */
-
-/**
- * @typedef GetPdfTypesParam
- * @property {string} [countryCode]
- * @property {boolean} storeOs
- */
-
-/**
- * @typedef SaveHtmlTemplateParam
- * @property {FileStoragePlatformModel.PdfConfig} body
- */
-
-/**
- * @typedef UpdateHtmlTemplateParam
- * @property {string} id
- * @property {FileStoragePlatformModel.PdfConfig} body
- */
-
 class FileStoragePlatformApplicationValidator {
   /** @returns {AppCompleteUploadParam} */
   static appCompleteUpload() {
     return Joi.object({
       namespace: Joi.string().allow("").required(),
 
-      body: FileStoragePlatformModel.StartResponse().required(),
-    }).required();
-  }
-
-  /** @returns {AppCopyFilesParam} */
-  static appCopyFiles() {
-    return Joi.object({
-      sync: Joi.boolean(),
-
-      body: FileStoragePlatformModel.CopyFiles().required(),
+      body: FileStoragePlatformModel.FileUpload().required(),
     }).required();
   }
 
@@ -140,7 +58,7 @@ class FileStoragePlatformApplicationValidator {
     return Joi.object({
       namespace: Joi.string().allow("").required(),
 
-      body: FileStoragePlatformModel.StartRequest().required(),
+      body: FileStoragePlatformModel.FileUploadStart().required(),
     }).required();
   }
 
@@ -166,97 +84,6 @@ class FileStoragePlatformApplicationValidator {
       body: FileStoragePlatformModel.ExtensionSlug().required(),
     }).required();
   }
-
-  /** @returns {DeletePdfGeneratorConfigParam} */
-  static deletePdfGeneratorConfig() {
-    return Joi.object({
-      id: Joi.string().allow("").required(),
-    }).required();
-  }
-
-  /** @returns {FetchPdfDefaultTemplateByIdParam} */
-  static fetchPdfDefaultTemplateById() {
-    return Joi.object({
-      id: Joi.string().allow("").required(),
-    }).required();
-  }
-
-  /** @returns {FetchPdfTypeByIdParam} */
-  static fetchPdfTypeById() {
-    return Joi.object({
-      id: Joi.string().allow("").required(),
-    }).required();
-  }
-
-  /** @returns {GeneratePaymentReceiptParam} */
-  static generatePaymentReceipt() {
-    return Joi.object({
-      body: FileStoragePlatformModel.PaymentReceiptRequestBody().required(),
-    }).required();
-  }
-
-  /** @returns {GetConfigHtmlTemplateByIdParam} */
-  static getConfigHtmlTemplateById() {
-    return Joi.object({
-      id: Joi.string().allow("").required(),
-    }).required();
-  }
-
-  /** @returns {GetDefaultPdfDataParam} */
-  static getDefaultPdfData() {
-    return Joi.object({
-      pdfTypeId: Joi.number().required(),
-      countryCode: Joi.string().allow(""),
-    }).required();
-  }
-
-  /** @returns {GetDefaultPdfTemplateParam} */
-  static getDefaultPdfTemplate() {
-    return Joi.object({
-      pdfTypeId: Joi.number().required(),
-      format: Joi.string().allow("").required(),
-      countryCode: Joi.string().allow(""),
-    }).required();
-  }
-
-  /** @returns {GetHtmlTemplateConfigParam} */
-  static getHtmlTemplateConfig() {
-    return Joi.object({
-      pdfTypeId: Joi.number().required(),
-      format: Joi.string().allow("").required(),
-      countryCode: Joi.string().allow(""),
-    }).required();
-  }
-
-  /** @returns {GetPdfPayloadByIdParam} */
-  static getPdfPayloadById() {
-    return Joi.object({
-      id: Joi.string().allow("").required(),
-    }).required();
-  }
-
-  /** @returns {GetPdfTypesParam} */
-  static getPdfTypes() {
-    return Joi.object({
-      countryCode: Joi.string().allow(""),
-      storeOs: Joi.boolean().required(),
-    }).required();
-  }
-
-  /** @returns {SaveHtmlTemplateParam} */
-  static saveHtmlTemplate() {
-    return Joi.object({
-      body: FileStoragePlatformModel.PdfConfig().required(),
-    }).required();
-  }
-
-  /** @returns {UpdateHtmlTemplateParam} */
-  static updateHtmlTemplate() {
-    return Joi.object({
-      id: Joi.string().allow("").required(),
-      body: FileStoragePlatformModel.PdfConfig().required(),
-    }).required();
-  }
 }
 
 module.exports = FileStoragePlatformApplicationValidator;

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

@@ -16,12 +16,12 @@ declare class FileStorage {
      * @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
+     * @returns {Promise<FileStoragePlatformModel.FileUploadComplete>} - Success response
      * @name completeUpload
      * @summary: Complete file upload.
      * @description: Starts the process of uploading a file to storage location, and returns a storage link in response. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/completeUpload/).
      */
-    completeUpload({ namespace, body, requestHeaders }?: FileStoragePlatformValidator.CompleteUploadParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.CompleteResponse>;
+    completeUpload({ namespace, body, requestHeaders }?: FileStoragePlatformValidator.CompleteUploadParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.FileUploadComplete>;
     /**
      * @param {FileStoragePlatformValidator.CopyFilesParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -36,32 +36,32 @@ declare class FileStorage {
      * @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
+     * @returns {Promise<FileStoragePlatformModel.SignUrlResult>} - Success response
      * @name getSignUrls
      * @summary: Get signed URLs.
      * @description: Retrieve signed URLs for file access. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getSignUrls/).
      */
-    getSignUrls({ body, requestHeaders }?: FileStoragePlatformValidator.GetSignUrlsParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.SignUrlResponse>;
+    getSignUrls({ body, requestHeaders }?: FileStoragePlatformValidator.GetSignUrlsParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.SignUrlResult>;
     /**
      * @param {FileStoragePlatformValidator.ProxyParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<FileStoragePlatformModel.ProxyResponse>} - Success response
+     * @returns {Promise<FileStoragePlatformModel.ProxyFileAccess>} - Success response
      * @name proxy
      * @summary: Proxy file access.
      * @description: Access files through a proxy. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/proxy/).
      */
-    proxy({ url, requestHeaders }?: FileStoragePlatformValidator.ProxyParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.ProxyResponse>;
+    proxy({ url, requestHeaders }?: FileStoragePlatformValidator.ProxyParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.ProxyFileAccess>;
     /**
      * @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
+     * @returns {Promise<FileStoragePlatformModel.FileUpload>} - Success response
      * @name startUpload
      * @summary: Start file upload.
      * @description: Inititates the process of uploading a file to storage location, and returns a storage link in response. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/startUpload/).
      */
-    startUpload({ namespace, body, requestHeaders }?: FileStoragePlatformValidator.StartUploadParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.StartResponse>;
+    startUpload({ namespace, body, requestHeaders }?: FileStoragePlatformValidator.StartUploadParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.FileUpload>;
     /**
      * @param data
      * @param {string} file_name

package/sdk/platform/FileStorage/FileStoragePlatformClient.js

@@ -103,7 +103,7 @@ class FileStorage {
    * @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
+   * @returns {Promise<FileStoragePlatformModel.FileUploadComplete>} - Success response
    * @name completeUpload
    * @summary: Complete file upload.
    * @description: Starts the process of uploading a file to storage location, and returns a storage link in response. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/completeUpload/).
@@ -163,7 +163,7 @@ class FileStorage {
 
     const {
       error: res_error,
-    } = FileStoragePlatformModel.CompleteResponse().validate(responseData, {
+    } = FileStoragePlatformModel.FileUploadComplete().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -266,7 +266,7 @@ class FileStorage {
    * @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
+   * @returns {Promise<FileStoragePlatformModel.SignUrlResult>} - Success response
    * @name getSignUrls
    * @summary: Get signed URLs.
    * @description: Retrieve signed URLs for file access. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getSignUrls/).
@@ -322,7 +322,7 @@ class FileStorage {
 
     const {
       error: res_error,
-    } = FileStoragePlatformModel.SignUrlResponse().validate(responseData, {
+    } = FileStoragePlatformModel.SignUrlResult().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -345,7 +345,7 @@ class FileStorage {
    * @param {FileStoragePlatformValidator.ProxyParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<FileStoragePlatformModel.ProxyResponse>} - Success response
+   * @returns {Promise<FileStoragePlatformModel.ProxyFileAccess>} - Success response
    * @name proxy
    * @summary: Proxy file access.
    * @description: Access files through a proxy. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/proxy/).
@@ -400,7 +400,7 @@ class FileStorage {
 
     const {
       error: res_error,
-    } = FileStoragePlatformModel.ProxyResponse().validate(responseData, {
+    } = FileStoragePlatformModel.ProxyFileAccess().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -423,7 +423,7 @@ class FileStorage {
    * @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
+   * @returns {Promise<FileStoragePlatformModel.FileUpload>} - Success response
    * @name startUpload
    * @summary: Start file upload.
    * @description: Inititates the process of uploading a file to storage location, and returns a storage link in response. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/startUpload/).
@@ -483,7 +483,7 @@ class FileStorage {
 
     const {
       error: res_error,
-    } = FileStoragePlatformModel.StartResponse().validate(responseData, {
+    } = FileStoragePlatformModel.FileUpload().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });