@gofynd/fdk-client-javascript 3.1.0-beta.1 → 3.2.0

package/sdk/platform/Content/ContentPlatformValidator.js

@@ -3,20 +3,25 @@ const Joi = require("joi");
 const ContentPlatformModel = require("./ContentPlatformModel");
 
 /**
- * @typedef CreateCustomFieldByResourceIdParam
- * @property {string} resource
- * @property {string} resourceId
- * @property {ContentPlatformModel.CustomFieldRequestSchema} body
+ * @typedef AddCompanyLanguageParam
+ * @property {ContentPlatformModel.CompanyLanguageCreate} body
+ */
+
+/**
+ * @typedef CreateCompanyResourceTranslationParam
+ * @property {ContentPlatformModel.ResourceTranslationCreate} body
  */
 
 /**
  * @typedef CreateCustomFieldDefinitionParam
+ * @property {string} resource
  * @property {ContentPlatformModel.CustomFieldDefinitionRequestSchema} body
  */
 
 /**
- * @typedef CreateCustomObjectParam
- * @property {ContentPlatformModel.CustomObjectRequestSchema} body
+ * @typedef CreateCustomObjectBySlugParam
+ * @property {string} definitionSlug
+ * @property {ContentPlatformModel.CustomObjectRequestSchemaWithoutId} body
  */
 
 /**
@@ -25,75 +30,109 @@ const ContentPlatformModel = require("./ContentPlatformModel");
  */
 
 /**
- * @typedef DeleteCustomFieldDefinitionParam
+ * @typedef DeleteCompanyLanguageParam
+ * @property {string} locale
+ */
+
+/**
+ * @typedef DeleteCompanyResourceTranslationParam
  * @property {string} id
  */
 
 /**
- * @typedef DeleteCustomFieldsByResourceIdParam
+ * @typedef DeleteCustomFieldDefinitionBySlugParam
+ * @property {string} slug
  * @property {string} resource
- * @property {string} resourceId
+ * @property {string} namespace
+ */
+
+/**
+ * @typedef DeleteCustomFieldsByResourceSlugParam
+ * @property {string} resource
+ * @property {string} resourceSlug
  * @property {string} ids
  */
 
 /**
- * @typedef DeleteCustomObjectParam
- * @property {string} id
+ * @typedef DeleteCustomObjectBySlugParam
+ * @property {string} definitionSlug
+ * @property {string} slug
  */
 
 /**
- * @typedef DeleteCustomObjectDefinitionParam
- * @property {string} id
+ * @typedef DeleteCustomObjectDefinitionBySlugParam
+ * @property {string} slug
  */
 
 /**
- * @typedef ExportCustomObjectEntriesParam
- * @property {string} definitionId
+ * @typedef ExportCustomObjectEntriesBySlugParam
+ * @property {string} slug
  */
 
 /**
- * @typedef GetCustomFieldDefinitionParam
- * @property {string} id
+ * @typedef GetAllResourceDefinitionsParam
+ * @property {string} [translatableResourceId]
  */
 
+/** @typedef GetAllSectionsParam */
+
+/** @typedef GetAllTranslatableResourcesParam */
+
+/** @typedef GetCompanyLanguagesParam */
+
 /**
- * @typedef GetCustomFieldDefinitionsParam
+ * @typedef GetCompanyResourceTranslationParam
+ * @property {string} locale
+ * @property {string} type
+ * @property {string} resourceId
+ */
+
+/**
+ * @typedef GetCustomFieldDefinitionByResourceParam
  * @property {string} pageNo
  * @property {string} pageSize
- * @property {string} [resources]
+ * @property {string} resource
  * @property {string} [types]
  * @property {string} [search]
  * @property {string} [slugs]
+ * @property {string} [namespaces]
  */
 
 /**
- * @typedef GetCustomFieldJobsParam
- * @property {string} page
- * @property {string} pageSize
- * @property {string} actionType
+ * @typedef GetCustomFieldDefinitionBySlugParam
+ * @property {string} slug
+ * @property {string} resource
+ * @property {string} namespace
  */
 
-/** @typedef GetCustomFieldTypesParam */
-
 /**
- * @typedef GetCustomFieldsParam
- * @property {string} resource
+ * @typedef GetCustomFieldDefinitionsParam
+ * @property {string} pageNo
+ * @property {string} pageSize
+ * @property {string} [resources]
+ * @property {string} [types]
+ * @property {string} [search]
+ * @property {string} [slugs]
+ * @property {string} [namespaces]
  */
 
