@gofynd/fdk-client-javascript 1.4.13 → 1.4.14

package/sdk/platform/FileStorage/FileStoragePlatformModel.js

@@ -1,13 +1,96 @@
 const Joi = require("joi");
 
 /**
- * @typedef ProxyResponse
- * @property {Object} [data]
- * @property {Object} [support]
+ * @typedef UpdatePdfType
+ * @property {number} [pdf_type_id]
+ * @property {string} [name]
+ * @property {string[]} [format]
+ * @property {boolean} [visibility]
+ * @property {Object} [schema]
+ * @property {boolean} [store_os]
+ * @property {string} [country_code]
+ */
+
+/**
+ * @typedef PdfTypeByIdDetails
+ * @property {boolean} [store_os]
+ * @property {string} [country_code]
+ * @property {number} [pdf_type_id]
+ * @property {number} [__v]
+ * @property {string} [_id]
+ * @property {string[]} [format]
+ * @property {string} [name]
+ * @property {boolean} [visibility]
+ */
+
+/**
+ * @typedef PdfConfigurationData
+ * @property {string} [_id]
+ * @property {number} [pdf_type_id]
+ * @property {string} [format]
+ * @property {string} [template]
+ * @property {string} [country_code]
+ * @property {number} [__v]
+ */
+
+/**
+ * @typedef UpdatedDefaultTemplateById
+ * @property {PdfConfigurationData} [data]
+ * @property {boolean} [success]
+ */
+
+/**
+ * @typedef UpdateTemplate
+ * @property {number} [pdf_type_id]
+ * @property {string} [format] - This is invoice document format such as A4, A6, POS, A5
+ * @property {string} [country_code] - This is iso code of a country
+ * @property {string} [template] - This is html template string
+ * @property {boolean} [store_os] - This flag is to identify store-os
+ */
+
+/**
+ * @typedef PdfDefaultTemplateById
+ * @property {string} [_id] - The ID of the PDF default template
+ * @property {string} [country_code] - The country code associated with the template
+ * @property {string} [format] - The format of the template (e.g., "A4")
+ * @property {number} [pdf_type_id] - The ID of the PDF type
+ * @property {number} [__v] - Version number
+ * @property {string} [template] - The HTML template content
  */
 
 /**
- * @typedef FailedResponse
+ * @typedef PdfTemplateCreateSuccess
+ * @property {number} [code]
+ * @property {boolean} [success]
+ * @property {PdfTemplateCreateSuccessData} [data]
+ */
+
+/**
+ * @typedef PdfTemplateCreateSuccessData
+ * @property {string} [_id]
+ * @property {number} [pdf_type_id]
+ * @property {string} [format]
+ * @property {string} [template]
+ * @property {string} [country_code]
+ * @property {number} [__v]
+ */
+
+/**
+ * @typedef CreateTemplate
+ * @property {number} pdf_type_id
+ * @property {string} format - This is invoice document format such as A4, A6, POS, A5
+ * @property {string} country_code - This is iso code of a country
+ * @property {string} [template] - This is html template string
+ */
+
+/**
+ * @typedef PdfDefaultTemplateSuccess
+ * @property {Document[]} [data]
+ * @property {boolean} [success] - Indicates if the request was successful.
+ */
+
+/**
+ * @typedef FailedBrowseFilesResult
  * @property {string} message
  */
 
@@ -25,7 +108,7 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef StartResponse
+ * @typedef FileUpload
  * @property {string} file_name
  * @property {string} file_path
  * @property {string} content_type
@@ -34,17 +117,11 @@ const Joi = require("joi");
  * @property {string} operation
  * @property {number} size
  * @property {Upload} upload
- * @property {CDN} cdn
  * @property {string[]} [tags]
  */
 
 /**
- * @typedef Params
- * @property {string} [subpath] - The subpath for the file.
- */
-
-/**
- * @typedef StartRequest
+ * @typedef FileUploadStart
  * @property {string} file_name
  * @property {string} content_type
  * @property {number} size
@@ -58,7 +135,7 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef CompleteResponse
+ * @typedef FileUploadComplete
  * @property {string} _id
  * @property {string} file_name
  * @property {string} file_path
@@ -76,6 +153,12 @@ const Joi = require("joi");
  * @property {CreatedBy} [created_by]
  */
 
