@gofynd/fdk-client-javascript 1.3.11-beta.7 → 1.4.0-beta.1

package/sdk/platform/Content/ContentPlatformApplicationValidator.js

@@ -28,6 +28,28 @@ const ContentPlatformModel = require("./ContentPlatformModel");
  * @property {ContentPlatformModel.AdminAnnouncementSchema} body
  */
 
+/**
+ * @typedef CreateAppCustomFieldByResourceIdParam
+ * @property {string} resource
+ * @property {string} resourceId
+ * @property {ContentPlatformModel.CustomFieldRequestSchema} body
+ */
+
+/**
+ * @typedef CreateAppCustomFieldDefinitionParam
+ * @property {ContentPlatformModel.CustomFieldDefinitionRequestSchema} body
+ */
+
+/**
+ * @typedef CreateAppCustomObjectParam
+ * @property {ContentPlatformModel.CustomObjectRequestSchema} body
+ */
+
+/**
+ * @typedef CreateAppCustomObjectDefinitionParam
+ * @property {ContentPlatformModel.CustomObjectDefinitionRequestSchema} body
+ */
+
 /**
  * @typedef CreateBlogParam
  * @property {ContentPlatformModel.BlogRequest} body
@@ -58,6 +80,11 @@ const ContentPlatformModel = require("./ContentPlatformModel");
  * @property {ContentPlatformModel.PageRequest} body
  */
 
+/**
+ * @typedef CreateSEOMarkupSchemaParam
+ * @property {ContentPlatformModel.SEOSchemaMarkupTemplateRequestBody} body
+ */
+
 /**
  * @typedef CreateSlideshowParam
  * @property {ContentPlatformModel.SlideshowRequest} body
@@ -68,6 +95,21 @@ const ContentPlatformModel = require("./ContentPlatformModel");
  * @property {string} announcementId - ID allotted to the announcement.
  */
 
+/**
+ * @typedef DeleteAppCustomFieldDefinitionParam
+ * @property {string} definitionId
+ */
+
+/**
+ * @typedef DeleteAppCustomObjectParam
+ * @property {string} metaobjectId
+ */
+
+/**
+ * @typedef DeleteAppCustomObjectDefinitionParam
+ * @property {string} definitionId
+ */
+
 /**
  * @typedef DeleteBlogParam
  * @property {string} id - ID allotted to the blog.
@@ -109,6 +151,12 @@ const ContentPlatformModel = require("./ContentPlatformModel");
  * @property {string} pathId - ID allotted to the path redirection rule.
  */
 
+/**
+ * @typedef DeleteSEOMarkupSchemaParam
+ * @property {string} id - Alphanumeric ID allotted to a SEO Markup Schema
+ *   Template created within a business.
+ */
+
 /**
  * @typedef DeleteSlideshowParam
  * @property {string} id - ID allotted to the slideshow.
@@ -126,6 +174,18 @@ const ContentPlatformModel = require("./ContentPlatformModel");
  * @property {ContentPlatformModel.UpdateHandpickedSchema} body
  */
 
+/**
+ * @typedef EditSEOMarkupSchemaParam
+ * @property {string} id - Alphanumeric ID allotted to a SEO Markup Schema
+ *   Template created within a business.
+ * @property {ContentPlatformModel.SEOSchemaMarkupTemplateRequestBody} body
+ */
+
+/**
+ * @typedef ExportAppCustomObjectEntriesParam
+ * @property {string} definitionId
+ */
+
 /**
  * @typedef GenerateSEOTitleParam
  * @property {ContentPlatformModel.GenerationEntityType} type - String
@@ -147,6 +207,66 @@ const ContentPlatformModel = require("./ContentPlatformModel");
  *   Default value is 10.
  */
 
