@gofynd/fdk-client-javascript 1.6.4 → 2.0.0

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

@@ -398,6 +398,19 @@ export = UserPlatformModel;
  * @typedef DeleteAccountConsent
  * @property {string} [consent_text]
  */
+/**
+ * @typedef GetUserTimeline
+ * @property {string} [delete_on] - Denotes the date on which the user will be deleted
+ * @property {UserTimeline[]} [timeline] - List of user timeline events
+ */
+/**
+ * @typedef UserTimeline
+ * @property {string} [date] - Denotes the date at which this event occured
+ * @property {string} [title] - Title of the timeline event
+ * @property {string} [type] - Type of the event, indicating its status
+ * @property {boolean} [visible] - Indicates whether the event should be shown on the UI
+ * @property {string} [sub_title] - Additional information about the event
+ */
 /**
  * @typedef Facebook
  * @property {string} [app_id]
@@ -517,6 +530,7 @@ export = UserPlatformModel;
  * @property {string} [rr_id]
  * @property {boolean} [archive]
  * @property {string} [status]
+ * @property {string} [deleted_on]
  */
 /**
  * @typedef PhoneNumber
@@ -536,7 +550,7 @@ export = UserPlatformModel;
 declare class UserPlatformModel {
 }
 declare namespace UserPlatformModel {
-    export { SuccessMessage, UserAttributeDefinition, UserAttributeDefinitionDetails, UserAttributeDefinitionValidation, UserAttribute, CreateUserAttribute, CreateUserAttributeDefinition, CreateStoreFrontUsersPayload, BulkUserExportSchema, BulkActionModel, CreatedBySchema, BulkActionLinkSchema, FileLinks, BulkActionCountSchema, BlockUserRequestSchema, ArchiveUserRequestSchema, UnDeleteUserRequestSchema, BlockUserSuccess, ArchiveUserSuccess, UnDeleteUserSuccess, UserSearchResponseSchema, CustomerListResponseSchema, BulkActionPaginationSchema, PaginationSchema, SessionListResponseSchema, SessionDeleteResponseSchema, SessionsDeleteResponseSchema, APIError, SessionListResponseInfo, Conditions, UserResponseErrorSchema, UserGroupResponseSchema, UserGroupListResponseSchema, ConditionsSchema, CreateUserGroup, CreateUserRequestSchema, CreateUserResponseSchema, CreateUserSessionRequestSchema, CreateUserSessionResponseSchema, PlatformSchema, LookAndFeel, Login, MetaSchema, Social, RequiredFields, PlatformEmail, PlatformMobile, RegisterRequiredFields, RegisterRequiredFieldsEmail, RegisterRequiredFieldsMobile, FlashCard, SocialTokens, DeleteAccountReasons, DeleteAccountConsent, Facebook, Accountkit, Google, SessionExpiry, UpdateUserGroupSchema, PartialUserGroupUpdateSchema, UserGroupUpdateData, UpdateUserRequestSchema, UserEmails, UserPhoneNumbers, UserSchema, UserSearchSchema, PhoneNumber, Email };
+    export { SuccessMessage, UserAttributeDefinition, UserAttributeDefinitionDetails, UserAttributeDefinitionValidation, UserAttribute, CreateUserAttribute, CreateUserAttributeDefinition, CreateStoreFrontUsersPayload, BulkUserExportSchema, BulkActionModel, CreatedBySchema, BulkActionLinkSchema, FileLinks, BulkActionCountSchema, BlockUserRequestSchema, ArchiveUserRequestSchema, UnDeleteUserRequestSchema, BlockUserSuccess, ArchiveUserSuccess, UnDeleteUserSuccess, UserSearchResponseSchema, CustomerListResponseSchema, BulkActionPaginationSchema, PaginationSchema, SessionListResponseSchema, SessionDeleteResponseSchema, SessionsDeleteResponseSchema, APIError, SessionListResponseInfo, Conditions, UserResponseErrorSchema, UserGroupResponseSchema, UserGroupListResponseSchema, ConditionsSchema, CreateUserGroup, CreateUserRequestSchema, CreateUserResponseSchema, CreateUserSessionRequestSchema, CreateUserSessionResponseSchema, PlatformSchema, LookAndFeel, Login, MetaSchema, Social, RequiredFields, PlatformEmail, PlatformMobile, RegisterRequiredFields, RegisterRequiredFieldsEmail, RegisterRequiredFieldsMobile, FlashCard, SocialTokens, DeleteAccountReasons, DeleteAccountConsent, GetUserTimeline, UserTimeline, Facebook, Accountkit, Google, SessionExpiry, UpdateUserGroupSchema, PartialUserGroupUpdateSchema, UserGroupUpdateData, UpdateUserRequestSchema, UserEmails, UserPhoneNumbers, UserSchema, UserSearchSchema, PhoneNumber, Email };
 }
 /** @returns {SuccessMessage} */
 declare function SuccessMessage(): SuccessMessage;
