@gofynd/fdk-client-javascript 1.3.11-beta.6 → 1.3.11-beta.8

package/sdk/application/Content/ContentApplicationClient.js

@@ -17,6 +17,10 @@ class Content {
       getAnnouncements: "/service/application/content/v1.0/announcements",
       getBlog: "/service/application/content/v1.0/blogs/{slug}",
       getBlogs: "/service/application/content/v1.0/blogs/",
+      getCustomFields:
+        "/service/application/content/v1.0/metafields/{resource}/{resource_id}",
+      getCustomObject:
+        "/service/application/content/v1.0/metaobjects/{metaobject_id}",
       getDataLoaders: "/service/application/content/v1.0/data-loader",
       getFaqBySlug: "/service/application/content/v1.0/faq/{slug}",
       getFaqCategories: "/service/application/content/v1.0/faq/categories",
@@ -31,6 +35,7 @@ class Content {
       getPage: "/service/application/content/v2.0/pages/{slug}",
       getPages: "/service/application/content/v2.0/pages/",
       getSEOConfiguration: "/service/application/content/v1.0/seo",
+      getSEOMarkupSchemas: "/service/application/content/v1.0/seo/schema",
       getSlideshow: "/service/application/content/v1.0/slideshow/{slug}",
       getSlideshows: "/service/application/content/v1.0/slideshow/",
       getSupportInformation: "/service/application/content/v1.0/support",
@@ -314,6 +319,165 @@ class Content {
     return paginator;
   }
 
+  /**
+   * @param {ContentApplicationValidator.GetCustomFieldsParam} arg - Arg object.
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<ContentApplicationModel.CustomFieldsResponseByResourceIdSchema>}
+   *   - Success response
+   *
+   * @name getCustomFields
+   * @summary: Get list of custom fields of given resource and resource_id.
+   * @description: Use this API to retrieve the custom fields for given resource and resource_id in param. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getCustomFields/).
+   */
+  async getCustomFields(
+    { resource, resourceId, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = ContentApplicationValidator.getCustomFields().validate(
+      { resource, resourceId },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = ContentApplicationValidator.getCustomFields().validate(
+      { resource, resourceId },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for application > Content > getCustomFields \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await ApplicationAPIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["getCustomFields"],
+        params: { resource, resourceId },
+      }),
+      query_params,
+      undefined,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = ContentApplicationModel.CustomFieldsResponseByResourceIdSchema().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 application > Content > getCustomFields \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
+  /**
+   * @param {ContentApplicationValidator.GetCustomObjectParam} arg - Arg object.
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<ContentApplicationModel.CustomObjectByIdSchema>} -
+   *   Success response
+   * @name getCustomObject
+   * @summary: Get custom object details
+   * @description: Use this API to retrieve the custom object details, their fields details with definitions and references. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getCustomObject/).
+   */
+  async getCustomObject(
+    { metaobjectId, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = ContentApplicationValidator.getCustomObject().validate(
+      { metaobjectId },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = ContentApplicationValidator.getCustomObject().validate(
+      { metaobjectId },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for application > Content > getCustomObject \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await ApplicationAPIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["getCustomObject"],
+        params: { metaobjectId },
+      }),
+      query_params,
+      undefined,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = ContentApplicationModel.CustomObjectByIdSchema().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 application > Content > getCustomObject \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
   /**
    * @param {ContentApplicationValidator.GetDataLoadersParam} arg - Arg object.
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -1314,6 +1478,88 @@ class Content {
     return response;
   }
 
+  /**
+   * @param {ContentApplicationValidator.GetSEOMarkupSchemasParam} arg - Arg object.
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<ContentApplicationModel.SeoSchemaComponent>} - Success response
+   * @name getSEOMarkupSchemas
+   * @summary: Get SEO Markup schemas of an application
+   * @description: Use this API to get all SEO Markup schema Templates setup for an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSEOMarkupSchemas/).
+   */
+  async getSEOMarkupSchemas(
+    { pageType, active, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = ContentApplicationValidator.getSEOMarkupSchemas().validate(
+      { pageType, active },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = ContentApplicationValidator.getSEOMarkupSchemas().validate(
+      { pageType, active },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for application > Content > getSEOMarkupSchemas \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+    query_params["page_type"] = pageType;
+    query_params["active"] = active;
+
+    const xHeaders = {};
+
+    const response = await ApplicationAPIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["getSEOMarkupSchemas"],
+        params: {},
+      }),
+      query_params,
+      undefined,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = ContentApplicationModel.SeoSchemaComponent().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 application > Content > getSEOMarkupSchemas \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
   /**
    * @param {ContentApplicationValidator.GetSlideshowParam} arg - Arg object.
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`

package/sdk/application/Content/ContentApplicationModel.d.ts

@@ -135,12 +135,68 @@ export = ContentApplicationModel;
  * @property {string} [end]
  * @property {string} [start]
  */
+/**
+ * @typedef CustomFieldSchema
+ * @property {string} [_id]
+ * @property {string} [application_id]
+ * @property {string} [company_id]
+ * @property {string} [created_at]
+ * @property {string} [created_by]
+ * @property {string} [creator]
+ * @property {string} [definition_id]
+ * @property {boolean} [has_invalid_values]
+ * @property {Object[]} [invalid_value_errors]
+ * @property {boolean} [is_deleted]
+ * @property {string} [key]
+ * @property {boolean} [multi_value]
+ * @property {string} [namespace]
+ * @property {string} [resource]
+ * @property {string} [resource_id]
+ * @property {string} [type]
+ * @property {string} [updated_at]
+ * @property {CustomFieldValue[]} [value]
+ */
+/**
+ * @typedef CustomFieldsResponseByResourceIdSchema
+ * @property {CustomFieldSchema[]} [items]
+ */
+/**
+ * @typedef CustomFieldValue
+ * @property {Object} [value]
+ */
 /**
  * @typedef CustomMetaTag
  * @property {string} [_id]
  * @property {string} [content]
  * @property {string} [name]
  */
+/**
+ * @typedef CustomObjectByIdSchema
+ * @property {string} [_id]
+ * @property {CustomObjectListItemDefinationSchema} [definition]
+ * @property {string} [display_name]
+ * @property {CustomObjectFieldSchema[]} [fields]
+ * @property {Object[]} [references]
+ * @property {string} [status]
+ */
+/**
+ * @typedef CustomObjectFieldSchema
+ * @property {string} [_id]
+ * @property {string} [definition_id]
+ * @property {string} [key]
+ * @property {string} [type]
+ * @property {CustomObjectFieldValue[]} [value]
+ */
+/**
+ * @typedef CustomObjectFieldValue
+ * @property {Object} [value]
+ */
+/**
+ * @typedef CustomObjectListItemDefinationSchema
+ * @property {string} [_id]
+ * @property {string} [name]
+ * @property {string} [type]
+ */
 /**
  * @typedef DataLoaderSchema
  * @property {DataLoaderSourceSchema} [__source]
@@ -355,10 +411,19 @@ export = ContentApplicationModel;
  */
 /**
  * @typedef SEO
+ * @property {SEObreadcrumb[]} [breadcrumb]
+ * @property {string} [canonical_url]
  * @property {string} [description]
  * @property {SEOImage} [image]
+ * @property {SEOMetaItem[]} [meta_tags]
+ * @property {SEOSitemap} [sitemap]
  * @property {string} [title]
  */
+/**
+ * @typedef SEObreadcrumb
+ * @property {Action} [action]
+ * @property {string} [url]
+ */
 /**
  * @typedef SeoComponent
  * @property {SeoSchema} [seo]
@@ -367,9 +432,20 @@ export = ContentApplicationModel;
  * @typedef SEOImage
  * @property {string} [url]
  */
+/**
+ * @typedef SEOMetaItem
+ * @property {SEOMetaItems[]} [items]
+ * @property {string} [title]
+ */
+/**
+ * @typedef SEOMetaItems
+ * @property {string} [key]
+ * @property {string} [value]
+ */
 /**
  * @typedef SeoSchema
  * @property {string} [_id]
+ * @property {string} [additonal_sitemap]
  * @property {string} [app]
  * @property {boolean} [cannonical_enabled]
  * @property {string} [created_at]
@@ -379,6 +455,27 @@ export = ContentApplicationModel;
  * @property {boolean} [sitemap_enabled]
  * @property {string} [updated_at]
  */
+/**
+ * @typedef SeoSchemaComponent
+ * @property {SEOSchemaMarkupTemplate[]} [items]
+ */
+/**
+ * @typedef SEOSchemaMarkupTemplate
+ * @property {boolean} [active]
+ * @property {string} [application]
+ * @property {string} [created_at]
+ * @property {string} [description]
+ * @property {string} [id]
+ * @property {string} [page_type]
+ * @property {string} [schema]
+ * @property {string} [title]
+ * @property {string} [updated_at]
+ */
+/**
+ * @typedef SEOSitemap
+ * @property {string} [frequency]
+ * @property {number} [priority]
+ */
 /**
  * @typedef SlideshowGetResponse
  * @property {SlideshowSchema[]} [items]
@@ -491,7 +588,7 @@ export = ContentApplicationModel;
 declare class ContentApplicationModel {
 }
 declare namespace ContentApplicationModel {
-    export { Action, ActionPage, AnnouncementSchema, AnnouncementsResponseSchema, ApplicationLegal, ApplicationLegalFAQ, Asset, Author, BlogGetResponse, BlogSchema, CategorySchema, ChildrenSchema, CommonError, ConfigurationSchema, ContactSchema, ContentAPIError, CreatedBySchema, CronSchedule, CustomMetaTag, DataLoaderSchema, DataLoaderSourceSchema, DataLoadersSchema, DateMeta, Detail, EmailProperties, EmailSchema, FAQCategorySchema, FaqResponseSchema, FaqSchema, GetFaqCategoriesSchema, GetFaqCategoryBySlugSchema, GetFaqSchema, LandingPageSchema, Language, LocaleLanguage, NavigationGetResponse, NavigationReference, NavigationSchema, NextSchedule, Orientation, Page, PageGetResponse, PageSchema, PhoneProperties, PhoneSchema, ResourceContent, ScheduleSchema, ScheduleStartSchema, SEO, SeoComponent, SEOImage, SeoSchema, SlideshowGetResponse, SlideshowMedia, SlideshowSchema, Support, TagSchema, TagSourceSchema, TagsSchema, PageType };
+    export { Action, ActionPage, AnnouncementSchema, AnnouncementsResponseSchema, ApplicationLegal, ApplicationLegalFAQ, Asset, Author, BlogGetResponse, BlogSchema, CategorySchema, ChildrenSchema, CommonError, ConfigurationSchema, ContactSchema, ContentAPIError, CreatedBySchema, CronSchedule, CustomFieldSchema, CustomFieldsResponseByResourceIdSchema, CustomFieldValue, CustomMetaTag, CustomObjectByIdSchema, CustomObjectFieldSchema, CustomObjectFieldValue, CustomObjectListItemDefinationSchema, DataLoaderSchema, DataLoaderSourceSchema, DataLoadersSchema, DateMeta, Detail, EmailProperties, EmailSchema, FAQCategorySchema, FaqResponseSchema, FaqSchema, GetFaqCategoriesSchema, GetFaqCategoryBySlugSchema, GetFaqSchema, LandingPageSchema, Language, LocaleLanguage, NavigationGetResponse, NavigationReference, NavigationSchema, NextSchedule, Orientation, Page, PageGetResponse, PageSchema, PhoneProperties, PhoneSchema, ResourceContent, ScheduleSchema, ScheduleStartSchema, SEO, SEObreadcrumb, SeoComponent, SEOImage, SEOMetaItem, SEOMetaItems, SeoSchema, SeoSchemaComponent, SEOSchemaMarkupTemplate, SEOSitemap, SlideshowGetResponse, SlideshowMedia, SlideshowSchema, Support, TagSchema, TagSourceSchema, TagsSchema, PageType };
 }
 /** @returns {Action} */
 declare function Action(): Action;
@@ -653,6 +750,38 @@ type CronSchedule = {
     end?: string;
     start?: string;
 };
+/** @returns {CustomFieldSchema} */
+declare function CustomFieldSchema(): CustomFieldSchema;
+type CustomFieldSchema = {
+    _id?: string;
+    application_id?: string;
+    company_id?: string;
+    created_at?: string;
+    created_by?: string;
+    creator?: string;
+    definition_id?: string;
+    has_invalid_values?: boolean;
+    invalid_value_errors?: any[];
+    is_deleted?: boolean;
+    key?: string;
+    multi_value?: boolean;
+    namespace?: string;
+    resource?: string;
+    resource_id?: string;
+    type?: string;
+    updated_at?: string;
+    value?: CustomFieldValue[];
+};
+/** @returns {CustomFieldsResponseByResourceIdSchema} */
+declare function CustomFieldsResponseByResourceIdSchema(): CustomFieldsResponseByResourceIdSchema;
+type CustomFieldsResponseByResourceIdSchema = {
+    items?: CustomFieldSchema[];
+};
+/** @returns {CustomFieldValue} */
+declare function CustomFieldValue(): CustomFieldValue;
+type CustomFieldValue = {
+    value?: any;
+};
 /** @returns {CustomMetaTag} */
 declare function CustomMetaTag(): CustomMetaTag;
 type CustomMetaTag = {
@@ -660,6 +789,37 @@ type CustomMetaTag = {
     content?: string;
     name?: string;
 };
+/** @returns {CustomObjectByIdSchema} */
+declare function CustomObjectByIdSchema(): CustomObjectByIdSchema;
+type CustomObjectByIdSchema = {
+    _id?: string;
+    definition?: CustomObjectListItemDefinationSchema;
+    display_name?: string;
+    fields?: CustomObjectFieldSchema[];
+    references?: any[];
+    status?: string;
+};
+/** @returns {CustomObjectFieldSchema} */
+declare function CustomObjectFieldSchema(): CustomObjectFieldSchema;
+type CustomObjectFieldSchema = {
+    _id?: string;
+    definition_id?: string;
+    key?: string;
+    type?: string;
+    value?: CustomObjectFieldValue[];
+};
+/** @returns {CustomObjectFieldValue} */
+declare function CustomObjectFieldValue(): CustomObjectFieldValue;
+type CustomObjectFieldValue = {
+    value?: any;
+};
+/** @returns {CustomObjectListItemDefinationSchema} */
+declare function CustomObjectListItemDefinationSchema(): CustomObjectListItemDefinationSchema;
+type CustomObjectListItemDefinationSchema = {
+    _id?: string;
+    name?: string;
+    type?: string;
+};
 /** @returns {DataLoaderSchema} */
 declare function DataLoaderSchema(): DataLoaderSchema;
 type DataLoaderSchema = {
@@ -907,10 +1067,20 @@ type ScheduleStartSchema = {
 /** @returns {SEO} */
 declare function SEO(): SEO;
 type SEO = {
+    breadcrumb?: SEObreadcrumb[];
+    canonical_url?: string;
     description?: string;
     image?: SEOImage;
+    meta_tags?: SEOMetaItem[];
+    sitemap?: SEOSitemap;
     title?: string;
 };
+/** @returns {SEObreadcrumb} */
+declare function SEObreadcrumb(): SEObreadcrumb;
+type SEObreadcrumb = {
+    action?: Action;
+    url?: string;
+};
 /** @returns {SeoComponent} */
 declare function SeoComponent(): SeoComponent;
 type SeoComponent = {
@@ -921,10 +1091,23 @@ declare function SEOImage(): SEOImage;
 type SEOImage = {
     url?: string;
 };
+/** @returns {SEOMetaItem} */
+declare function SEOMetaItem(): SEOMetaItem;
+type SEOMetaItem = {
+    items?: SEOMetaItems[];
+    title?: string;
+};
+/** @returns {SEOMetaItems} */
+declare function SEOMetaItems(): SEOMetaItems;
+type SEOMetaItems = {
+    key?: string;
+    value?: string;
+};
 /** @returns {SeoSchema} */
 declare function SeoSchema(): SeoSchema;
 type SeoSchema = {
     _id?: string;
+    additonal_sitemap?: string;
     app?: string;
     cannonical_enabled?: boolean;
     created_at?: string;
@@ -934,6 +1117,30 @@ type SeoSchema = {
     sitemap_enabled?: boolean;
     updated_at?: string;
 };
+/** @returns {SeoSchemaComponent} */
+declare function SeoSchemaComponent(): SeoSchemaComponent;
+type SeoSchemaComponent = {
+    items?: SEOSchemaMarkupTemplate[];
+};
+/** @returns {SEOSchemaMarkupTemplate} */
+declare function SEOSchemaMarkupTemplate(): SEOSchemaMarkupTemplate;
+type SEOSchemaMarkupTemplate = {
+    active?: boolean;
+    application?: string;
+    created_at?: string;
+    description?: string;
+    id?: string;
+    page_type?: string;
+    schema?: string;
+    title?: string;
+    updated_at?: string;
+};
+/** @returns {SEOSitemap} */
+declare function SEOSitemap(): SEOSitemap;
+type SEOSitemap = {
+    frequency?: string;
+    priority?: number;
+};
 /** @returns {SlideshowGetResponse} */
 declare function SlideshowGetResponse(): SlideshowGetResponse;
 type SlideshowGetResponse = {