@gofynd/fdk-client-javascript 1.4.13 → 1.4.14

package/sdk/platform/Content/ContentPlatformApplicationValidator.js

@@ -28,21 +28,16 @@ const ContentPlatformModel = require("./ContentPlatformModel");
  * @property {ContentPlatformModel.AdminAnnouncementSchema} body
  */
 
-/**
- * @typedef CreateAppCustomFieldByResourceIdParam
- * @property {string} resource
- * @property {string} resourceId
- * @property {ContentPlatformModel.CustomFieldRequestSchema} body
- */
-
 /**
  * @typedef CreateAppCustomFieldDefinitionParam
+ * @property {string} resource
  * @property {ContentPlatformModel.CustomFieldDefinitionRequestSchema} body
  */
 
 /**
- * @typedef CreateAppCustomObjectParam
- * @property {ContentPlatformModel.CustomObjectRequestSchema} body
+ * @typedef CreateAppCustomObjectBySlugParam
+ * @property {string} definitionSlug
+ * @property {ContentPlatformModel.CustomObjectRequestSchemaWithoutId} body
  */
 
 /**
@@ -52,7 +47,7 @@ const ContentPlatformModel = require("./ContentPlatformModel");
 
 /**
  * @typedef CreateBlogParam
- * @property {ContentPlatformModel.BlogRequest} body
+ * @property {ContentPlatformModel.BlogPayload} body
  */
 
 /**
@@ -67,17 +62,17 @@ const ContentPlatformModel = require("./ContentPlatformModel");
 
 /**
  * @typedef CreateNavigationParam
- * @property {ContentPlatformModel.NavigationRequest} body
+ * @property {ContentPlatformModel.NavigationPayload} body
  */
 
 /**
  * @typedef CreatePageParam
- * @property {ContentPlatformModel.PageRequest} body
+ * @property {ContentPlatformModel.PagePayload} body
  */
 
 /**
  * @typedef CreatePagePreviewParam
- * @property {ContentPlatformModel.PageRequest} body
+ * @property {ContentPlatformModel.PagePayload} body
  */
 
 /**
@@ -87,7 +82,7 @@ const ContentPlatformModel = require("./ContentPlatformModel");
 
 /**
  * @typedef CreateSlideshowParam
- * @property {ContentPlatformModel.SlideshowRequest} body
+ * @property {ContentPlatformModel.SlideshowPayload} body
  */
 
 /**
@@ -96,18 +91,21 @@ const ContentPlatformModel = require("./ContentPlatformModel");
  */
 
 /**
- * @typedef DeleteAppCustomFieldDefinitionParam
- * @property {string} definitionId
+ * @typedef DeleteAppCustomFieldDefinitionBySlugParam
+ * @property {string} slug
+ * @property {string} resource
+ * @property {string} namespace
  */
 
 /**
- * @typedef DeleteAppCustomObjectParam
- * @property {string} metaobjectId
+ * @typedef DeleteAppCustomObjectBySlugParam
+ * @property {string} definitionSlug
+ * @property {string} slug
  */
 
 /**
- * @typedef DeleteAppCustomObjectDefinitionParam
- * @property {string} definitionId
+ * @typedef DeleteAppCustomObjectDefinitionBySlugParam
+ * @property {string} slug
  */
 
 /**
@@ -182,8 +180,8 @@ const ContentPlatformModel = require("./ContentPlatformModel");
  */
 
 /**
- * @typedef ExportAppCustomObjectEntriesParam
- * @property {string} definitionId
+ * @typedef ExportAppCustomObjectEntriesBySlugParam
+ * @property {string} slug
  */
 
 /**
@@ -208,40 +206,51 @@ const ContentPlatformModel = require("./ContentPlatformModel");
  */
 
 /**
- * @typedef GetAppCustomFieldDefinitionParam
- * @property {string} definitionId
+ * @typedef GetAppCustomFieldDefinitionByResourceParam
+ * @property {string} pageNo
+ * @property {string} pageSize
+ * @property {string} resource
+ * @property {string} [types]
+ * @property {string} [search]
+ * @property {string} [slugs]
+ * @property {string} [namespaces]
+ */
+
+/**
+ * @typedef GetAppCustomFieldDefinitionBySlugParam
+ * @property {string} slug
+ * @property {string} resource
+ * @property {string} namespace
  */
 
 /**
  * @typedef GetAppCustomFieldDefinitionsParam
  * @property {string} pageNo
  * @property {string} pageSize
- * @property {string} [resource]
- * @property {string} [type]
+ * @property {string} [resources]
+ * @property {string} [types]
  * @property {string} [search]
+ * @property {string} [slugs]
+ * @property {string} [namespaces]
  */
 
 /** @typedef GetAppCustomFieldTypesParam */
 
 /**
- * @typedef GetAppCustomFieldsParam
+ * @typedef GetAppCustomFieldsByResourceSlugParam
  * @property {string} resource
+ * @property {string} resourceSlug
  */
 
 /**
- * @typedef GetAppCustomFieldsByResourceIdParam
- * @property {string} resource
- * @property {string} resourceId
+ * @typedef GetAppCustomObjectBySlugParam
+ * @property {string} definitionSlug
+ * @property {string} slug
  */
 
 /**
- * @typedef GetAppCustomObjectParam
- * @property {string} metaobjectId
- */
-
-/**
- * @typedef GetAppCustomObjectDefinitionParam
- * @property {string} definitionId
+ * @typedef GetAppCustomObjectDefinitionBySlugParam
+ * @property {string} slug
  */
 
 /**
@@ -252,10 +261,10 @@ const ContentPlatformModel = require("./ContentPlatformModel");
  */
 
 /**
- * @typedef GetAppCustomObjectsParam
- * @property {string} [definitionId]
+ * @typedef GetAppCustomObjectsBySlugParam
  * @property {string} pageNo
  * @property {string} pageSize
+ * @property {string} definitionSlug
  */
 
 /**
@@ -343,8 +352,8 @@ const ContentPlatformModel = require("./ContentPlatformModel");
  * @typedef GetNavigationBySlugParam
  * @property {string} slug - A short, human-readable, URL-friendly identifier of
  *   a navigation. You can get slug value of a navigation from `getNavigations` API.
- * @property {string} devicePlatform - Filter navigations by platform.
- *   Acceptable values are: web, android, ios, all
+ * @property {string} [devicePlatform] - Filter navigations by platform.
+ *   Acceptable values are: web, android, ios.
  */
 
 /**
@@ -427,8 +436,8 @@ const ContentPlatformModel = require("./ContentPlatformModel");
 /** @typedef GetSupportInformationParam */
 
 /**
- * @typedef ImportAppCustomObjectEntriesParam
- * @property {string} definitionId
+ * @typedef ImportAppCustomObjectEntriesBySlugParam
+ * @property {string} slug
  * @property {ContentPlatformModel.CustomObjectBulkSchema} body
  */
 
