@gofynd/fdk-client-javascript 1.5.1 → 1.6.0

package/sdk/platform/Payment/PaymentPlatformModel.js

@@ -1002,6 +1002,13 @@ const Joi = require("joi");
  * @property {Object[]} [tags] - Optional address tag
  */
 
+/**
+ * @typedef ReasonDetail
+ * @property {string} [code] - The code indicating the type of reason.
+ * @property {string} [description] - A detailed description of the payment
+ *   reason or error.
+ */
+
 /**
  * @typedef PaymentSessionDetail
  * @property {string} payment_id - Unique transaction id generated by payment gateway
@@ -1038,6 +1045,7 @@ const Joi = require("joi");
  *   merchant account) by payment gateway.
  * @property {Object} [meta] - Extra meta data specific to extension
  * @property {string} status - Status of the payment
+ * @property {ReasonDetail} [reason]
  */
 
 /**
@@ -1361,6 +1369,42 @@ const Joi = require("joi");
  * @property {PaymentModeCustomConfigSchema[]} items
  */
 
+/**
+ * @typedef CustomerValidationSchema
+ * @property {string} aggregator - Aggregator name of the payment gateway.
+ * @property {number} transaction_amount - Payable amount
+ * @property {string} [cart_id] - Unique identifier for the shopping cart.
+ */
+
+/**
+ * @typedef UserCreditSchema
+ * @property {number} amount - The monetary value, which can represent available
+ *   balance, redeemed balance, or hold amount, depending on the context.
+ * @property {string} currency - The currency code (e.g., INR, USD).
+ * @property {string} [unique_id] - A unique identifier for the payment transaction.
+ */
+
+/**
+ * @typedef CreditAccountSummary
+ * @property {string} account_id - Unique identifier associated with the
+ *   customer's account
+ * @property {string} status - Current state of the account, indicating whether
+ *   it is ACTIVE, INACTIVE, or UNREGISTERED.
+ * @property {UserCreditSchema} [redeemable_balance]
+ * @property {UserCreditSchema} [available_balance]
+ * @property {UserCreditSchema} [amount_on_hold]
+ */
+
+/**
+ * @typedef ValidateCustomerCreditSchema
+ * @property {boolean} success - Successful or failure of API
+ * @property {boolean} is_eligible - The customer is eligible to make a transaction or not
+ * @property {boolean} [is_applied] - Credit is applied to the user's account or not
+ * @property {string} message - Detailed message about the user credt eligibility.
+ * @property {string} [cart_id] - Unique identifier for the shopping cart.
+ * @property {CreditAccountSummary} [account]
+ */
+
 class PaymentPlatformModel {
   /** @returns {PaymentGatewayConfigDetails} */
   static PaymentGatewayConfigDetails() {
@@ -2587,6 +2631,14 @@ class PaymentPlatformModel {
     });
   }
 