+/**
+ * @typedef GetAppCustomFieldDefinitionParam
+ * @property {string} definitionId
+ */
+
+/**
+ * @typedef GetAppCustomFieldDefinitionsParam
+ * @property {string} pageNo
+ * @property {string} pageSize
+ * @property {string} [resource]
+ * @property {string} [type]
+ * @property {string} [search]
+ */
+
+/** @typedef GetAppCustomFieldTypesParam */
+
+/**
+ * @typedef GetAppCustomFieldsParam
+ * @property {string} resource
+ */
+
+/**
+ * @typedef GetAppCustomFieldsByResourceIdParam
+ * @property {string} resource
+ * @property {string} resourceId
+ */
+
+/**
+ * @typedef GetAppCustomObjectParam
+ * @property {string} metaobjectId
+ */
+
+/**
+ * @typedef GetAppCustomObjectDefinitionParam
+ * @property {string} definitionId
+ */
+
+/**
+ * @typedef GetAppCustomObjectDefinitionsParam
+ * @property {string} pageNo
+ * @property {string} pageSize
+ * @property {string} [search]
+ */
+
+/**
+ * @typedef GetAppCustomObjectsParam
+ * @property {string} [definitionId]
+ * @property {string} pageNo
+ * @property {string} pageSize
+ */
+
+/**
+ * @typedef GetAppJobsParam
+ * @property {string} page
+ * @property {string} pageSize
+ * @property {string} actionType
+ */
+
+/** @typedef GetAppResourcesParam */
+
 /**
  * @typedef GetBlogBySlugParam
  * @property {string} slug - A short, human-readable, URL-friendly identifier of
@@ -169,8 +289,19 @@ const ContentPlatformModel = require("./ContentPlatformModel");
 
 /** @typedef GetDataLoadersParam */
 
+/**
+ * @typedef GetDataLoadersByServiceParam
+ * @property {string} serviceName - Service name of the data loader..
+ */
+
 /** @typedef GetDefaultNavigationsParam */
 
+/**
+ * @typedef GetDefaultSEOMarkupSchemaParam
+ * @property {string} [pageType] - The type of page against which schema
+ *   template was created
+ */
+
 /**
  * @typedef GetFaqByIdOrSlugParam
  * @property {string} idOrSlug - ID or the slug allotted to an FAQ category.
@@ -260,6 +391,22 @@ const ContentPlatformModel = require("./ContentPlatformModel");
 
 /** @typedef GetSEOConfigurationParam */
 
+/**
+ * @typedef GetSEOMarkupSchemaParam
+ * @property {string} id - Alphanumeric ID allotted to a SEO Markup Schema
+ *   Template created within a business.
+ */
+
+/**
+ * @typedef GetSEOMarkupSchemasParam
+ * @property {string} [title] - Title of the seo schema.
+ * @property {string} [active] - Boolean value for fetching seo schema.
+ * @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 10.
+ */
+
 /**
  * @typedef GetSlideshowBySlugParam
  * @property {string} slug - A short, human-readable, URL-friendly identifier of
@@ -280,6 +427,12 @@ const ContentPlatformModel = require("./ContentPlatformModel");
 
 /** @typedef GetSupportInformationParam */
 
+/**
+ * @typedef ImportAppCustomObjectEntriesParam
+ * @property {string} definitionId
+ * @property {ContentPlatformModel.CustomObjectBulkSchema} body
+ */
+
 /**
  * @typedef RemoveInjectableTagParam
  * @property {ContentPlatformModel.RemoveHandpickedSchema} body
@@ -291,6 +444,11 @@ const ContentPlatformModel = require("./ContentPlatformModel");
  * @property {string} operationId - Name of operation id of the service.
  */
 
+/**
+ * @typedef SampleAppCustomObjectBulkEntryParam
+ * @property {string} definitionId
+ */
+
 /**
  * @typedef SelectDataLoaderParam
  * @property {string} dataLoaderId - ID allotted to the data loader.
@@ -308,6 +466,24 @@ const ContentPlatformModel = require("./ContentPlatformModel");
  * @property {ContentPlatformModel.ScheduleSchema} body
  */
 
