@gofynd/fdk-client-javascript 1.6.3 → 2.0.0

package/sdk/public/Content/ContentPublicClient.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 ContentPublicValidator = require("./ContentPublicValidator");
 const ContentPublicModel = require("./ContentPublicModel");
@@ -16,7 +17,10 @@ class Content {
   constructor(_conf) {
     this._conf = _conf;
     this._relativeUrls = {
+      getAllLanguages: "/service/public/content/languages",
       getAllTags: "/service/public/content/tags",
+      getAllTranslatableResources:
+        "/service/public/content/translatable/resources",
       getAnalyticsTags: "/service/public/content/analytics-tags",
       getBasicDetails: "/service/public/content/basic-details",
       getCredentialsByEntity:
@@ -24,6 +28,7 @@ class Content {
       getCustomPage: "/service/public/content/custom-pages/{slug}",
       getFooterContent: "/service/public/content/footer",
       getHomePageContent: "/service/public/content/home-page",
+      getLanguageByLocale: "/service/public/content/languages/{locale}",
       getMenuContent: "/service/public/content/menu",
       getMenuContentByType: "/service/public/content/menu/{type}",
       getNavbar: "/service/public/content/navbar",
@@ -45,6 +50,82 @@ class Content {
     };
   }
 
+  /**
+   * @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/).
+   */
+  async getAllLanguages(
+    { requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = ContentPublicValidator.getAllLanguages().validate(
+      {},
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = ContentPublicValidator.getAllLanguages().validate(
+      {},
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for public > Content > getAllLanguages \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await PublicAPIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["getAllLanguages"],
+        params: {},
+      }),
+      query_params,
+      undefined,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const { error: res_error } = Joi.any().validate(responseData, {
+      abortEarly: false,
+      allowUnknown: true,
+    });
+
+    if (res_error) {
+      if (this._conf.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for public > Content > getAllLanguages \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
   /**
    * @param {ContentPublicValidator.GetAllTagsParam} arg - Arg object.
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -58,14 +139,6 @@ class Content {
     { 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 } = ContentPublicValidator.getAllTags().validate(
       {},
       { abortEarly: false, allowUnknown: true }
@@ -129,6 +202,84 @@ class Content {
     return response;
   }
 
+  /**
+   * @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/).
+   */
+  async getAllTranslatableResources(
+    { requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = ContentPublicValidator.getAllTranslatableResources().validate(
+      {},
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = ContentPublicValidator.getAllTranslatableResources().validate(
+      {},
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for public > Content > getAllTranslatableResources \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await PublicAPIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["getAllTranslatableResources"],
+        params: {},
+      }),
+      query_params,
+      undefined,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const { error: res_error } = Joi.any().validate(responseData, {
+      abortEarly: false,
+      allowUnknown: true,
+    });
+
+    if (res_error) {
+      if (this._conf.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for public > Content > getAllTranslatableResources \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
   /**
    * @param {ContentPublicValidator.GetAnalyticsTagsParam} arg - Arg object.
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -142,14 +293,6 @@ class Content {
     { 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 } = ContentPublicValidator.getAnalyticsTags().validate(
       {},
       { abortEarly: false, allowUnknown: true }
@@ -228,14 +371,6 @@ class Content {
     { 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 } = ContentPublicValidator.getBasicDetails().validate(
       {},
       { abortEarly: false, allowUnknown: true }
@@ -314,18 +449,12 @@ class Content {
     { entityType, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-
-    if (!entityType) {
-      invalidInput.push({
-        message: `The 'entityType' field is required.`,
-        path: ["entityType"],
+    const errors = validateRequiredParams(arguments[0], ["entityType"]);
+    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));
     }
 
@@ -407,18 +536,12 @@ class Content {
     { slug, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-
-    if (!slug) {
-      invalidInput.push({
-        message: `The 'slug' field is required.`,
-        path: ["slug"],
+    const errors = validateRequiredParams(arguments[0], ["slug"]);
+    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));
     }
 
@@ -498,14 +621,6 @@ class Content {
     { 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 } = ContentPublicValidator.getFooterContent().validate(
       {},
       { abortEarly: false, allowUnknown: true }
@@ -584,21 +699,6 @@ class Content {
     { pageType, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-
-    if (!pageType) {
-      invalidInput.push({
-        message: `The 'pageType' field is required.`,
-        path: ["pageType"],
-      });
-    }
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
     const { error } = ContentPublicValidator.getHomePageContent().validate(
       { pageType },
       { abortEarly: false, allowUnknown: true }
@@ -665,6 +765,93 @@ class Content {
     return response;
   }
 
+  /**
+   * @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/).
+   */
+  async getLanguageByLocale(
+    { locale, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const errors = validateRequiredParams(arguments[0], ["locale"]);
+    if (errors.length > 0) {
+      const error = new FDKClientValidationError({
+        message: "Missing required field",
+        details: errors,
+      });
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const { error } = ContentPublicValidator.getLanguageByLocale().validate(
+      { locale },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = ContentPublicValidator.getLanguageByLocale().validate(
+      { locale },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for public > Content > getLanguageByLocale \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await PublicAPIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["getLanguageByLocale"],
+        params: { locale },
+      }),
+      query_params,
+      undefined,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = ContentPublicModel.Language().validate(responseData, {
+      abortEarly: false,
+      allowUnknown: true,
+    });
+
+    if (res_error) {
+      if (this._conf.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for public > Content > getLanguageByLocale \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
   /**
    * @param {ContentPublicValidator.GetMenuContentParam} arg - Arg object.
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -678,14 +865,6 @@ class Content {
     { 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 } = ContentPublicValidator.getMenuContent().validate(
       {},
       { abortEarly: false, allowUnknown: true }
@@ -764,18 +943,12 @@ class Content {
     { type, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-
-    if (!type) {
-      invalidInput.push({
-        message: `The 'type' field is required.`,
-        path: ["type"],
+    const errors = validateRequiredParams(arguments[0], ["type"]);
+    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));
     }
 
@@ -857,14 +1030,6 @@ class Content {
     { 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 } = ContentPublicValidator.getNavbar().validate(
       {},
       { abortEarly: false, allowUnknown: true }
@@ -941,14 +1106,6 @@ class Content {
     { 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 } = ContentPublicValidator.getPricingBanner().validate(
       {},
       { abortEarly: false, allowUnknown: true }

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

@@ -278,10 +278,59 @@ export = ContentPublicModel;
  * @property {string} [stack_trace]
  * @property {Object} [meta]
  */
+/**
+ * @typedef Language
+ * @property {string} [_id] - Unique identifier for the language entry in the
+ *   system database.
+ * @property {string} locale - Standard language code following ISO 639-1 format
+ *   for language identification.
+ * @property {string} direction - Text direction specification for proper
+ *   content rendering in the language.
+ * @property {string} name - Full name of the language in English for easy
+ *   reference and display at the merchant panel.
+ * @property {string} [display_name] - Translated name of the language in
+ *   English for easy reference and display at the website.
+ */
+/**
+ * @typedef Error
+ * @property {string} [error] - Detailed error message explaining the nature of
+ *   the failure or invalid request.
+ */
+/**
+ * @typedef TranslatableResource
+ * @property {string} [_id] - Unique identifier for the translatable resource in
+ *   the system.
+ * @property {string} type - Categorization of the resource indicating its
+ *   context and ownership level
+ * @property {string} name - Primary identifier or title of the resource in its
+ *   default language.
+ * @property {string} description - Detailed explanation of the resource's
+ *   purpose and content scope.
+ * @property {Meta} meta
+ */
+/**
+ * @typedef Meta
+ * @property {string} [created_by] - MongoDB ObjectId of the user who initially
+ *   created the resource.
+ * @property {string} [updated_by] - MongoDB ObjectId of the user who last
+ *   modified the resource.
+ * @property {string} [created_at] - Timestamp indicating when the resource was
+ *   first created.
+ * @property {string} [updated_at] - Timestamp indicating when the resource was
+ *   last modified.
+ */
+/**
+ * @typedef ResourceTranslation
+ * @property {string} [_id] - Unique identifier for the translation entry in the system.
+ * @property {string} [locale] - Language code indicating the target language of
+ *   the translation.
+ * @property {Object} [value] - Contains the translated content with flexible
+ *   schema based on resource type.
+ */
 declare class ContentPublicModel {
 }
 declare namespace ContentPublicModel {
-    export { BasicDetailsPayloadSchema, WhatsNew, Features, BusinessAccount, SellerSupport, MenuSchema, MenusSchema, MenuTypeSchema, CompanyLevelMenuItemSchema, ApplicationLevelMenuItemSchema, VisibleOnSchema, SalesChannelSchema, OtherSellerSchema, FooterContentSchema, AnalyticsTagsSchema, CustomPageBySlugSchema, ItemSchema, CreateCustomPageSeoSchema, RawHtmlContentSchema, FooterSchema, HomePageContentSchema, NavItemSchema, NavbarSchema, MediaSchema, CreatedBySchema, PricingBannerSchema, SdkReadmeSchema, TagsSchema, CustomItemSchema, PageSchema, UserSchema, CredentialSchema, ConfigurationSchema, CredentialsSchema, ContentAPIError };
+    export { BasicDetailsPayloadSchema, WhatsNew, Features, BusinessAccount, SellerSupport, MenuSchema, MenusSchema, MenuTypeSchema, CompanyLevelMenuItemSchema, ApplicationLevelMenuItemSchema, VisibleOnSchema, SalesChannelSchema, OtherSellerSchema, FooterContentSchema, AnalyticsTagsSchema, CustomPageBySlugSchema, ItemSchema, CreateCustomPageSeoSchema, RawHtmlContentSchema, FooterSchema, HomePageContentSchema, NavItemSchema, NavbarSchema, MediaSchema, CreatedBySchema, PricingBannerSchema, SdkReadmeSchema, TagsSchema, CustomItemSchema, PageSchema, UserSchema, CredentialSchema, ConfigurationSchema, CredentialsSchema, ContentAPIError, Language, Error, TranslatableResource, Meta, ResourceTranslation };
 }
 /** @returns {BasicDetailsPayloadSchema} */
 declare function BasicDetailsPayloadSchema(): BasicDetailsPayloadSchema;
@@ -597,3 +646,108 @@ type ContentAPIError = {
     stack_trace?: string;
     meta?: any;
 };
+/** @returns {Language} */
+declare function Language(): Language;
+type Language = {
+    /**
+     * - Unique identifier for the language entry in the
+     * system database.
+     */
+    _id?: string;
+    /**
+     * - Standard language code following ISO 639-1 format
+     * for language identification.
+     */
+    locale: string;
+    /**
+     * - Text direction specification for proper
+     * content rendering in the language.
+     */
+    direction: string;
+    /**
+     * - Full name of the language in English for easy
+     * reference and display at the merchant panel.
+     */
+    name: string;
+    /**
+     * - Translated name of the language in
+     * English for easy reference and display at the website.
+     */
+    display_name?: string;
+};
+/** @returns {Error} */
+declare function Error(): Error;
+type Error = {
+    /**
+     * - Detailed error message explaining the nature of
+     * the failure or invalid request.
+     */
+    error?: string;
+};
+/** @returns {TranslatableResource} */
+declare function TranslatableResource(): TranslatableResource;
+type TranslatableResource = {
+    /**
+     * - Unique identifier for the translatable resource in
+     * the system.
+     */
+    _id?: string;
+    /**
+     * - Categorization of the resource indicating its
+     * context and ownership level
+     */
+    type: string;
+    /**
+     * - Primary identifier or title of the resource in its
+     * default language.
+     */
+    name: string;
+    /**
+     * - Detailed explanation of the resource's
+     * purpose and content scope.
+     */
+    description: string;
+    meta: Meta;
+};
+/** @returns {Meta} */
+declare function Meta(): Meta;
+type Meta = {
+    /**
+     * - MongoDB ObjectId of the user who initially
+     * created the resource.
+     */
+    created_by?: string;
+    /**
+     * - MongoDB ObjectId of the user who last
+     * modified the resource.
+     */
+    updated_by?: string;
+    /**
+     * - Timestamp indicating when the resource was
+     * first created.
+     */
+    created_at?: string;
+    /**
+     * - Timestamp indicating when the resource was
+     * last modified.
+     */
+    updated_at?: string;
+};
+/** @returns {ResourceTranslation} */
+declare function ResourceTranslation(): ResourceTranslation;
+type ResourceTranslation = {
+    /**
+     * - Unique identifier for the translation entry in the system.
+     */
+    _id?: string;
+    /**
+     * - Language code indicating the target language of
+     * the translation.
+     */
+    locale?: string;
+    /**
+     * - Contains the translated content with flexible
+     * schema based on resource type.
+     */
+    value?: any;
+};