@@ -444,8 +453,8 @@ const ContentPlatformModel = require("./ContentPlatformModel");
  */
 
 /**
- * @typedef SampleAppCustomObjectBulkEntryParam
- * @property {string} definitionId
+ * @typedef SampleAppCustomObjectBulkEntryBySlugParam
+ * @property {string} slug
  */
 
 /**
@@ -466,27 +475,37 @@ const ContentPlatformModel = require("./ContentPlatformModel");
  */
 
 /**
- * @typedef UpdateAppCustomFieldDefinitionParam
- * @property {string} definitionId
+ * @typedef UpdateAppCustomFieldByResourceSlugParam
+ * @property {string} resource
+ * @property {string} resourceSlug
+ * @property {ContentPlatformModel.CustomFieldRequestSchema} body
+ */
+
+/**
+ * @typedef UpdateAppCustomFieldDefinitionBySlugParam
+ * @property {string} slug
+ * @property {string} resource
+ * @property {string} namespace
  * @property {ContentPlatformModel.CustomFieldDefinitionRequestSchema} body
  */
 
 /**
- * @typedef UpdateAppCustomObjectParam
- * @property {string} metaobjectId
- * @property {ContentPlatformModel.CustomObjectRequestSchema} body
+ * @typedef UpdateAppCustomObjectBySlugParam
+ * @property {string} definitionSlug
+ * @property {string} slug
+ * @property {ContentPlatformModel.CustomObjectRequestSchemaWithoutId} body
  */
 
 /**
- * @typedef UpdateAppCustomObjectDefinitionParam
- * @property {string} definitionId
+ * @typedef UpdateAppCustomObjectDefinitionBySlugParam
+ * @property {string} slug
  * @property {ContentPlatformModel.CustomObjectDefinitionUpdateRequestSchema} body
  */
 
 /**
  * @typedef UpdateBlogParam
  * @property {string} id - ID allotted to the blog.
- * @property {ContentPlatformModel.BlogRequest} body
+ * @property {ContentPlatformModel.BlogPayload} body
  */
 
 /**
@@ -521,7 +540,7 @@ const ContentPlatformModel = require("./ContentPlatformModel");
 /**
  * @typedef UpdateNavigationParam
  * @property {string} id - ID allotted to the navigation.
- * @property {ContentPlatformModel.NavigationRequest} body
+ * @property {ContentPlatformModel.NavigationPayload} body
  */
 
 /**
@@ -534,7 +553,7 @@ const ContentPlatformModel = require("./ContentPlatformModel");
  * @typedef UpdatePagePreviewParam
  * @property {string} slug - A short, human-readable, URL-friendly identifier of
  *   a page. You can get slug value of a page from `getPages` API.
- * @property {ContentPlatformModel.PagePublishRequest} body
+ * @property {ContentPlatformModel.PagePublishPayload} body
  */
 
 /**
@@ -551,7 +570,7 @@ const ContentPlatformModel = require("./ContentPlatformModel");
 /**
  * @typedef UpdateSlideshowParam
  * @property {string} id - ID allotted to the slideshow.
- * @property {ContentPlatformModel.SlideshowRequest} body
+ * @property {ContentPlatformModel.SlideshowPayload} body
  */
 
 /**
@@ -596,26 +615,19 @@ 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({
+      resource: Joi.string().allow("").required(),
       body: ContentPlatformModel.CustomFieldDefinitionRequestSchema().required(),
     }).required();
   }
 
-  /** @returns {CreateAppCustomObjectParam} */
-  static createAppCustomObject() {
+  /** @returns {CreateAppCustomObjectBySlugParam} */
+  static createAppCustomObjectBySlug() {
     return Joi.object({
-      body: ContentPlatformModel.CustomObjectRequestSchema().required(),
+      definitionSlug: Joi.string().allow("").required(),
+      body: ContentPlatformModel.CustomObjectRequestSchemaWithoutId().required(),
     }).required();
   }
 
@@ -629,7 +641,7 @@ class ContentPlatformApplicationValidator {
   /** @returns {CreateBlogParam} */
   static createBlog() {
     return Joi.object({
-      body: ContentPlatformModel.BlogRequest().required(),
+      body: ContentPlatformModel.BlogPayload().required(),
     }).required();
   }
 
@@ -650,21 +662,21 @@ class ContentPlatformApplicationValidator {
   /** @returns {CreateNavigationParam} */
   static createNavigation() {
     return Joi.object({
-      body: ContentPlatformModel.NavigationRequest().required(),
+      body: ContentPlatformModel.NavigationPayload().required(),
     }).required();
   }
 
   /** @returns {CreatePageParam} */
   static createPage() {
     return Joi.object({
-      body: ContentPlatformModel.PageRequest().required(),
+      body: ContentPlatformModel.PagePayload().required(),
     }).required();
   }
 
   /** @returns {CreatePagePreviewParam} */
   static createPagePreview() {
     return Joi.object({
-      body: ContentPlatformModel.PageRequest().required(),
+      body: ContentPlatformModel.PagePayload().required(),
     }).required();
   }
 
@@ -678,7 +690,7 @@ class ContentPlatformApplicationValidator {
   /** @returns {CreateSlideshowParam} */
   static createSlideshow() {
     return Joi.object({
-      body: ContentPlatformModel.SlideshowRequest().required(),
+      body: ContentPlatformModel.SlideshowPayload().required(),
     }).required();
   }
 
@@ -689,24 +701,27 @@ class ContentPlatformApplicationValidator {
     }).required();
   }
 
-  /** @returns {DeleteAppCustomFieldDefinitionParam} */
-  static deleteAppCustomFieldDefinition() {
+  /** @returns {DeleteAppCustomFieldDefinitionBySlugParam} */
+  static deleteAppCustomFieldDefinitionBySlug() {
     return Joi.object({
-      definitionId: Joi.string().allow("").required(),
+      slug: Joi.string().allow("").required(),
+      resource: Joi.string().allow("").required(),
+      namespace: Joi.string().allow("").required(),
     }).required();
   }
 
-  /** @returns {DeleteAppCustomObjectParam} */
-  static deleteAppCustomObject() {
+  /** @returns {DeleteAppCustomObjectBySlugParam} */
+  static deleteAppCustomObjectBySlug() {
     return Joi.object({
-      metaobjectId: Joi.string().allow("").required(),
+      definitionSlug: Joi.string().allow("").required(),
+      slug: Joi.string().allow("").required(),
     }).required();
   }
 
-  /** @returns {DeleteAppCustomObjectDefinitionParam} */
-  static deleteAppCustomObjectDefinition() {
+  /** @returns {DeleteAppCustomObjectDefinitionBySlugParam} */
+  static deleteAppCustomObjectDefinitionBySlug() {
     return Joi.object({
-      definitionId: Joi.string().allow("").required(),
+      slug: Joi.string().allow("").required(),
     }).required();
   }
 
@@ -805,10 +820,10 @@ class ContentPlatformApplicationValidator {
     }).required();
   }
 
-  /** @returns {ExportAppCustomObjectEntriesParam} */
-  static exportAppCustomObjectEntries() {
+  /** @returns {ExportAppCustomObjectEntriesBySlugParam} */
+  static exportAppCustomObjectEntriesBySlug() {
     return Joi.object({
-      definitionId: Joi.string().allow("").required(),
+      slug: Joi.string().allow("").required(),
     }).required();
   }
 
@@ -835,10 +850,25 @@ class ContentPlatformApplicationValidator {
     }).required();
   }
 
-  /** @returns {GetAppCustomFieldDefinitionParam} */
-  static getAppCustomFieldDefinition() {
+  /** @returns {GetAppCustomFieldDefinitionByResourceParam} */
+  static getAppCustomFieldDefinitionByResource() {
     return Joi.object({
-      definitionId: Joi.string().allow("").required(),
+      pageNo: Joi.string().allow("").required(),
+      pageSize: Joi.string().allow("").required(),
+      resource: Joi.string().allow("").required(),
+      types: Joi.string().allow(""),
+      search: Joi.string().allow(""),
+      slugs: Joi.string().allow(""),
+      namespaces: Joi.string().allow(""),
+    }).required();
+  }
+
+  /** @returns {GetAppCustomFieldDefinitionBySlugParam} */
+  static getAppCustomFieldDefinitionBySlug() {
+    return Joi.object({
+      slug: Joi.string().allow("").required(),
+      resource: Joi.string().allow("").required(),
+      namespace: Joi.string().allow("").required(),
     }).required();
   }
 
@@ -847,9 +877,11 @@ class ContentPlatformApplicationValidator {
     return Joi.object({
       pageNo: Joi.string().allow("").required(),
       pageSize: Joi.string().allow("").required(),
-      resource: Joi.string().allow(""),
-      type: Joi.string().allow(""),
+      resources: Joi.string().allow(""),
+      types: Joi.string().allow(""),
       search: Joi.string().allow(""),
+      slugs: Joi.string().allow(""),
+      namespaces: Joi.string().allow(""),
     }).required();
   }
 
@@ -858,32 +890,26 @@ class ContentPlatformApplicationValidator {
     return Joi.object({}).required();
   }
 
-  /** @returns {GetAppCustomFieldsParam} */
-  static getAppCustomFields() {
-    return Joi.object({
-      resource: Joi.string().allow("").required(),
-    }).required();
-  }
-
-  /** @returns {GetAppCustomFieldsByResourceIdParam} */
-  static getAppCustomFieldsByResourceId() {
+  /** @returns {GetAppCustomFieldsByResourceSlugParam} */
+  static getAppCustomFieldsByResourceSlug() {
     return Joi.object({
       resource: Joi.string().allow("").required(),
-      resourceId: Joi.string().allow("").required(),
+      resourceSlug: Joi.string().allow("").required(),
     }).required();
   }
 
-  /** @returns {GetAppCustomObjectParam} */
-  static getAppCustomObject() {
+  /** @returns {GetAppCustomObjectBySlugParam} */
+  static getAppCustomObjectBySlug() {
     return Joi.object({
-      metaobjectId: Joi.string().allow("").required(),
+      definitionSlug: Joi.string().allow("").required(),
+      slug: Joi.string().allow("").required(),
     }).required();
   }
 
-  /** @returns {GetAppCustomObjectDefinitionParam} */
-  static getAppCustomObjectDefinition() {
+  /** @returns {GetAppCustomObjectDefinitionBySlugParam} */
+  static getAppCustomObjectDefinitionBySlug() {
     return Joi.object({
-      definitionId: Joi.string().allow("").required(),
+      slug: Joi.string().allow("").required(),
     }).required();
   }
 
@@ -896,12 +922,12 @@ class ContentPlatformApplicationValidator {
     }).required();
   }
 
-  /** @returns {GetAppCustomObjectsParam} */
-  static getAppCustomObjects() {
+  /** @returns {GetAppCustomObjectsBySlugParam} */
+  static getAppCustomObjectsBySlug() {
     return Joi.object({
-      definitionId: Joi.string().allow(""),
       pageNo: Joi.string().allow("").required(),
       pageSize: Joi.string().allow("").required(),
+      definitionSlug: Joi.string().allow("").required(),
     }).required();
   }
 
@@ -1013,7 +1039,7 @@ class ContentPlatformApplicationValidator {
   static getNavigationBySlug() {
     return Joi.object({
       slug: Joi.string().allow("").required(),
-      devicePlatform: Joi.string().allow("").required(),
+      devicePlatform: Joi.string().allow(""),
     }).required();
   }
 
@@ -1110,10 +1136,10 @@ class ContentPlatformApplicationValidator {
     return Joi.object({}).required();
   }
 
-  /** @returns {ImportAppCustomObjectEntriesParam} */
-  static importAppCustomObjectEntries() {
+  /** @returns {ImportAppCustomObjectEntriesBySlugParam} */
+  static importAppCustomObjectEntriesBySlug() {
     return Joi.object({
-      definitionId: Joi.string().allow("").required(),
+      slug: Joi.string().allow("").required(),
       body: ContentPlatformModel.CustomObjectBulkSchema().required(),
     }).required();
   }
@@ -1133,10 +1159,10 @@ class ContentPlatformApplicationValidator {
     }).required();
   }
 
-  /** @returns {SampleAppCustomObjectBulkEntryParam} */
-  static sampleAppCustomObjectBulkEntry() {
+  /** @returns {SampleAppCustomObjectBulkEntryBySlugParam} */
+  static sampleAppCustomObjectBulkEntryBySlug() {
     return Joi.object({
-      definitionId: Joi.string().allow("").required(),
+      slug: Joi.string().allow("").required(),
     }).required();
   }
 
@@ -1163,26 +1189,38 @@ class ContentPlatformApplicationValidator {
     }).required();
   }
 
-  /** @returns {UpdateAppCustomFieldDefinitionParam} */
-  static updateAppCustomFieldDefinition() {
+  /** @returns {UpdateAppCustomFieldByResourceSlugParam} */
+  static updateAppCustomFieldByResourceSlug() {
     return Joi.object({
-      definitionId: Joi.string().allow("").required(),
+      resource: Joi.string().allow("").required(),
+      resourceSlug: Joi.string().allow("").required(),
+      body: ContentPlatformModel.CustomFieldRequestSchema().required(),
+    }).required();
+  }
+
+  /** @returns {UpdateAppCustomFieldDefinitionBySlugParam} */
+  static updateAppCustomFieldDefinitionBySlug() {
+    return Joi.object({
+      slug: Joi.string().allow("").required(),
+      resource: Joi.string().allow("").required(),
+      namespace: Joi.string().allow("").required(),
       body: ContentPlatformModel.CustomFieldDefinitionRequestSchema().required(),
     }).required();
   }
 
-  /** @returns {UpdateAppCustomObjectParam} */
-  static updateAppCustomObject() {
+  /** @returns {UpdateAppCustomObjectBySlugParam} */
+  static updateAppCustomObjectBySlug() {
     return Joi.object({
-      metaobjectId: Joi.string().allow("").required(),
-      body: ContentPlatformModel.CustomObjectRequestSchema().required(),
+      definitionSlug: Joi.string().allow("").required(),
+      slug: Joi.string().allow("").required(),
+      body: ContentPlatformModel.CustomObjectRequestSchemaWithoutId().required(),
     }).required();
   }
 
-  /** @returns {UpdateAppCustomObjectDefinitionParam} */
-  static updateAppCustomObjectDefinition() {
+  /** @returns {UpdateAppCustomObjectDefinitionBySlugParam} */
+  static updateAppCustomObjectDefinitionBySlug() {
     return Joi.object({
-      definitionId: Joi.string().allow("").required(),
+      slug: Joi.string().allow("").required(),
       body: ContentPlatformModel.CustomObjectDefinitionUpdateRequestSchema().required(),
     }).required();
   }
@@ -1191,7 +1229,7 @@ class ContentPlatformApplicationValidator {
   static updateBlog() {
     return Joi.object({
       id: Joi.string().allow("").required(),
-      body: ContentPlatformModel.BlogRequest().required(),
+      body: ContentPlatformModel.BlogPayload().required(),
     }).required();
   }
 
@@ -1238,7 +1276,7 @@ class ContentPlatformApplicationValidator {
   static updateNavigation() {
     return Joi.object({
       id: Joi.string().allow("").required(),
-      body: ContentPlatformModel.NavigationRequest().required(),
+      body: ContentPlatformModel.NavigationPayload().required(),
     }).required();
   }
 
@@ -1254,7 +1292,7 @@ class ContentPlatformApplicationValidator {
   static updatePagePreview() {
     return Joi.object({
       slug: Joi.string().allow("").required(),
-      body: ContentPlatformModel.PagePublishRequest().required(),
+      body: ContentPlatformModel.PagePublishPayload().required(),
     }).required();
   }
 
@@ -1277,7 +1315,7 @@ class ContentPlatformApplicationValidator {
   static updateSlideshow() {
     return Joi.object({
       id: Joi.string().allow("").required(),
-      body: ContentPlatformModel.SlideshowRequest().required(),
+      body: ContentPlatformModel.SlideshowPayload().required(),
     }).required();
   }