+  /** @returns {ReasonDetail} */
+  static ReasonDetail() {
+    return Joi.object({
+      code: Joi.string().allow(""),
+      description: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {PaymentSessionDetail} */
   static PaymentSessionDetail() {
     return Joi.object({
@@ -2612,6 +2664,7 @@ class PaymentPlatformModel {
       captured: Joi.boolean(),
       meta: Joi.object().pattern(/\S/, Joi.any()),
       status: Joi.string().allow("").required(),
+      reason: PaymentPlatformModel.ReasonDetail(),
     });
   }
 
@@ -2990,5 +3043,46 @@ class PaymentPlatformModel {
         .required(),
     });
   }
+
+  /** @returns {CustomerValidationSchema} */
+  static CustomerValidationSchema() {
+    return Joi.object({
+      aggregator: Joi.string().allow("").required(),
+      transaction_amount: Joi.number().required(),
+      cart_id: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {UserCreditSchema} */
+  static UserCreditSchema() {
+    return Joi.object({
+      amount: Joi.number().required(),
+      currency: Joi.string().allow("").required(),
+      unique_id: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {CreditAccountSummary} */
+  static CreditAccountSummary() {
+    return Joi.object({
+      account_id: Joi.string().allow("").required(),
+      status: Joi.string().allow("").required(),
+      redeemable_balance: PaymentPlatformModel.UserCreditSchema(),
+      available_balance: PaymentPlatformModel.UserCreditSchema(),
+      amount_on_hold: PaymentPlatformModel.UserCreditSchema(),
+    });
+  }
+
+  /** @returns {ValidateCustomerCreditSchema} */
+  static ValidateCustomerCreditSchema() {
+    return Joi.object({
+      success: Joi.boolean().required(),
+      is_eligible: Joi.boolean().required(),
+      is_applied: Joi.boolean(),
+      message: Joi.string().allow("").required(),
+      cart_id: Joi.string().allow(""),
+      account: PaymentPlatformModel.CreditAccountSummary(),
+    });
+  }
 }
 module.exports = PaymentPlatformModel;

package/sdk/platform/User/UserPlatformModel.d.ts

@@ -211,7 +211,7 @@ export = UserPlatformModel;
  * @property {string} [first_name]
  * @property {string} [last_name]
  * @property {string} [gender]
- * @property {string} username
+ * @property {string} [username]
  * @property {Object} [meta]
  * @property {string} [external_id]
  * @property {string} [rr_id]
@@ -835,7 +835,7 @@ type CreateUserRequestSchema = {
     first_name?: string;
     last_name?: string;
     gender?: string;
-    username: string;
+    username?: string;
     meta?: any;
     external_id?: string;
     rr_id?: string;

package/sdk/platform/User/UserPlatformModel.js

@@ -239,7 +239,7 @@ const Joi = require("joi");
  * @property {string} [first_name]
  * @property {string} [last_name]
  * @property {string} [gender]
- * @property {string} username
+ * @property {string} [username]
  * @property {Object} [meta]
  * @property {string} [external_id]
  * @property {string} [rr_id]
@@ -827,7 +827,7 @@ class UserPlatformModel {
       first_name: Joi.string().allow(""),
       last_name: Joi.string().allow(""),
       gender: Joi.string().allow(""),
-      username: Joi.string().allow("").required(),
+      username: Joi.string().allow(""),
       meta: Joi.object().pattern(/\S/, Joi.any()),
       external_id: Joi.string().allow(""),
       rr_id: Joi.string().allow(""),

package/sdk/platform/Webhook/WebhookPlatformModel.d.ts

@@ -55,7 +55,7 @@ export = WebhookPlatformModel;
  */
 /**
  * @typedef EventConfigResult
- * @property {EventConfig[]} [event_configs]
+ * @property {EventConfig[]} [event_configs] - List of event configurations.
  */
 /**
  * @typedef Association
@@ -96,7 +96,7 @@ export = WebhookPlatformModel;
  * @property {string} [created_on] - The date and time when the subscriber was created.
  * @property {string} [type] - The type of subscriber, which can either be passed as null.
  * @property {AuthMeta} [auth_meta]
- * @property {EventConfig[]} [event_configs]
+ * @property {EventConfig[]} [event_configs] - List of event configurations.
  */
 /**
  * @typedef Events
@@ -183,7 +183,7 @@ export = WebhookPlatformModel;
  */
 /**
  * @typedef SubscriberConfigList
- * @property {SubscriberDetails[]} [items]
+ * @property {SubscriberDetails[]} [items] - List of subscriber details.
  * @property {Page} [page]
  */
 /**
@@ -199,7 +199,7 @@ export = WebhookPlatformModel;
  * @property {string} type - The type of the configuration.
  * @property {Object} [custom_headers] - Custom headers for the configuration.
  * @property {AuthMeta} [auth_meta]
- * @property {RestEventData[]} events
+ * @property {RestEventData[]} events - List of event data for configuration.
  */
 /**
  * @typedef QueueEventData
@@ -211,13 +211,13 @@ export = WebhookPlatformModel;
  */
 /**
  * @typedef KafkaConfig
- * @property {string} [type]
- * @property {QueueEventData[]} events
+ * @property {string} [type] - Type of Kafka configuration (optional).
+ * @property {QueueEventData[]} events - List of event data for configuration.
  */
 /**
  * @typedef PubSubConfig
- * @property {string} [type]
- * @property {QueueEventData[]} events
+ * @property {string} [type] - Type of Pub/Sub configuration (optional).
+ * @property {QueueEventData[]} events - List of event data for configuration.
  */
 /**
  * @typedef TemporalEventData
@@ -230,8 +230,8 @@ export = WebhookPlatformModel;
  */
 /**
  * @typedef TemporalConfig
- * @property {string} [type]
- * @property {TemporalEventData[]} events
+ * @property {string} [type] - Type of Temporal configuration (optional).
+ * @property {TemporalEventData[]} events - List of event data for configuration.
  */
 /**
  * @typedef SqsEventData
@@ -243,8 +243,8 @@ export = WebhookPlatformModel;
  */
 /**
  * @typedef SqsConfig
- * @property {string} [type]
- * @property {SqsEventData[]} events
+ * @property {string} [type] - Type of SQS configuration (optional).
+ * @property {SqsEventData[]} events - List of event data for configuration.
  */
 /**
  * @typedef EventBridgeData
@@ -257,8 +257,9 @@ export = WebhookPlatformModel;
  */
 /**
  * @typedef EventBridgeConfig
- * @property {string} [type]
- * @property {EventBridgeData[]} events
+ * @property {string} [type] - Type of event configuration (optional).
+ * @property {EventBridgeData[]} events - List of event data for EventBridge
+ *   configuration.
  */
 /**
  * @typedef EventMapBody
@@ -445,6 +446,9 @@ type EventConfig = {
 /** @returns {EventConfigResult} */
 declare function EventConfigResult(): EventConfigResult;
 type EventConfigResult = {
+    /**
+     * - List of event configurations.
+     */
     event_configs?: EventConfig[];
 };
 /** @returns {Association} */
@@ -547,6 +551,9 @@ type SubscriberDetails = {
      */
     type?: string;
     auth_meta?: AuthMeta;
+    /**
+     * - List of event configurations.
+     */
     event_configs?: EventConfig[];
 };
 /** @returns {Events} */
@@ -776,6 +783,9 @@ type SubscriberConfigResult = {
 /** @returns {SubscriberConfigList} */
 declare function SubscriberConfigList(): SubscriberConfigList;
 type SubscriberConfigList = {
+    /**
+     * - List of subscriber details.
+     */
     items?: SubscriberDetails[];
     page?: Page;
 };
@@ -815,6 +825,9 @@ type RestConfig = {
      */
     custom_headers?: any;
     auth_meta?: AuthMeta;
+    /**
+     * - List of event data for configuration.
+     */
     events: RestEventData[];
 };
 /** @returns {QueueEventData} */
@@ -844,13 +857,25 @@ type QueueEventData = {
 /** @returns {KafkaConfig} */
 declare function KafkaConfig(): KafkaConfig;
 type KafkaConfig = {
+    /**
+     * - Type of Kafka configuration (optional).
+     */
     type?: string;
+    /**
+     * - List of event data for configuration.
+     */
     events: QueueEventData[];
 };
 /** @returns {PubSubConfig} */
 declare function PubSubConfig(): PubSubConfig;
 type PubSubConfig = {
+    /**
+     * - Type of Pub/Sub configuration (optional).
+     */
     type?: string;
+    /**
+     * - List of event data for configuration.
+     */
     events: QueueEventData[];
 };
 /** @returns {TemporalEventData} */
@@ -884,7 +909,13 @@ type TemporalEventData = {
 /** @returns {TemporalConfig} */
 declare function TemporalConfig(): TemporalConfig;
 type TemporalConfig = {
+    /**
+     * - Type of Temporal configuration (optional).
+     */
     type?: string;
+    /**
+     * - List of event data for configuration.
+     */
     events: TemporalEventData[];
 };
 /** @returns {SqsEventData} */
@@ -914,7 +945,13 @@ type SqsEventData = {
 /** @returns {SqsConfig} */
 declare function SqsConfig(): SqsConfig;
 type SqsConfig = {
+    /**
+     * - Type of SQS configuration (optional).
+     */
     type?: string;
+    /**
+     * - List of event data for configuration.
+     */
     events: SqsEventData[];
 };
 /** @returns {EventBridgeData} */
@@ -945,7 +982,14 @@ type EventBridgeData = {
 /** @returns {EventBridgeConfig} */
 declare function EventBridgeConfig(): EventBridgeConfig;
 type EventBridgeConfig = {
+    /**
+     * - Type of event configuration (optional).
+     */
     type?: string;
+    /**
+     * - List of event data for EventBridge
+     * configuration.
+     */
     events: EventBridgeData[];
 };
 /** @returns {EventMapBody} */

package/sdk/platform/Webhook/WebhookPlatformModel.js

@@ -60,7 +60,7 @@ const Joi = require("joi");
 
 /**
  * @typedef EventConfigResult
- * @property {EventConfig[]} [event_configs]
+ * @property {EventConfig[]} [event_configs] - List of event configurations.
  */
 
 /**
@@ -105,7 +105,7 @@ const Joi = require("joi");
  * @property {string} [created_on] - The date and time when the subscriber was created.
  * @property {string} [type] - The type of subscriber, which can either be passed as null.
  * @property {AuthMeta} [auth_meta]
- * @property {EventConfig[]} [event_configs]
+ * @property {EventConfig[]} [event_configs] - List of event configurations.
  */
 
 /**
@@ -199,7 +199,7 @@ const Joi = require("joi");
 
 /**
  * @typedef SubscriberConfigList
- * @property {SubscriberDetails[]} [items]
+ * @property {SubscriberDetails[]} [items] - List of subscriber details.
  * @property {Page} [page]
  */
 
@@ -217,7 +217,7 @@ const Joi = require("joi");
  * @property {string} type - The type of the configuration.
  * @property {Object} [custom_headers] - Custom headers for the configuration.
  * @property {AuthMeta} [auth_meta]
- * @property {RestEventData[]} events
+ * @property {RestEventData[]} events - List of event data for configuration.
  */
 
 /**
@@ -231,14 +231,14 @@ const Joi = require("joi");
 
 /**
  * @typedef KafkaConfig
- * @property {string} [type]
- * @property {QueueEventData[]} events
+ * @property {string} [type] - Type of Kafka configuration (optional).
+ * @property {QueueEventData[]} events - List of event data for configuration.
  */
 
 /**
  * @typedef PubSubConfig
- * @property {string} [type]
- * @property {QueueEventData[]} events
+ * @property {string} [type] - Type of Pub/Sub configuration (optional).
+ * @property {QueueEventData[]} events - List of event data for configuration.
  */
 
 /**
@@ -253,8 +253,8 @@ const Joi = require("joi");
 
 /**
  * @typedef TemporalConfig
- * @property {string} [type]
- * @property {TemporalEventData[]} events
+ * @property {string} [type] - Type of Temporal configuration (optional).
+ * @property {TemporalEventData[]} events - List of event data for configuration.
  */
 
 /**
@@ -268,8 +268,8 @@ const Joi = require("joi");
 
 /**
  * @typedef SqsConfig
- * @property {string} [type]
- * @property {SqsEventData[]} events
+ * @property {string} [type] - Type of SQS configuration (optional).
+ * @property {SqsEventData[]} events - List of event data for configuration.
  */
 
 /**
@@ -284,8 +284,9 @@ const Joi = require("joi");
 
 /**
  * @typedef EventBridgeConfig
- * @property {string} [type]
- * @property {EventBridgeData[]} events
+ * @property {string} [type] - Type of event configuration (optional).
+ * @property {EventBridgeData[]} events - List of event data for EventBridge
+ *   configuration.
  */
 
 /**

package/sdk/public/Catalog/CatalogPublicClient.d.ts

@@ -0,0 +1,22 @@
+export = Catalog;
+declare class Catalog {
+    constructor(_conf: any);
+    _conf: any;
+    _relativeUrls: {
+        getTaxonomyByLevel: string;
+    };
+    _urls: {};
+    updateUrls(urls: any): void;
+    /**
+     * @param {CatalogPublicValidator.GetTaxonomyByLevelParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PublicAPIClient").Options} - Options
+     * @returns {Promise<CatalogPublicModel.TaxonomyResponseSchema>} - Success response
+     * @name getTaxonomyByLevel
+     * @summary: Get Taxonomy Information by Level
+     * @description: Get Taxonomy Details for a given level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/catalog/getTaxonomyByLevel/).
+     */
+    getTaxonomyByLevel({ level, l0Slug, l1Slug, l2Slug, l3Slug, limit, requestHeaders }?: CatalogPublicValidator.GetTaxonomyByLevelParam, { responseHeaders }?: object): Promise<CatalogPublicModel.TaxonomyResponseSchema>;
+}
+import CatalogPublicValidator = require("./CatalogPublicValidator");
+import CatalogPublicModel = require("./CatalogPublicModel");

package/sdk/public/Catalog/CatalogPublicClient.js

@@ -0,0 +1,138 @@
+const {
+  FDKClientValidationError,
+  FDKResponseValidationError,
+} = require("../../common/FDKError");
+
+const PublicAPIClient = require("../PublicAPIClient");
+const constructUrl = require("../constructUrl");
+const Paginator = require("../../common/Paginator");
+
+const CatalogPublicValidator = require("./CatalogPublicValidator");
+const CatalogPublicModel = require("./CatalogPublicModel");
+const Joi = require("joi");
+const { Logger } = require("./../../common/Logger");
+
+class Catalog {
+  constructor(_conf) {
+    this._conf = _conf;
+    this._relativeUrls = {
+      getTaxonomyByLevel: "/service/public/catalog/v1.0/taxonomy/level/{level}",
+    };
+    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 {CatalogPublicValidator.GetTaxonomyByLevelParam} arg - Arg object.
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PublicAPIClient").Options} - Options
+   * @returns {Promise<CatalogPublicModel.TaxonomyResponseSchema>} - Success response
+   * @name getTaxonomyByLevel
+   * @summary: Get Taxonomy Information by Level
+   * @description: Get Taxonomy Details for a given level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/catalog/getTaxonomyByLevel/).
+   */
+  async getTaxonomyByLevel(
+    { level, l0Slug, l1Slug, l2Slug, l3Slug, limit, requestHeaders } = {
+      requestHeaders: {},
+    },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    let invalidInput = [];
+
+    if (!level) {
+      invalidInput.push({
+        message: `The 'level' field is required.`,
+        path: ["level"],
+      });
+    }
+    if (invalidInput.length) {
+      const error = new Error();
+      error.message = "Missing required field";
+      error.details = invalidInput;
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const { error } = CatalogPublicValidator.getTaxonomyByLevel().validate(
+      { level, l0Slug, l1Slug, l2Slug, l3Slug, limit },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = CatalogPublicValidator.getTaxonomyByLevel().validate(
+      { level, l0Slug, l1Slug, l2Slug, l3Slug, limit },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for public > Catalog > getTaxonomyByLevel \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+    query_params["l0_slug"] = l0Slug;
+    query_params["l1_slug"] = l1Slug;
+    query_params["l2_slug"] = l2Slug;
+    query_params["l3_slug"] = l3Slug;
+    query_params["limit"] = limit;
+
+    const xHeaders = {};
+
+    const response = await PublicAPIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["getTaxonomyByLevel"],
+        params: { level },
+      }),
+      query_params,
+      undefined,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = CatalogPublicModel.TaxonomyResponseSchema().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 public > Catalog > getTaxonomyByLevel \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+}
+
+module.exports = Catalog;