@gofynd/fdk-client-javascript 1.4.13 → 1.4.14

package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts

@@ -11,7 +11,7 @@ export = FileStorageApplicationModel;
  * @property {string} url - The signed URL for uploading the file.
  */
 /**
- * @typedef StartResponse
+ * @typedef FileUpload
  * @property {string} file_name - The name of the file that was uploaded.
  * @property {string} file_path - The path to the file in the storage location.
  * @property {string} content_type - The content type of the file.
@@ -20,7 +20,6 @@ export = FileStorageApplicationModel;
  * @property {string} operation - The operation to be performed on the storage service.
  * @property {number} size - The size of the file in bytes.
  * @property {Upload} upload
- * @property {CDN} cdn
  * @property {string[]} [tags] - Tags associated with the file.
  */
 /**
@@ -29,7 +28,7 @@ export = FileStorageApplicationModel;
  *   within the storage structure where the file should be placed or is located.
  */
 /**
- * @typedef StartRequest
+ * @typedef FileUploadStart
  * @property {string} file_name - The name of the file to be uploaded.
  * @property {string} content_type - The name of the file to be uploaded.
  * @property {number} size - The size of the file in bytes.
@@ -41,7 +40,7 @@ export = FileStorageApplicationModel;
  * @property {string} [username] - The username of the user who created the file.
  */
 /**
- * @typedef CompleteResponse
+ * @typedef FileUploadComplete
  * @property {string} _id - The unique identifier of the uploaded file.
  * @property {string} file_name - The name of the file that was uploaded.
  * @property {string} file_path - The path to the file in the storage location.
@@ -65,18 +64,18 @@ export = FileStorageApplicationModel;
  * @property {number} expiry - The expiration time for the signed URL.
  */
 /**
- * @typedef SignUrlResponse
+ * @typedef SignUrlResult
  * @property {Urls[]} urls - Signed URL object.
  */
 /**
- * @typedef SignUrlRequest
+ * @typedef SignUrl
  * @property {number} expiry - The expiration time for the signed URL.
- * @property {string[]} urls - List of asset URLs to be signed. .
+ * @property {string[]} urls - List of asset URLs to be signed.
  */
 declare class FileStorageApplicationModel {
 }
 declare namespace FileStorageApplicationModel {
-    export { CDN, Upload, StartResponse, Params, StartRequest, CreatedBy, CompleteResponse, Urls, SignUrlResponse, SignUrlRequest };
+    export { CDN, Upload, FileUpload, Params, FileUploadStart, CreatedBy, FileUploadComplete, Urls, SignUrlResult, SignUrl };
 }
 /** @returns {CDN} */
 declare function CDN(): CDN;
@@ -106,9 +105,9 @@ type Upload = {
      */
     url: string;
 };
