@gofynd/fdk-client-javascript 1.6.4 → 2.0.0

package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js

@@ -5,14 +5,16 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
 /**
  * @typedef BulkServiceabilityParam
  * @property {string} extensionId - Unique Identifier of courier partner extension.
- * @property {string} schemeId - Unique identifier of courier partner scheme.
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
+ *   or modify scheme details.
  * @property {ServiceabilityPlatformModel.BulkRegionJobDetails} body
  */
 
 /**
  * @typedef BulkTatParam
  * @property {string} extensionId - Unique Identifier of courier partner extension.
- * @property {string} schemeId - Unique identifier of courier partner scheme.
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
+ *   or modify scheme details.
  * @property {ServiceabilityPlatformModel.BulkRegionJobDetails} body
  */
 
@@ -23,11 +25,12 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
 
 /**
  * @typedef CreateCourierPartnerSchemeParam
- * @property {ServiceabilityPlatformModel.CourierPartnerSchemeV2DetailsModel} body
+ * @property {ServiceabilityPlatformModel.CourierPartnerSchemeDetailsModel} body
  */
 
 /**
  * @typedef CreatePackageMaterialParam
+ * @property {number} [pageNo] - The current page number for paginated results.
  * @property {ServiceabilityPlatformModel.PackageMaterial} body
  */
 
@@ -36,18 +39,12 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
  * @property {ServiceabilityPlatformModel.PackageRule} body
  */
 
-/**
- * @typedef CreateZoneParam
- * @property {ServiceabilityPlatformModel.CreateZoneData} body
- */
-
-/** @typedef GetAllStoresParam */
-
 /**
  * @typedef GetBulkServiceabilityParam
  * @property {string} extensionId - Unique Identifier of courier partner extension.
- * @property {string} schemeId - Unique identifier of courier partner scheme.
- * @property {number} [pageNo] - Index of the item to start returning with
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
+ *   or modify scheme details.
+ * @property {number} [pageNo] - The current page number for paginated results.
  * @property {number} [pageSize] - Determines the items to be displayed in a page
  * @property {string} [batchId] - Unique identifier of bulk job
  * @property {string} [action] - Import or export bulk type
@@ -61,8 +58,9 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
 /**
  * @typedef GetBulkTatParam
  * @property {string} extensionId - Unique Identifier of courier partner extension.
- * @property {string} schemeId - Unique identifier of courier partner scheme.
- * @property {number} [pageNo] - Index of the item to start returning with
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
+ *   or modify scheme details.
+ * @property {number} [pageNo] - The current page number for paginated results.
  * @property {number} [pageSize] - Determines the items to be displayed in a page
  * @property {string} [batchId] - Unique identifier of bulk job
  * @property {string} [action] - Import or export bulk type
@@ -77,31 +75,40 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
 
 /**
  * @typedef GetCountriesParam
- * @property {boolean} [onboarding] - Only fetch countries which allowed for
+ * @property {boolean} [onboard] - Only fetch countries which allowed for
  *   onboard on Platform.
- * @property {number} [pageNo] - Page number.
- * @property {number} [pageSize] - Page size.
- * @property {string} [q] - Search.
- * @property {string} [hierarchy] - Fetch countries that has certain heirarchy present.
+ * @property {number} [pageNo] - The page number to navigate through the given
+ *   set of results. Default value is 1.
+ * @property {number} [pageSize] - The number of items to retrieve in each page.
+ *   Default value is 12
+ * @property {string} [q] - The search string to search in the list of countries by name.
+ * @property {string} [hierarchy] - The search filter to filter countries based
+ *   on their available hierarchy.
  */
 
 /**
  * @typedef GetCourierPartnerAccountParam
- * @property {string} accountId - Unique ID of courier partner account
+ * @property {string} accountId - Unique ID of courier account
  */
 
 /**
  * @typedef GetCourierPartnerAccountsParam
- * @property {number} [pageNo] - Index of the item to start returning with
+ * @property {number} [pageNo] - The current page number for paginated results.
  * @property {number} [pageSize] - Determines the items to be displayed in a page
- * @property {string} [stage] - Stage of the account. enabled/disabled
+ * @property {string} [stage] - Stage of the account.
  * @property {string} [paymentMode] - Filters dp accounts based on payment mode
  * @property {string} [transportType] - Filters dp accounts based on transport_type
+ * @property {string[]} [accountIds] - Filters dp accounts based on their ids
+ * @property {boolean} [selfShip] - To filter self ship/non self ship dp accounts
+ * @property {boolean} [ownAccount] - Filters seller owned or Fynd Managed dp accounts
+ * @property {string} [q] - Filters dp accounts based on case sensitive partial
+ *   account name
  */
 
 /**
  * @typedef GetCourierPartnerSchemeParam
- * @property {string} schemeId - Unique Identifier of Scheme
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
+ *   or modify scheme details.
  */
 
 /**
@@ -115,16 +122,24 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
  *   returned in the response.
  */
 