+/** @typedef GetCustomFieldTypesParam */
+
 /**
- * @typedef GetCustomFieldsByResourceIdParam
+ * @typedef GetCustomFieldsByResourceSlugParam
  * @property {string} resource
- * @property {string} resourceId
+ * @property {string} resourceSlug
  */
 
 /**
- * @typedef GetCustomObjectParam
- * @property {string} id
+ * @typedef GetCustomObjectBySlugParam
+ * @property {string} definitionSlug
+ * @property {string} slug
  */
 
 /**
- * @typedef GetCustomObjectDefinitionParam
- * @property {string} id
+ * @typedef GetCustomObjectDefinitionBySlugParam
+ * @property {string} slug
  */
 
 /**
@@ -104,10 +143,10 @@ const ContentPlatformModel = require("./ContentPlatformModel");
  */
 
 /**
- * @typedef GetCustomObjectsParam
- * @property {string} [definitionId]
+ * @typedef GetCustomObjectsBySlugParam
  * @property {string} pageNo
  * @property {string} pageSize
+ * @property {string} definitionSlug
  */
 
 /**
@@ -117,65 +156,107 @@ const ContentPlatformModel = require("./ContentPlatformModel");
  * @property {string} actionType
  */
 
+/**
+ * @typedef GetResourceDefinitionByIdParam
+ * @property {string} id
+ */
+
 /** @typedef GetResourcesParam */
 
 /**
- * @typedef ImportCustomObjectEntriesParam
- * @property {string} definitionId
+ * @typedef GetSectionByIdParam
+ * @property {string} id
+ */
+
+/**
+ * @typedef GetTranslatableResourceByIdParam
+ * @property {string} id
+ */
+
+/**
+ * @typedef GetTranslatableResourcesBySectionIdParam
+ * @property {string} id
+ */
+
+/**
+ * @typedef ImportCustomObjectEntriesBySlugParam
+ * @property {string} slug
  * @property {ContentPlatformModel.CustomObjectBulkSchema} body
  */
 
 /**
- * @typedef SampleCustomObjectBulkEntryParam
- * @property {string} definitionId
+ * @typedef SampleCustomObjectBulkEntryBySlugParam
+ * @property {string} slug
+ */
+
+/**
+ * @typedef UpdateCompanyLanguageDefaultParam
+ * @property {string} locale
+ * @property {ContentPlatformModel.CompanyLanguageUpdate} body
+ */
+
+/**
+ * @typedef UpdateCompanyResourceTranslationParam
+ * @property {string} id
+ * @property {ContentPlatformModel.ResourceTranslationUpdate} body
  */
 
 /**
- * @typedef UpdateCustomFieldByResourceIdParam
+ * @typedef UpdateCustomFieldByResourceSlugParam
  * @property {string} resource
- * @property {string} resourceId
+ * @property {string} resourceSlug
  * @property {ContentPlatformModel.CustomFieldRequestSchema} body
  */
 
 /**
- * @typedef UpdateCustomFieldDefinitionParam
- * @property {string} id
+ * @typedef UpdateCustomFieldDefinitionBySlugParam
+ * @property {string} slug
+ * @property {string} resource
+ * @property {string} namespace
  * @property {ContentPlatformModel.CustomFieldDefinitionRequestSchema} body
  */
 
 /**
- * @typedef UpdateCustomObjectParam
- * @property {string} id
- * @property {ContentPlatformModel.CustomObjectRequestSchema} body
+ * @typedef UpdateCustomObjectBySlugParam
+ * @property {string} definitionSlug
+ * @property {string} slug
+ * @property {ContentPlatformModel.CustomObjectRequestSchemaWithoutId} body
  */
 
 /**
- * @typedef UpdateCustomObjectDefinitionParam
- * @property {string} id
+ * @typedef UpdateCustomObjectDefinitionBySlugParam
+ * @property {string} slug
  * @property {ContentPlatformModel.CustomObjectDefinitionUpdateRequestSchema} body
  */
 
 class ContentPlatformValidator {
-  /** @returns {CreateCustomFieldByResourceIdParam} */
-  static createCustomFieldByResourceId() {
+  /** @returns {AddCompanyLanguageParam} */
+  static addCompanyLanguage() {
     return Joi.object({
-      resource: Joi.string().allow("").required(),
-      resourceId: Joi.string().allow("").required(),
-      body: ContentPlatformModel.CustomFieldRequestSchema().required(),
+      body: ContentPlatformModel.CompanyLanguageCreate().required(),
+    }).required();
+  }
+
+  /** @returns {CreateCompanyResourceTranslationParam} */
+  static createCompanyResourceTranslation() {
+    return Joi.object({
+      body: ContentPlatformModel.ResourceTranslationCreate().required(),
     }).required();
   }
 
   /** @returns {CreateCustomFieldDefinitionParam} */
   static createCustomFieldDefinition() {
     return Joi.object({
+      resource: Joi.string().allow("").required(),
       body: ContentPlatformModel.CustomFieldDefinitionRequestSchema().required(),
     }).required();
   }
 
-  /** @returns {CreateCustomObjectParam} */
-  static createCustomObject() {
+  /** @returns {CreateCustomObjectBySlugParam} */
+  static createCustomObjectBySlug() {
     return Joi.object({
-      body: ContentPlatformModel.CustomObjectRequestSchema().required(),
+      definitionSlug: Joi.string().allow("").required(),
+      body: ContentPlatformModel.CustomObjectRequestSchemaWithoutId().required(),
     }).required();
   }
 
@@ -186,68 +267,123 @@ class ContentPlatformValidator {
     }).required();
   }
 
-  /** @returns {DeleteCustomFieldDefinitionParam} */
-  static deleteCustomFieldDefinition() {
+  /** @returns {DeleteCompanyLanguageParam} */
+  static deleteCompanyLanguage() {
+    return Joi.object({
+      locale: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {DeleteCompanyResourceTranslationParam} */
+  static deleteCompanyResourceTranslation() {
     return Joi.object({
       id: Joi.string().allow("").required(),
     }).required();
   }
 
-  /** @returns {DeleteCustomFieldsByResourceIdParam} */
-  static deleteCustomFieldsByResourceId() {
+  /** @returns {DeleteCustomFieldDefinitionBySlugParam} */
+  static deleteCustomFieldDefinitionBySlug() {
     return Joi.object({
+      slug: Joi.string().allow("").required(),
       resource: Joi.string().allow("").required(),
-      resourceId: Joi.string().allow("").required(),
+      namespace: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {DeleteCustomFieldsByResourceSlugParam} */
+  static deleteCustomFieldsByResourceSlug() {
+    return Joi.object({
+      resource: Joi.string().allow("").required(),
+      resourceSlug: Joi.string().allow("").required(),
       ids: Joi.string().allow("").required(),
     }).required();
   }
 
-  /** @returns {DeleteCustomObjectParam} */
-  static deleteCustomObject() {
+  /** @returns {DeleteCustomObjectBySlugParam} */
+  static deleteCustomObjectBySlug() {
     return Joi.object({
-      id: Joi.string().allow("").required(),
+      definitionSlug: Joi.string().allow("").required(),
+      slug: Joi.string().allow("").required(),
     }).required();
   }
 
-  /** @returns {DeleteCustomObjectDefinitionParam} */
-  static deleteCustomObjectDefinition() {
+  /** @returns {DeleteCustomObjectDefinitionBySlugParam} */
+  static deleteCustomObjectDefinitionBySlug() {
     return Joi.object({
-      id: Joi.string().allow("").required(),
+      slug: Joi.string().allow("").required(),
     }).required();
   }
 
-  /** @returns {ExportCustomObjectEntriesParam} */
-  static exportCustomObjectEntries() {
+  /** @returns {ExportCustomObjectEntriesBySlugParam} */
+  static exportCustomObjectEntriesBySlug() {
     return Joi.object({
-      definitionId: Joi.string().allow("").required(),
+      slug: Joi.string().allow("").required(),
     }).required();
   }
 
-  /** @returns {GetCustomFieldDefinitionParam} */
-  static getCustomFieldDefinition() {
+  /** @returns {GetAllResourceDefinitionsParam} */
+  static getAllResourceDefinitions() {
     return Joi.object({
-      id: Joi.string().allow("").required(),
+      translatableResourceId: Joi.string().allow(""),
     }).required();
   }
 
-  /** @returns {GetCustomFieldDefinitionsParam} */
-  static getCustomFieldDefinitions() {
+  /** @returns {GetAllSectionsParam} */
+  static getAllSections() {
+    return Joi.object({}).required();
+  }
+
+  /** @returns {GetAllTranslatableResourcesParam} */
+  static getAllTranslatableResources() {
+    return Joi.object({}).required();
+  }
+
+  /** @returns {GetCompanyLanguagesParam} */
+  static getCompanyLanguages() {
+    return Joi.object({}).required();
+  }
+
+  /** @returns {GetCompanyResourceTranslationParam} */
+  static getCompanyResourceTranslation() {
+    return Joi.object({
+      locale: Joi.string().allow("").required(),
+      type: Joi.string().allow("").required(),
+      resourceId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {GetCustomFieldDefinitionByResourceParam} */
+  static getCustomFieldDefinitionByResource() {
     return Joi.object({
       pageNo: Joi.string().allow("").required(),
       pageSize: Joi.string().allow("").required(),
-      resources: Joi.string().allow(""),
+      resource: Joi.string().allow("").required(),
       types: Joi.string().allow(""),
       search: Joi.string().allow(""),
       slugs: Joi.string().allow(""),
+      namespaces: Joi.string().allow(""),
     }).required();
   }
 
-  /** @returns {GetCustomFieldJobsParam} */
-  static getCustomFieldJobs() {
+  /** @returns {GetCustomFieldDefinitionBySlugParam} */
+  static getCustomFieldDefinitionBySlug() {
     return Joi.object({
-      page: Joi.string().allow("").required(),
+      slug: Joi.string().allow("").required(),
+      resource: Joi.string().allow("").required(),
+      namespace: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {GetCustomFieldDefinitionsParam} */
+  static getCustomFieldDefinitions() {
+    return Joi.object({
+      pageNo: Joi.string().allow("").required(),
       pageSize: Joi.string().allow("").required(),
-      actionType: Joi.string().allow("").required(),
+      resources: Joi.string().allow(""),
+      types: Joi.string().allow(""),
+      search: Joi.string().allow(""),
+      slugs: Joi.string().allow(""),
+      namespaces: Joi.string().allow(""),
     }).required();
   }
 
@@ -256,32 +392,26 @@ class ContentPlatformValidator {
     return Joi.object({}).required();
   }
 
-  /** @returns {GetCustomFieldsParam} */
-  static getCustomFields() {
+  /** @returns {GetCustomFieldsByResourceSlugParam} */
+  static getCustomFieldsByResourceSlug() {
     return Joi.object({
       resource: Joi.string().allow("").required(),
+      resourceSlug: Joi.string().allow("").required(),
     }).required();
   }
 
-  /** @returns {GetCustomFieldsByResourceIdParam} */
-  static getCustomFieldsByResourceId() {
+  /** @returns {GetCustomObjectBySlugParam} */
+  static getCustomObjectBySlug() {
     return Joi.object({
-      resource: Joi.string().allow("").required(),
-      resourceId: Joi.string().allow("").required(),
+      definitionSlug: Joi.string().allow("").required(),
+      slug: Joi.string().allow("").required(),
     }).required();
   }
 
-  /** @returns {GetCustomObjectParam} */
-  static getCustomObject() {
+  /** @returns {GetCustomObjectDefinitionBySlugParam} */
+  static getCustomObjectDefinitionBySlug() {
     return Joi.object({
-      id: Joi.string().allow("").required(),
-    }).required();
-  }
-
-  /** @returns {GetCustomObjectDefinitionParam} */
-  static getCustomObjectDefinition() {
-    return Joi.object({
-      id: Joi.string().allow("").required(),
+      slug: Joi.string().allow("").required(),
     }).required();
   }
 
@@ -294,12 +424,12 @@ class ContentPlatformValidator {
     }).required();
   }
 
-  /** @returns {GetCustomObjectsParam} */
-  static getCustomObjects() {
+  /** @returns {GetCustomObjectsBySlugParam} */
+  static getCustomObjectsBySlug() {
     return Joi.object({
-      definitionId: Joi.string().allow(""),
       pageNo: Joi.string().allow("").required(),
       pageSize: Joi.string().allow("").required(),
+      definitionSlug: Joi.string().allow("").required(),
     }).required();
   }
 
@@ -312,55 +442,102 @@ class ContentPlatformValidator {
     }).required();
   }
 
+  /** @returns {GetResourceDefinitionByIdParam} */
+  static getResourceDefinitionById() {
+    return Joi.object({
+      id: Joi.string().allow("").required(),
+    }).required();
+  }
+
   /** @returns {GetResourcesParam} */
   static getResources() {
     return Joi.object({}).required();
   }
 
-  /** @returns {ImportCustomObjectEntriesParam} */
-  static importCustomObjectEntries() {
+  /** @returns {GetSectionByIdParam} */
+  static getSectionById() {
+    return Joi.object({
+      id: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {GetTranslatableResourceByIdParam} */
+  static getTranslatableResourceById() {
+    return Joi.object({
+      id: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {GetTranslatableResourcesBySectionIdParam} */
+  static getTranslatableResourcesBySectionId() {
     return Joi.object({
-      definitionId: Joi.string().allow("").required(),
+      id: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {ImportCustomObjectEntriesBySlugParam} */
+  static importCustomObjectEntriesBySlug() {
+    return Joi.object({
+      slug: Joi.string().allow("").required(),
       body: ContentPlatformModel.CustomObjectBulkSchema().required(),
     }).required();
   }
 
-  /** @returns {SampleCustomObjectBulkEntryParam} */
-  static sampleCustomObjectBulkEntry() {
+  /** @returns {SampleCustomObjectBulkEntryBySlugParam} */
+  static sampleCustomObjectBulkEntryBySlug() {
+    return Joi.object({
+      slug: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {UpdateCompanyLanguageDefaultParam} */
+  static updateCompanyLanguageDefault() {
     return Joi.object({
-      definitionId: Joi.string().allow("").required(),
+      locale: Joi.string().allow("").required(),
+      body: ContentPlatformModel.CompanyLanguageUpdate().required(),
     }).required();
   }
 
-  /** @returns {UpdateCustomFieldByResourceIdParam} */
-  static updateCustomFieldByResourceId() {
+  /** @returns {UpdateCompanyResourceTranslationParam} */
+  static updateCompanyResourceTranslation() {
+    return Joi.object({
+      id: Joi.string().allow("").required(),
+      body: ContentPlatformModel.ResourceTranslationUpdate().required(),
+    }).required();
+  }
+
+  /** @returns {UpdateCustomFieldByResourceSlugParam} */
+  static updateCustomFieldByResourceSlug() {
     return Joi.object({
       resource: Joi.string().allow("").required(),
-      resourceId: Joi.string().allow("").required(),
+      resourceSlug: Joi.string().allow("").required(),
       body: ContentPlatformModel.CustomFieldRequestSchema().required(),
     }).required();
   }
 
-  /** @returns {UpdateCustomFieldDefinitionParam} */
-  static updateCustomFieldDefinition() {
+  /** @returns {UpdateCustomFieldDefinitionBySlugParam} */
+  static updateCustomFieldDefinitionBySlug() {
     return Joi.object({
-      id: Joi.string().allow("").required(),
+      slug: Joi.string().allow("").required(),
+      resource: Joi.string().allow("").required(),
+      namespace: Joi.string().allow("").required(),
       body: ContentPlatformModel.CustomFieldDefinitionRequestSchema().required(),
     }).required();
   }
 
-  /** @returns {UpdateCustomObjectParam} */
-  static updateCustomObject() {
+  /** @returns {UpdateCustomObjectBySlugParam} */
+  static updateCustomObjectBySlug() {
     return Joi.object({
-      id: Joi.string().allow("").required(),
-      body: ContentPlatformModel.CustomObjectRequestSchema().required(),
+      definitionSlug: Joi.string().allow("").required(),
+      slug: Joi.string().allow("").required(),
+      body: ContentPlatformModel.CustomObjectRequestSchemaWithoutId().required(),
     }).required();
   }
 
-  /** @returns {UpdateCustomObjectDefinitionParam} */
-  static updateCustomObjectDefinition() {
+  /** @returns {UpdateCustomObjectDefinitionBySlugParam} */
+  static updateCustomObjectDefinitionBySlug() {
     return Joi.object({
-      id: Joi.string().allow("").required(),
+      slug: Joi.string().allow("").required(),
       body: ContentPlatformModel.CustomObjectDefinitionUpdateRequestSchema().required(),
     }).required();
   }