+/**
+ * @typedef ProxyFileAccess
+ * @property {Object} [data]
+ * @property {Object} [support]
+ */
+
 /**
  * @typedef DestinationNamespace
  * @property {string} [namespace]
@@ -95,18 +178,18 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef SignUrlResponse
+ * @typedef SignUrlResult
  * @property {Urls[]} urls
  */
 
 /**
- * @typedef SignUrlRequest
+ * @typedef SignUrl
  * @property {number} expiry
  * @property {string[]} urls
  */
 
 /**
- * @typedef InvoiceTypesDataResponse
+ * @typedef InvoiceTypesData
  * @property {boolean} [status]
  * @property {string} _id
  * @property {number} pdf_type_id
@@ -114,12 +197,13 @@ const Joi = require("joi");
  * @property {string[]} format
  * @property {number} __v
  * @property {boolean} visibility
+ * @property {boolean} store_os
  * @property {string} country_code
  */
 
 /**
- * @typedef InvoiceTypesResponse
- * @property {InvoiceTypesDataResponse[]} data
+ * @typedef InvoiceTypes
+ * @property {InvoiceTypesData[]} data
  * @property {boolean} success
  */
 
@@ -432,7 +516,7 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef DummyTemplateDataPayload
+ * @typedef PdfPayloadDetails
  * @property {boolean} [is_export]
  * @property {boolean} [is_export_shipment]
  * @property {string} [app_domain_name]
@@ -466,8 +550,6 @@ const Joi = require("joi");
  * @property {boolean} [is_self_ship]
  * @property {string} [mode]
  * @property {boolean} [is_self_pickup]
- * @property {Object} [shipment_meta] - This field represents the shipment meta details
- * @property {Object} [order_meta] - This field represents the order meta details
  * @property {string} [platform_name]
  * @property {number} [amount_to_be_collected]
  * @property {number} [amount_paid]
@@ -487,13 +569,29 @@ const Joi = require("joi");
  * @property {string} [_id] - This field contains the unique identifier for the
  *   PDF payload.
  * @property {number} [pdf_type_id] - This is invoice unique id
- * @property {DummyTemplateDataPayload} payload
+ * @property {PdfPayloadDetails} payload
  * @property {string} [country_code] - This field represents the country code.
+ * @property {number} [__v]
+ */
+
+/**
+ * @typedef savePdfPayload
+ * @property {number} [pdf_type_id]
+ * @property {PdfPayloadDetails} [payload]
+ * @property {string} [country_code]
+ */
+
+/**
+ * @typedef MapperDetails
+ * @property {string} [_id]
+ * @property {number} [pdf_type_id]
+ * @property {PdfPayloadDetails} [payload]
+ * @property {string} [country_code]
  * @property {number} [__v] - This field holds the version number.
  */
 
 /**
- * @typedef DummyTemplateDataItems
+ * @typedef PdfDataItemsDetails
  * @property {DummyTemplateData[]} data
  * @property {boolean} success
  */
@@ -501,22 +599,37 @@ const Joi = require("joi");
 /**
  * @typedef PdfConfig
  * @property {string} [format] - This is invoice document format such as A4, A6, POS
- * @property {string} [template] - This is html template string
- * @property {number} [pdf_type_id]
+ * @property {string} [template] - This is html template string.
+ * @property {number} [pdf_type_id] - This field holds an identifier for the type of PDF.
+ * @property {string} [country_code] - This field contains the country code.
+ * @property {boolean} [default_template] - This field indicates whether the
+ *   fetched HTML template is the default template.
  */
 
 /**
  * @typedef PdfConfigSuccessData
- * @property {string} [_id]
- * @property {number} [company_id]
- * @property {string} [application_id]
- * @property {number} [pdf_type_id]
- * @property {string} [format]
- * @property {string} [template]
- * @property {number} [__v]
+ * @property {string} [_id] - This field contains the unique identifier for the
+ *   PDF configuration.
+ * @property {number} [company_id] - This field holds the identifier for the
+ *   company associated with the PDF configuration.
+ * @property {string} [application_id] - This field contains the identifier for
+ *   the application that uses this PDF configuration.
+ * @property {number} [pdf_type_id] - This field holds an identifier for the type of PDF.
+ * @property {string} [format] - This field specifies the format of the invoice document.
+ * @property {string} [template] - This field contains the HTML template string
+ *   for the PDF document.
+ * @property {number} [__v] - This field holds the version number of the PDF
+ *   configuration document.
  * @property {string} [country_code]
  */
 
+/**
+ * @typedef DeleteMapperById
+ * @property {string} [message] - This field represents the country code.
+ * @property {boolean} [default_template] - This field indicates whether the
+ *   HTML template is the default template.
+ */
+
 /**
  * @typedef PdfConfigSuccess
  * @property {PdfConfigSuccessData[]} [data]
@@ -540,12 +653,6 @@ const Joi = require("joi");
  * @property {boolean} [success]
  */
 
