@gofynd/fdk-client-javascript 1.4.5 → 1.4.7

package/sdk/application/Payment/PaymentApplicationModel.d.ts

@@ -169,19 +169,19 @@ export = PaymentApplicationModel;
  */
 /**
  * @typedef PaymentStatusUpdateRequest
- * @property {string} status - Status of payment.
- * @property {string} merchant_transaction_id - Unique fynd transaction id
+ * @property {string} [status] - Status of payment.
+ * @property {string} [merchant_transaction_id] - Unique fynd transaction id
  * @property {string} method - Payment method
  * @property {string} [device_id] - EDC machine Unique Identifier
  * @property {string} aggregator - Payment gateway name
- * @property {string} customer_id - Payment gateway customer id.
- * @property {string} contact - Customer valid mobile number
+ * @property {string} [customer_id] - Payment gateway customer id.
+ * @property {string} [contact] - Customer valid mobile number
  * @property {string} merchant_order_id - Unique fynd order id
  * @property {string} [vpa] - Customer vpa address
- * @property {string} order_id - Payment gateway order id
- * @property {string} currency - Currency code.
- * @property {number} amount - Payable amount.
- * @property {string} email - Customer valid email
+ * @property {string} [order_id] - Payment gateway order id
+ * @property {string} [currency] - Currency code.
+ * @property {number} [amount] - Payable amount.
+ * @property {string} [email] - Customer valid email
  */
 /**
  * @typedef PaymentStatusUpdateResponse
@@ -263,7 +263,7 @@ export = PaymentApplicationModel;
 /**
  * @typedef AggregatorRoute
  * @property {Object} [data] - Data
- * @property {string} [payment_flow_data] - Payment_flow_data
+ * @property {Object} [payment_flow_data] - Payment_flow_data
  * @property {string} [payment_flow] - Payment_flow
  * @property {string} [api_link] - Api_link
  */