+/**
+ * @typedef GetInstalledCourierPartnerExtensionsParam
+ * @property {number} [pageNo] - The current page number for paginated results.
+ * @property {number} [pageSize] - Determines the items to be displayed in a page
+ * @property {string} [isInstalled] - Filter to get installed extensions only
+ */
+
 /**
  * @typedef GetOptimalLocationsParam
- * @property {ServiceabilityPlatformModel.OptimlLocationsDetailsSchema} body
+ * @property {ServiceabilityPlatformModel.OptimlLocationsRequestSchema} body
  */
 
 /**
  * @typedef GetPackageMaterialListParam
- * @property {number} [pageNo] - Index of the item to start returning with
+ * @property {number} [pageNo] - The current page number for paginated results.
  * @property {number} [pageSize] - Determines the items to be displayed in a page
- * @property {string} [q] - Perform regex search on items matching name for given value
+ * @property {string} [q] - Used to search for matching results based on the
+ *   provided input.
  * @property {string} [size] - Filters items based on given size
  * @property {string} [packageType] - Filters items based on given package_type
  */
@@ -135,50 +150,20 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
  *   identifier for a Package Material Rule
  */
 
-/**
- * @typedef GetPackageMaterialRulesParam
- * @property {number} [pageNo] - Index of the item to start returning with
- * @property {number} [pageSize] - Determines the items to be displayed in a page
- * @property {string} [isActive] - Filters items based on given is_active
- */
-
 /**
  * @typedef GetPackageMaterialsParam
- * @property {string} packageMaterialId - Unique identifier for a Package. Material
+ * @property {string} packageMaterialId - A `package_material_id` is a unique
+ *   identifier for a Package Material
  */
 
 /**
  * @typedef GetSampleFileServiceabilityStatusParam
- * @property {number} [pageNo] - Index of the item to start returning with
+ * @property {number} [pageNo] - The current page number for paginated results.
  * @property {number} [pageSize] - Determines the items to be displayed in a page
  * @property {string} [batchId] - Batch id of the execution
  */
 