-/**
- * @typedef PdfDefaultTemplateSuccess
- * @property {Document[]} [data]
- * @property {boolean} [success] - Indicates if the request was successful.
- */
-
 /**
  * @typedef Document
  * @property {string} [_id]
@@ -636,16 +743,117 @@ const Joi = require("joi");
  */
 
 class FileStoragePlatformModel {
-  /** @returns {ProxyResponse} */
-  static ProxyResponse() {
+  /** @returns {UpdatePdfType} */
+  static UpdatePdfType() {
     return Joi.object({
-      data: Joi.object().pattern(/\S/, Joi.any()),
-      support: Joi.object().pattern(/\S/, Joi.any()),
+      pdf_type_id: Joi.number(),
+      name: Joi.string().allow(""),
+      format: Joi.array().items(Joi.string().allow("")),
+      visibility: Joi.boolean(),
+      schema: Joi.object().pattern(/\S/, Joi.any()),
+      store_os: Joi.boolean(),
+      country_code: Joi.string().allow(""),
     });
   }
 
-  /** @returns {FailedResponse} */
-  static FailedResponse() {
+  /** @returns {PdfTypeByIdDetails} */
+  static PdfTypeByIdDetails() {
+    return Joi.object({
+      store_os: Joi.boolean(),
+      country_code: Joi.string().allow(""),
+      pdf_type_id: Joi.number(),
+      __v: Joi.number(),
+      _id: Joi.string().allow(""),
+      format: Joi.array().items(Joi.string().allow("")),
+      name: Joi.string().allow(""),
+      visibility: Joi.boolean(),
+    });
+  }
+
+  /** @returns {PdfConfigurationData} */
+  static PdfConfigurationData() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+      pdf_type_id: Joi.number(),
+      format: Joi.string().allow(""),
+      template: Joi.string().allow(""),
+      country_code: Joi.string().allow(""),
+      __v: Joi.number(),
+    });
+  }
+
+  /** @returns {UpdatedDefaultTemplateById} */
+  static UpdatedDefaultTemplateById() {
+    return Joi.object({
+      data: FileStoragePlatformModel.PdfConfigurationData(),
+      success: Joi.boolean(),
+    });
+  }
+
+  /** @returns {UpdateTemplate} */
+  static UpdateTemplate() {
+    return Joi.object({
+      pdf_type_id: Joi.number(),
+      format: Joi.string().allow(""),
+      country_code: Joi.string().allow(""),
+      template: Joi.string().allow(""),
+      store_os: Joi.boolean(),
+    });
+  }
+
+  /** @returns {PdfDefaultTemplateById} */
+  static PdfDefaultTemplateById() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+      country_code: Joi.string().allow(""),
+      format: Joi.string().allow(""),
+      pdf_type_id: Joi.number(),
+      __v: Joi.number(),
+      template: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {PdfTemplateCreateSuccess} */
+  static PdfTemplateCreateSuccess() {
+    return Joi.object({
+      code: Joi.number(),
+      success: Joi.boolean(),
+      data: FileStoragePlatformModel.PdfTemplateCreateSuccessData(),
+    });
+  }
+
+  /** @returns {PdfTemplateCreateSuccessData} */
+  static PdfTemplateCreateSuccessData() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+      pdf_type_id: Joi.number(),
+      format: Joi.string().allow(""),
+      template: Joi.string().allow(""),
+      country_code: Joi.string().allow(""),
+      __v: Joi.number(),
+    });
+  }
+
+  /** @returns {CreateTemplate} */
+  static CreateTemplate() {
+    return Joi.object({
+      pdf_type_id: Joi.number().required(),
+      format: Joi.string().allow("").required(),
+      country_code: Joi.string().allow("").required(),
+      template: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {PdfDefaultTemplateSuccess} */
+  static PdfDefaultTemplateSuccess() {
+    return Joi.object({
+      data: Joi.array().items(FileStoragePlatformModel.Document()),
+      success: Joi.boolean(),
+    });
+  }
+
+  /** @returns {FailedBrowseFilesResult} */
+  static FailedBrowseFilesResult() {
     return Joi.object({
       message: Joi.string().allow("").required(),
     });
@@ -668,8 +876,8 @@ class FileStoragePlatformModel {
     });
   }
 
-  /** @returns {StartResponse} */
-  static StartResponse() {
+  /** @returns {FileUpload} */
+  static FileUpload() {
     return Joi.object({
       file_name: Joi.string().allow("").required(),
       file_path: Joi.string().allow("").required(),
@@ -679,20 +887,12 @@ class FileStoragePlatformModel {
       operation: Joi.string().allow("").required(),
       size: Joi.number().required(),
       upload: FileStoragePlatformModel.Upload().required(),
-      cdn: FileStoragePlatformModel.CDN().required(),
       tags: Joi.array().items(Joi.string().allow("")),
     });
   }
 
-  /** @returns {Params} */
-  static Params() {
-    return Joi.object({
-      subpath: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {StartRequest} */
-  static StartRequest() {
+  /** @returns {FileUploadStart} */
+  static FileUploadStart() {
     return Joi.object({
       file_name: Joi.string().allow("").required(),
       content_type: Joi.string().allow("").required(),
@@ -709,8 +909,8 @@ class FileStoragePlatformModel {
     });
   }
 
-  /** @returns {CompleteResponse} */
-  static CompleteResponse() {
+  /** @returns {FileUploadComplete} */
+  static FileUploadComplete() {
     return Joi.object({
       _id: Joi.string().allow("").required(),
       file_name: Joi.string().allow("").required(),
@@ -730,6 +930,14 @@ class FileStoragePlatformModel {
     });
   }
 
+  /** @returns {ProxyFileAccess} */
+  static ProxyFileAccess() {
+    return Joi.object({
+      data: Joi.object().pattern(/\S/, Joi.any()),
+      support: Joi.object().pattern(/\S/, Joi.any()),
+    });
+  }
+
   /** @returns {DestinationNamespace} */
   static DestinationNamespace() {
     return Joi.object({
@@ -754,23 +962,23 @@ class FileStoragePlatformModel {
     });
   }
 
-  /** @returns {SignUrlResponse} */
-  static SignUrlResponse() {
+  /** @returns {SignUrlResult} */
+  static SignUrlResult() {
     return Joi.object({
       urls: Joi.array().items(FileStoragePlatformModel.Urls()).required(),
     });
   }
 
-  /** @returns {SignUrlRequest} */
-  static SignUrlRequest() {
+  /** @returns {SignUrl} */
+  static SignUrl() {
     return Joi.object({
       expiry: Joi.number().required(),
       urls: Joi.array().items(Joi.string().allow("")).required(),
     });
   }
 
-  /** @returns {InvoiceTypesDataResponse} */
-  static InvoiceTypesDataResponse() {
+  /** @returns {InvoiceTypesData} */
+  static InvoiceTypesData() {
     return Joi.object({
       status: Joi.boolean(),
       _id: Joi.string().allow("").required(),
@@ -779,15 +987,16 @@ class FileStoragePlatformModel {
       format: Joi.array().items(Joi.string().allow("")).required(),
       __v: Joi.number().required(),
       visibility: Joi.boolean().required(),
+      store_os: Joi.boolean().required(),
       country_code: Joi.string().allow("").required(),
     });
   }
 
-  /** @returns {InvoiceTypesResponse} */
-  static InvoiceTypesResponse() {
+  /** @returns {InvoiceTypes} */
+  static InvoiceTypes() {
     return Joi.object({
       data: Joi.array()
-        .items(FileStoragePlatformModel.InvoiceTypesDataResponse())
+        .items(FileStoragePlatformModel.InvoiceTypesData())
         .required(),
       success: Joi.boolean().required(),
     });
@@ -1158,8 +1367,8 @@ class FileStoragePlatformModel {
     });
   }
 
-  /** @returns {DummyTemplateDataPayload} */
-  static DummyTemplateDataPayload() {
+  /** @returns {PdfPayloadDetails} */
+  static PdfPayloadDetails() {
     return Joi.object({
       is_export: Joi.boolean(),
       is_export_shipment: Joi.boolean(),
@@ -1194,8 +1403,6 @@ class FileStoragePlatformModel {
       is_self_ship: Joi.boolean(),
       mode: Joi.string().allow(""),
       is_self_pickup: Joi.boolean(),
-      shipment_meta: Joi.object().pattern(/\S/, Joi.any()),
-      order_meta: Joi.object().pattern(/\S/, Joi.any()),
       platform_name: Joi.string().allow(""),
       amount_to_be_collected: Joi.number(),
       amount_paid: Joi.number(),
@@ -1216,14 +1423,34 @@ class FileStoragePlatformModel {
     return Joi.object({
       _id: Joi.string().allow(""),
       pdf_type_id: Joi.number(),
-      payload: FileStoragePlatformModel.DummyTemplateDataPayload().required(),
+      payload: FileStoragePlatformModel.PdfPayloadDetails().required(),
       country_code: Joi.string().allow(""),
       __v: Joi.number(),
     });
   }
 
-  /** @returns {DummyTemplateDataItems} */
-  static DummyTemplateDataItems() {
+  /** @returns {savePdfPayload} */
+  static savePdfPayload() {
+    return Joi.object({
+      pdf_type_id: Joi.number(),
+      payload: FileStoragePlatformModel.PdfPayloadDetails(),
+      country_code: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {MapperDetails} */
+  static MapperDetails() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+      pdf_type_id: Joi.number(),
+      payload: FileStoragePlatformModel.PdfPayloadDetails(),
+      country_code: Joi.string().allow(""),
+      __v: Joi.number(),
+    });
+  }
+
+  /** @returns {PdfDataItemsDetails} */
+  static PdfDataItemsDetails() {
     return Joi.object({
       data: Joi.array()
         .items(FileStoragePlatformModel.DummyTemplateData())
@@ -1238,6 +1465,8 @@ class FileStoragePlatformModel {
       format: Joi.string().allow(""),
       template: Joi.string().allow(""),
       pdf_type_id: Joi.number(),
+      country_code: Joi.string().allow(""),
+      default_template: Joi.boolean(),
     });
   }
 
@@ -1255,6 +1484,14 @@ class FileStoragePlatformModel {
     });
   }
 
+  /** @returns {DeleteMapperById} */
+  static DeleteMapperById() {
+    return Joi.object({
+      message: Joi.string().allow(""),
+      default_template: Joi.boolean(),
+    });
+  }
+
   /** @returns {PdfConfigSuccess} */
   static PdfConfigSuccess() {
     return Joi.object({
@@ -1284,14 +1521,6 @@ class FileStoragePlatformModel {
     });
   }
 
-  /** @returns {PdfDefaultTemplateSuccess} */
-  static PdfDefaultTemplateSuccess() {
-    return Joi.object({
-      data: Joi.array().items(FileStoragePlatformModel.Document()),
-      success: Joi.boolean(),
-    });
-  }
-
   /** @returns {Document} */
   static Document() {
     return Joi.object({
@@ -1385,7 +1614,7 @@ class FileStoragePlatformModel {
     return Joi.object({
       job_type: Joi.string().allow(""),
       action: Joi.string().allow(""),
-      event: Joi.any(),
+      event: Joi.object().pattern(/\S/, Joi.any()),
       organizaton_id: Joi.string().allow(""),
       company_id: Joi.number(),
       application_id: Joi.array().items(Joi.string().allow("")),
@@ -1393,7 +1622,7 @@ class FileStoragePlatformModel {
       trace_id: Joi.array().items(Joi.string().allow("")),
       created_timestamp: Joi.number(),
       service: FileStoragePlatformModel.PaymentReceiptService(),
-      event_trace_info: Joi.any(),
+      event_trace_info: Joi.object().pattern(/\S/, Joi.any()),
       trace: Joi.string().allow(""),
     });
   }

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

@@ -14,7 +14,7 @@ export = FileStoragePlatformValidator;
  *   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
+ * @property {FileStoragePlatformModel.FileUpload} body
  */
 /**
  * @typedef CopyFilesParam
@@ -23,7 +23,7 @@ export = FileStoragePlatformValidator;
  */
 /**
  * @typedef GetSignUrlsParam
- * @property {FileStoragePlatformModel.SignUrlRequest} body
+ * @property {FileStoragePlatformModel.SignUrl} body
  */
 /**
  * @typedef ProxyParam
@@ -35,7 +35,7 @@ export = FileStoragePlatformValidator;
  *   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
  */
 declare class FileStoragePlatformValidator {
     /** @returns {BrowseParam} */
@@ -79,14 +79,14 @@ type CompleteUploadParam = {
      * inside the storage bucket.
      */
     namespace: string;
-    body: FileStoragePlatformModel.StartResponse;
+    body: FileStoragePlatformModel.FileUpload;
 };
 type CopyFilesParam = {
     sync?: boolean;
     body: FileStoragePlatformModel.CopyFiles;
 };
 type GetSignUrlsParam = {
-    body: FileStoragePlatformModel.SignUrlRequest;
+    body: FileStoragePlatformModel.SignUrl;
 };
 type ProxyParam = {
     /**
@@ -102,6 +102,6 @@ type StartUploadParam = {
      * inside the storage bucket.
      */
     namespace: string;
-    body: FileStoragePlatformModel.StartRequest;
+    body: FileStoragePlatformModel.FileUploadStart;
 };
 import FileStoragePlatformModel = require("./FileStoragePlatformModel");