@gofynd/fdk-client-javascript 1.3.11-beta.7 → 1.4.0-beta.1

package/sdk/platform/FileStorage/FileStoragePlatformModel.js

@@ -141,6 +141,7 @@ const Joi = require("joi");
  * @typedef DummyTemplateData
  * @property {number} [__v]
  * @property {string} [_id]
+ * @property {string} [country_code]
  * @property {DummyTemplateDataPayload} payload
  * @property {number} [pdf_type_id]
  */
@@ -169,7 +170,7 @@ const Joi = require("joi");
  * @property {string} [disclaimer]
  * @property {Image} [image]
  * @property {InvoiceDetail} [invoice_detail]
- * @property {boolean} [is_international]
+ * @property {boolean} [is_export]
  * @property {boolean} [is_self_pickup]
  * @property {boolean} [is_self_ship]
  * @property {Meta} [meta]
@@ -190,6 +191,11 @@ const Joi = require("joi");
  * @property {Object[]} [waybills]
  */
 
+/**
+ * @typedef ExtensionSlug
+ * @property {string} [extension_slug]
+ */
+
 /**
  * @typedef FailedResponse
  * @property {string} message
@@ -229,7 +235,7 @@ const Joi = require("joi");
  * @typedef InvoiceTypesDataResponse
  * @property {number} __v
  * @property {string} _id
- * @property {string} [country_code]
+ * @property {string} country_code
  * @property {string[]} format
  * @property {string} name
  * @property {number} pdf_type_id
@@ -290,11 +296,6 @@ const Joi = require("joi");
  * @property {UpiQrcodeGenerator} [upi_qrcode_generator]
  */
 
-/**
- * @typedef Params
- * @property {string} [subpath] - The subpath for the file.
- */
-
 /**
  * @typedef PaymentData
  * @property {number} [amount]
@@ -499,7 +500,7 @@ const Joi = require("joi");
  * @typedef StartRequest
  * @property {string} content_type
  * @property {string} file_name
- * @property {Params} [params]
+ * @property {Object} [params]
  * @property {number} size
  * @property {string[]} [tags]
  */
@@ -752,6 +753,7 @@ class FileStoragePlatformModel {
     return Joi.object({
       __v: Joi.number(),
       _id: Joi.string().allow(""),
+      country_code: Joi.string().allow(""),
       payload: FileStoragePlatformModel.DummyTemplateDataPayload().required(),
       pdf_type_id: Joi.number(),
     });
@@ -786,7 +788,7 @@ class FileStoragePlatformModel {
       disclaimer: Joi.string().allow(""),
       image: FileStoragePlatformModel.Image(),
       invoice_detail: FileStoragePlatformModel.InvoiceDetail(),
-      is_international: Joi.boolean(),
+      is_export: Joi.boolean(),
       is_self_pickup: Joi.boolean(),
       is_self_ship: Joi.boolean(),
       meta: FileStoragePlatformModel.Meta(),
@@ -808,6 +810,13 @@ class FileStoragePlatformModel {
     });
   }
 
