@gofynd/fdk-client-javascript 1.0.3 → 1.1.0

package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts

@@ -136,6 +136,23 @@ declare class Cart {
     getCouponById({ id }?: {
         id: string;
     }): Promise<CouponUpdate>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.code] -
+     * @returns {Promise<Object>} - Success response
+     * @summary: Check if coupon is already created with coupon code
+     * @description: Check if sent coupon code is already existing coupon code. As coupon code is to be unique.
+     */
+    getCouponCodeExists({ code }?: {
+        code?: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @returns {Promise<Object>} - Success response
+     * @summary: Get coupon options enums with display values
+     * @description: Get coupon enum values for fields in valid coupon object. Used for front end to create, update and filter coupon lists via fields
+     */
+    getCouponOptionValues({}?: any): Promise<any>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageNo] -
@@ -195,6 +212,16 @@ declare class Cart {
     getPromotionById({ id }?: {
         id: string;
     }): Promise<PromotionUpdate>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.code] -
+     * @returns {Promise<Object>} - Success response
+     * @summary: Check if promotion is already created with promotion code
+     * @description: Check if sent promotion code is already existing promotion code. As promotion code is to be unique.
+     */
+    getPromotionCodeExists({ code }?: {
+        code?: string;
+    }): Promise<any>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageNo] -

package/sdk/platform/Cart/CartPlatformApplicationClient.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 CartValidator = require("./CartPlatformApplicationValidator");
 const CartModel = require("./CartPlatformModel");
 const { Logger } = require("./../../common/Logger");