-/** @returns {StartResponse} */
-declare function StartResponse(): StartResponse;
-type StartResponse = {
+/** @returns {FileUpload} */
+declare function FileUpload(): FileUpload;
+type FileUpload = {
     /**
      * - The name of the file that was uploaded.
      */
@@ -138,7 +137,6 @@ type StartResponse = {
      */
     size: number;
     upload: Upload;
-    cdn: CDN;
     /**
      * - Tags associated with the file.
      */
@@ -153,9 +151,9 @@ type Params = {
      */
     subpath?: string;
 };
-/** @returns {StartRequest} */
-declare function StartRequest(): StartRequest;
-type StartRequest = {
+/** @returns {FileUploadStart} */
+declare function FileUploadStart(): FileUploadStart;
+type FileUploadStart = {
     /**
      * - The name of the file to be uploaded.
      */
@@ -182,9 +180,9 @@ type CreatedBy = {
      */
     username?: string;
 };
-/** @returns {CompleteResponse} */
-declare function CompleteResponse(): CompleteResponse;
-type CompleteResponse = {
+/** @returns {FileUploadComplete} */
+declare function FileUploadComplete(): FileUploadComplete;
+type FileUploadComplete = {
     /**
      * - The unique identifier of the uploaded file.
      */
@@ -250,23 +248,23 @@ type Urls = {
      */
     expiry: number;
 };
-/** @returns {SignUrlResponse} */
-declare function SignUrlResponse(): SignUrlResponse;
-type SignUrlResponse = {
+/** @returns {SignUrlResult} */
+declare function SignUrlResult(): SignUrlResult;
+type SignUrlResult = {
     /**
      * - Signed URL object.
      */
     urls: Urls[];
 };
-/** @returns {SignUrlRequest} */
-declare function SignUrlRequest(): SignUrlRequest;
-type SignUrlRequest = {
+/** @returns {SignUrl} */
+declare function SignUrl(): SignUrl;
+type SignUrl = {
     /**
      * - The expiration time for the signed URL.
      */
     expiry: number;
     /**
-     * - List of asset URLs to be signed. .
+     * - List of asset URLs to be signed.
      */
     urls: string[];
 };

package/sdk/application/FileStorage/FileStorageApplicationModel.js

@@ -14,7 +14,7 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef StartResponse
+ * @typedef FileUpload
  * @property {string} file_name - The name of the file that was uploaded.
  * @property {string} file_path - The path to the file in the storage location.
  * @property {string} content_type - The content type of the file.
@@ -23,7 +23,6 @@ const Joi = require("joi");
  * @property {string} operation - The operation to be performed on the storage service.
  * @property {number} size - The size of the file in bytes.
  * @property {Upload} upload
- * @property {CDN} cdn
  * @property {string[]} [tags] - Tags associated with the file.
  */
 
@@ -34,7 +33,7 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef StartRequest
+ * @typedef FileUploadStart
  * @property {string} file_name - The name of the file to be uploaded.
  * @property {string} content_type - The name of the file to be uploaded.
  * @property {number} size - The size of the file in bytes.
@@ -48,7 +47,7 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef CompleteResponse
+ * @typedef FileUploadComplete
  * @property {string} _id - The unique identifier of the uploaded file.
  * @property {string} file_name - The name of the file that was uploaded.
  * @property {string} file_path - The path to the file in the storage location.
@@ -74,14 +73,14 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef SignUrlResponse
+ * @typedef SignUrlResult
  * @property {Urls[]} urls - Signed URL object.
  */
 
 /**
- * @typedef SignUrlRequest
+ * @typedef SignUrl
  * @property {number} expiry - The expiration time for the signed URL.
- * @property {string[]} urls - List of asset URLs to be signed. .
+ * @property {string[]} urls - List of asset URLs to be signed.
  */
 
 class FileStorageApplicationModel {
@@ -102,8 +101,8 @@ class FileStorageApplicationModel {
     });
   }
 
-  /** @returns {StartResponse} */
-  static StartResponse() {
+  /** @returns {FileUpload} */
+  static FileUpload() {
     return Joi.object({
       file_name: Joi.string().allow("").required(),
       file_path: Joi.string().allow("").required(),
@@ -113,7 +112,6 @@ class FileStorageApplicationModel {
       operation: Joi.string().allow("").required(),
       size: Joi.number().required(),
       upload: FileStorageApplicationModel.Upload().required(),
-      cdn: FileStorageApplicationModel.CDN().required(),
       tags: Joi.array().items(Joi.string().allow("")),
     });
   }
@@ -125,8 +123,8 @@ class FileStorageApplicationModel {
     });
   }
 
-  /** @returns {StartRequest} */
-  static StartRequest() {
+  /** @returns {FileUploadStart} */
+  static FileUploadStart() {
     return Joi.object({
       file_name: Joi.string().allow("").required(),
       content_type: Joi.string().allow("").required(),
@@ -143,8 +141,8 @@ class FileStorageApplicationModel {
     });
   }
 
-  /** @returns {CompleteResponse} */
-  static CompleteResponse() {
+  /** @returns {FileUploadComplete} */
+  static FileUploadComplete() {
     return Joi.object({
       _id: Joi.string().allow("").required(),
       file_name: Joi.string().allow("").required(),
@@ -172,15 +170,15 @@ class FileStorageApplicationModel {
     });
   }
 
-  /** @returns {SignUrlResponse} */
-  static SignUrlResponse() {
+  /** @returns {SignUrlResult} */
+  static SignUrlResult() {
     return Joi.object({
       urls: Joi.array().items(FileStorageApplicationModel.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(),

package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts

@@ -5,11 +5,11 @@ export = FileStorageApplicationValidator;
  *   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 {FileStorageApplicationModel.StartResponse} body
+ * @property {FileStorageApplicationModel.FileUpload} body
  */
 /**
  * @typedef SignUrlsParam
- * @property {FileStorageApplicationModel.SignUrlRequest} body
+ * @property {FileStorageApplicationModel.SignUrl} body
  */
 /**
  * @typedef StartUploadParam
@@ -17,7 +17,7 @@ export = FileStorageApplicationValidator;
  *   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 {FileStorageApplicationModel.StartRequest} body
+ * @property {FileStorageApplicationModel.FileUploadStart} body
  */
 declare class FileStorageApplicationValidator {
     /** @returns {CompleteUploadParam} */
@@ -38,10 +38,10 @@ type CompleteUploadParam = {
      * inside the storage bucket.
      */
     namespace: string;
-    body: FileStorageApplicationModel.StartResponse;
+    body: FileStorageApplicationModel.FileUpload;
 };
 type SignUrlsParam = {
-    body: FileStorageApplicationModel.SignUrlRequest;
+    body: FileStorageApplicationModel.SignUrl;
 };
 type StartUploadParam = {
     /**
@@ -51,6 +51,6 @@ type StartUploadParam = {
      * inside the storage bucket.
      */
     namespace: string;
-    body: FileStorageApplicationModel.StartRequest;
+    body: FileStorageApplicationModel.FileUploadStart;
 };
 import FileStorageApplicationModel = require("./FileStorageApplicationModel");

package/sdk/application/FileStorage/FileStorageApplicationValidator.js

@@ -8,12 +8,12 @@ const FileStorageApplicationModel = require("./FileStorageApplicationModel");
  *   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 {FileStorageApplicationModel.StartResponse} body
+ * @property {FileStorageApplicationModel.FileUpload} body
  */
 
 /**
  * @typedef SignUrlsParam
- * @property {FileStorageApplicationModel.SignUrlRequest} body
+ * @property {FileStorageApplicationModel.SignUrl} body
  */
 
 /**
@@ -22,7 +22,7 @@ const FileStorageApplicationModel = require("./FileStorageApplicationModel");
  *   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 {FileStorageApplicationModel.StartRequest} body
+ * @property {FileStorageApplicationModel.FileUploadStart} body
  */
 
 class FileStorageApplicationValidator {
@@ -30,14 +30,14 @@ class FileStorageApplicationValidator {
   static completeUpload() {
     return Joi.object({
       namespace: Joi.string().allow("").required(),
-      body: FileStorageApplicationModel.StartResponse().required(),
+      body: FileStorageApplicationModel.FileUpload().required(),
     }).required();
   }
 
   /** @returns {SignUrlsParam} */
   static signUrls() {
     return Joi.object({
-      body: FileStorageApplicationModel.SignUrlRequest().required(),
+      body: FileStorageApplicationModel.SignUrl().required(),
     }).required();
   }
 
@@ -45,7 +45,7 @@ class FileStorageApplicationValidator {
   static startUpload() {
     return Joi.object({
       namespace: Joi.string().allow("").required(),
-      body: FileStorageApplicationModel.StartRequest().required(),
+      body: FileStorageApplicationModel.FileUploadStart().required(),
     }).required();
   }
 }

package/sdk/application/Finance/FinanceApplicationClient.d.ts

@@ -0,0 +1,36 @@
+export = Finance;
+declare class Finance {
+    constructor(_conf: any);
+    _conf: any;
+    _relativeUrls: {
+        customerCreditBalance: string;
+        lockUnlockCreditNote: string;
+    };
+    _urls: {};
+    updateUrls(urls: any): void;
+    /**
+     * @param {FinanceApplicationValidator.CustomerCreditBalanceParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<FinanceApplicationModel.CustomerCreditBalanceResponseSchema>}
+     *   - Success response
+     *
+     * @name customerCreditBalance
+     * @summary: This API will provide customer's credit balance against phone number or email and seller*affiliate id
+     * @description: This API will provide customer's credit balance against phone number or email and seller*affiliate id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/finance/customerCreditBalance/).
+     */
+    customerCreditBalance({ body, requestHeaders }?: FinanceApplicationValidator.CustomerCreditBalanceParam, { responseHeaders }?: object): Promise<FinanceApplicationModel.CustomerCreditBalanceResponseSchema>;
+    /**
+     * @param {FinanceApplicationValidator.LockUnlockCreditNoteParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<FinanceApplicationModel.LockUnlockResponseSchema>} -
+     *   Success response
+     * @name lockUnlockCreditNote
+     * @summary: Lock or Unlock requested credit note.
+     * @description: Used to lock or unlock requested credit note. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/finance/lockUnlockCreditNote/).
+     */
+    lockUnlockCreditNote({ body, requestHeaders }?: FinanceApplicationValidator.LockUnlockCreditNoteParam, { responseHeaders }?: object): Promise<FinanceApplicationModel.LockUnlockResponseSchema>;
+}
+import FinanceApplicationValidator = require("./FinanceApplicationValidator");
+import FinanceApplicationModel = require("./FinanceApplicationModel");

package/sdk/application/Finance/FinanceApplicationClient.js

@@ -0,0 +1,202 @@
+const ApplicationAPIClient = require("../ApplicationAPIClient");
+const {
+  FDKClientValidationError,
+  FDKResponseValidationError,
+} = require("../../common/FDKError");
+const constructUrl = require("../constructUrl");
+const Paginator = require("../../common/Paginator");
+const FinanceApplicationValidator = require("./FinanceApplicationValidator");
+const FinanceApplicationModel = require("./FinanceApplicationModel");
+const { Logger } = require("./../../common/Logger");
+const Joi = require("joi");
+
+class Finance {
+  constructor(_conf) {
+    this._conf = _conf;
+    this._relativeUrls = {
+      customerCreditBalance:
+        "/service/application/finance/v1.0/customer-credit-balance",
+      lockUnlockCreditNote:
+        "/service/application/finance/v1.0/lock-unlock-credit-note",
+    };
+    this._urls = Object.entries(this._relativeUrls).reduce(
+      (urls, [method, relativeUrl]) => {
+        urls[method] = `${_conf.domain}${relativeUrl}`;
+        return urls;
+      },
+      {}
+    );
+  }
+
+  updateUrls(urls) {
+    this._urls = {
+      ...this._urls,
+      ...urls,
+    };
+  }
+
+  /**
+   * @param {FinanceApplicationValidator.CustomerCreditBalanceParam} arg - Arg object.
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<FinanceApplicationModel.CustomerCreditBalanceResponseSchema>}
+   *   - Success response
+   *
+   * @name customerCreditBalance
+   * @summary: This API will provide customer's credit balance against phone number or email and seller*affiliate id
+   * @description: This API will provide customer's credit balance against phone number or email and seller*affiliate id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/finance/customerCreditBalance/).
+   */
+  async customerCreditBalance(
+    { body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = FinanceApplicationValidator.customerCreditBalance().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,
+    } = FinanceApplicationValidator.customerCreditBalance().validate(
+      { body },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for application > Finance > customerCreditBalance \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await ApplicationAPIClient.execute(
+      this._conf,
+      "post",
+      constructUrl({
+        url: this._urls["customerCreditBalance"],
+        params: {},
+      }),
+      query_params,
+      body,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = FinanceApplicationModel.CustomerCreditBalanceResponseSchema().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: true }
+    );
+
+    if (res_error) {
+      if (this._conf.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for application > Finance > customerCreditBalance \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
+  /**
+   * @param {FinanceApplicationValidator.LockUnlockCreditNoteParam} arg - Arg object.
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<FinanceApplicationModel.LockUnlockResponseSchema>} -
+   *   Success response
+   * @name lockUnlockCreditNote
+   * @summary: Lock or Unlock requested credit note.
+   * @description: Used to lock or unlock requested credit note. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/finance/lockUnlockCreditNote/).
+   */
+  async lockUnlockCreditNote(
+    { body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = FinanceApplicationValidator.lockUnlockCreditNote().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,
+    } = FinanceApplicationValidator.lockUnlockCreditNote().validate(
+      { body },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for application > Finance > lockUnlockCreditNote \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await ApplicationAPIClient.execute(
+      this._conf,
+      "post",
+      constructUrl({
+        url: this._urls["lockUnlockCreditNote"],
+        params: {},
+      }),
+      query_params,
+      body,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = FinanceApplicationModel.LockUnlockResponseSchema().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: true }
+    );
+
+    if (res_error) {
+      if (this._conf.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for application > Finance > lockUnlockCreditNote \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+}
+
+module.exports = Finance;