+  /** @returns {ExtensionSlug} */
+  static ExtensionSlug() {
+    return Joi.object({
+      extension_slug: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {FailedResponse} */
   static FailedResponse() {
     return Joi.object({
@@ -858,7 +867,7 @@ class FileStoragePlatformModel {
     return Joi.object({
       __v: Joi.number().required(),
       _id: Joi.string().allow("").required(),
-      country_code: Joi.string().allow(""),
+      country_code: Joi.string().allow("").required(),
       format: Joi.array().items(Joi.string().allow("")).required(),
       name: Joi.string().allow("").required(),
       pdf_type_id: Joi.number().required(),
@@ -936,13 +945,6 @@ class FileStoragePlatformModel {
     });
   }
 
-  /** @returns {Params} */
-  static Params() {
-    return Joi.object({
-      subpath: Joi.string().allow(""),
-    });
-  }
-
   /** @returns {PaymentData} */
   static PaymentData() {
     return Joi.object({
@@ -1200,7 +1202,7 @@ class FileStoragePlatformModel {
     return Joi.object({
       content_type: Joi.string().allow("").required(),
       file_name: Joi.string().allow("").required(),
-      params: FileStoragePlatformModel.Params(),
+      params: Joi.object().pattern(/\S/, Joi.any()),
       size: Joi.number().required(),
       tags: Joi.array().items(Joi.string().allow("")),
     });

package/sdk/platform/Finance/FinancePlatformClient.d.ts

@@ -199,6 +199,17 @@ declare class Finance {
      * @description: Gets all customer Cn filters and search. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getReportingFilters/).
      */
     getReportingFilters({ filterKey, affiliateId, requestHeaders }?: FinancePlatformValidator.GetReportingFiltersParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetReportingFiltersResponse>;
+    /**
+     * @param {FinancePlatformValidator.InvoiceActivityLogsParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<FinancePlatformModel.InvoiceActivityLogsResponse>} -
+     *   Success response
+     * @name invoiceActivityLogs
+     * @summary: Display activity log details of an invoice.
+     * @description: Display activity log details of invoice. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoiceActivityLogs/).
+     */
+    invoiceActivityLogs({ invoiceNumber, requestHeaders }?: FinancePlatformValidator.InvoiceActivityLogsParam, { responseHeaders }?: object): Promise<FinancePlatformModel.InvoiceActivityLogsResponse>;
     /**
      * @param {FinancePlatformValidator.InvoiceListingParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -219,6 +230,17 @@ declare class Finance {
      * @description: Gives pdf view of invoice. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoicePDF/).
      */
     invoicePDF({ body, requestHeaders }?: FinancePlatformValidator.InvoicePDFParam, { responseHeaders }?: object): Promise<FinancePlatformModel.InvoicePdfResponse>;
+    /**
+     * @param {FinancePlatformValidator.InvoicePaymentDetailsParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<FinancePlatformModel.InvoicePaymentDetailsResponse>} -
+     *   Success response
+     * @name invoicePaymentDetails
+     * @summary: Display payment details of an invoice.
+     * @description: Display payment details of invoice. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoicePaymentDetails/).
+     */
+    invoicePaymentDetails({ invoiceNumber, requestHeaders }?: FinancePlatformValidator.InvoicePaymentDetailsParam, { responseHeaders }?: object): Promise<FinancePlatformModel.InvoicePaymentDetailsResponse>;
     /**
      * @param {FinancePlatformValidator.InvoiceTypeParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -261,6 +283,17 @@ declare class Finance {
      * @description: Payment Processing API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/paymentProcess/).
      */
     paymentProcess({ body, requestHeaders }?: FinancePlatformValidator.PaymentProcessParam, { responseHeaders }?: object): Promise<FinancePlatformModel.PaymentProcessResponse>;
+    /**
+     * @param {FinancePlatformValidator.UnlockCreditNoteParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<FinancePlatformModel.UnlockCreditNoteResponse>} -
+     *   Success response
+     * @name unlockCreditNote
+     * @summary: Unlocks credit notes.
+     * @description: Used to unlock all request credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/unlockCreditNote/).
+     */
+    unlockCreditNote({ body, requestHeaders }?: FinancePlatformValidator.UnlockCreditNoteParam, { responseHeaders }?: object): Promise<FinancePlatformModel.UnlockCreditNoteResponse>;
 }
 import FinancePlatformValidator = require("./FinancePlatformValidator");
 import FinancePlatformModel = require("./FinancePlatformModel");

package/sdk/platform/Finance/FinancePlatformClient.js

@@ -1464,6 +1464,86 @@ class Finance {
     return response;
   }
 
+  /**
+   * @param {FinancePlatformValidator.InvoiceActivityLogsParam} arg - Arg object
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<FinancePlatformModel.InvoiceActivityLogsResponse>} -
+   *   Success response
+   * @name invoiceActivityLogs
+   * @summary: Display activity log details of an invoice.
+   * @description: Display activity log details of invoice. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoiceActivityLogs/).
+   */
+  async invoiceActivityLogs(
+    { invoiceNumber, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = FinancePlatformValidator.invoiceActivityLogs().validate(
+      {
+        invoiceNumber,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = FinancePlatformValidator.invoiceActivityLogs().validate(
+      {
+        invoiceNumber,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > Finance > invoiceActivityLogs \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/finance/v1.0/company/${this.config.companyId}/invoice/${invoiceNumber}/activity`,
+      query_params,
+      undefined,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = FinancePlatformModel.InvoiceActivityLogsResponse().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: true }
+    );
+
+    if (res_error) {
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for platform > Finance > invoiceActivityLogs \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
   /**
    * @param {FinancePlatformValidator.InvoiceListingParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -1620,6 +1700,86 @@ class Finance {
     return response;
   }
 
+  /**
+   * @param {FinancePlatformValidator.InvoicePaymentDetailsParam} arg - Arg object
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<FinancePlatformModel.InvoicePaymentDetailsResponse>} -
+   *   Success response
+   * @name invoicePaymentDetails
+   * @summary: Display payment details of an invoice.
+   * @description: Display payment details of invoice. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoicePaymentDetails/).
+   */
+  async invoicePaymentDetails(
+    { invoiceNumber, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = FinancePlatformValidator.invoicePaymentDetails().validate(
+      {
+        invoiceNumber,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = FinancePlatformValidator.invoicePaymentDetails().validate(
+      {
+        invoiceNumber,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > Finance > invoicePaymentDetails \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/finance/v1.0/company/${this.config.companyId}/invoice/${invoiceNumber}/payment`,
+      query_params,
+      undefined,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = FinancePlatformModel.InvoicePaymentDetailsResponse().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: true }
+    );
+
+    if (res_error) {
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for platform > Finance > invoicePaymentDetails \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
   /**
    * @param {FinancePlatformValidator.InvoiceTypeParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -1935,6 +2095,86 @@ class Finance {
 
     return response;
   }
+
+  /**
+   * @param {FinancePlatformValidator.UnlockCreditNoteParam} arg - Arg object
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<FinancePlatformModel.UnlockCreditNoteResponse>} -
+   *   Success response
+   * @name unlockCreditNote
+   * @summary: Unlocks credit notes.
+   * @description: Used to unlock all request credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/unlockCreditNote/).
+   */
+  async unlockCreditNote(
+    { body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = FinancePlatformValidator.unlockCreditNote().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = FinancePlatformValidator.unlockCreditNote().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > Finance > unlockCreditNote \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/finance/v1.0/company/${this.config.companyId}/credit-notes/unlock`,
+      query_params,
+      body,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = FinancePlatformModel.UnlockCreditNoteResponse().validate(responseData, {
+      abortEarly: false,
+      allowUnknown: true,
+    });
+
+    if (res_error) {
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for platform > Finance > unlockCreditNote \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
 }
 
 module.exports = Finance;