+const Joi = require("joi");
 
 class Cart {
   constructor(config, applicationId) {
@@ -658,6 +659,120 @@ class Cart {
     return response;
   }
 
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} [arg.code] -
+   * @returns {Promise<Object>} - Success response
+   * @summary: Check if coupon is already created with coupon code
+   * @description: Check if sent coupon code is already existing coupon code. As coupon code is to be unique.
+   */
+  async getCouponCodeExists({ code } = {}) {
+    const { error } = CartValidator.getCouponCodeExists().validate(
+      {
+        code,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = CartValidator.getCouponCodeExists().validate(
+      {
+        code,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getCouponCodeExists",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
+    const query_params = {};
+    query_params["code"] = code;
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/cart/v1.0/company/${this.config.companyId}/application/${this.applicationId}/coupon_code_exists`,
+      query_params,
+      undefined
+    );
+
+    const { error: res_error } = Joi.any().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getCouponCodeExists",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @returns {Promise<Object>} - Success response
+   * @summary: Get coupon options enums with display values
+   * @description: Get coupon enum values for fields in valid coupon object. Used for front end to create, update and filter coupon lists via fields
+   */
+  async getCouponOptionValues({} = {}) {
+    const { error } = CartValidator.getCouponOptionValues().validate(
+      {},
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = CartValidator.getCouponOptionValues().validate(
+      {},
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getCouponOptionValues",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
+    const query_params = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/cart/v1.0/company/${this.config.companyId}/application/${this.applicationId}/coupon_options`,
+      query_params,
+      undefined
+    );
+
+    const { error: res_error } = Joi.any().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getCouponOptionValues",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
+  }
+
   /**
    * @param {Object} arg - Arg object.
    * @param {number} [arg.pageNo] -
@@ -866,6 +981,66 @@ class Cart {
     return response;
   }
 
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} [arg.code] -
+   * @returns {Promise<Object>} - Success response
+   * @summary: Check if promotion is already created with promotion code
+   * @description: Check if sent promotion code is already existing promotion code. As promotion code is to be unique.
+   */
+  async getPromotionCodeExists({ code } = {}) {
+    const { error } = CartValidator.getPromotionCodeExists().validate(
+      {
+        code,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = CartValidator.getPromotionCodeExists().validate(
+      {
+        code,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getPromotionCodeExists",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
+    const query_params = {};
+    query_params["code"] = code;
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/cart/v1.0/company/${this.config.companyId}/application/${this.applicationId}/promotion_code_exists`,
+      query_params,
+      undefined
+    );
+
+    const { error: res_error } = Joi.any().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getPromotionCodeExists",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
+  }
+
   /**
    * @param {Object} arg - Arg object.
    * @param {number} [arg.pageNo] -
@@ -1335,4 +1510,5 @@ class Cart {
     return response;
   }
 }
+
 module.exports = Cart;

package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts

@@ -9,8 +9,11 @@ declare class CartValidator {
     static getAbandonedCart(): any;
     static getAbandonedCartDetails(): any;
     static getCouponById(): any;
+    static getCouponCodeExists(): any;
+    static getCouponOptionValues(): any;
     static getCoupons(): any;
     static getPromotionById(): any;
+    static getPromotionCodeExists(): any;
     static getPromotions(): any;
     static updateCart(): any;
     static updateCoupon(): any;

package/sdk/platform/Cart/CartPlatformApplicationValidator.js

@@ -1,6 +1,6 @@
 const Joi = require("joi");
-const CartModel = require("./CartPlatformModel");
 
+const CartModel = require("./CartPlatformModel");
 class CartValidator {
   static addItems() {
     return Joi.object({
@@ -66,6 +66,16 @@ class CartValidator {
     }).required();
   }
 
+  static getCouponCodeExists() {
+    return Joi.object({
+      code: Joi.string().allow(""),
+    }).required();
+  }
+
+  static getCouponOptionValues() {
+    return Joi.object({}).required();
+  }
+
   static getCoupons() {
     return Joi.object({
       pageNo: Joi.number(),
@@ -85,6 +95,12 @@ class CartValidator {
     }).required();
   }
 
+  static getPromotionCodeExists() {
+    return Joi.object({
+      code: Joi.string().allow(""),
+    }).required();
+  }
+
   static getPromotions() {
     return Joi.object({
       pageNo: Joi.number(),

package/sdk/platform/Cart/CartPlatformModel.js

@@ -74,7 +74,9 @@ class CartModel {
       extra_meta: Joi.any(),
       item_id: Joi.number(),
       item_size: Joi.string().allow(""),
-      parent_item_identifiers: Joi.any(),
+      parent_item_identifiers: Joi.array().items(
+        Joi.object().pattern(/\S/, Joi.string().allow(""))
+      ),
       pos: Joi.boolean(),
       product_group_tags: Joi.array().items(Joi.string().allow("").allow(null)),
       quantity: Joi.number(),
@@ -421,7 +423,7 @@ class CartModel {
   }
   static OpenapiCartDetailsRequest() {
     return Joi.object({
-      cart_items: CartModel.CartItem(),
+      cart_items: Joi.array().items(CartModel.CartItem()).required(),
     });
   }
   static OpenapiCartDetailsResponse() {
@@ -434,7 +436,7 @@ class CartModel {
   }
   static OpenApiCartServiceabilityRequest() {
     return Joi.object({
-      cart_items: CartModel.CartItem(),
+      cart_items: Joi.array().items(CartModel.CartItem()).required(),
       shipping_address: CartModel.ShippingAddress().required(),
     });
   }
@@ -881,6 +883,8 @@ class CartModel {
       city: Joi.string().allow("").allow(null),
       country: Joi.string().allow("").allow(null),
       country_code: Joi.string().allow(""),
+      country_iso_code: Joi.string().allow(""),
+      country_phone_code: Joi.string().allow(""),
       email: Joi.string().allow(""),
       landmark: Joi.string().allow(""),
       meta: Joi.any(),

package/sdk/platform/Catalog/CatalogPlatformApplicationClient.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 CatalogValidator = require("./CatalogPlatformApplicationValidator");
 const CatalogModel = require("./CatalogPlatformModel");
 const { Logger } = require("./../../common/Logger");
+const Joi = require("joi");
 
 class Catalog {
   constructor(config, applicationId) {
@@ -4033,4 +4034,5 @@ class Catalog {
     return response;
   }
 }
+
 module.exports = Catalog;

package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js

@@ -1,6 +1,6 @@
 const Joi = require("joi");
-const CatalogModel = require("./CatalogPlatformModel");
 
+const CatalogModel = require("./CatalogPlatformModel");
 class CatalogValidator {
   static addCollectionItems() {
     return Joi.object({

package/sdk/platform/Catalog/CatalogPlatformClient.d.ts

@@ -330,7 +330,7 @@ declare class Catalog {
     /**
      * @param {Object} arg - Arg object.
      * @param {boolean} [arg.isActive] - The is_active status for the optin id.
-     * @param {boolean} [arg.q] - The search value to filter the list.
+     * @param {string} [arg.q] - The search value to filter the list.
      * @param {number} [arg.pageNo] - The number of page for the company id.
      * @param {number} [arg.pageSize] - Number of records that can be seen on
      *   the page for the company id.
@@ -342,7 +342,7 @@ declare class Catalog {
      */
     getCompanyBrandDetail({ isActive, q, pageNo, pageSize, marketplace, }?: {
         isActive?: boolean;
-        q?: boolean;
+        q?: string;
         pageNo?: number;
         pageSize?: number;
         marketplace?: string;

package/sdk/platform/Catalog/CatalogPlatformClient.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 CatalogValidator = require("./CatalogPlatformValidator");
 const CatalogModel = require("./CatalogPlatformModel");
 const { Logger } = require("./../../common/Logger");
+const Joi = require("joi");
 
 class Catalog {
   constructor(config) {
@@ -1947,7 +1948,7 @@ class Catalog {
   /**
    * @param {Object} arg - Arg object.
    * @param {boolean} [arg.isActive] - The is_active status for the optin id.
-   * @param {boolean} [arg.q] - The search value to filter the list.
+   * @param {string} [arg.q] - The search value to filter the list.
    * @param {number} [arg.pageNo] - The number of page for the company id.
    * @param {number} [arg.pageSize] - Number of records that can be seen on
    *   the page for the company id.
@@ -3792,9 +3793,7 @@ class Catalog {
    */
   async getSingleProductHSNCode({ reportingHsn } = {}) {
     const { error } = CatalogValidator.getSingleProductHSNCode().validate(
-      {
-        reportingHsn,
-      },
+      { reportingHsn },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -3805,9 +3804,7 @@ class Catalog {
     const {
       error: warrning,
     } = CatalogValidator.getSingleProductHSNCode().validate(
-      {
-        reportingHsn,
-      },
+      { reportingHsn },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {

package/sdk/platform/Catalog/CatalogPlatformModel.js

@@ -1179,15 +1179,15 @@ class CatalogModel {
       addresses: Joi.array().items(CatalogModel.GetAddressSerializer()),
       business_type: Joi.string().allow(""),
       company_type: Joi.string().allow(""),
-      created_by: CatalogModel.UserSerializer1(),
+      created_by: CatalogModel.UserSerializer2(),
       created_on: Joi.string().allow(""),
-      modified_by: CatalogModel.UserSerializer1(),
+      modified_by: CatalogModel.UserSerializer2(),
       modified_on: Joi.string().allow(""),
       name: Joi.string().allow(""),
       reject_reason: Joi.string().allow(""),
       stage: Joi.string().allow(""),
       uid: Joi.number(),
-      verified_by: CatalogModel.UserSerializer1(),
+      verified_by: CatalogModel.UserSerializer2(),
       verified_on: Joi.string().allow(""),
     });
   }
@@ -1270,14 +1270,14 @@ class CatalogModel {
       code: Joi.string().allow("").required(),
       company: CatalogModel.GetCompanySerializer(),
       contact_numbers: Joi.array().items(CatalogModel.SellerPhoneNumber()),
-      created_by: CatalogModel.UserSerializer2(),
+      created_by: CatalogModel.UserSerializer1(),
       created_on: Joi.string().allow(""),
       display_name: Joi.string().allow("").required(),
       documents: Joi.array().items(CatalogModel.Document()),
       gst_credentials: CatalogModel.InvoiceDetailsSerializer(),
       integration_type: CatalogModel.LocationIntegrationType(),
       manager: CatalogModel.LocationManagerSerializer(),
-      modified_by: CatalogModel.UserSerializer2(),
+      modified_by: CatalogModel.UserSerializer1(),
       modified_on: Joi.string().allow(""),
       name: Joi.string().allow("").required(),
       notification_emails: Joi.array().items(Joi.string().allow("")),
@@ -1287,7 +1287,7 @@ class CatalogModel {
       store_type: Joi.string().allow(""),
       timing: Joi.array().items(CatalogModel.LocationDayWiseSerializer()),
       uid: Joi.number(),
-      verified_by: CatalogModel.UserSerializer2(),
+      verified_by: CatalogModel.UserSerializer1(),
       verified_on: Joi.string().allow(""),
       warnings: Joi.any(),
     });
@@ -1622,7 +1622,7 @@ class CatalogModel {
       has_next: Joi.boolean(),
       has_previous: Joi.boolean(),
       item_total: Joi.number().required(),
-      next_id: Joi.string().allow(""),
+      next_id: Joi.string().allow("").allow(null),
       type: Joi.string().allow("").required(),
     });
   }
@@ -2288,7 +2288,7 @@ class CatalogModel {
       net_quantity: CatalogModel.NetQuantity(),
       no_of_boxes: Joi.number(),
       product_group_tag: Joi.array().items(Joi.string().allow("")),
-      product_publish: CatalogModel.ProductPublish(),
+      product_publish: CatalogModel.ProductPublish1(),
       requester: Joi.string().allow(""),
       return_config: CatalogModel.ReturnConfig().required(),
       short_description: Joi.string().allow(""),
@@ -2504,7 +2504,7 @@ class CatalogModel {
       pending: Joi.string().allow(""),
       primary_color: Joi.string().allow(""),
       product_group_tag: Joi.array().items(Joi.string().allow("")),
-      product_publish: CatalogModel.ProductPublish1(),
+      product_publish: CatalogModel.ProductPublish(),
       return_config: CatalogModel.ReturnConfigResponse(),
       short_description: Joi.string().allow(""),
       size_guide: Joi.string().allow(""),

package/sdk/platform/Catalog/CatalogPlatformValidator.js

@@ -193,7 +193,7 @@ class CatalogValidator {
   static getCompanyBrandDetail() {
     return Joi.object({
       isActive: Joi.boolean(),
-      q: Joi.boolean(),
+      q: Joi.string().allow(""),
       pageNo: Joi.number(),
       pageSize: Joi.number(),
       marketplace: Joi.string().allow(""),
@@ -538,4 +538,5 @@ class CatalogValidator {
     }).required();
   }
 }
+
 module.exports = CatalogValidator;

package/sdk/platform/Common/CommonPlatformClient.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 CommonValidator = require("./CommonPlatformValidator");
 const CommonModel = require("./CommonPlatformModel");
 const { Logger } = require("./../../common/Logger");
+const Joi = require("joi");
 
 class Common {
   constructor(config) {
@@ -23,10 +24,7 @@ class Common {
    */
   async getLocations({ locationType, id } = {}) {
     const { error } = CommonValidator.getLocations().validate(
-      {
-        locationType,
-        id,
-      },
+      { locationType, id },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -35,10 +33,7 @@ class Common {
 
     // Showing warrnings if extra unknown parameters are found
     const { error: warrning } = CommonValidator.getLocations().validate(
-      {
-        locationType,
-        id,
-      },
+      { locationType, id },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
@@ -90,10 +85,7 @@ class Common {
    */
   async searchApplication({ authorization, query } = {}) {
     const { error } = CommonValidator.searchApplication().validate(
-      {
-        authorization,
-        query,
-      },
+      { authorization, query },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -102,10 +94,7 @@ class Common {
 
     // Showing warrnings if extra unknown parameters are found
     const { error: warrning } = CommonValidator.searchApplication().validate(
-      {
-        authorization,
-        query,
-      },
+      { authorization, query },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {

package/sdk/platform/Common/CommonPlatformValidator.js

@@ -16,4 +16,5 @@ class CommonValidator {
     });
   }
 }
+
 module.exports = CommonValidator;

package/sdk/platform/Communication/CommunicationPlatformApplicationClient.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 CommunicationValidator = require("./CommunicationPlatformApplicationValidator");
 const CommunicationModel = require("./CommunicationPlatformModel");
 const { Logger } = require("./../../common/Logger");
+const Joi = require("joi");
 
 class Communication {
   constructor(config, applicationId) {
@@ -3072,4 +3073,5 @@ class Communication {
     return response;
   }
 }
+
 module.exports = Communication;

package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js

@@ -1,6 +1,6 @@
 const Joi = require("joi");
-const CommunicationModel = require("./CommunicationPlatformModel");
 
+const CommunicationModel = require("./CommunicationPlatformModel");
 class CommunicationValidator {
   static createAudience() {
     return Joi.object({

package/sdk/platform/Communication/CommunicationPlatformClient.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 CommunicationValidator = require("./CommunicationPlatformValidator");
 const CommunicationModel = require("./CommunicationPlatformModel");
 const { Logger } = require("./../../common/Logger");
+const Joi = require("joi");
 
 class Communication {
   constructor(config) {
@@ -103,7 +104,7 @@ class Communication {
       });
       return data;
     };
-    paginator.setCallback(callback);
+    paginator.setCallback(callback.bind(this));
     return paginator;
   }
 }

package/sdk/platform/Communication/CommunicationPlatformValidator.js

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

package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.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 CompanyProfileValidator = require("./CompanyProfilePlatformValidator");
 const CompanyProfileModel = require("./CompanyProfilePlatformModel");
 const { Logger } = require("./../../common/Logger");
+const Joi = require("joi");
 
 class CompanyProfile {
   constructor(config) {
@@ -566,7 +567,7 @@ class CompanyProfile {
       });
       return data;
     };
-    paginator.setCallback(callback);
+    paginator.setCallback(callback.bind(this));
     return paginator;
   }
 
@@ -826,7 +827,7 @@ class CompanyProfile {
       });
       return data;
     };
-    paginator.setCallback(callback);
+    paginator.setCallback(callback.bind(this));
     return paginator;
   }
 

package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js

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