@@ -1189,6 +1203,42 @@ declare function DeleteAccountConsent(): DeleteAccountConsent;
 type DeleteAccountConsent = {
     consent_text?: string;
 };
+/** @returns {GetUserTimeline} */
+declare function GetUserTimeline(): GetUserTimeline;
+type GetUserTimeline = {
+    /**
+     * - Denotes the date on which the user will be deleted
+     */
+    delete_on?: string;
+    /**
+     * - List of user timeline events
+     */
+    timeline?: UserTimeline[];
+};
+/** @returns {UserTimeline} */
+declare function UserTimeline(): UserTimeline;
+type UserTimeline = {
+    /**
+     * - Denotes the date at which this event occured
+     */
+    date?: string;
+    /**
+     * - Title of the timeline event
+     */
+    title?: string;
+    /**
+     * - Type of the event, indicating its status
+     */
+    type?: string;
+    /**
+     * - Indicates whether the event should be shown on the UI
+     */
+    visible?: boolean;
+    /**
+     * - Additional information about the event
+     */
+    sub_title?: string;
+};
 /** @returns {Facebook} */
 declare function Facebook(): Facebook;
 type Facebook = {
@@ -1338,6 +1388,7 @@ type UserSearchSchema = {
     rr_id?: string;
     archive?: boolean;
     status?: string;
+    deleted_on?: string;
 };
 /** @returns {PhoneNumber} */
 declare function PhoneNumber(): PhoneNumber;

package/sdk/platform/User/UserPlatformModel.js

@@ -453,6 +453,21 @@ const Joi = require("joi");
  * @property {string} [consent_text]
  */
 
+/**
+ * @typedef GetUserTimeline
+ * @property {string} [delete_on] - Denotes the date on which the user will be deleted
+ * @property {UserTimeline[]} [timeline] - List of user timeline events
+ */
+
+/**
+ * @typedef UserTimeline
+ * @property {string} [date] - Denotes the date at which this event occured
+ * @property {string} [title] - Title of the timeline event
+ * @property {string} [type] - Type of the event, indicating its status
+ * @property {boolean} [visible] - Indicates whether the event should be shown on the UI
+ * @property {string} [sub_title] - Additional information about the event
+ */
+
 /**
  * @typedef Facebook
  * @property {string} [app_id]
@@ -583,6 +598,7 @@ const Joi = require("joi");
  * @property {string} [rr_id]
  * @property {boolean} [archive]
  * @property {string} [status]
+ * @property {string} [deleted_on]
  */
 
 /**
@@ -1155,6 +1171,25 @@ class UserPlatformModel {
     });
   }
 
+  /** @returns {GetUserTimeline} */
+  static GetUserTimeline() {
+    return Joi.object({
+      delete_on: Joi.string().allow(""),
+      timeline: Joi.array().items(UserPlatformModel.UserTimeline()),
+    });
+  }
+
+  /** @returns {UserTimeline} */
+  static UserTimeline() {
+    return Joi.object({
+      date: Joi.string().allow(""),
+      title: Joi.string().allow(""),
+      type: Joi.string().allow(""),
+      visible: Joi.boolean(),
+      sub_title: Joi.string().allow("").allow(null),
+    });
+  }
+
   /** @returns {Facebook} */
   static Facebook() {
     return Joi.object({
@@ -1302,6 +1337,7 @@ class UserPlatformModel {
       rr_id: Joi.string().allow(""),
       archive: Joi.boolean(),
       status: Joi.string().allow(""),
+      deleted_on: Joi.string().allow(""),
     });
   }
 

package/sdk/platform/Webhook/WebhookPlatformModel.d.ts

@@ -8,6 +8,7 @@ export = WebhookPlatformModel;
  * @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 BroadcasterConfig
@@ -347,6 +348,10 @@ type Page = {
      * - The number of items per page.
      */
     size?: number;
+    /**
+     * - The number of items per page.
+     */
+    page_size?: number;
 };
 /** @returns {BroadcasterConfig} */
 declare function BroadcasterConfig(): BroadcasterConfig;

package/sdk/platform/Webhook/WebhookPlatformModel.js

@@ -9,6 +9,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.
  */
 
 /**
@@ -356,6 +357,7 @@ class WebhookPlatformModel {
       current: Joi.number(),
       type: Joi.string().allow("").required(),
       size: Joi.number(),
+      page_size: Joi.number(),
     });
   }
 

package/sdk/public/Catalog/CatalogPublicClient.d.ts

@@ -16,7 +16,7 @@ declare class Catalog {
      * @summary: Get Taxonomy Information by Level
      * @description: Get Taxonomy Details for a given level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/catalog/getTaxonomyByLevel/).
      */
-    getTaxonomyByLevel({ level, l0Slug, l1Slug, l2Slug, l3Slug, limit, requestHeaders }?: CatalogPublicValidator.GetTaxonomyByLevelParam, { responseHeaders }?: object): Promise<CatalogPublicModel.TaxonomyResponseSchema>;
+    getTaxonomyByLevel({ level, l0Slug, l1Slug, l2Slug, l3Slug, limit, requestHeaders }?: CatalogPublicValidator.GetTaxonomyByLevelParam, { responseHeaders }?: object, ...args: any[]): Promise<CatalogPublicModel.TaxonomyResponseSchema>;
 }
 import CatalogPublicValidator = require("./CatalogPublicValidator");
 import CatalogPublicModel = require("./CatalogPublicModel");

package/sdk/public/Catalog/CatalogPublicClient.js

@@ -6,6 +6,7 @@ const {
 const PublicAPIClient = require("../PublicAPIClient");
 const constructUrl = require("../constructUrl");
 const Paginator = require("../../common/Paginator");
+const { validateRequiredParams } = require("../../common/Validator");
 
 const CatalogPublicValidator = require("./CatalogPublicValidator");
 const CatalogPublicModel = require("./CatalogPublicModel");
@@ -49,18 +50,12 @@ class Catalog {
     },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-
-    if (!level) {
-      invalidInput.push({
-        message: `The 'level' field is required.`,
-        path: ["level"],
+    const errors = validateRequiredParams(arguments[0], ["level"]);
+    if (errors.length > 0) {
+      const error = new FDKClientValidationError({
+        message: "Missing required field",
+        details: errors,
       });
-    }
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
       return Promise.reject(new FDKClientValidationError(error));
     }
 

package/sdk/public/Configuration/ConfigurationPublicClient.js

@@ -6,6 +6,7 @@ const {
 const PublicAPIClient = require("../PublicAPIClient");
 const constructUrl = require("../constructUrl");
 const Paginator = require("../../common/Paginator");
+const { validateRequiredParams } = require("../../common/Validator");
 
 const ConfigurationPublicValidator = require("./ConfigurationPublicValidator");
 const ConfigurationPublicModel = require("./ConfigurationPublicModel");
@@ -49,14 +50,6 @@ class Configuration {
     { locationType, id, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
     const { error } = ConfigurationPublicValidator.getLocations().validate(
       { locationType, id },
       { abortEarly: false, allowUnknown: true }
@@ -138,14 +131,6 @@ class Configuration {
     { authorization, query, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
     const { error } = ConfigurationPublicValidator.searchApplication().validate(
       { authorization, query },
       { abortEarly: false, allowUnknown: true }

package/sdk/public/Content/ContentPublicClient.d.ts

@@ -3,13 +3,16 @@ declare class Content {
     constructor(_conf: any);
     _conf: any;
     _relativeUrls: {
+        getAllLanguages: string;
         getAllTags: string;
+        getAllTranslatableResources: string;
         getAnalyticsTags: string;
         getBasicDetails: string;
         getCredentialsByEntity: string;
         getCustomPage: string;
         getFooterContent: string;
         getHomePageContent: string;
+        getLanguageByLocale: string;
         getMenuContent: string;
         getMenuContentByType: string;
         getNavbar: string;
@@ -17,6 +20,16 @@ declare class Content {
     };
     _urls: {};
     updateUrls(urls: any): void;
+    /**
+     * @param {ContentPublicValidator.GetAllLanguagesParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PublicAPIClient").Options} - Options
+     * @returns {Promise<Object>} - Success response
+     * @name getAllLanguages
+     * @summary: Get All Languages
+     * @description: Fetches complete list of languages supported by the platform with their locale codes and text directions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/content/getAllLanguages/).
+     */
+    getAllLanguages({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
     /**
      * @param {ContentPublicValidator.GetAllTagsParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -27,6 +40,16 @@ declare class Content {
      * @description: Retrieve custom tag with injected css/javascript info. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/content/getAllTags/).
      */
     getAllTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPublicModel.TagsSchema>;
+    /**
+     * @param {ContentPublicValidator.GetAllTranslatableResourcesParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PublicAPIClient").Options} - Options
+     * @returns {Promise<Object>} - Success response
+     * @name getAllTranslatableResources
+     * @summary: Get Translatable Items
+     * @description: Retrieves all resources that can be translated across different languages in the system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/content/getAllTranslatableResources/).
+     */
+    getAllTranslatableResources({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
     /**
      * @param {ContentPublicValidator.GetAnalyticsTagsParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -56,7 +79,7 @@ declare class Content {
      * @summary: Get credentials to power chat support systems
      * @description: Get credentials for support system - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/content/getCredentialsByEntity/).
      */
-    getCredentialsByEntity({ entityType, requestHeaders }?: ContentPublicValidator.GetCredentialsByEntityParam, { responseHeaders }?: object): Promise<ContentPublicModel.CredentialsSchema>;
+    getCredentialsByEntity({ entityType, requestHeaders }?: ContentPublicValidator.GetCredentialsByEntityParam, { responseHeaders }?: object, ...args: any[]): Promise<ContentPublicModel.CredentialsSchema>;
     /**
      * @param {ContentPublicValidator.GetCustomPageParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -66,7 +89,7 @@ declare class Content {
      * @summary: Retrieve info for custom page.
      * @description: Retrieve info of custom pagee to develop and manage custom webpages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/content/getCustomPage/).
      */
-    getCustomPage({ slug, requestHeaders }?: ContentPublicValidator.GetCustomPageParam, { responseHeaders }?: object): Promise<ContentPublicModel.CustomPageBySlugSchema>;
+    getCustomPage({ slug, requestHeaders }?: ContentPublicValidator.GetCustomPageParam, { responseHeaders }?: object, ...args: any[]): Promise<ContentPublicModel.CustomPageBySlugSchema>;
     /**
      * @param {ContentPublicValidator.GetFooterContentParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -87,6 +110,16 @@ declare class Content {
      * @description: Retrieve home page content for a specific page type. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/content/getHomePageContent/).
      */
     getHomePageContent({ pageType, requestHeaders }?: ContentPublicValidator.GetHomePageContentParam, { responseHeaders }?: object): Promise<ContentPublicModel.HomePageContentSchema>;
+    /**
+     * @param {ContentPublicValidator.GetLanguageByLocaleParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PublicAPIClient").Options} - Options
+     * @returns {Promise<ContentPublicModel.Language>} - Success response
+     * @name getLanguageByLocale
+     * @summary: Get Single Language
+     * @description: Retrieves detailed information about a specific language using its locale identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/content/getLanguageByLocale/).
+     */
+    getLanguageByLocale({ locale, requestHeaders }?: ContentPublicValidator.GetLanguageByLocaleParam, { responseHeaders }?: object, ...args: any[]): Promise<ContentPublicModel.Language>;
     /**
      * @param {ContentPublicValidator.GetMenuContentParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -106,7 +139,7 @@ declare class Content {
      * @summary: Get desktop menu content
      * @description: Retrieves the desktop menu content. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/content/getMenuContentByType/).
      */
-    getMenuContentByType({ type, requestHeaders }?: ContentPublicValidator.GetMenuContentByTypeParam, { responseHeaders }?: object): Promise<ContentPublicModel.MenuTypeSchema>;
+    getMenuContentByType({ type, requestHeaders }?: ContentPublicValidator.GetMenuContentByTypeParam, { responseHeaders }?: object, ...args: any[]): Promise<ContentPublicModel.MenuTypeSchema>;
     /**
      * @param {ContentPublicValidator.GetNavbarParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`