-/**
- * @typedef GetServiceabilityParam
- * @property {string} extensionId - Unique Identifier of courier partner extension.
- * @property {string} schemeId - Unique identifier of courier partner scheme.
- * @property {string} regionId - Unique identifier of a region
- */
-
-/**
- * @typedef GetZoneByIdParam
- * @property {string} zoneId - A `zone_id` is a unique identifier for a particular zone.
- */
-
-/**
- * @typedef GetZonesParam
- * @property {number} [pageNo] - Index of the item to start returning with
- * @property {number} [pageSize] - Determines the items to be displayed in a page
- * @property {boolean} [isActive] - Status of Zone (either active or inactive)
- * @property {string} [channelId] - Zones filtered by an application
- * @property {string} [q] - Search with name as a free text
- * @property {string} [countryIsoCode] - ISO2 code of the country
- * @property {string} [state] - State name
- * @property {string} [city] - City name
- * @property {string} [pincode] - Pincode value to search zones
- * @property {string} [sector] - Sector value to search zones
- */
+/** @typedef GetSelfShipDetailsParam */
 
 /**
  * @typedef SampleFileServiceabilityParam
@@ -187,19 +172,20 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
 
 /**
  * @typedef UpdateCompanyConfigurationParam
- * @property {ServiceabilityPlatformModel.CompanyConfig} body
+ * @property {ServiceabilityPlatformModel.CompanyConfigurationSchema} body
  */
 
 /**
  * @typedef UpdateCourierPartnerAccountParam
- * @property {string} accountId - Unique ID of courier partner account
- * @property {ServiceabilityPlatformModel.CourierAccountUpdateDetails} body
+ * @property {string} accountId - Unique ID of courier account
+ * @property {ServiceabilityPlatformModel.CourierAccountDetailsBody} body
  */
 
 /**
  * @typedef UpdateCourierPartnerSchemeParam
- * @property {string} schemeId - Unique Identifier of Scheme
- * @property {ServiceabilityPlatformModel.CourierPartnerSchemeV2UpdateDetails} body
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
+ *   or modify scheme details.
+ * @property {ServiceabilityPlatformModel.CourierPartnerSchemeUpdateDetailsSchema} body
  */
 
 /**
@@ -211,22 +197,14 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
 
 /**
  * @typedef UpdatePackageMaterialsParam
- * @property {string} packageMaterialId - Unique identifier for a Package. Material
+ * @property {string} packageMaterialId - A `package_material_id` is a unique
+ *   identifier for a Package Material
  * @property {ServiceabilityPlatformModel.PackageMaterial} body
  */
 
 /**
- * @typedef UpdateServiceabilityParam
- * @property {string} extensionId - Unique Identifier of courier partner extension.
- * @property {string} schemeId - Unique identifier of courier partner scheme.
- * @property {string} regionId - Unique identifier of a region
- * @property {ServiceabilityPlatformModel.ServiceabilityModel} body
- */
-
-/**
- * @typedef UpdateZoneByIdParam
- * @property {string} zoneId - A `zone_id` is a unique identifier for a particular zone.
- * @property {ServiceabilityPlatformModel.UpdateZoneData} body
+ * @typedef UpdateSelfShipDetailsParam
+ * @property {ServiceabilityPlatformModel.SelfshipSchema} body
  */
 
 class ServiceabilityPlatformValidator {
@@ -258,13 +236,14 @@ class ServiceabilityPlatformValidator {
   /** @returns {CreateCourierPartnerSchemeParam} */
   static createCourierPartnerScheme() {
     return Joi.object({
-      body: ServiceabilityPlatformModel.CourierPartnerSchemeV2DetailsModel().required(),
+      body: ServiceabilityPlatformModel.CourierPartnerSchemeDetailsModel().required(),
     }).required();
   }
 
   /** @returns {CreatePackageMaterialParam} */
   static createPackageMaterial() {
     return Joi.object({
+      pageNo: Joi.number(),
       body: ServiceabilityPlatformModel.PackageMaterial().required(),
     }).required();
   }
@@ -276,18 +255,6 @@ class ServiceabilityPlatformValidator {
     }).required();
   }
 