+/**
+ * @typedef UpdateAppCustomFieldDefinitionParam
+ * @property {string} definitionId
+ * @property {ContentPlatformModel.CustomFieldDefinitionRequestSchema} body
+ */
+
+/**
+ * @typedef UpdateAppCustomObjectParam
+ * @property {string} metaobjectId
+ * @property {ContentPlatformModel.CustomObjectRequestSchema} body
+ */
+
+/**
+ * @typedef UpdateAppCustomObjectDefinitionParam
+ * @property {string} definitionId
+ * @property {ContentPlatformModel.CustomObjectDefinitionUpdateRequestSchema} body
+ */
+
 /**
  * @typedef UpdateBlogParam
  * @property {string} id - ID allotted to the blog.
@@ -421,6 +597,36 @@ class ContentPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {CreateAppCustomFieldByResourceIdParam} */
+  static createAppCustomFieldByResourceId() {
+    return Joi.object({
+      resource: Joi.string().allow("").required(),
+      resourceId: Joi.string().allow("").required(),
+      body: ContentPlatformModel.CustomFieldRequestSchema().required(),
+    }).required();
+  }
+
+  /** @returns {CreateAppCustomFieldDefinitionParam} */
+  static createAppCustomFieldDefinition() {
+    return Joi.object({
+      body: ContentPlatformModel.CustomFieldDefinitionRequestSchema().required(),
+    }).required();
+  }
+
+  /** @returns {CreateAppCustomObjectParam} */
+  static createAppCustomObject() {
+    return Joi.object({
+      body: ContentPlatformModel.CustomObjectRequestSchema().required(),
+    }).required();
+  }
+
+  /** @returns {CreateAppCustomObjectDefinitionParam} */
+  static createAppCustomObjectDefinition() {
+    return Joi.object({
+      body: ContentPlatformModel.CustomObjectDefinitionRequestSchema().required(),
+    }).required();
+  }
+
   /** @returns {CreateBlogParam} */
   static createBlog() {
     return Joi.object({
@@ -463,6 +669,13 @@ class ContentPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {CreateSEOMarkupSchemaParam} */
+  static createSEOMarkupSchema() {
+    return Joi.object({
+      body: ContentPlatformModel.SEOSchemaMarkupTemplateRequestBody().required(),
+    }).required();
+  }
+
   /** @returns {CreateSlideshowParam} */
   static createSlideshow() {
     return Joi.object({
@@ -477,6 +690,27 @@ class ContentPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {DeleteAppCustomFieldDefinitionParam} */
+  static deleteAppCustomFieldDefinition() {
+    return Joi.object({
+      definitionId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {DeleteAppCustomObjectParam} */
+  static deleteAppCustomObject() {
+    return Joi.object({
+      metaobjectId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {DeleteAppCustomObjectDefinitionParam} */
+  static deleteAppCustomObjectDefinition() {
+    return Joi.object({
+      definitionId: Joi.string().allow("").required(),
+    }).required();
+  }
+
   /** @returns {DeleteBlogParam} */
   static deleteBlog() {
     return Joi.object({
@@ -534,6 +768,13 @@ class ContentPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {DeleteSEOMarkupSchemaParam} */
+  static deleteSEOMarkupSchema() {
+    return Joi.object({
+      id: Joi.string().allow("").required(),
+    }).required();
+  }
+
   /** @returns {DeleteSlideshowParam} */
   static deleteSlideshow() {
     return Joi.object({
@@ -557,6 +798,21 @@ class ContentPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {EditSEOMarkupSchemaParam} */
+  static editSEOMarkupSchema() {
+    return Joi.object({
+      id: Joi.string().allow("").required(),
+      body: ContentPlatformModel.SEOSchemaMarkupTemplateRequestBody().required(),
+    }).required();
+  }
+
+  /** @returns {ExportAppCustomObjectEntriesParam} */
+  static exportAppCustomObjectEntries() {
+    return Joi.object({
+      definitionId: Joi.string().allow("").required(),
+    }).required();
+  }
+
   /** @returns {GenerateSEOTitleParam} */
   static generateSEOTitle() {
     return Joi.object({
@@ -580,6 +836,90 @@ class ContentPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {GetAppCustomFieldDefinitionParam} */
+  static getAppCustomFieldDefinition() {
+    return Joi.object({
+      definitionId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {GetAppCustomFieldDefinitionsParam} */
+  static getAppCustomFieldDefinitions() {
+    return Joi.object({
+      pageNo: Joi.string().allow("").required(),
+      pageSize: Joi.string().allow("").required(),
+      resource: Joi.string().allow(""),
+      type: Joi.string().allow(""),
+      search: Joi.string().allow(""),
+    }).required();
+  }
+
+  /** @returns {GetAppCustomFieldTypesParam} */
+  static getAppCustomFieldTypes() {
+    return Joi.object({}).required();
+  }
+
+  /** @returns {GetAppCustomFieldsParam} */
+  static getAppCustomFields() {
+    return Joi.object({
+      resource: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {GetAppCustomFieldsByResourceIdParam} */
+  static getAppCustomFieldsByResourceId() {
+    return Joi.object({
+      resource: Joi.string().allow("").required(),
+      resourceId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {GetAppCustomObjectParam} */
+  static getAppCustomObject() {
+    return Joi.object({
+      metaobjectId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {GetAppCustomObjectDefinitionParam} */
+  static getAppCustomObjectDefinition() {
+    return Joi.object({
+      definitionId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {GetAppCustomObjectDefinitionsParam} */
+  static getAppCustomObjectDefinitions() {
+    return Joi.object({
+      pageNo: Joi.string().allow("").required(),
+      pageSize: Joi.string().allow("").required(),
+      search: Joi.string().allow(""),
+    }).required();
+  }
+
+  /** @returns {GetAppCustomObjectsParam} */
+  static getAppCustomObjects() {
+    return Joi.object({
+      definitionId: Joi.string().allow(""),
+      pageNo: Joi.string().allow("").required(),
+      pageSize: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {GetAppJobsParam} */
+  static getAppJobs() {
+    return Joi.object({
+      page: Joi.string().allow("").required(),
+      pageSize: Joi.string().allow("").required(),
+      actionType: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {GetAppResourcesParam} */
+  static getAppResources() {
+    return Joi.object({}).required();
+  }
+
   /** @returns {GetBlogBySlugParam} */
   static getBlogBySlug() {
     return Joi.object({
@@ -607,11 +947,25 @@ class ContentPlatformApplicationValidator {
     return Joi.object({}).required();
   }
 
+  /** @returns {GetDataLoadersByServiceParam} */
+  static getDataLoadersByService() {
+    return Joi.object({
+      serviceName: Joi.string().allow("").required(),
+    }).required();
+  }
+
   /** @returns {GetDefaultNavigationsParam} */
   static getDefaultNavigations() {
     return Joi.object({}).required();
   }
 
+  /** @returns {GetDefaultSEOMarkupSchemaParam} */
+  static getDefaultSEOMarkupSchema() {
+    return Joi.object({
+      pageType: Joi.string().allow(""),
+    }).required();
+  }
+
   /** @returns {GetFaqByIdOrSlugParam} */
   static getFaqByIdOrSlug() {
     return Joi.object({
@@ -720,6 +1074,23 @@ class ContentPlatformApplicationValidator {
     return Joi.object({}).required();
   }
 
+  /** @returns {GetSEOMarkupSchemaParam} */
+  static getSEOMarkupSchema() {
+    return Joi.object({
+      id: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {GetSEOMarkupSchemasParam} */
+  static getSEOMarkupSchemas() {
+    return Joi.object({
+      title: Joi.string().allow(""),
+      active: Joi.string().allow(""),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+    }).required();
+  }
+
   /** @returns {GetSlideshowBySlugParam} */
   static getSlideshowBySlug() {
     return Joi.object({
@@ -742,6 +1113,14 @@ class ContentPlatformApplicationValidator {
     return Joi.object({}).required();
   }
 
+  /** @returns {ImportAppCustomObjectEntriesParam} */
+  static importAppCustomObjectEntries() {
+    return Joi.object({
+      definitionId: Joi.string().allow("").required(),
+      body: ContentPlatformModel.CustomObjectBulkSchema().required(),
+    }).required();
+  }
+
   /** @returns {RemoveInjectableTagParam} */
   static removeInjectableTag() {
     return Joi.object({
@@ -757,6 +1136,13 @@ class ContentPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {SampleAppCustomObjectBulkEntryParam} */
+  static sampleAppCustomObjectBulkEntry() {
+    return Joi.object({
+      definitionId: Joi.string().allow("").required(),
+    }).required();
+  }
+
   /** @returns {SelectDataLoaderParam} */
   static selectDataLoader() {
     return Joi.object({
@@ -780,6 +1166,30 @@ class ContentPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {UpdateAppCustomFieldDefinitionParam} */
+  static updateAppCustomFieldDefinition() {
+    return Joi.object({
+      definitionId: Joi.string().allow("").required(),
+      body: ContentPlatformModel.CustomFieldDefinitionRequestSchema().required(),
+    }).required();
+  }
+
+  /** @returns {UpdateAppCustomObjectParam} */
+  static updateAppCustomObject() {
+    return Joi.object({
+      metaobjectId: Joi.string().allow("").required(),
+      body: ContentPlatformModel.CustomObjectRequestSchema().required(),
+    }).required();
+  }
+
+  /** @returns {UpdateAppCustomObjectDefinitionParam} */
+  static updateAppCustomObjectDefinition() {
+    return Joi.object({
+      definitionId: Joi.string().allow("").required(),
+      body: ContentPlatformModel.CustomObjectDefinitionUpdateRequestSchema().required(),
+    }).required();
+  }
+
   /** @returns {UpdateBlogParam} */
   static updateBlog() {
     return Joi.object({