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

package/sdk/platform/Discount/DiscountPlatformValidator.js

@@ -4,12 +4,12 @@ const DiscountPlatformModel = require("./DiscountPlatformModel");
 
 /**
  * @typedef CancelDownloadJobParam
- * @property {string} id - Id
+ * @property {string} id - Unique identifier for the discount
  */
 
 /**
  * @typedef CancelValidationJobParam
- * @property {string} id - Id
+ * @property {string} id - Unique identifier for the discount.
  */
 
 /**
@@ -19,55 +19,65 @@ const DiscountPlatformModel = require("./DiscountPlatformModel");
 
 /**
  * @typedef DownloadDiscountFileParam
- * @property {string} type - Type
+ * @property {string} type - The type of discount file to download, either
+ *   'product' or 'inventory'.
  * @property {DiscountPlatformModel.DownloadFileJob} body
  */
 
 /**
  * @typedef GetDiscountParam
- * @property {string} id - Unique id.
+ * @property {string} id - Unique identifier for the discount.
  */
 
 /**
  * @typedef GetDiscountsParam
- * @property {string} [view] - Listing or calender. Default is listing.
+ * @property {string} [view] - Specifies the format in which the discounts are
+ *   displayed. Options are 'listing' for a list view or 'calendar' for a
+ *   calendar view. Defaults to 'listing'.
  * @property {string} [q] - The search query. This can be a partial or complete
  *   name of a discount.
- * @property {number} [pageNo] - Page number. Default is 1.
- * @property {number} [pageSize] - Page size. Default is 12.
- * @property {boolean} [archived] - Archived. Default is false.
- * @property {number} [month] - Month. Default is current month.
- * @property {number} [year] - Year. Default is current year.
- * @property {string} [type] - Basic or custom.
- * @property {string[]} [appIds] - Application ids.
+ * @property {number} [pageNo] - The page number to navigate through the given
+ *   set of results. Default is 1.
+ * @property {number} [pageSize] - Number of items to retrieve in each page.
+ *   Default is 12.
+ * @property {boolean} [archived] - Indicates whether to include expired
+ *   discounts in the results. Defaults to false.
+ * @property {number} [month] - The month for which discounts is requested.
+ *   Defaults to the current month if not specified.
+ * @property {number} [year] - The year for which discounts is requested.
+ *   Defaults to the current year if not specified.
+ * @property {string} [type] - Specifies the type of disocunt to list, either
+ *   'basic' or 'custom'.
+ * @property {string[]} [appIds] - A `application_id` is a unique identifier for
+ *   a particular sales channel.
  */
 
 /**
  * @typedef GetDownloadJobParam
- * @property {string} id - Id
+ * @property {string} id - Unique identifier for the discount.
  */
 
 /**
  * @typedef GetValidationJobParam
- * @property {string} id - Id
+ * @property {string} id - Unique identifier for the discount.
  */
 
 /**
  * @typedef UpdateDiscountParam
- * @property {string} id - Id
+ * @property {string} id - Unique identifier for the discount.
  * @property {DiscountPlatformModel.CreateUpdateDiscount} body
  */
 
 /**
  * @typedef UpsertDiscountItemsParam
- * @property {string} id - Job ID of the discount.
+ * @property {string} id - Unique identifier for the discount.
  * @property {DiscountPlatformModel.BulkDiscount} body
  */
 
 /**
  * @typedef ValidateDiscountFileParam
- * @property {string} [discount] - Discount
- * @property {DiscountPlatformModel.FileJobRequest} body
+ * @property {string} [discount] - Unique identifier for the discount.
+ * @property {DiscountPlatformModel.FileJobRequestSchema} body
  */
 
 class DiscountPlatformValidator {
@@ -156,7 +166,7 @@ class DiscountPlatformValidator {
   static validateDiscountFile() {
     return Joi.object({
       discount: Joi.string().allow(""),
-      body: DiscountPlatformModel.FileJobRequest().required(),
+      body: DiscountPlatformModel.FileJobRequestSchema().required(),
     }).required();
   }
 }

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

@@ -9,34 +9,24 @@ declare class FileStorage {
      *
      * @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 appCompleteUpload
      * @summary: Application complete upload.
      * @description: Finish uploading a file from an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/appCompleteUpload/).
      */
-    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<Object>} - Success response
-     * @name appCopyFiles
-     * @summary: Application copy files.
-     * @description: Copy files from an application to another location. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/appCopyFiles/).
-     */
-    appCopyFiles({ body, sync, requestHeaders }?: FileStoragePlatformApplicationValidator.AppCopyFilesParam, { responseHeaders }?: object): Promise<any>;
+    appCompleteUpload({ namespace, body, requestHeaders }?: FileStoragePlatformApplicationValidator.AppCompleteUploadParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.FileUploadComplete>;
     /**
      * @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
+     * @returns {Promise<FileStoragePlatformModel.FileUpload>} - Success response
      * @name appStartUpload
      * @summary: Application start upload.
      * @description: Start uploading a file from an application and returns a storage link in response. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/appStartUpload/).
      */
-    appStartUpload({ namespace, body, requestHeaders }?: FileStoragePlatformApplicationValidator.AppStartUploadParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.StartResponse>;
+    appStartUpload({ namespace, body, requestHeaders }?: FileStoragePlatformApplicationValidator.AppStartUploadParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.FileUpload>;
     /**
      * @param {FileStoragePlatformApplicationValidator.AppbrowseParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -57,155 +47,6 @@ declare class FileStorage {
      * @description: Browse Files - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/browsefiles/).
      */
     browsefiles({ namespace, body, page, limit, search, requestHeaders }?: FileStoragePlatformApplicationValidator.BrowsefilesParam, { responseHeaders }?: object): Promise<any>;
-    /**
-     * @param {FileStoragePlatformApplicationValidator.DeletePdfGeneratorConfigParam} arg
-     *   - Arg object
-     *
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<Object>} - Success response
-     * @name deletePdfGeneratorConfig
-     * @summary: Delete a PDF generator configuration
-     * @description: Deletes a specific PDF generator configuration based on the provided id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/deletePdfGeneratorConfig/).
-     */
-    deletePdfGeneratorConfig({ id, requestHeaders }?: FileStoragePlatformApplicationValidator.DeletePdfGeneratorConfigParam, { responseHeaders }?: object): Promise<any>;
-    /**
-     * @param {FileStoragePlatformApplicationValidator.FetchPdfDefaultTemplateByIdParam} arg
-     *   - Arg object
-     *
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<FileStoragePlatformModel.PdfDefaultTemplateResponse>}
-     *   - Success response
-     *
-     * @name fetchPdfDefaultTemplateById
-     * @summary: get default html template for invoice or label
-     * @description: get default html template for invoice such as Invoice, Label, Deliver challan - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/fetchPdfDefaultTemplateById/).
-     */
-    fetchPdfDefaultTemplateById({ id, requestHeaders }?: FileStoragePlatformApplicationValidator.FetchPdfDefaultTemplateByIdParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.PdfDefaultTemplateResponse>;
-    /**
-     * @param {FileStoragePlatformApplicationValidator.FetchPdfTypeByIdParam} arg
-     *   - Arg object
-     *
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<FileStoragePlatformModel.PdfTypeIdResponse>} - Success response
-     * @name fetchPdfTypeById
-     * @summary: Get the pdf types of by id
-     * @description: Get the pdf types of PDF formats for filter - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/fetchPdfTypeById/).
-     */
-    fetchPdfTypeById({ id, requestHeaders }?: FileStoragePlatformApplicationValidator.FetchPdfTypeByIdParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.PdfTypeIdResponse>;
-    /**
-     * @param {FileStoragePlatformApplicationValidator.GeneratePaymentReceiptParam} arg
-     *   - Arg object
-     *
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<Object>} - Success response
-     * @name generatePaymentReceipt
-     * @summary: Generate payment receipt.
-     * @description: Generate Payment Receipt for Jiomart Digital - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/generatePaymentReceipt/).
-     */
-    generatePaymentReceipt({ body, requestHeaders }?: FileStoragePlatformApplicationValidator.GeneratePaymentReceiptParam, { responseHeaders }?: object): Promise<any>;
-    /**
-     * @param {FileStoragePlatformApplicationValidator.GetConfigHtmlTemplateByIdParam} arg
-     *   - Arg object
-     *
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<Object>} - Success response
-     * @name getConfigHtmlTemplateById
-     * @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/getConfigHtmlTemplateById/).
-     */
-    getConfigHtmlTemplateById({ id, requestHeaders }?: FileStoragePlatformApplicationValidator.GetConfigHtmlTemplateByIdParam, { responseHeaders }?: object): Promise<any>;
-    /**
-     * @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 default PDF data.
-     * @description: Retrieve default data for PDF generation. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getDefaultPdfData/).
-     */
-    getDefaultPdfData({ pdfTypeId, countryCode, 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: Get default PDF template.
-     * @description: Retrieve the default PDF template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getDefaultPdfTemplate/).
-     */
-    getDefaultPdfTemplate({ pdfTypeId, format, countryCode, requestHeaders }?: FileStoragePlatformApplicationValidator.GetDefaultPdfTemplateParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.PdfDefaultTemplateSuccess>;
-    /**
-     * @param {FileStoragePlatformApplicationValidator.GetHtmlTemplateConfigParam} arg
-     *   - Arg object
-     *
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<FileStoragePlatformModel.PdfConfigSuccess>} - Success response
-     * @name getHtmlTemplateConfig
-     * @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/getHtmlTemplateConfig/).
-     */
-    getHtmlTemplateConfig({ pdfTypeId, format, countryCode, requestHeaders }?: FileStoragePlatformApplicationValidator.GetHtmlTemplateConfigParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.PdfConfigSuccess>;
-    /**
-     * @param {FileStoragePlatformApplicationValidator.GetPdfPayloadByIdParam} arg
-     *   - Arg object
-     *
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<FileStoragePlatformModel.DummyPayloadById>} - Success response
-     * @name getPdfPayloadById
-     * @summary: Get default PDF data.
-     * @description: Retrieve default data for PDF generation. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getPdfPayloadById/).
-     */
-    getPdfPayloadById({ id, requestHeaders }?: FileStoragePlatformApplicationValidator.GetPdfPayloadByIdParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.DummyPayloadById>;
-    /**
-     * @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, Delivery challan - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getPdfTypes/).
-     */
-    getPdfTypes({ storeOs, countryCode, requestHeaders }?: FileStoragePlatformApplicationValidator.GetPdfTypesParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.InvoiceTypesResponse>;
-    /**
-     * @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: Save HTML template.
-     * @description: Store an HTML template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/saveHtmlTemplate/).
-     */
-    saveHtmlTemplate({ body, requestHeaders }?: FileStoragePlatformApplicationValidator.SaveHtmlTemplateParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.PdfConfigSaveSuccess>;
-    /**
-     * @param {FileStoragePlatformApplicationValidator.UpdateHtmlTemplateParam} arg
-     *   - Arg object
-     *
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<FileStoragePlatformModel.PdfConfigSaveSuccess>} -
-     *   Success response
-     * @name updateHtmlTemplate
-     * @summary: Update HTML Template
-     * @description: Update the HTML Template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/updateHtmlTemplate/).
-     */
-    updateHtmlTemplate({ id, body, requestHeaders }?: FileStoragePlatformApplicationValidator.UpdateHtmlTemplateParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.PdfConfigSaveSuccess>;
     /**
      * @param data
      * @param {string} file_name