@gofynd/fdk-client-javascript 1.0.3 → 1.0.4

package/sdk/platform/Order/OrderPlatformClient.js

@@ -1,9 +1,10 @@
-const Paginator = require("../../common/Paginator");
-const { FDKClientValidationError } = require("../../common/FDKError");
 const PlatformAPIClient = require("../PlatformAPIClient");
+const { FDKClientValidationError } = require("../../common/FDKError");
+const Paginator = require("../../common/Paginator");
 const OrderValidator = require("./OrderPlatformValidator");
 const OrderModel = require("./OrderPlatformModel");
 const { Logger } = require("./../../common/Logger");
+const Joi = require("joi");
 
 class Order {
   constructor(config) {
@@ -215,12 +216,20 @@ class Order {
    * @summary:
    * @description:
    */
-  async click2Call({ caller, receiver, bagId, callingTo, callerId } = {}) {
+  async click2Call({
+    caller,
+    receiver,
+    bagId,
+
+    callingTo,
+    callerId,
+  } = {}) {
     const { error } = OrderValidator.click2Call().validate(
       {
         caller,
         receiver,
         bagId,
+
         callingTo,
         callerId,
       },
@@ -236,6 +245,7 @@ class Order {
         caller,
         receiver,
         bagId,
+
         callingTo,
         callerId,
       },
@@ -2831,6 +2841,7 @@ class Order {
   async updateAddress({
     shipmentId,
     addressCategory,
+
     name,
     address,
     addressType,
@@ -2846,6 +2857,7 @@ class Order {
       {
         shipmentId,
         addressCategory,
+
         name,
         address,
         addressType,
@@ -2868,6 +2880,7 @@ class Order {
       {
         shipmentId,
         addressCategory,
+
         name,
         address,
         addressType,

package/sdk/platform/Order/OrderPlatformModel.js

@@ -136,6 +136,7 @@ class OrderModel {
       employee_discount: Joi.number(),
       is_priority: Joi.boolean(),
       loyalty_discount: Joi.number(),
+      marketplace_invoice_id: Joi.string().allow("").allow(null),
       order_item_id: Joi.string().allow(""),
       quantity: Joi.number(),
       size_level_total_qty: Joi.number().allow(null),

package/sdk/platform/Order/OrderPlatformValidator.js

@@ -357,4 +357,5 @@ class OrderValidator {
     }).required();
   }
 }
+
 module.exports = OrderValidator;

package/sdk/platform/Partner/PartnerPlatformApplicationClient.js

@@ -1,9 +1,10 @@
-const Paginator = require("../../common/Paginator");
 const PlatformAPIClient = require("../PlatformAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
+const Paginator = require("../../common/Paginator");
 const PartnerValidator = require("./PartnerPlatformApplicationValidator");
 const PartnerModel = require("./PartnerPlatformModel");
 const { Logger } = require("./../../common/Logger");
+const Joi = require("joi");
 
 class Partner {
   constructor(config, applicationId) {
@@ -141,4 +142,5 @@ class Partner {
     return response;
   }
 }
+
 module.exports = Partner;

package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js

@@ -1,6 +1,6 @@
 const Joi = require("joi");
-const PartnerModel = require("./PartnerPlatformModel");
 
+const PartnerModel = require("./PartnerPlatformModel");
 class PartnerValidator {
   static addProxyPath() {
     return Joi.object({

package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts

@@ -31,7 +31,7 @@ declare class Payment {
      * @summary: Get bank details
      * @description: Use this API to get saved bank details for returned/cancelled order using order id.
      */
-    getBankAccountDetailsOpenAPI({ orderId, requestHash }?: {
+    getBankAccountDetailsOpenAPI({ orderId, requestHash, }?: {
         orderId: string;
         requestHash?: string;
     }): Promise<RefundAccountResponse>;

package/sdk/platform/Payment/PaymentPlatformApplicationClient.js

@@ -1,9 +1,10 @@
-const Paginator = require("../../common/Paginator");
 const PlatformAPIClient = require("../PlatformAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
+const Paginator = require("../../common/Paginator");
 const PaymentValidator = require("./PaymentPlatformApplicationValidator");
 const PaymentModel = require("./PaymentPlatformModel");
 const { Logger } = require("./../../common/Logger");
+const Joi = require("joi");
 
 class Payment {
   constructor(config, applicationId) {
@@ -145,10 +146,15 @@ class Payment {
    * @summary: Get bank details
    * @description: Use this API to get saved bank details for returned/cancelled order using order id.
    */
-  async getBankAccountDetailsOpenAPI({ orderId, requestHash } = {}) {
+  async getBankAccountDetailsOpenAPI({
+    orderId,
+
+    requestHash,
+  } = {}) {
     const { error } = PaymentValidator.getBankAccountDetailsOpenAPI().validate(
       {
         orderId,
+
         requestHash,
       },
       { abortEarly: false, allowUnknown: true }
@@ -163,6 +169,7 @@ class Payment {
     } = PaymentValidator.getBankAccountDetailsOpenAPI().validate(
       {
         orderId,
+
         requestHash,
       },
       { abortEarly: false, allowUnknown: false }
@@ -344,9 +351,7 @@ class Payment {
    */
   async getUserBeneficiaries({ orderId } = {}) {
     const { error } = PaymentValidator.getUserBeneficiaries().validate(
-      {
-        orderId,
-      },
+      { orderId },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -357,9 +362,7 @@ class Payment {
     const {
       error: warrning,
     } = PaymentValidator.getUserBeneficiaries().validate(
-      {
-        orderId,
-      },
+      { orderId },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
@@ -476,9 +479,7 @@ class Payment {
    */
   async getUserOrderBeneficiaries({ orderId } = {}) {
     const { error } = PaymentValidator.getUserOrderBeneficiaries().validate(
-      {
-        orderId,
-      },
+      { orderId },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -489,9 +490,7 @@ class Payment {
     const {
       error: warrning,
     } = PaymentValidator.getUserOrderBeneficiaries().validate(
-      {
-        orderId,
-      },
+      { orderId },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
@@ -726,4 +725,5 @@ class Payment {
     return response;
   }
 }
+
 module.exports = Payment;

package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js

@@ -1,6 +1,6 @@
 const Joi = require("joi");
-const PaymentModel = require("./PaymentPlatformModel");
 
+const PaymentModel = require("./PaymentPlatformModel");
 class PaymentValidator {
   static addRefundBankAccountUsingOTP() {
     return Joi.object({

package/sdk/platform/Payment/PaymentPlatformClient.js

@@ -1,9 +1,10 @@
-const Paginator = require("../../common/Paginator");
-const { FDKClientValidationError } = require("../../common/FDKError");
 const PlatformAPIClient = require("../PlatformAPIClient");
+const { FDKClientValidationError } = require("../../common/FDKError");
+const Paginator = require("../../common/Paginator");
 const PaymentValidator = require("./PaymentPlatformValidator");
 const PaymentModel = require("./PaymentPlatformModel");
 const { Logger } = require("./../../common/Logger");
+const Joi = require("joi");
 
 class Payment {
   constructor(config) {

package/sdk/platform/Payment/PaymentPlatformValidator.js

@@ -63,4 +63,5 @@ class PaymentValidator {
     }).required();
   }
 }
+
 module.exports = PaymentValidator;

package/sdk/platform/PlatformClient.d.ts

@@ -1443,6 +1443,7 @@ type DefaultNavigationResponse = {
 };
 type Detail = {
     description?: string;
+    image_url?: string;
     title?: string;
 };
 type EditorMeta = {
@@ -3267,6 +3268,7 @@ type AffiliateMeta = {
     employee_discount?: number;
     is_priority?: boolean;
     loyalty_discount?: number;
+    marketplace_invoice_id?: string;
     order_item_id?: string;
     quantity?: number;
     size_level_total_qty?: number;
@@ -5787,15 +5789,15 @@ type GetCompanySerializer = {
     addresses?: GetAddressSerializer[];
     business_type?: string;
     company_type?: string;
-    created_by?: UserSerializer1;
+    created_by?: UserSerializer2;
     created_on?: string;
-    modified_by?: UserSerializer1;
+    modified_by?: UserSerializer2;
     modified_on?: string;
     name?: string;
     reject_reason?: string;
     stage?: string;
     uid?: number;
-    verified_by?: UserSerializer1;
+    verified_by?: UserSerializer2;
     verified_on?: string;
 };
 type GetConfigMetadataResponse = {
@@ -5866,14 +5868,14 @@ type GetLocationSerializer = {
     code: string;
     company?: GetCompanySerializer;
     contact_numbers?: SellerPhoneNumber[];
-    created_by?: UserSerializer2;
+    created_by?: UserSerializer1;
     created_on?: string;
     display_name: string;
     documents?: Document[];
     gst_credentials?: InvoiceDetailsSerializer;
     integration_type?: LocationIntegrationType;
     manager?: LocationManagerSerializer;
-    modified_by?: UserSerializer2;
+    modified_by?: UserSerializer1;
     modified_on?: string;
     name: string;
     notification_emails?: string[];
@@ -5883,7 +5885,7 @@ type GetLocationSerializer = {
     store_type?: string;
     timing?: LocationDayWiseSerializer[];
     uid?: number;
-    verified_by?: UserSerializer2;
+    verified_by?: UserSerializer1;
     verified_on?: string;
     warnings?: any;
 };
@@ -9289,7 +9291,7 @@ type AddProductCart = {
     extra_meta?: any;
     item_id?: number;
     item_size?: string;
-    parent_item_identifiers?: any;
+    parent_item_identifiers?: any[];
     pos?: boolean;
     product_group_tags?: string[];
     quantity?: number;
@@ -9540,7 +9542,7 @@ type LoyaltyPoints = {
     total?: number;
 };
 type OpenapiCartDetailsRequest = {
-    cart_items?: CartItem;
+    cart_items: CartItem[];
 };
 type OpenapiCartDetailsResponse = {
     breakup_values?: CartBreakup;
@@ -9549,7 +9551,7 @@ type OpenapiCartDetailsResponse = {
     message?: string;
 };
 type OpenApiCartServiceabilityRequest = {
-    cart_items?: CartItem;
+    cart_items: CartItem[];
     shipping_address: ShippingAddress;
 };
 type OpenApiCartServiceabilityResponse = {
@@ -9882,6 +9884,8 @@ type ShippingAddress = {
     city?: string;
     country?: string;
     country_code?: string;
+    country_iso_code?: string;
+    country_phone_code?: string;
     email?: string;
     landmark?: string;
     meta?: any;

package/sdk/platform/PlatformClient.js

@@ -1789,6 +1789,7 @@ class PlatformClient {
 /**
  * @typedef Detail
  * @property {string} [description]
+ * @property {string} [image_url]
  * @property {string} [title]
  */
 /**
@@ -3929,6 +3930,7 @@ class PlatformClient {
  * @property {number} [employee_discount]
  * @property {boolean} [is_priority]
  * @property {number} [loyalty_discount]
+ * @property {string} [marketplace_invoice_id]
  * @property {string} [order_item_id]
  * @property {number} [quantity]
  * @property {number} [size_level_total_qty]
@@ -6839,15 +6841,15 @@ class PlatformClient {
  * @property {GetAddressSerializer[]} [addresses]
  * @property {string} [business_type]
  * @property {string} [company_type]
- * @property {UserSerializer1} [created_by]
+ * @property {UserSerializer2} [created_by]
  * @property {string} [created_on]
- * @property {UserSerializer1} [modified_by]
+ * @property {UserSerializer2} [modified_by]
  * @property {string} [modified_on]
  * @property {string} [name]
  * @property {string} [reject_reason]
  * @property {string} [stage]
  * @property {number} [uid]
- * @property {UserSerializer1} [verified_by]
+ * @property {UserSerializer2} [verified_by]
  * @property {string} [verified_on]
  */
 /**
@@ -6924,14 +6926,14 @@ class PlatformClient {
  * @property {string} code
  * @property {GetCompanySerializer} [company]
  * @property {SellerPhoneNumber[]} [contact_numbers]
- * @property {UserSerializer2} [created_by]
+ * @property {UserSerializer1} [created_by]
  * @property {string} [created_on]
  * @property {string} display_name
  * @property {Document[]} [documents]
  * @property {InvoiceDetailsSerializer} [gst_credentials]
  * @property {LocationIntegrationType} [integration_type]
  * @property {LocationManagerSerializer} [manager]
- * @property {UserSerializer2} [modified_by]
+ * @property {UserSerializer1} [modified_by]
  * @property {string} [modified_on]
  * @property {string} name
  * @property {string[]} [notification_emails]
@@ -6941,7 +6943,7 @@ class PlatformClient {
  * @property {string} [store_type]
  * @property {LocationDayWiseSerializer[]} [timing]
  * @property {number} [uid]
- * @property {UserSerializer2} [verified_by]
+ * @property {UserSerializer1} [verified_by]
  * @property {string} [verified_on]
  * @property {Object} [warnings]
  */
@@ -11116,7 +11118,7 @@ class PlatformClient {
  * @property {Object} [extra_meta]
  * @property {number} [item_id]
  * @property {string} [item_size]
- * @property {Object} [parent_item_identifiers]
+ * @property {Object[]} [parent_item_identifiers]
  * @property {boolean} [pos]
  * @property {string[]} [product_group_tags]
  * @property {number} [quantity]
@@ -11427,7 +11429,7 @@ class PlatformClient {
  */
 /**
  * @typedef OpenapiCartDetailsRequest
- * @property {CartItem} [cart_items]
+ * @property {CartItem[]} cart_items
  */
 /**
  * @typedef OpenapiCartDetailsResponse
@@ -11438,7 +11440,7 @@ class PlatformClient {
  */
 /**
  * @typedef OpenApiCartServiceabilityRequest
- * @property {CartItem} [cart_items]
+ * @property {CartItem[]} cart_items
  * @property {ShippingAddress} shipping_address
  */
 /**
@@ -11830,6 +11832,8 @@ class PlatformClient {
  * @property {string} [city]
  * @property {string} [country]
  * @property {string} [country_code]
+ * @property {string} [country_iso_code]
+ * @property {string} [country_phone_code]
  * @property {string} [email]
  * @property {string} [landmark]
  * @property {Object} [meta]

package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts

@@ -33,7 +33,7 @@ declare class Rewards {
      * @summary: Get offer by name
      * @description: Use this API to get the offer details and configuration by entering the name of the offer.
      */
-    getOfferByName({ name, cookie }?: {
+    getOfferByName({ name, cookie, }?: {
         name: string;
         cookie: string;
     }): Promise<Offer>;
@@ -54,7 +54,7 @@ declare class Rewards {
      * @summary: Get all transactions of reward points
      * @description: Use this API to get a list of points transactions.
      */
-    getUserPointsHistory({ userId, pageId, pageSize }?: {
+    getUserPointsHistory({ userId, pageId, pageSize, }?: {
         userId: string;
         pageId?: string;
         pageSize?: number;
@@ -133,7 +133,7 @@ declare class Rewards {
      * @summary: Update offer by name
      * @description: Use this API to update the offer details
      */
-    updateOfferByName({ name, body }?: {
+    updateOfferByName({ name, body, }?: {
         name: string;
         body: Offer;
     }): Promise<Offer>;
@@ -145,7 +145,7 @@ declare class Rewards {
      * @summary: Update user status
      * @description: Use this API to update the user status active/archive
      */
-    updateUserStatus({ userId, body }?: {
+    updateUserStatus({ userId, body, }?: {
         userId: string;
         body: AppUser;
     }): Promise<AppUser>;

package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js

@@ -1,9 +1,10 @@
-const Paginator = require("../../common/Paginator");
 const PlatformAPIClient = require("../PlatformAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
+const Paginator = require("../../common/Paginator");
 const RewardsValidator = require("./RewardsPlatformApplicationValidator");
 const RewardsModel = require("./RewardsPlatformModel");
 const { Logger } = require("./../../common/Logger");
+const Joi = require("joi");
 
 class Rewards {
   constructor(config, applicationId) {
@@ -20,9 +21,7 @@ class Rewards {
    */
   async getGiveawayAudienceStatus({ audienceId } = {}) {
     const { error } = RewardsValidator.getGiveawayAudienceStatus().validate(
-      {
-        audienceId,
-      },
+      { audienceId },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -33,9 +32,7 @@ class Rewards {
     const {
       error: warrning,
     } = RewardsValidator.getGiveawayAudienceStatus().validate(
-      {
-        audienceId,
-      },
+      { audienceId },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
@@ -143,10 +140,15 @@ class Rewards {
    * @summary: Get offer by name
    * @description: Use this API to get the offer details and configuration by entering the name of the offer.
    */
-  async getOfferByName({ name, cookie } = {}) {
+  async getOfferByName({
+    name,
+
+    cookie,
+  } = {}) {
     const { error } = RewardsValidator.getOfferByName().validate(
       {
         name,
+
         cookie,
       },
       { abortEarly: false, allowUnknown: true }
@@ -159,6 +161,7 @@ class Rewards {
     const { error: warrning } = RewardsValidator.getOfferByName().validate(
       {
         name,
+
         cookie,
       },
       { abortEarly: false, allowUnknown: false }
@@ -265,10 +268,16 @@ class Rewards {
    * @summary: Get all transactions of reward points
    * @description: Use this API to get a list of points transactions.
    */
-  async getUserPointsHistory({ userId, pageId, pageSize } = {}) {
+  async getUserPointsHistory({
+    userId,
+
+    pageId,
+    pageSize,
+  } = {}) {
     const { error } = RewardsValidator.getUserPointsHistory().validate(
       {
         userId,
+
         pageId,
         pageSize,
       },
@@ -284,6 +293,7 @@ class Rewards {
     } = RewardsValidator.getUserPointsHistory().validate(
       {
         userId,
+
         pageId,
         pageSize,
       },
@@ -673,10 +683,15 @@ class Rewards {
    * @summary: Update offer by name
    * @description: Use this API to update the offer details
    */
-  async updateOfferByName({ name, body } = {}) {
+  async updateOfferByName({
+    name,
+
+    body,
+  } = {}) {
     const { error } = RewardsValidator.updateOfferByName().validate(
       {
         name,
+
         body,
       },
       { abortEarly: false, allowUnknown: true }
@@ -689,6 +704,7 @@ class Rewards {
     const { error: warrning } = RewardsValidator.updateOfferByName().validate(
       {
         name,
+
         body,
       },
       { abortEarly: false, allowUnknown: false }
@@ -735,10 +751,15 @@ class Rewards {
    * @summary: Update user status
    * @description: Use this API to update the user status active/archive
    */
-  async updateUserStatus({ userId, body } = {}) {
+  async updateUserStatus({
+    userId,
+
+    body,
+  } = {}) {
     const { error } = RewardsValidator.updateUserStatus().validate(
       {
         userId,
+
         body,
       },
       { abortEarly: false, allowUnknown: true }
@@ -751,6 +772,7 @@ class Rewards {
     const { error: warrning } = RewardsValidator.updateUserStatus().validate(
       {
         userId,
+
         body,
       },
       { abortEarly: false, allowUnknown: false }
@@ -798,9 +820,7 @@ class Rewards {
    */
   async user({ userId } = {}) {
     const { error } = RewardsValidator.user().validate(
-      {
-        userId,
-      },
+      { userId },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -809,9 +829,7 @@ class Rewards {
 
     // Showing warrnings if extra unknown parameters are found
     const { error: warrning } = RewardsValidator.user().validate(
-      {
-        userId,
-      },
+      { userId },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
@@ -848,4 +866,5 @@ class Rewards {
     return response;
   }
 }
+
 module.exports = Rewards;

package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js

@@ -1,6 +1,6 @@
 const Joi = require("joi");
-const RewardsModel = require("./RewardsPlatformModel");
 
+const RewardsModel = require("./RewardsPlatformModel");
 class RewardsValidator {
   static getGiveawayAudienceStatus() {
     return Joi.object({

package/sdk/platform/Share/SharePlatformApplicationClient.js

@@ -1,9 +1,10 @@
-const Paginator = require("../../common/Paginator");
 const PlatformAPIClient = require("../PlatformAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
+const Paginator = require("../../common/Paginator");
 const ShareValidator = require("./SharePlatformApplicationValidator");
 const ShareModel = require("./SharePlatformModel");
 const { Logger } = require("./../../common/Logger");
+const Joi = require("joi");
 
 class Share {
   constructor(config, applicationId) {
@@ -310,4 +311,5 @@ class Share {
     return response;
   }
 }
+
 module.exports = Share;

package/sdk/platform/Share/SharePlatformApplicationValidator.js

@@ -1,6 +1,6 @@
 const Joi = require("joi");
-const ShareModel = require("./SharePlatformModel");
 
+const ShareModel = require("./SharePlatformModel");
 class ShareValidator {
   static createShortLink() {
     return Joi.object({

package/sdk/platform/Theme/ThemePlatformApplicationClient.js

@@ -1,9 +1,10 @@
-const Paginator = require("../../common/Paginator");
 const PlatformAPIClient = require("../PlatformAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
+const Paginator = require("../../common/Paginator");
 const ThemeValidator = require("./ThemePlatformApplicationValidator");
 const ThemeModel = require("./ThemePlatformModel");
 const { Logger } = require("./../../common/Logger");
+const Joi = require("joi");
 
 class Theme {
   constructor(config, applicationId) {
@@ -1469,4 +1470,5 @@ class Theme {
     return response;
   }
 }
+
 module.exports = Theme;

package/sdk/platform/Theme/ThemePlatformApplicationValidator.js

@@ -1,6 +1,6 @@
 const Joi = require("joi");
-const ThemeModel = require("./ThemePlatformModel");
 
+const ThemeModel = require("./ThemePlatformModel");
 class ThemeValidator {
   static addToThemeLibrary() {
     return Joi.object({