-  /** @returns {CreateZoneParam} */
-  static createZone() {
-    return Joi.object({
-      body: ServiceabilityPlatformModel.CreateZoneData().required(),
-    }).required();
-  }
-
-  /** @returns {GetAllStoresParam} */
-  static getAllStores() {
-    return Joi.object({}).required();
-  }
-
   /** @returns {GetBulkServiceabilityParam} */
   static getBulkServiceability() {
     return Joi.object({
@@ -330,7 +297,7 @@ class ServiceabilityPlatformValidator {
   /** @returns {GetCountriesParam} */
   static getCountries() {
     return Joi.object({
-      onboarding: Joi.boolean(),
+      onboard: Joi.boolean(),
       pageNo: Joi.number(),
       pageSize: Joi.number(),
       q: Joi.string().allow(""),
@@ -353,6 +320,10 @@ class ServiceabilityPlatformValidator {
       stage: Joi.string().allow(""),
       paymentMode: Joi.string().allow(""),
       transportType: Joi.string().allow(""),
+      accountIds: Joi.array().items(Joi.string().allow("")),
+      selfShip: Joi.boolean(),
+      ownAccount: Joi.boolean(),
+      q: Joi.string().allow(""),
     }).required();
   }
 
@@ -373,10 +344,19 @@ class ServiceabilityPlatformValidator {
     }).required();
   }
 
+  /** @returns {GetInstalledCourierPartnerExtensionsParam} */
+  static getInstalledCourierPartnerExtensions() {
+    return Joi.object({
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+      isInstalled: Joi.string().allow(""),
+    }).required();
+  }
+
   /** @returns {GetOptimalLocationsParam} */
   static getOptimalLocations() {
     return Joi.object({
-      body: ServiceabilityPlatformModel.OptimlLocationsDetailsSchema().required(),
+      body: ServiceabilityPlatformModel.OptimlLocationsRequestSchema().required(),
     }).required();
   }
 
@@ -398,15 +378,6 @@ class ServiceabilityPlatformValidator {
     }).required();
   }
 
-  /** @returns {GetPackageMaterialRulesParam} */
-  static getPackageMaterialRules() {
-    return Joi.object({
-      pageNo: Joi.number(),
-      pageSize: Joi.number(),
-      isActive: Joi.string().allow(""),
-    }).required();
-  }
-
   /** @returns {GetPackageMaterialsParam} */
   static getPackageMaterials() {
     return Joi.object({
@@ -423,36 +394,9 @@ class ServiceabilityPlatformValidator {
     }).required();
   }
 
-  /** @returns {GetServiceabilityParam} */
-  static getServiceability() {
-    return Joi.object({
-      extensionId: Joi.string().allow("").required(),
-      schemeId: Joi.string().allow("").required(),
-      regionId: Joi.string().allow("").required(),
-    }).required();
-  }
-
-  /** @returns {GetZoneByIdParam} */
-  static getZoneById() {
-    return Joi.object({
-      zoneId: Joi.string().allow("").required(),
-    }).required();
-  }
-
-  /** @returns {GetZonesParam} */
-  static getZones() {
-    return Joi.object({
-      pageNo: Joi.number(),
-      pageSize: Joi.number(),
-      isActive: Joi.boolean(),
-      channelId: Joi.string().allow(""),
-      q: Joi.string().allow(""),
-      countryIsoCode: Joi.string().allow(""),
-      state: Joi.string().allow(""),
-      city: Joi.string().allow(""),
-      pincode: Joi.string().allow(""),
-      sector: Joi.string().allow(""),
-    }).required();
+  /** @returns {GetSelfShipDetailsParam} */
+  static getSelfShipDetails() {
+    return Joi.object({}).required();
   }
 
   /** @returns {SampleFileServiceabilityParam} */
@@ -465,7 +409,7 @@ class ServiceabilityPlatformValidator {
   /** @returns {UpdateCompanyConfigurationParam} */
   static updateCompanyConfiguration() {
     return Joi.object({
-      body: ServiceabilityPlatformModel.CompanyConfig().required(),
+      body: ServiceabilityPlatformModel.CompanyConfigurationSchema().required(),
     }).required();
   }
 
@@ -473,7 +417,7 @@ class ServiceabilityPlatformValidator {
   static updateCourierPartnerAccount() {
     return Joi.object({
       accountId: Joi.string().allow("").required(),
-      body: ServiceabilityPlatformModel.CourierAccountUpdateDetails().required(),
+      body: ServiceabilityPlatformModel.CourierAccountDetailsBody().required(),
     }).required();
   }
 
@@ -481,7 +425,7 @@ class ServiceabilityPlatformValidator {
   static updateCourierPartnerScheme() {
     return Joi.object({
       schemeId: Joi.string().allow("").required(),
-      body: ServiceabilityPlatformModel.CourierPartnerSchemeV2UpdateDetails().required(),
+      body: ServiceabilityPlatformModel.CourierPartnerSchemeUpdateDetailsSchema().required(),
     }).required();
   }
 
@@ -501,21 +445,10 @@ class ServiceabilityPlatformValidator {
     }).required();
   }
 
-  /** @returns {UpdateServiceabilityParam} */
-  static updateServiceability() {
-    return Joi.object({
-      extensionId: Joi.string().allow("").required(),
-      schemeId: Joi.string().allow("").required(),
-      regionId: Joi.string().allow("").required(),
-      body: ServiceabilityPlatformModel.ServiceabilityModel().required(),
-    }).required();
-  }
-
-  /** @returns {UpdateZoneByIdParam} */
-  static updateZoneById() {
+  /** @returns {UpdateSelfShipDetailsParam} */
+  static updateSelfShipDetails() {
     return Joi.object({
-      zoneId: Joi.string().allow("").required(),
-      body: ServiceabilityPlatformModel.UpdateZoneData().required(),
+      body: ServiceabilityPlatformModel.SelfshipSchema().required(),
     }).required();
   }
 }

package/sdk/platform/Share/SharePlatformModel.d.ts

@@ -106,6 +106,7 @@ export = SharePlatformModel;
  * @property {number} [current] - The current page number.
  * @property {string} type - The type of the page, such as 'PageType'.
  * @property {number} [size] - The number of items per page.
+ * @property {number} [page_size] - The number of items per page.
  */
 /**
  * @typedef ShortLinkList
@@ -289,6 +290,10 @@ type Page = {
      * - The number of items per page.
      */
     size?: number;
+    /**
+     * - The number of items per page.
+     */
+    page_size?: number;
 };
 /** @returns {ShortLinkList} */
 declare function ShortLinkList(): ShortLinkList;

package/sdk/platform/Share/SharePlatformModel.js

@@ -119,6 +119,7 @@ const Joi = require("joi");
  * @property {number} [current] - The current page number.
  * @property {string} type - The type of the page, such as 'PageType'.
  * @property {number} [size] - The number of items per page.
+ * @property {number} [page_size] - The number of items per page.
  */
 
 /**
@@ -273,6 +274,7 @@ class SharePlatformModel {
       current: Joi.number(),
       type: Joi.string().allow("").required(),
       size: Joi.number(),
+      page_size: Joi.number(),
     });
   }
 

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

@@ -274,6 +274,16 @@ declare class User {
      * @description: Retrieve a list of user groups. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserGroups/).
      */
     getUserGroups({ pageNo, pageSize, name, type, status, groupUid, requestHeaders }?: UserPlatformApplicationValidator.GetUserGroupsParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupListResponseSchema>;
+    /**
+     * @param {UserPlatformApplicationValidator.GetUserTimelineParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<UserPlatformModel.GetUserTimeline>} - Success response
+     * @name getUserTimeline
+     * @summary: Get Deleted User Timeline
+     * @description: Fetches the timeline for the user who has made a data erase request. The timeline will show when the request was raised and when the request will be completed. It will also show if request has been cancelled before completion. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserTimeline/).
+     */
+    getUserTimeline({ userId, requestHeaders }?: UserPlatformApplicationValidator.GetUserTimelineParam, { responseHeaders }?: object): Promise<UserPlatformModel.GetUserTimeline>;
     /**
      * @param {UserPlatformApplicationValidator.GetUsersJobByJobIdParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`

package/sdk/platform/User/UserPlatformApplicationClient.js

@@ -2049,6 +2049,85 @@ class User {
     return response;
   }
 
+  /**
+   * @param {UserPlatformApplicationValidator.GetUserTimelineParam} arg - Arg object
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<UserPlatformModel.GetUserTimeline>} - Success response
+   * @name getUserTimeline
+   * @summary: Get Deleted User Timeline
+   * @description: Fetches the timeline for the user who has made a data erase request. The timeline will show when the request was raised and when the request will be completed. It will also show if request has been cancelled before completion. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserTimeline/).
+   */
+  async getUserTimeline(
+    { userId, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = UserPlatformApplicationValidator.getUserTimeline().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,
+    } = UserPlatformApplicationValidator.getUserTimeline().validate(
+      {
+        userId,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > User > getUserTimeline \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/user/v1.0/company/${this.config.companyId}/application/${this.applicationId}/customers/${userId}/timeline`,
+      query_params,
+      undefined,
+      requestHeaders,
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = UserPlatformModel.GetUserTimeline().validate(responseData, {
+      abortEarly: false,
+      allowUnknown: true,
+    });
+
+    if (res_error) {
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for platform > User > getUserTimeline \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
   /**
    * @param {UserPlatformApplicationValidator.GetUsersJobByJobIdParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`

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

@@ -137,6 +137,10 @@ export = UserPlatformApplicationValidator;
  * @property {string} [status] - To get User Groups with given status
  * @property {number} [groupUid] - To get User Groups with given uid
  */
+/**
+ * @typedef GetUserTimelineParam
+ * @property {string} userId - User ID
+ */
 /**
  * @typedef GetUsersJobByJobIdParam
  * @property {string} jobId - The unique identifier of the job. This is used to
@@ -233,6 +237,8 @@ declare class UserPlatformApplicationValidator {
     static getUserGroupById(): GetUserGroupByIdParam;
     /** @returns {GetUserGroupsParam} */
     static getUserGroups(): GetUserGroupsParam;
+    /** @returns {GetUserTimelineParam} */
+    static getUserTimeline(): GetUserTimelineParam;
     /** @returns {GetUsersJobByJobIdParam} */
     static getUsersJobByJobId(): GetUsersJobByJobIdParam;
     /** @returns {SearchUsersParam} */
@@ -253,7 +259,7 @@ declare class UserPlatformApplicationValidator {
     static updateUserGroupPartially(): UpdateUserGroupPartiallyParam;
 }
 declare namespace UserPlatformApplicationValidator {
-    export { ArchiveUserParam, BlockOrUnblockUsersParam, BulkImportStoreFrontUsersParam, CreateBulkExportUsersParam, CreateUserParam, CreateUserAttributeDefinitionParam, CreateUserGroupParam, CreateUserSessionParam, DeleteActiveSessionsParam, DeleteSessionParam, DeleteUserAttributeParam, DeleteUserAttributeDefinitionByIdParam, GetActiveSessionsParam, GetBulkExportUsersListParam, GetBulkImportUsersListParam, GetCustomersParam, GetPlatformConfigParam, GetUserAttributeParam, GetUserAttributeByIdParam, GetUserAttributeDefinitionByIdParam, GetUserAttributeDefinitionsParam, GetUserAttributesForUserParam, GetUserGroupByIdParam, GetUserGroupsParam, GetUsersJobByJobIdParam, SearchUsersParam, UnDeleteUserParam, UpdatePlatformConfigParam, UpdateUserParam, UpdateUserAttributeParam, UpdateUserAttributeDefinitionParam, UpdateUserGroupParam, UpdateUserGroupPartiallyParam };
+    export { ArchiveUserParam, BlockOrUnblockUsersParam, BulkImportStoreFrontUsersParam, CreateBulkExportUsersParam, CreateUserParam, CreateUserAttributeDefinitionParam, CreateUserGroupParam, CreateUserSessionParam, DeleteActiveSessionsParam, DeleteSessionParam, DeleteUserAttributeParam, DeleteUserAttributeDefinitionByIdParam, GetActiveSessionsParam, GetBulkExportUsersListParam, GetBulkImportUsersListParam, GetCustomersParam, GetPlatformConfigParam, GetUserAttributeParam, GetUserAttributeByIdParam, GetUserAttributeDefinitionByIdParam, GetUserAttributeDefinitionsParam, GetUserAttributesForUserParam, GetUserGroupByIdParam, GetUserGroupsParam, GetUserTimelineParam, GetUsersJobByJobIdParam, SearchUsersParam, UnDeleteUserParam, UpdatePlatformConfigParam, UpdateUserParam, UpdateUserAttributeParam, UpdateUserAttributeDefinitionParam, UpdateUserGroupParam, UpdateUserGroupPartiallyParam };
 }
 type ArchiveUserParam = {
     body: UserPlatformModel.ArchiveUserRequestSchema;
@@ -522,6 +528,12 @@ type GetUserGroupsParam = {
      */
     groupUid?: number;
 };
+type GetUserTimelineParam = {
+    /**
+     * - User ID
+     */
+    userId: string;
+};
 type GetUsersJobByJobIdParam = {
     /**
      * - The unique identifier of the job. This is used to

package/sdk/platform/User/UserPlatformApplicationValidator.js

@@ -164,6 +164,11 @@ const UserPlatformModel = require("./UserPlatformModel");
  * @property {number} [groupUid] - To get User Groups with given uid
  */
 
+/**
+ * @typedef GetUserTimelineParam
+ * @property {string} userId - User ID
+ */
+
 /**
  * @typedef GetUsersJobByJobIdParam
  * @property {string} jobId - The unique identifier of the job. This is used to
@@ -425,6 +430,13 @@ class UserPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {GetUserTimelineParam} */
+  static getUserTimeline() {
+    return Joi.object({
+      userId: Joi.string().allow("").required(),
+    }).required();
+  }
+
   /** @returns {GetUsersJobByJobIdParam} */
   static getUsersJobByJobId() {
     return Joi.object({