@gofynd/fdk-client-javascript 1.0.3 → 1.1.0

package/sdk/platform/PlatformClient.js

@@ -2263,6 +2263,18 @@ class PlatformClient {
  * @property {number} [discount_amount]
  * @property {boolean} [is_valid]
  */
+/**
+ * @typedef CreateOneTimeCharge
+ * @property {OneTimeChargeItem} charge
+ * @property {boolean} [is_test]
+ * @property {string} name
+ * @property {string} return_url
+ */
+/**
+ * @typedef CreateOneTimeChargeResponse
+ * @property {OneTimeChargeEntity} [charge]
+ * @property {string} [confirm_url]
+ */
 /**
  * @typedef CreateSubscriptionCharge
  * @property {boolean} [is_test]
@@ -2535,6 +2547,33 @@ class PlatformClient {
  * @property {string} [end]
  * @property {string} [start]
  */
+/**
+ * @typedef OneTimeChargeEntity
+ * @property {string} [_id]
+ * @property {string} [activated_on]
+ * @property {string} [cancelled_on]
+ * @property {string} [entity_id]
+ * @property {string} [entity_type]
+ * @property {boolean} [is_test]
+ * @property {Object} [meta]
+ * @property {Object} [metadata]
+ * @property {string} [name]
+ * @property {EntityChargePrice} [price]
+ * @property {string} [pricing_type]
+ * @property {string} [return_url]
+ * @property {string} [status]
+ * @property {string} [subscriber_id]
+ */
+/**
+ * @typedef OneTimeChargeItem
+ * @property {number} [capped_amount]
+ * @property {boolean} [is_test]
+ * @property {Object} [metadata]
+ * @property {string} name
+ * @property {EntityChargePrice} price
+ * @property {string} pricing_type
+ * @property {string} [term]
+ */
 /**
  * @typedef Page
  * @property {number} [current]
@@ -2723,6 +2762,7 @@ class PlatformClient {
 /**
  * @typedef SubscriptionStatus
  * @property {boolean} [is_enabled]
+ * @property {number} [mandate_amount]
  * @property {Subscription} [subscription]
  */
 /**
@@ -3929,6 +3969,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 +6880,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 +6965,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 +6982,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]
  */
@@ -7838,7 +7879,7 @@ class PlatformClient {
  * @property {NetQuantity} [net_quantity]
  * @property {number} [no_of_boxes]
  * @property {string[]} [product_group_tag]
- * @property {ProductPublish} [product_publish]
+ * @property {ProductPublish1} [product_publish]
  * @property {string} [requester]
  * @property {ReturnConfig} return_config
  * @property {string} [short_description]
@@ -8034,7 +8075,7 @@ class PlatformClient {
  * @property {string} [pending]
  * @property {string} [primary_color]
  * @property {string[]} [product_group_tag]
- * @property {ProductPublish1} [product_publish]
+ * @property {ProductPublish} [product_publish]
  * @property {ReturnConfigResponse} [return_config]
  * @property {string} [short_description]
  * @property {string} [size_guide]
@@ -11116,7 +11157,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 +11468,7 @@ class PlatformClient {
  */
 /**
  * @typedef OpenapiCartDetailsRequest
- * @property {CartItem} [cart_items]
+ * @property {CartItem[]} cart_items
  */
 /**
  * @typedef OpenapiCartDetailsResponse
@@ -11438,7 +11479,7 @@ class PlatformClient {
  */
 /**
  * @typedef OpenApiCartServiceabilityRequest
- * @property {CartItem} [cart_items]
+ * @property {CartItem[]} cart_items
  * @property {ShippingAddress} shipping_address
  */
 /**
@@ -11830,6 +11871,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

@@ -5,12 +5,14 @@ declare class Rewards {
     applicationId: any;
     /**
      * @param {Object} arg - Arg object.
+     * @param {string} arg.id - Giveaway ID
      * @param {string} arg.audienceId - Audience id
      * @returns {Promise<GiveawayAudience>} - Success response
      * @summary: Get the Giveaway audience status
      * @description: Get giveaway audience status
      */
-    getGiveawayAudienceStatus({ audienceId }?: {
+    getGiveawayAudienceStatus({ id, audienceId }?: {
+        id: string;
         audienceId: string;
     }): Promise<GiveawayAudience>;
     /**
@@ -26,16 +28,12 @@ declare class Rewards {
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.name - The name given to the offer.
-     * @param {string} arg.cookie - User's session cookie. This cookie is set in
-     *   browser cookie when logged-in to fynd's authentication system i.e.
-     *   `Grimlock` or by using grimlock-backend SDK for backend implementation.
      * @returns {Promise<Offer>} - Success response
      * @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 }?: {
         name: string;
-        cookie: string;
     }): Promise<Offer>;
     /**
      * @param {Object} arg - Arg object.
@@ -44,6 +42,16 @@ declare class Rewards {
      * @description: Use this API to get a list of valid android paths required by the Rewards INIT API to validate a fradualent device.
      */
     getRewardsConfiguration({}?: any): Promise<ConfigurationRes>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.userId - User id
+     * @returns {Promise<UserRes>} - Success response
+     * @summary: Get user reward details
+     * @description: Use this API to get the user reward details
+     */
+    getUserDetails({ userId }?: {
+        userId: string;
+    }): Promise<UserRes>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.userId - User id
@@ -54,7 +62,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 +141,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,19 +153,9 @@ 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>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.userId - User id
-     * @returns {Promise<UserRes>} - Success response
-     * @summary: Get user reward details
-     * @description: Use this API to get the user reward details
-     */
-    user({ userId }?: {
-        userId: string;
-    }): Promise<UserRes>;
 }
 import Paginator = require("../../common/Paginator");

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) {
@@ -13,16 +14,15 @@ class Rewards {
 
   /**
    * @param {Object} arg - Arg object.
+   * @param {string} arg.id - Giveaway ID
    * @param {string} arg.audienceId - Audience id
    * @returns {Promise<GiveawayAudience>} - Success response
    * @summary: Get the Giveaway audience status
    * @description: Get giveaway audience status
    */
-  async getGiveawayAudienceStatus({ audienceId } = {}) {
+  async getGiveawayAudienceStatus({ id, audienceId } = {}) {
     const { error } = RewardsValidator.getGiveawayAudienceStatus().validate(
-      {
-        audienceId,
-      },
+      { id, audienceId },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -33,9 +33,7 @@ class Rewards {
     const {
       error: warrning,
     } = RewardsValidator.getGiveawayAudienceStatus().validate(
-      {
-        audienceId,
-      },
+      { id, audienceId },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
@@ -51,7 +49,7 @@ class Rewards {
     const response = await PlatformAPIClient.execute(
       this.config,
       "get",
-      `/service/platform/rewards/v1.0/company/${this.config.companyId}/application/${this.applicationId}/giveaways/audience/${audienceId}/status`,
+      `/service/platform/rewards/v1.0/company/${this.config.companyId}/application/${this.applicationId}/giveaways/:id/audience/${audienceId}/status`,
       query_params,
       undefined
     );
@@ -136,19 +134,13 @@ class Rewards {
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.name - The name given to the offer.
-   * @param {string} arg.cookie - User's session cookie. This cookie is set in
-   *   browser cookie when logged-in to fynd's authentication system i.e.
-   *   `Grimlock` or by using grimlock-backend SDK for backend implementation.
    * @returns {Promise<Offer>} - Success response
    * @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 } = {}) {
     const { error } = RewardsValidator.getOfferByName().validate(
-      {
-        name,
-        cookie,
-      },
+      { name },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -157,10 +149,7 @@ class Rewards {
 
     // Showing warrnings if extra unknown parameters are found
     const { error: warrning } = RewardsValidator.getOfferByName().validate(
-      {
-        name,
-        cookie,
-      },
+      { name },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
@@ -255,6 +244,61 @@ class Rewards {
     return response;
   }
 
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.userId - User id
+   * @returns {Promise<UserRes>} - Success response
+   * @summary: Get user reward details
+   * @description: Use this API to get the user reward details
+   */
+  async getUserDetails({ userId } = {}) {
+    const { error } = RewardsValidator.getUserDetails().validate(
+      { userId },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = RewardsValidator.getUserDetails().validate(
+      { userId },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getUserDetails",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
+    const query_params = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/rewards/v1.0/company/${this.config.companyId}/application/${this.applicationId}/users/${userId}/`,
+      query_params,
+      undefined
+    );
+
+    const { error: res_error } = RewardsModel.UserRes().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getUserDetails",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
+  }
+
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.userId - User id
@@ -265,10 +309,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 +334,7 @@ class Rewards {
     } = RewardsValidator.getUserPointsHistory().validate(
       {
         userId,
+
         pageId,
         pageSize,
       },
@@ -673,10 +724,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 +745,7 @@ class Rewards {
     const { error: warrning } = RewardsValidator.updateOfferByName().validate(
       {
         name,
+
         body,
       },
       { abortEarly: false, allowUnknown: false }
@@ -735,10 +792,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 +813,7 @@ class Rewards {
     const { error: warrning } = RewardsValidator.updateUserStatus().validate(
       {
         userId,
+
         body,
       },
       { abortEarly: false, allowUnknown: false }
@@ -788,64 +851,6 @@ class Rewards {
 
     return response;
   }
-
-  /**
-   * @param {Object} arg - Arg object.
-   * @param {string} arg.userId - User id
-   * @returns {Promise<UserRes>} - Success response
-   * @summary: Get user reward details
-   * @description: Use this API to get the user reward details
-   */
-  async user({ userId } = {}) {
-    const { error } = RewardsValidator.user().validate(
-      {
-        userId,
-      },
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = RewardsValidator.user().validate(
-      {
-        userId,
-      },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: "Parameter Validation warrnings for user",
-      });
-      Logger({ level: "WARN", message: warrning });
-    }
-
-    const query_params = {};
-
-    const response = await PlatformAPIClient.execute(
-      this.config,
-      "get",
-      `/service/platform/rewards/v1.0/company/${this.config.companyId}/application/${this.applicationId}/users/${userId}/`,
-      query_params,
-      undefined
-    );
-
-    const { error: res_error } = RewardsModel.UserRes().validate(response, {
-      abortEarly: false,
-      allowUnknown: false,
-    });
-
-    if (res_error) {
-      Logger({
-        level: "WARN",
-        message: "Response Validation Warnnings for user",
-      });
-      Logger({ level: "WARN", message: res_error });
-    }
-
-    return response;
-  }
 }
+
 module.exports = Rewards;

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

@@ -4,6 +4,7 @@ declare class RewardsValidator {
     static getGiveawayById(): any;
     static getOfferByName(): any;
     static getRewardsConfiguration(): any;
+    static getUserDetails(): any;
     static getUserPointsHistory(): any;
     static saveGiveAway(): any;
     static setRewardsConfiguration(): any;
@@ -12,5 +13,4 @@ declare class RewardsValidator {
     static updateGiveAway(): any;
     static updateOfferByName(): any;
     static updateUserStatus(): any;
-    static user(): any;
 }

package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js

@@ -1,9 +1,10 @@
 const Joi = require("joi");
-const RewardsModel = require("./RewardsPlatformModel");
 
+const RewardsModel = require("./RewardsPlatformModel");
 class RewardsValidator {
   static getGiveawayAudienceStatus() {
     return Joi.object({
+      id: Joi.string().allow("").required(),
       audienceId: Joi.string().allow("").required(),
     }).required();
   }
@@ -17,8 +18,6 @@ class RewardsValidator {
   static getOfferByName() {
     return Joi.object({
       name: Joi.string().allow("").required(),
-
-      cookie: Joi.string().allow("").required(),
     }).required();
   }
 
@@ -26,6 +25,12 @@ class RewardsValidator {
     return Joi.object({}).required();
   }
 
+  static getUserDetails() {
+    return Joi.object({
+      userId: Joi.string().allow("").required(),
+    }).required();
+  }
+
   static getUserPointsHistory() {
     return Joi.object({
       userId: Joi.string().allow("").required(),
@@ -80,12 +85,6 @@ class RewardsValidator {
       body: RewardsModel.AppUser().required(),
     }).required();
   }
-
-  static user() {
-    return Joi.object({
-      userId: Joi.string().allow("").required(),
-    }).required();
-  }
 }
 
 module.exports = RewardsValidator;

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({

package/sdk/platform/User/UserPlatformApplicationClient.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 UserValidator = require("./UserPlatformApplicationValidator");
 const UserModel = require("./UserPlatformModel");
 const { Logger } = require("./../../common/Logger");
+const Joi = require("joi");
 
 class User {
   constructor(config, applicationId) {
@@ -1090,4 +1091,5 @@ class User {
     return response;
   }
 }
+
 module.exports = User;

package/sdk/platform/User/UserPlatformApplicationValidator.js

@@ -1,6 +1,6 @@
 const Joi = require("joi");
-const UserModel = require("./UserPlatformModel");
 
+const UserModel = require("./UserPlatformModel");
 class UserValidator {
   static archiveUser() {
     return Joi.object({

package/sdk/platform/Webhook/WebhookPlatformClient.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 WebhookValidator = require("./WebhookPlatformValidator");
 const WebhookModel = require("./WebhookPlatformModel");
 const { Logger } = require("./../../common/Logger");
+const Joi = require("joi");
 
 class Webhook {
   constructor(config) {