@gofynd/fdk-client-javascript 3.16.3 → 3.17.0

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

@@ -324,7 +324,7 @@ export = UserPlatformModel;
  * @property {string} [user_attribute_definition_id] - ID of the user attribute
  *   definition used in the condition
  * @property {string} [type] - Type of condition to apply on the attribute value.
- * @property {string} [value] - Value of the condition
+ * @property {Object} [value] - Value of the condition
  * @property {boolean} [ignore_year] - Indicates if the year should be ignored
  *   for the condition
  */
@@ -1347,7 +1347,7 @@ type ConditionsSchema = {
     /**
      * - Value of the condition
      */
-    value?: string;
+    value?: any;
     /**
      * - Indicates if the year should be ignored
      * for the condition

package/sdk/platform/User/UserPlatformModel.js

@@ -364,7 +364,7 @@ const Joi = require("joi");
  * @property {string} [user_attribute_definition_id] - ID of the user attribute
  *   definition used in the condition
  * @property {string} [type] - Type of condition to apply on the attribute value.
- * @property {string} [value] - Value of the condition
+ * @property {Object} [value] - Value of the condition
  * @property {boolean} [ignore_year] - Indicates if the year should be ignored
  *   for the condition
  */
@@ -926,7 +926,7 @@ class UserPlatformModel {
   static BulkUserAttributeRequestBody() {
     return Joi.object({
       definition_id: Joi.string().allow("").required(),
-      value: Joi.any().required(),
+      value: Joi.object().pattern(/\S/, Joi.any()).required(),
     });
   }
 
@@ -1206,7 +1206,7 @@ class UserPlatformModel {
     return Joi.object({
       user_attribute_definition_id: Joi.string().allow(""),
       type: Joi.string().allow(""),
-      value: Joi.string().allow(""),
+      value: Joi.object().pattern(/\S/, Joi.any()),
       ignore_year: Joi.boolean(),
     });
   }
@@ -1247,7 +1247,7 @@ class UserPlatformModel {
     return Joi.object({
       definition_id: Joi.string().allow("").required(),
       type: Joi.string().allow("").required(),
-      value: Joi.any().required(),
+      value: Joi.object().pattern(/\S/, Joi.any()).required(),
     });
   }
 

package/sdk/platform/index.d.ts

@@ -18,7 +18,6 @@ export namespace PlatformModel {
     const OrderPlatformModel: typeof import("./Order/OrderPlatformModel");
     const PartnerPlatformModel: typeof import("./Partner/PartnerPlatformModel");
     const PaymentPlatformModel: typeof import("./Payment/PaymentPlatformModel");
-    const RewardsPlatformModel: typeof import("./Rewards/RewardsPlatformModel");
     const SharePlatformModel: typeof import("./Share/SharePlatformModel");
     const ThemePlatformModel: typeof import("./Theme/ThemePlatformModel");
     const UserPlatformModel: typeof import("./User/UserPlatformModel");

package/sdk/platform/index.js

@@ -36,8 +36,6 @@ module.exports = {
 
     PaymentPlatformModel: require("./Payment/PaymentPlatformModel"),
 
-    RewardsPlatformModel: require("./Rewards/RewardsPlatformModel"),
-
     SharePlatformModel: require("./Share/SharePlatformModel"),
 
     ThemePlatformModel: require("./Theme/ThemePlatformModel"),

package/sdk/public/Configuration/ConfigurationPublicModel.d.ts

@@ -37,6 +37,11 @@ export = ConfigurationPublicModel;
  *   redirection is for long time period redirection, and temporary redirection
  *   for a short time period.
  */
+/**
+ * @typedef RegionDetails
+ * @property {string} [slug] - Region slug identifier.
+ * @property {string} [zone] - Zone identifier within the region.
+ */
 /**
  * @typedef ApplicationMeta
  * @property {string} [name] - Indicates the name of application meta
@@ -82,6 +87,9 @@ export = ConfigurationPublicModel;
  * @property {SecureUrl} [mobile_logo]
  * @property {Domain} [domain]
  * @property {string} [slug]
+ * @property {string} [region] - Region identifier for the sales channel. When
+ *   zone is "default", this equals the slug. Otherwise, it is formatted as "slug/zone".
+ * @property {RegionDetails} [region_details]
  */
 /**
  * @typedef NotFound
@@ -129,7 +137,7 @@ export = ConfigurationPublicModel;
 declare class ConfigurationPublicModel {
 }
 declare namespace ConfigurationPublicModel {
-    export { ApplicationResponseSchema, Domain, ApplicationWebsite, ApplicationCors, ApplicationAuth, ApplicationRedirections, ApplicationMeta, SecureUrl, Application, NotFound, BadRequestSchema, LocationDefaultLanguage, LocationDefaultCurrency, LocationCountry, Locations };
+    export { ApplicationResponseSchema, Domain, ApplicationWebsite, ApplicationCors, ApplicationAuth, ApplicationRedirections, RegionDetails, ApplicationMeta, SecureUrl, Application, NotFound, BadRequestSchema, LocationDefaultLanguage, LocationDefaultCurrency, LocationCountry, Locations };
 }
 /** @returns {ApplicationResponseSchema} */
 declare function ApplicationResponseSchema(): ApplicationResponseSchema;
@@ -208,6 +216,18 @@ type ApplicationRedirections = {
      */
     type?: string;
 };
+/** @returns {RegionDetails} */
+declare function RegionDetails(): RegionDetails;
+type RegionDetails = {
+    /**
+     * - Region slug identifier.
+     */
+    slug?: string;
+    /**
+     * - Zone identifier within the region.
+     */
+    zone?: string;
+};
 /** @returns {ApplicationMeta} */
 declare function ApplicationMeta(): ApplicationMeta;
 type ApplicationMeta = {
@@ -307,6 +327,12 @@ type Application = {
     mobile_logo?: SecureUrl;
     domain?: Domain;
     slug?: string;
+    /**
+     * - Region identifier for the sales channel. When
+     * zone is "default", this equals the slug. Otherwise, it is formatted as "slug/zone".
+     */
+    region?: string;
+    region_details?: RegionDetails;
 };
 /** @returns {NotFound} */
 declare function NotFound(): NotFound;

package/sdk/public/Configuration/ConfigurationPublicModel.js

@@ -44,6 +44,12 @@ const Joi = require("joi");
  *   for a short time period.
  */
 
+/**
+ * @typedef RegionDetails
+ * @property {string} [slug] - Region slug identifier.
+ * @property {string} [zone] - Zone identifier within the region.
+ */
+
 /**
  * @typedef ApplicationMeta
  * @property {string} [name] - Indicates the name of application meta
@@ -91,6 +97,9 @@ const Joi = require("joi");
  * @property {SecureUrl} [mobile_logo]
  * @property {Domain} [domain]
  * @property {string} [slug]
+ * @property {string} [region] - Region identifier for the sales channel. When
+ *   zone is "default", this equals the slug. Otherwise, it is formatted as "slug/zone".
+ * @property {RegionDetails} [region_details]
  */
 
 /**
@@ -193,6 +202,14 @@ class ConfigurationPublicModel {
     });
   }
 
+  /** @returns {RegionDetails} */
+  static RegionDetails() {
+    return Joi.object({
+      slug: Joi.string().allow(""),
+      zone: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {ApplicationMeta} */
   static ApplicationMeta() {
     return Joi.object({
@@ -239,6 +256,8 @@ class ConfigurationPublicModel {
       mobile_logo: ConfigurationPublicModel.SecureUrl(),
       domain: ConfigurationPublicModel.Domain(),
       slug: Joi.string().allow(""),
+      region: Joi.string().allow(""),
+      region_details: ConfigurationPublicModel.RegionDetails(),
     });
   }
 

package/sdk/application/Rewards/RewardsApplicationClient.d.ts

@@ -1,79 +0,0 @@
-export = Rewards;
-declare class Rewards {
-    constructor(_conf: any);
-    _conf: any;
-    _relativeUrls: {
-        catalogueOrder: string;
-        getOfferByName: string;
-        getOrderDiscount: string;
-        getUserPoints: string;
-        getUserPointsHistory: string;
-        getUserReferralDetails: string;
-        redeemReferralCode: string;
-    };
-    _urls: {};
-    updateUrls(urls: any): void;
-    /**
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<CatalogueOrderDetails>} - Success response
-     * @name catalogueOrder
-     * @summary: Order from catalogue
-     * @description: Place a reward on order items available in the catalogue. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/catalogueOrder/).
-     */
-    catalogueOrder({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CatalogueOrderDetails>;
-    /**
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<Offer>} - Success response
-     * @name getOfferByName
-     * @summary: Get specific offer
-     * @description: Retrieves detailed information about an offer by its name. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/getOfferByName/).
-     */
-    getOfferByName({ name, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<Offer>;
-    /**
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<OrderDiscountDetails>} - Success response
-     * @name getOrderDiscount
-     * @summary: Order discount
-     * @description: Retrieve the discount applied to a specific order. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/getOrderDiscount/).
-     */
-    getOrderDiscount({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<OrderDiscountDetails>;
-    /**
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<PointsDetails>} - Success response
-     * @name getUserPoints
-     * @summary: Current points
-     * @description: Retrieves the current reward points balance for the user. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/getUserPoints/).
-     */
-    getUserPoints({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<PointsDetails>;
-    /**
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<PointsHistoryDetails>} - Success response
-     * @name getUserPointsHistory
-     * @summary: Points history
-     * @description: Gets the historical data of points earned or spent by the user. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/getUserPointsHistory/).
-     */
-    getUserPointsHistory({ pageId, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<PointsHistoryDetails>;
-    /**
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<ReferralDetails>} - Success response
-     * @name getUserReferralDetails
-     * @summary: Referral details
-     * @description: Gets the details of the user’s referral status and codes. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/getUserReferralDetails/).
-     */
-    getUserReferralDetails({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ReferralDetails>;
-    /**
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<RedeemReferralCodeDetails>} - Success response
-     * @name redeemReferralCode
-     * @summary: Redeem code
-     * @description: Applies a referral code to earn or redeem rewards. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/redeemReferralCode/).
-     */
-    redeemReferralCode({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<RedeemReferralCodeDetails>;
-}

package/sdk/application/Rewards/RewardsApplicationClient.js

@@ -1,315 +0,0 @@
-const {
-  FDKClientValidationError,
-  FDKResponseValidationError,
-} = require("../../common/FDKError");
-
-const ApplicationAPIClient = require("../ApplicationAPIClient");
-const constructUrl = require("../constructUrl");
-const Paginator = require("../../common/Paginator");
-const { validateRequiredParams } = require("../../common/Validator");
-
-class Rewards {
-  constructor(_conf) {
-    this._conf = _conf;
-    this._relativeUrls = {
-      catalogueOrder:
-        "/service/application/rewards/v1.0/catalogue/offer/order/",
-      getOfferByName: "/service/application/rewards/v1.0/offers/{name}/",
-      getOrderDiscount:
-        "/service/application/rewards/v1.0/user/offer/order-discount/",
-      getUserPoints: "/service/application/rewards/v1.0/user/points/",
-      getUserPointsHistory:
-        "/service/application/rewards/v1.0/user/points/history/",
-      getUserReferralDetails:
-        "/service/application/rewards/v1.0/user/referral/",
-      redeemReferralCode:
-        "/service/application/rewards/v1.0/user/referral/redeem/",
-    };
-    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 {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<CatalogueOrderDetails>} - Success response
-   * @name catalogueOrder
-   * @summary: Order from catalogue
-   * @description: Place a reward on order items available in the catalogue. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/catalogueOrder/).
-   */
-  async catalogueOrder(
-    { body, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const query_params = {};
-
-    const xHeaders = {};
-
-    const response = await ApplicationAPIClient.execute(
-      this._conf,
-      "post",
-      constructUrl({
-        url: this._urls["catalogueOrder"],
-        params: {},
-      }),
-      query_params,
-      body,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    return response;
-  }
-
-  /**
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<Offer>} - Success response
-   * @name getOfferByName
-   * @summary: Get specific offer
-   * @description: Retrieves detailed information about an offer by its name. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/getOfferByName/).
-   */
-  async getOfferByName(
-    { name, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const errors = validateRequiredParams(arguments[0], ["name"]);
-    if (errors.length > 0) {
-      const error = new FDKClientValidationError({
-        message: "Missing required field",
-        details: errors,
-      });
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    const query_params = {};
-
-    const xHeaders = {};
-
-    const response = await ApplicationAPIClient.execute(
-      this._conf,
-      "get",
-      constructUrl({
-        url: this._urls["getOfferByName"],
-        params: { name },
-      }),
-      query_params,
-      undefined,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    return response;
-  }
-
-  /**
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<OrderDiscountDetails>} - Success response
-   * @name getOrderDiscount
-   * @summary: Order discount
-   * @description: Retrieve the discount applied to a specific order. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/getOrderDiscount/).
-   */
-  async getOrderDiscount(
-    { body, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const query_params = {};
-
-    const xHeaders = {};
-
-    const response = await ApplicationAPIClient.execute(
-      this._conf,
-      "post",
-      constructUrl({
-        url: this._urls["getOrderDiscount"],
-        params: {},
-      }),
-      query_params,
-      body,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    return response;
-  }
-
-  /**
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<PointsDetails>} - Success response
-   * @name getUserPoints
-   * @summary: Current points
-   * @description: Retrieves the current reward points balance for the user. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/getUserPoints/).
-   */
-  async getUserPoints(
-    { requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const query_params = {};
-
-    const xHeaders = {};
-
-    const response = await ApplicationAPIClient.execute(
-      this._conf,
-      "get",
-      constructUrl({
-        url: this._urls["getUserPoints"],
-        params: {},
-      }),
-      query_params,
-      undefined,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    return response;
-  }
-
-  /**
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<PointsHistoryDetails>} - Success response
-   * @name getUserPointsHistory
-   * @summary: Points history
-   * @description: Gets the historical data of points earned or spent by the user. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/getUserPointsHistory/).
-   */
-  async getUserPointsHistory(
-    { pageId, pageSize, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const query_params = {};
-    query_params["page_id"] = pageId;
-    query_params["page_size"] = pageSize;
-
-    const xHeaders = {};
-
-    const response = await ApplicationAPIClient.execute(
-      this._conf,
-      "get",
-      constructUrl({
-        url: this._urls["getUserPointsHistory"],
-        params: {},
-      }),
-      query_params,
-      undefined,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    return response;
-  }
-
-  /**
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<ReferralDetails>} - Success response
-   * @name getUserReferralDetails
-   * @summary: Referral details
-   * @description: Gets the details of the user’s referral status and codes. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/getUserReferralDetails/).
-   */
-  async getUserReferralDetails(
-    { requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const query_params = {};
-
-    const xHeaders = {};
-
-    const response = await ApplicationAPIClient.execute(
-      this._conf,
-      "get",
-      constructUrl({
-        url: this._urls["getUserReferralDetails"],
-        params: {},
-      }),
-      query_params,
-      undefined,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    return response;
-  }
-
-  /**
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<RedeemReferralCodeDetails>} - Success response
-   * @name redeemReferralCode
-   * @summary: Redeem code
-   * @description: Applies a referral code to earn or redeem rewards. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/redeemReferralCode/).
-   */
-  async redeemReferralCode(
-    { body, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const query_params = {};
-
-    const xHeaders = {};
-
-    const response = await ApplicationAPIClient.execute(
-      this._conf,
-      "post",
-      constructUrl({
-        url: this._urls["redeemReferralCode"],
-        params: {},
-      }),
-      query_params,
-      body,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    return response;
-  }
-}
-
-module.exports = Rewards;