@@ -1544,11 +1544,11 @@ type PaymentStatusUpdateRequest = {
     /**
      * - Status of payment.
      */
-    status: string;
+    status?: string;
     /**
      * - Unique fynd transaction id
      */
-    merchant_transaction_id: string;
+    merchant_transaction_id?: string;
     /**
      * - Payment method
      */
@@ -1564,11 +1564,11 @@ type PaymentStatusUpdateRequest = {
     /**
      * - Payment gateway customer id.
      */
-    customer_id: string;
+    customer_id?: string;
     /**
      * - Customer valid mobile number
      */
-    contact: string;
+    contact?: string;
     /**
      * - Unique fynd order id
      */
@@ -1580,19 +1580,19 @@ type PaymentStatusUpdateRequest = {
     /**
      * - Payment gateway order id
      */
-    order_id: string;
+    order_id?: string;
     /**
      * - Currency code.
      */
-    currency: string;
+    currency?: string;
     /**
      * - Payable amount.
      */
-    amount: number;
+    amount?: number;
     /**
      * - Customer valid email
      */
-    email: string;
+    email?: string;
 };
 /** @returns {PaymentStatusUpdateResponse} */
 declare function PaymentStatusUpdateResponse(): PaymentStatusUpdateResponse;
@@ -1849,7 +1849,7 @@ type AggregatorRoute = {
     /**
      * - Payment_flow_data
      */
-    payment_flow_data?: string;
+    payment_flow_data?: any;
     /**
      * - Payment_flow
      */

package/sdk/application/Payment/PaymentApplicationModel.js

@@ -188,19 +188,19 @@ const Joi = require("joi");
 
 /**
  * @typedef PaymentStatusUpdateRequest
- * @property {string} status - Status of payment.
- * @property {string} merchant_transaction_id - Unique fynd transaction id
+ * @property {string} [status] - Status of payment.
+ * @property {string} [merchant_transaction_id] - Unique fynd transaction id
  * @property {string} method - Payment method
  * @property {string} [device_id] - EDC machine Unique Identifier
  * @property {string} aggregator - Payment gateway name
- * @property {string} customer_id - Payment gateway customer id.
- * @property {string} contact - Customer valid mobile number
+ * @property {string} [customer_id] - Payment gateway customer id.
+ * @property {string} [contact] - Customer valid mobile number
  * @property {string} merchant_order_id - Unique fynd order id
  * @property {string} [vpa] - Customer vpa address
- * @property {string} order_id - Payment gateway order id
- * @property {string} currency - Currency code.
- * @property {number} amount - Payable amount.
- * @property {string} email - Customer valid email
+ * @property {string} [order_id] - Payment gateway order id
+ * @property {string} [currency] - Currency code.
+ * @property {number} [amount] - Payable amount.
+ * @property {string} [email] - Customer valid email
  */
 
 /**
@@ -289,7 +289,7 @@ const Joi = require("joi");
 /**
  * @typedef AggregatorRoute
  * @property {Object} [data] - Data
- * @property {string} [payment_flow_data] - Payment_flow_data
+ * @property {Object} [payment_flow_data] - Payment_flow_data
  * @property {string} [payment_flow] - Payment_flow
  * @property {string} [api_link] - Api_link
  */
@@ -1399,19 +1399,19 @@ class PaymentApplicationModel {
   /** @returns {PaymentStatusUpdateRequest} */
   static PaymentStatusUpdateRequest() {
     return Joi.object({
-      status: Joi.string().allow("").required(),
-      merchant_transaction_id: Joi.string().allow("").required(),
+      status: Joi.string().allow(""),
+      merchant_transaction_id: Joi.string().allow(""),
       method: Joi.string().allow("").required(),
       device_id: Joi.string().allow("").allow(null),
       aggregator: Joi.string().allow("").required(),
-      customer_id: Joi.string().allow("").required(),
-      contact: Joi.string().allow("").required(),
+      customer_id: Joi.string().allow(""),
+      contact: Joi.string().allow(""),
       merchant_order_id: Joi.string().allow("").required(),
       vpa: Joi.string().allow(""),
-      order_id: Joi.string().allow("").required(),
-      currency: Joi.string().allow("").required(),
-      amount: Joi.number().allow(null).required(),
-      email: Joi.string().allow("").required(),
+      order_id: Joi.string().allow(""),
+      currency: Joi.string().allow(""),
+      amount: Joi.number().allow(null),
+      email: Joi.string().allow(""),
     });
   }
 
@@ -1464,13 +1464,17 @@ class PaymentApplicationModel {
       cod_limit: Joi.number().allow(null),
       intent_flow: Joi.boolean().allow(null),
       fynd_vpa: Joi.string().allow("").allow(null),
-      intent_app_error_dict_list: Joi.array().items(
-        PaymentApplicationModel.IntentAppErrorList()
-      ),
+      intent_app_error_dict_list: Joi.array()
+        .items(PaymentApplicationModel.IntentAppErrorList())
+        .allow(null, ""),
       aggregator_name: Joi.string().allow("").required(),
       card_fingerprint: Joi.string().allow("").allow(null),
-      intent_app_error_list: Joi.array().items(Joi.string().allow("")),
-      intent_app: Joi.array().items(PaymentApplicationModel.IntentApp()),
+      intent_app_error_list: Joi.array()
+        .items(Joi.string().allow(""))
+        .allow(null, ""),
+      intent_app: Joi.array()
+        .items(PaymentApplicationModel.IntentApp())
+        .allow(null, ""),
       expired: Joi.boolean().allow(null),
       retry_count: Joi.number().allow(null),
       exp_year: Joi.number().allow(null),
@@ -1513,7 +1517,7 @@ class PaymentApplicationModel {
   static AggregatorRoute() {
     return Joi.object({
       data: Joi.any().allow(null),
-      payment_flow_data: Joi.string().allow("").allow(null),
+      payment_flow_data: Joi.any().allow(null),
       payment_flow: Joi.string().allow("").allow(null),
       api_link: Joi.string().allow("").allow(null),
     });
@@ -1571,9 +1575,9 @@ class PaymentApplicationModel {
       prepayment_value: Joi.number().allow(null),
       cancellation_type: Joi.string().allow("").allow(null),
       refund_time_limit: Joi.number().allow(null),
-      all_prepayment_type: Joi.array().items(
-        Joi.string().allow("").allow(null)
-      ),
+      all_prepayment_type: Joi.array()
+        .items(Joi.string().allow("").allow(null))
+        .allow(null, ""),
       allow_custom_advance_amount: Joi.boolean().allow(null),
     });
   }
@@ -1594,7 +1598,9 @@ class PaymentApplicationModel {
       display_priority: Joi.number().allow(null),
       payment_mode_id: Joi.number().allow(null),
       display_name: Joi.string().allow("").allow(null),
-      list: Joi.array().items(PaymentApplicationModel.PaymentModeList()),
+      list: Joi.array()
+        .items(PaymentApplicationModel.PaymentModeList())
+        .allow(null, ""),
       split: PaymentApplicationModel.SplitObject(),
       advance: PaymentApplicationModel.AdvanceObject(),
     });
@@ -1606,9 +1612,9 @@ class PaymentApplicationModel {
       payment_options: PaymentApplicationModel.PaymentOptionAndFlow().required(),
       success: Joi.boolean().required(),
       payment_breakup: Joi.any(),
-      advance_payment: Joi.array().items(
-        PaymentApplicationModel.AdvancePaymentObject()
-      ),
+      advance_payment: Joi.array()
+        .items(PaymentApplicationModel.AdvancePaymentObject())
+        .allow(null, ""),
     });
   }
 
@@ -1847,9 +1853,9 @@ class PaymentApplicationModel {
   static OrderBeneficiaryResponse() {
     return Joi.object({
       show_beneficiary_details: Joi.boolean(),
-      beneficiaries: Joi.array().items(
-        PaymentApplicationModel.OrderBeneficiaryDetails()
-      ),
+      beneficiaries: Joi.array()
+        .items(PaymentApplicationModel.OrderBeneficiaryDetails())
+        .allow(null, ""),
     });
   }
 
@@ -2355,7 +2361,7 @@ class PaymentApplicationModel {
   static OutstandingOrderDetailsResponse() {
     return Joi.object({
       status_code: Joi.number().required(),
-      data: Joi.array().items(Joi.any()),
+      data: Joi.array().items(Joi.any()).allow(null, ""),
       success: Joi.boolean().required(),
       message: Joi.string().allow("").allow(null),
     });
@@ -2365,7 +2371,7 @@ class PaymentApplicationModel {
   static PaidOrderDetailsResponse() {
     return Joi.object({
       status_code: Joi.number().required(),
-      data: Joi.array().items(Joi.any()),
+      data: Joi.array().items(Joi.any()).allow(null, ""),
       success: Joi.boolean().required(),
       message: Joi.string().allow("").allow(null),
     });

package/sdk/application/Webhook/WebhookApplicationClient.d.ts

@@ -0,0 +1,22 @@
+export = Webhook;
+declare class Webhook {
+    constructor(_conf: any);
+    _conf: any;
+    _relativeUrls: {
+        saveClickEvent: string;
+    };
+    _urls: {};
+    updateUrls(urls: any): void;
+    /**
+     * @param {WebhookApplicationValidator.SaveClickEventParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<WebhookApplicationModel.ClickEventResponse>} - Success response
+     * @name saveClickEvent
+     * @summary: Endpoint to capture click events from sales channels and persist them in database.
+     * @description: Endpoint to capture click events from sales channels. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/webhook/saveClickEvent/).
+     */
+    saveClickEvent({ body, requestHeaders }?: WebhookApplicationValidator.SaveClickEventParam, { responseHeaders }?: object): Promise<WebhookApplicationModel.ClickEventResponse>;
+}
+import WebhookApplicationValidator = require("./WebhookApplicationValidator");
+import WebhookApplicationModel = require("./WebhookApplicationModel");

package/sdk/application/Webhook/WebhookApplicationClient.js

@@ -0,0 +1,115 @@
+const ApplicationAPIClient = require("../ApplicationAPIClient");
+const {
+  FDKClientValidationError,
+  FDKResponseValidationError,
+} = require("../../common/FDKError");
+const constructUrl = require("../constructUrl");
+const Paginator = require("../../common/Paginator");
+const WebhookApplicationValidator = require("./WebhookApplicationValidator");
+const WebhookApplicationModel = require("./WebhookApplicationModel");
+const { Logger } = require("./../../common/Logger");
+const Joi = require("joi");
+
+class Webhook {
+  constructor(_conf) {
+    this._conf = _conf;
+    this._relativeUrls = {
+      saveClickEvent:
+        "/service/application/webhook/v1.0/click-analytics/events",
+    };
+    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 {WebhookApplicationValidator.SaveClickEventParam} arg - Arg object.
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<WebhookApplicationModel.ClickEventResponse>} - Success response
+   * @name saveClickEvent
+   * @summary: Endpoint to capture click events from sales channels and persist them in database.
+   * @description: Endpoint to capture click events from sales channels. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/webhook/saveClickEvent/).
+   */
+  async saveClickEvent(
+    { body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = WebhookApplicationValidator.saveClickEvent().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,
+    } = WebhookApplicationValidator.saveClickEvent().validate(
+      { body },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for application > Webhook > saveClickEvent \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await ApplicationAPIClient.execute(
+      this._conf,
+      "post",
+      constructUrl({
+        url: this._urls["saveClickEvent"],
+        params: {},
+      }),
+      query_params,
+      body,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = WebhookApplicationModel.ClickEventResponse().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 > Webhook > saveClickEvent \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+}
+
+module.exports = Webhook;

package/sdk/application/Webhook/WebhookApplicationModel.d.ts

@@ -0,0 +1,37 @@
+export = WebhookApplicationModel;
+/**
+ * @typedef ClickEventBatch
+ * @property {string} [event_name]
+ */
+/**
+ * @typedef ClickEventRequest
+ * @property {ClickEventBatch[]} [batch]
+ */
+/**
+ * @typedef ClickEventResponse
+ * @property {number} [success_count]
+ * @property {number} [failed_count]
+ * @property {ClickEventBatch[]} [failed_events]
+ */
+declare class WebhookApplicationModel {
+}
+declare namespace WebhookApplicationModel {
+    export { ClickEventBatch, ClickEventRequest, ClickEventResponse };
+}
+/** @returns {ClickEventBatch} */
+declare function ClickEventBatch(): ClickEventBatch;
+type ClickEventBatch = {
+    event_name?: string;
+};
+/** @returns {ClickEventRequest} */
+declare function ClickEventRequest(): ClickEventRequest;
+type ClickEventRequest = {
+    batch?: ClickEventBatch[];
+};
+/** @returns {ClickEventResponse} */
+declare function ClickEventResponse(): ClickEventResponse;
+type ClickEventResponse = {
+    success_count?: number;
+    failed_count?: number;
+    failed_events?: ClickEventBatch[];
+};

package/sdk/application/Webhook/WebhookApplicationModel.js

@@ -0,0 +1,46 @@
+const Joi = require("joi");
+
+/**
+ * @typedef ClickEventBatch
+ * @property {string} [event_name]
+ */
+
+/**
+ * @typedef ClickEventRequest
+ * @property {ClickEventBatch[]} [batch]
+ */
+
+/**
+ * @typedef ClickEventResponse
+ * @property {number} [success_count]
+ * @property {number} [failed_count]
+ * @property {ClickEventBatch[]} [failed_events]
+ */
+
+class WebhookApplicationModel {
+  /** @returns {ClickEventBatch} */
+  static ClickEventBatch() {
+    return Joi.object({
+      event_name: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {ClickEventRequest} */
+  static ClickEventRequest() {
+    return Joi.object({
+      batch: Joi.array().items(WebhookApplicationModel.ClickEventBatch()),
+    });
+  }
+
+  /** @returns {ClickEventResponse} */
+  static ClickEventResponse() {
+    return Joi.object({
+      success_count: Joi.number(),
+      failed_count: Joi.number(),
+      failed_events: Joi.array().items(
+        WebhookApplicationModel.ClickEventBatch()
+      ),
+    });
+  }
+}
+module.exports = WebhookApplicationModel;

package/sdk/application/Webhook/WebhookApplicationValidator.d.ts

@@ -0,0 +1,16 @@
+export = WebhookApplicationValidator;
+/**
+ * @typedef SaveClickEventParam
+ * @property {WebhookApplicationModel.ClickEventRequest} body
+ */
+declare class WebhookApplicationValidator {
+    /** @returns {SaveClickEventParam} */
+    static saveClickEvent(): SaveClickEventParam;
+}
+declare namespace WebhookApplicationValidator {
+    export { SaveClickEventParam };
+}
+type SaveClickEventParam = {
+    body: WebhookApplicationModel.ClickEventRequest;
+};
+import WebhookApplicationModel = require("./WebhookApplicationModel");

package/sdk/application/Webhook/WebhookApplicationValidator.js

@@ -0,0 +1,19 @@
+const Joi = require("joi");
+
+const WebhookApplicationModel = require("./WebhookApplicationModel");
+
+/**
+ * @typedef SaveClickEventParam
+ * @property {WebhookApplicationModel.ClickEventRequest} body
+ */
+
+class WebhookApplicationValidator {
+  /** @returns {SaveClickEventParam} */
+  static saveClickEvent() {
+    return Joi.object({
+      body: WebhookApplicationModel.ClickEventRequest().required(),
+    }).required();
+  }
+}
+
+module.exports = WebhookApplicationValidator;

package/sdk/application/index.d.ts

@@ -12,9 +12,9 @@ export namespace ApplicationModel {
     const LogisticApplicationModel: typeof import("./Logistic/LogisticApplicationModel");
     const OrderApplicationModel: typeof import("./Order/OrderApplicationModel");
     const PaymentApplicationModel: typeof import("./Payment/PaymentApplicationModel");
-    const PosCartApplicationModel: typeof import("./PosCart/PosCartApplicationModel");
     const RewardsApplicationModel: typeof import("./Rewards/RewardsApplicationModel");
     const ShareApplicationModel: typeof import("./Share/ShareApplicationModel");
     const ThemeApplicationModel: typeof import("./Theme/ThemeApplicationModel");
     const UserApplicationModel: typeof import("./User/UserApplicationModel");
+    const WebhookApplicationModel: typeof import("./Webhook/WebhookApplicationModel");
 }

package/sdk/application/index.js

@@ -24,8 +24,6 @@ module.exports = {
 
     PaymentApplicationModel: require("./Payment/PaymentApplicationModel"),
 
-    PosCartApplicationModel: require("./PosCart/PosCartApplicationModel"),
-
     RewardsApplicationModel: require("./Rewards/RewardsApplicationModel"),
 
     ShareApplicationModel: require("./Share/ShareApplicationModel"),
@@ -33,5 +31,7 @@ module.exports = {
     ThemeApplicationModel: require("./Theme/ThemeApplicationModel"),
 
     UserApplicationModel: require("./User/UserApplicationModel"),
+
+    WebhookApplicationModel: require("./Webhook/WebhookApplicationModel"),
   },
 };

package/sdk/partner/Webhook/WebhookPartnerClient.d.ts

@@ -58,7 +58,7 @@ declare class Webhook {
      * @param {import("../PartnerAPIClient").Options} - Options
      * @returns {Promise<WebhookPartnerModel.HistoryResponse>} - Success response
      * @name getHistoricalReports
-     * @summary: Get report download history
+     * @summary: Get report download history.
      * @description: Retrieve history reports for a specific company based on the provided filters.
      *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/webhook/getHistoricalReports/).
      */
@@ -90,7 +90,7 @@ declare class Webhook {
      * @param {import("../PartnerAPIClient").Options} - Options
      * @returns {Promise<WebhookPartnerModel.UpdateSubscriberResponse>} - Success response
      * @name updateSubscriber
-     * @summary: Update subscriber status by id
+     * @summary: Update subscriber status by id.
      * @description: Update subscriber status by id.
      *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/webhook/updateSubscriber/).
      */

package/sdk/partner/Webhook/WebhookPartnerClient.js

@@ -438,7 +438,7 @@ class Webhook {
    * @param {import("../PartnerAPIClient").Options} - Options
    * @returns {Promise<WebhookPartnerModel.HistoryResponse>} - Success response
    * @name getHistoricalReports
-   * @summary: Get report download history
+   * @summary: Get report download history.
    * @description: Retrieve history reports for a specific company based on the provided filters.
    *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/webhook/getHistoricalReports/).
    */
@@ -672,7 +672,7 @@ class Webhook {
    * @param {import("../PartnerAPIClient").Options} - Options
    * @returns {Promise<WebhookPartnerModel.UpdateSubscriberResponse>} - Success response
    * @name updateSubscriber
-   * @summary: Update subscriber status by id
+   * @summary: Update subscriber status by id.
    * @description: Update subscriber status by id.
    *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/webhook/updateSubscriber/).
    */