agent-generator-cli 1.0.0 → 1.0.2

package/source/openapi-specifications/v1.0/support/CommunityCategory.json

@@ -0,0 +1,1896 @@
+{
+  "openapi" : "3.1.0",
+  "info" : {
+    "title" : "CommunityCategory",
+    "version" : "1.0.0",
+    "x-clan-group" : "helpCenter",
+    "x-module-group" : "community"
+  },
+  "paths" : {
+    "/api/v1/communityCategory/{categoryId}/permalinks" : {
+      "get" : {
+        "tags" : [ "CommunityCategory" ],
+        "summary" : "Get permalinks of category or forum",
+        "description" : "This API fetches all permalinks of a community category or forum.",
+        "operationId" : "getAllPermalinksOfCategory",
+        "parameters" : [ {
+          "$ref" : "#/components/parameters/categoryId"
+        }, {
+          "$ref" : "../common/Common.json#/components/parameters/orgId"
+        } ],
+        "responses" : {
+          "200" : {
+            "$ref" : "#/components/responses/communityCategorySecondaryPermalinks"
+          }
+        },
+        "security" : [ {
+          "org-oauth" : [ "Desk.accessAll.ALL" ]
+        }, {
+          "iam-oauth2-schema" : [ "Desk.forums.READ", "Desk.community.READ" ]
+        } ],
+        "x-audience" : [ "company-internal" ],
+        "x-custom-url-attribute" : {
+          "security" : {
+            "throttle" : {
+              "inline" : [ {
+                "scope" : "APPSERVER",
+                "rules" : [ {
+                  "duration" : 300000,
+                  "lock-period" : 600000,
+                  "threshold" : 50,
+                  "hip" : false
+                } ],
+                "window" : "ROLLING",
+                "key" : "url.path+user.zuid"
+              } ]
+            },
+            "extraparams" : {
+              "disable" : true,
+              "ignore" : false
+            },
+            "authentication" : { }
+          },
+          "clan-group" : "helpCenter",
+          "apihash" : "29369de366a05c41e55d250e21360d25",
+          "module-group" : "community",
+          "apimethod" : "com.zoho.desk.helpcenter.community.categories.CategoryRestService.getAllPermalinksOfCategory"
+        }
+      },
+      "post" : {
+        "tags" : [ "CommunityCategory" ],
+        "summary" : "Update permalink of category or forum",
+        "description" : "This API updates the primary permalink of a community category or forum.",
+        "operationId" : "addSecondaryPermalink",
+        "parameters" : [ {
+          "$ref" : "#/components/parameters/categoryId"
+        }, {
+          "$ref" : "../common/Common.json#/components/parameters/orgId"
+        } ],
+        "requestBody" : {
+          "$ref" : "#/components/requestBodies/addSecondaryPermalinkJSON"
+        },
+        "responses" : {
+          "422" : {
+            "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
+          },
+          "204" : {
+            "$ref" : "../common/Common.json#/components/responses/emptyResponse"
+          }
+        },
+        "security" : [ {
+          "org-oauth" : [ "Desk.accessAll.ALL" ]
+        }, {
+          "iam-oauth2-schema" : [ "Desk.forums.UPDATE", "Desk.community.UPDATE" ]
+        } ],
+        "x-audience" : [ "company-internal" ],
+        "x-custom-url-attribute" : {
+          "security" : {
+            "throttle" : {
+              "inline" : [ {
+                "scope" : "APPSERVER",
+                "rules" : [ {
+                  "duration" : 300000,
+                  "lock-period" : 600000,
+                  "threshold" : 50,
+                  "hip" : false
+                } ],
+                "window" : "ROLLING",
+                "key" : "url.path+user.zuid"
+              } ]
+            },
+            "extraparams" : {
+              "disable" : true,
+              "ignore" : false
+            },
+            "authentication" : { }
+          },
+          "clan-group" : "helpCenter",
+          "apihash" : "9608e6e19191a18a0654ea505cf418fd",
+          "module-group" : "community",
+          "apimethod" : "com.zoho.desk.helpcenter.community.categories.CategoryRestService.addPermalink"
+        }
+      }
+    },
+    "/api/v1/communityCategory/{categoryId}/disable" : {
+      "post" : {
+        "tags" : [ "CommunityCategory" ],
+        "summary" : "Disable community category or forum",
+        "description" : "This API disables a community category or forum and restricts posting access to users.",
+        "operationId" : "disableCommunityCategory",
+        "parameters" : [ {
+          "$ref" : "#/components/parameters/categoryId"
+        }, {
+          "$ref" : "../common/Common.json#/components/parameters/orgId"
+        } ],
+        "responses" : {
+          "422" : {
+            "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
+          },
+          "204" : {
+            "$ref" : "../common/Common.json#/components/responses/emptyResponse"
+          }
+        },
+        "security" : [ {
+          "org-oauth" : [ "Desk.accessAll.ALL" ]
+        }, {
+          "iam-oauth2-schema" : [ "Desk.forums.UPDATE", "Desk.community.UPDATE" ]
+        } ],
+        "x-audience" : [ "external-public" ],
+        "x-custom-url-attribute" : {
+          "security" : {
+            "throttle" : {
+              "inline" : [ {
+                "scope" : "APPSERVER",
+                "rules" : [ {
+                  "duration" : 300000,
+                  "lock-period" : 600000,
+                  "threshold" : 20,
+                  "hip" : false
+                } ],
+                "window" : "ROLLING",
+                "key" : "url.path+user.zuid"
+              } ]
+            },
+            "extraparams" : {
+              "disable" : true,
+              "ignore" : false
+            },
+            "authentication" : { }
+          },
+          "clan-group" : "helpCenter",
+          "apihash" : "8f4d41d37c3972d2c9df3cf429155836",
+          "module-group" : "community",
+          "apimethod" : "com.zoho.desk.helpcenter.community.categories.CategoryRestService.disable"
+        }
+      }
+    },
+    "/api/v1/communityCategory/{categoryId}/enable" : {
+      "post" : {
+        "tags" : [ "CommunityCategory" ],
+        "summary" : "Enable community category or forum",
+        "description" : "This API enables a community category or forum and provides posting access to users.",
+        "operationId" : "enableCommunityCategory",
+        "parameters" : [ {
+          "$ref" : "#/components/parameters/categoryId"
+        }, {
+          "$ref" : "../common/Common.json#/components/parameters/orgId"
+        } ],
+        "responses" : {
+          "422" : {
+            "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
+          },
+          "204" : {
+            "$ref" : "../common/Common.json#/components/responses/emptyResponse"
+          }
+        },
+        "security" : [ {
+          "org-oauth" : [ "Desk.accessAll.ALL" ]
+        }, {
+          "iam-oauth2-schema" : [ "Desk.forums.UPDATE", "Desk.community.UPDATE" ]
+        } ],
+        "x-audience" : [ "external-public" ],
+        "x-custom-url-attribute" : {
+          "security" : {
+            "throttle" : {
+              "inline" : [ {
+                "scope" : "APPSERVER",
+                "rules" : [ {
+                  "duration" : 300000,
+                  "lock-period" : 600000,
+                  "threshold" : 20,
+                  "hip" : false
+                } ],
+                "window" : "ROLLING",
+                "key" : "url.path+user.zuid"
+              } ]
+            },
+            "extraparams" : {
+              "disable" : true,
+              "ignore" : false
+            },
+            "authentication" : { }
+          },
+          "clan-group" : "helpCenter",
+          "apihash" : "6b732b953e0ba11ece08e473bd34e079",
+          "module-group" : "community",
+          "apimethod" : "com.zoho.desk.helpcenter.community.categories.CategoryRestService.enable"
+        }
+      }
+    },
+    "/api/v1/allCommunityCategory" : {
+      "get" : {
+        "tags" : [ "CommunityCategory" ],
+        "summary" : "List all categories",
+        "description" : "This API lists all community categories to be displayed on the setup page of desk",
+        "operationId" : "getCommunityCategoriesForSetup",
+        "parameters" : [ {
+          "$ref" : "../common/Common.json#/components/parameters/orgId"
+        } ],
+        "responses" : {
+          "200" : {
+            "$ref" : "#/components/responses/listAllCommunityCategoriesForSetup"
+          }
+        },
+        "security" : [ {
+          "org-oauth" : [ "Desk.accessAll.ALL" ]
+        }, {
+          "iam-oauth2-schema" : [ "Desk.forums.READ", "Desk.community.READ" ]
+        } ],
+        "x-audience" : [ "company-internal" ],
+        "x-custom-url-attribute" : {
+          "security" : {
+            "throttle" : {
+              "inline" : [ {
+                "scope" : "APPSERVER",
+                "rules" : [ {
+                  "duration" : 60000,
+                  "lock-period" : 600000,
+                  "threshold" : 70,
+                  "hip" : false
+                } ],
+                "window" : "ROLLING",
+                "key" : "url.path+user.zuid"
+              } ]
+            },
+            "extraparams" : {
+              "disable" : true,
+              "ignore" : false
+            },
+            "authentication" : { }
+          },
+          "clan-group" : "helpCenter",
+          "apihash" : "0c15ef28d0ca7a735c71d1bb906ba9ae",
+          "module-group" : "community",
+          "apimethod" : "com.zoho.desk.helpcenter.community.categories.CategoryRestService.getAllCategoriesForSetup"
+        }
+      }
+    },
+    "/api/v1/communityCategory" : {
+      "get" : {
+        "tags" : [ "CommunityCategory" ],
+        "summary" : "List community categories",
+        "description" : "This API lists a particular number of community categories.",
+        "operationId" : "getCommunityCategory",
+        "parameters" : [ {
+          "name" : "departmentId",
+          "in" : "query",
+          "description" : "ID of the department for which the categories to be filtered.",
+          "required" : false,
+          "style" : "form",
+          "explode" : true,
+          "schema" : {
+            "type" : [ "string", "null", "integer" ],
+            "format" : "int64",
+            "description" : "ID of the department for which the categories to be filtered.",
+            "pattern" : "([0-9]+)"
+          }
+        }, {
+          "$ref" : "../common/Common.json#/components/parameters/orgId"
+        } ],
+        "responses" : {
+          "200" : {
+            "$ref" : "#/components/responses/listAllCommunityCategories"
+          }
+        },
+        "security" : [ {
+          "org-oauth" : [ "Desk.accessAll.ALL" ]
+        }, {
+          "iam-oauth2-schema" : [ "Desk.forums.READ", "Desk.community.READ" ]
+        } ],
+        "x-audience" : [ "external-public" ],
+        "x-custom-url-attribute" : {
+          "security" : {
+            "throttle" : {
+              "inline" : [ {
+                "scope" : "APPSERVER",
+                "rules" : [ {
+                  "duration" : 60000,
+                  "lock-period" : 600000,
+                  "threshold" : 70,
+                  "hip" : false
+                } ],
+                "window" : "ROLLING",
+                "key" : "url.path+user.zuid"
+              } ]
+            },
+            "extraparams" : {
+              "disable" : true,
+              "ignore" : false
+            },
+            "authentication" : { }
+          },
+          "clan-group" : "helpCenter",
+          "apihash" : "90cd64600e273b1d684545af7f8d4e5c",
+          "module-group" : "community",
+          "apimethod" : "com.zoho.desk.helpcenter.community.categories.CategoryRestService.getCategories"
+        }
+      }
+    },
+    "/api/v1/communityCategory/{categoryId}/follow" : {
+      "post" : {
+        "tags" : [ "CommunityCategory" ],
+        "summary" : "Follow a community category or forum",
+        "description" : "This API helps users to follow a community category or forum. ",
+        "operationId" : "followCommunityCategory",
+        "parameters" : [ {
+          "$ref" : "#/components/parameters/categoryId"
+        }, {
+          "$ref" : "../common/Common.json#/components/parameters/orgId"
+        } ],
+        "responses" : {
+          "422" : {
+            "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
+          },
+          "204" : {
+            "$ref" : "../common/Common.json#/components/responses/emptyResponse"
+          }
+        },
+        "security" : [ {
+          "org-oauth" : [ "Desk.accessAll.ALL" ]
+        }, {
+          "iam-oauth2-schema" : [ "Desk.forums.UPDATE", "Desk.community.UPDATE" ]
+        } ],
+        "x-audience" : [ "external-public" ],
+        "x-custom-url-attribute" : {
+          "security" : {
+            "throttle" : {
+              "inline" : [ {
+                "scope" : "APPSERVER",
+                "rules" : [ {
+                  "duration" : 300000,
+                  "lock-period" : 600000,
+                  "threshold" : 50,
+                  "hip" : false
+                } ],
+                "window" : "ROLLING",
+                "key" : "url.path+user.zuid"
+              } ]
+            },
+            "extraparams" : {
+              "disable" : true,
+              "ignore" : false
+            },
+            "authentication" : { }
+          },
+          "clan-group" : "helpCenter",
+          "apihash" : "375b20959084f4d29740667b77ab57a4",
+          "module-group" : "community",
+          "apimethod" : "com.zoho.desk.helpcenter.community.categories.CategoryRestService.followCategoryByControllers"
+        }
+      }
+    },
+    "/api/v1/communityCategory/{categoryId}/unfollow" : {
+      "post" : {
+        "tags" : [ "CommunityCategory" ],
+        "summary" : "Unfollow a community category or forum",
+        "description" : "This API helps end-users unfollow a community category or forum.",
+        "operationId" : "unfollowCommunityCategory",
+        "parameters" : [ {
+          "$ref" : "#/components/parameters/categoryId"
+        }, {
+          "$ref" : "../common/Common.json#/components/parameters/orgId"
+        } ],
+        "responses" : {
+          "422" : {
+            "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
+          },
+          "204" : {
+            "$ref" : "../common/Common.json#/components/responses/emptyResponse"
+          }
+        },
+        "security" : [ {
+          "org-oauth" : [ "Desk.accessAll.ALL" ]
+        }, {
+          "iam-oauth2-schema" : [ "Desk.forums.UPDATE", "Desk.community.UPDATE" ]
+        } ],
+        "x-audience" : [ "external-public" ],
+        "x-custom-url-attribute" : {
+          "security" : {
+            "throttle" : {
+              "inline" : [ {
+                "scope" : "APPSERVER",
+                "rules" : [ {
+                  "duration" : 300000,
+                  "lock-period" : 600000,
+                  "threshold" : 50,
+                  "hip" : false
+                } ],
+                "window" : "ROLLING",
+                "key" : "url.path+user.zuid"
+              } ]
+            },
+            "extraparams" : {
+              "disable" : true,
+              "ignore" : false
+            },
+            "authentication" : { }
+          },
+          "clan-group" : "helpCenter",
+          "apihash" : "6e2601241543921072b6029f021ce9ec",
+          "module-group" : "community",
+          "apimethod" : "com.zoho.desk.helpcenter.community.categories.CategoryRestService.unfollowCategoryByControllers"
+        }
+      }
+    },
+    "/api/v1/communityCategory/{categoryId}/followers" : {
+      "get" : {
+        "tags" : [ "CommunityCategory" ],
+        "summary" : "List followers of community category or forum",
+        "description" : "This API lists a particular number of users who follow a community category or forum, based on the limit defined.",
+        "operationId" : "getCommunityCategoryFollowers",
+        "parameters" : [ {
+          "name" : "limit",
+          "in" : "query",
+          "description" : "Number of users to list",
+          "required" : false,
+          "style" : "form",
+          "explode" : true,
+          "schema" : {
+            "type" : [ "string", "null", "integer" ],
+            "format" : "int32",
+            "description" : "Number of users to list",
+            "minimum" : 1,
+            "pattern" : "([0-9]+)"
+          }
+        }, {
+          "name" : "from",
+          "in" : "query",
+          "description" : "Index number, starting from which the users must be listed",
+          "required" : false,
+          "style" : "form",
+          "explode" : true,
+          "schema" : {
+            "type" : [ "string", "null", "integer" ],
+            "format" : "int32",
+            "description" : "Index number, starting from which the users must be listed",
+            "pattern" : "([0-9]+)"
+          }
+        }, {
+          "name" : "userType",
+          "in" : "query",
+          "description" : "to filter agent and end user",
+          "required" : false,
+          "style" : "form",
+          "explode" : true,
+          "schema" : {
+            "type" : [ "string", "null" ],
+            "description" : "to filter agent and end user",
+            "enum" : [ "AGENT", "END_USER" ],
+            "maxLength" : 100,
+            "minLength" : 0
+          }
+        }, {
+          "$ref" : "#/components/parameters/categoryId"
+        }, {
+          "$ref" : "../common/Common.json#/components/parameters/orgId"
+        } ],
+        "responses" : {
+          "422" : {
+            "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
+          },
+          "200" : {
+            "$ref" : "#/components/responses/listAllCommunityCategoryFollowers"
+          }
+        },
+        "security" : [ {
+          "org-oauth" : [ "Desk.accessAll.ALL" ]
+        }, {
+          "iam-oauth2-schema" : [ "Desk.forums.READ", "Desk.community.READ" ]
+        } ],
+        "x-audience" : [ "external-public" ],
+        "x-custom-url-attribute" : {
+          "security" : {
+            "throttle" : {
+              "inline" : [ {
+                "scope" : "APPSERVER",
+                "rules" : [ {
+                  "duration" : 300000,
+                  "lock-period" : 600000,
+                  "threshold" : 50,
+                  "hip" : false
+                } ],
+                "window" : "ROLLING",
+                "key" : "url.path+user.zuid"
+              } ]
+            },
+            "extraparams" : {
+              "disable" : true,
+              "ignore" : false
+            },
+            "authentication" : { }
+          },
+          "clan-group" : "helpCenter",
+          "apihash" : "9d050030aff0a5e04eec50da6a86d109",
+          "module-group" : "community",
+          "apimethod" : "com.zoho.desk.helpcenter.community.categories.CategoryRestService.getFollowersOfCategory"
+        }
+      }
+    },
+    "/api/v1/communityCategoryByPermalink" : {
+      "get" : {
+        "tags" : [ "CommunityCategory" ],
+        "summary" : "Get category or forum by permalink",
+        "description" : "This API fetches the details of a community category or forum, based on the permalink in the API request. ",
+        "operationId" : "getACategoryByPermalink",
+        "parameters" : [
+          {
+            "$ref" : "../common/Common.json#/components/parameters/orgId"
+          },
+          {
+            "$ref" : "#/components/parameters/permalink"
+          },
+          {
+            "$ref" : "#/components/parameters/include"
+          }
+        ],
+        "responses" : {
+          "422" : {
+            "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
+          },
+          "200" : {
+            "$ref" : "#/components/responses/getACategoryByPermalinkResponse"
+          }
+        },
+        "security" : [ {
+          "org-oauth" : [ "Desk.accessAll.ALL" ]
+        }, {
+          "iam-oauth2-schema" : [ "Desk.forums.READ", "Desk.community.READ" ]
+        } ],
+        "x-audience" : [ "external-public" ],
+        "x-custom-url-attribute" : {
+          "security" : {
+            "throttle" : {
+              "inline" : [ {
+                "scope" : "APPSERVER",
+                "rules" : [ {
+                  "duration" : 60000,
+                  "lock-period" : 600000,
+                  "threshold" : 30,
+                  "hip" : false
+                } ],
+                "window" : "ROLLING",
+                "key" : "url.path+user.zuid"
+              } ]
+            },
+            "extraparams" : {
+              "disable" : true,
+              "ignore" : false
+            },
+            "authentication" : { }
+          },
+          "clan-group" : "helpCenter",
+          "apihash" : "9c497f62a974030cfdfb75408871dfd2",
+          "module-group" : "community",
+          "apimethod" : "com.zoho.desk.helpcenter.community.categories.CategoryRestService.getCategoryByPermalinkForControllers"
+        }
+      }
+    },
+    "/api/v1/communityCategory/{categoryId}" : {
+      "get" : {
+        "tags" : [ "CommunityCategory" ],
+        "summary" : "Get community categories",
+        "description" : "This API get a community categories details.",
+        "operationId" : "getACategory",
+        "parameters" : [ {
+            "$ref" : "../common/Common.json#/components/parameters/orgId"
+          },{
+            "$ref" : "#/components/parameters/categoryId"
+          },{
+            "$ref" : "#/components/parameters/include"
+        }],
+        "responses" : {
+          "200" : {
+            "$ref" : "#/components/responses/getACategoryByPermalinkResponse"
+          },
+          "422" : {
+            "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
+          }
+        },
+        "security" : [ {
+          "org-oauth" : [ "Desk.accessAll.ALL" ]
+        }, {
+          "iam-oauth2-schema" : [ "Desk.forums.READ", "Desk.community.READ" ]
+        } ],
+        "x-audience" : [ "external-public" ],
+        "x-custom-url-attribute" : {
+          "security" : {
+            "throttle" : {
+              "inline" : [ {
+                "scope" : "APPSERVER",
+                "rules" : [ {
+                  "duration" : 60000,
+                  "lock-period" : 600000,
+                  "threshold" : 30,
+                  "hip" : false
+                } ],
+                "window" : "ROLLING",
+                "key" : "url.path+user.zuid"
+              } ]
+            },
+            "extraparams" : {
+              "disable" : true,
+              "ignore" : false
+            },
+            "authentication" : { }
+          },
+          "clan-group" : "helpCenter",
+          "apihash" : "92cd2705aa56090d389d464ef86147c7",
+          "module-group" : "community",
+          "apimethod" : "com.zoho.desk.helpcenter.community.categories.CategoryRestService.getCategory"
+        }
+      }
+    }
+  },
+  "components" : {
+    "schemas" : {
+      "moderator" : {
+        "type" : [ "null", "object" ],
+        "additionalProperties" : false,
+        "properties" : {
+          "photoUrl" : {
+            "type" : [ "string", "null" ],
+            "maxLength" : 400,
+            "minLength" : 0,
+            "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
+          },
+          "name" : {
+            "type" : [ "string", "null" ],
+            "maxLength" : 200,
+            "minLength" : 0,
+            "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+",
+            "x-custom-parameters-attributes" : {
+              "removeExif" : false,
+              "filterMatchedContent" : false,
+              "antivirus" : false,
+              "replacementString" : "",
+              "allowInvalid" : false,
+              "descrption" : "Name of the community category or forum",
+              "secret" : false,
+              "preserveCharsLimit" : 10,
+              "trim" : false,
+              "internalParam" : false,
+              "preserveChars" : "0,5",
+              "importUrl" : false,
+              "decrypt" : false
+            }
+          },
+          "id" : {
+            "type" : [ "string", "null", "integer" ],
+            "format" : "int64",
+            "pattern" : "([0-9]+)"
+          },
+          "type" : {
+            "type" : [ "string", "null" ],
+            "enum" : [ "END_USER", "AGENT" ],
+            "maxLength" : 100,
+            "minLength" : 0
+          }
+        },
+        "required" : [ "id", "name", "photoUrl", "type" ]
+      },
+      "communityCategoryModeratorJSONArray" : {
+        "type" : [ "null", "array" ],
+        "items" : {
+          "$ref" : "./CommunityCategory.json#/components/schemas/moderator"
+        }
+      },
+      "groups" : {
+        "type" : [ "null", "object" ],
+        "additionalProperties" : false,
+        "properties" : {
+          "name" : {
+            "type" : [ "string", "null" ],
+            "maxLength" : 100,
+            "minLength" : 0,
+            "pattern" : "[0-9a-zA-Z_\\-\\&\\.\\$\\@\\^\\(\\)\\{\\}\\~\\=\\-\\|\\*\\+\\?\\[\\]\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+",
+            "x-custom-parameters-attributes" : {
+              "removeExif" : false,
+              "filterMatchedContent" : false,
+              "antivirus" : false,
+              "replacementString" : "",
+              "allowInvalid" : false,
+              "descrption" : "Name of the community category or forum",
+              "secret" : false,
+              "preserveCharsLimit" : 10,
+              "trim" : false,
+              "internalParam" : false,
+              "preserveChars" : "0,5",
+              "importUrl" : false,
+              "decrypt" : false
+            }
+          },
+          "id" : {
+            "type" : [ "string", "null", "integer" ],
+            "format" : "int64",
+            "pattern" : "([0-9]+)"
+          }
+        },
+        "required" : [ "id", "name" ]
+      },
+      "communityCategoryGroupsJSONArray" : {
+        "type" : [ "null", "array" ],
+        "items" : {
+          "$ref" : "./CommunityCategory.json#/components/schemas/groups"
+        }
+      },
+      "communityManagerChildCategoryWithGroupsJSON" : {
+        "type" : [ "null", "object" ],
+        "additionalProperties" : false,
+        "properties" : {
+          "isFollowing" : {
+            "type" : [ "boolean", "null" ]
+          },
+          "visibility" : {
+            "type" : [ "string", "null" ],
+            "maxLength" : 200,
+            "minLength" : 0,
+            "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+",
+            "x-custom-parameters-attributes" : {
+              "removeExif" : false,
+              "filterMatchedContent" : false,
+              "antivirus" : false,
+              "replacementString" : "",
+              "allowInvalid" : false,
+              "descrption" : "Visibility setting of the community category or forum. Values allowed are: @ALL@, @LOGGED_IN_USERS@, @GROUPS@ , @AGENTS@ and @MODERATORS@.",
+              "secret" : false,
+              "preserveCharsLimit" : 10,
+              "trim" : false,
+              "internalParam" : false,
+              "preserveChars" : "0,5",
+              "importUrl" : false,
+              "decrypt" : false
+            }
+          },
+          "departmentId" : {
+            "type" : [ "string", "null", "integer" ],
+            "format" : "int64",
+            "pattern" : "([0-9]+)"
+          },
+          "description" : {
+            "type" : [ "string", "null" ],
+            "maxLength" : 100,
+            "minLength" : 0,
+            "x-custom-parameters-attributes" : {
+              "removeExif" : false,
+              "filterMatchedContent" : false,
+              "antivirus" : false,
+              "replacementString" : "",
+              "allowInvalid" : false,
+              "descrption" : "A brief description of the community category or forum",
+              "secret" : false,
+              "preserveCharsLimit" : 10,
+              "trim" : false,
+              "internalParam" : false,
+              "preserveChars" : "0,5",
+              "xss" : "antisamyfilter_custom",
+              "importUrl" : false,
+              "decrypt" : false
+            }
+          },
+          "groups" : {
+            "$ref" : "./CommunityCategory.json#/components/schemas/communityCategoryGroupsJSONArray"
+          },
+          "canAutoConvertTicket" : {
+            "type" : [ "boolean", "null" ],
+            "x-custom-parameters-attributes" : {
+              "removeExif" : false,
+              "filterMatchedContent" : false,
+              "antivirus" : false,
+              "replacementString" : "",
+              "allowInvalid" : false,
+              "descrption" : "Key that defines whether topics posted in the forum must be automatically converted into tickets or not",
+              "secret" : false,
+              "preserveCharsLimit" : 10,
+              "trim" : false,
+              "internalParam" : false,
+              "preserveChars" : "0,5",
+              "importUrl" : false,
+              "decrypt" : false
+            }
+          },
+          "photoUrl" : {
+            "type" : [ "string", "null" ],
+            "maxLength" : 500,
+            "minLength" : 0,
+            "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
+          },
+          "moderation" : {
+            "type" : [ "string", "null" ],
+            "maxLength" : 200,
+            "minLength" : 0,
+            "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+",
+            "x-custom-parameters-attributes" : {
+              "removeExif" : false,
+              "filterMatchedContent" : false,
+              "antivirus" : false,
+              "replacementString" : "",
+              "allowInvalid" : false,
+              "descrption" : "Moderation setting for the community category or forum. Values allowed are: @NONE@ (no moderation), @ALL_POSTS@ (all posts of category will be moderated) and @FIRST_POST@ (only the first forum post of users will be moderated).",
+              "secret" : false,
+              "preserveCharsLimit" : 10,
+              "trim" : false,
+              "internalParam" : false,
+              "preserveChars" : "0,5",
+              "importUrl" : false,
+              "decrypt" : false
+            }
+          },
+          "name" : {
+            "type" : [ "string", "null" ],
+            "maxLength" : 200,
+            "minLength" : 0,
+            "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+",
+            "x-custom-parameters-attributes" : {
+              "removeExif" : false,
+              "filterMatchedContent" : false,
+              "antivirus" : false,
+              "replacementString" : "",
+              "allowInvalid" : false,
+              "descrption" : "Name of the community category or forum",
+              "secret" : false,
+              "preserveCharsLimit" : 10,
+              "trim" : false,
+              "internalParam" : false,
+              "preserveChars" : "0,5",
+              "importUrl" : false,
+              "decrypt" : false
+            }
+          },
+          "parentCategoryId" : {
+            "type" : [ "string", "null", "integer" ],
+            "format" : "int64",
+            "pattern" : "([0-9]+)"
+          },
+          "id" : {
+            "type" : [ "string", "null", "integer" ],
+            "format" : "int64",
+            "pattern" : "([0-9]+)"
+          },
+          "position" : {
+            "type" : [ "string", "null", "integer" ],
+            "format" : "int32",
+            "pattern" : "([0-9]+)"
+          },
+          "permalink" : {
+            "type" : [ "string", "null" ],
+            "maxLength" : 250,
+            "minLength" : 0,
+            "pattern" : "[a-zA-Z0-9%\\-._/?\\P{InBasicLatin}]*"
+          },
+          "status" : {
+            "type" : [ "string", "null" ],
+            "enum" : [ "ENABLED", "LOCKED", "DISABLED" ],
+            "maxLength" : 100,
+            "minLength" : 0
+          },
+          "moderators" : {
+            "$ref" : "./CommunityCategory.json#/components/schemas/communityCategoryModeratorJSONArray"
+          },
+          "child" : {
+            "type" : [ "null", "array" ],
+            "items" : {
+              "type" : [ "null", "object" ],
+              "additionalProperties" : false
+            },
+            "uniqueItems" : false
+          }
+        },
+        "required" : [ "canAutoConvertTicket", "child", "departmentId", "description", "groups", "id", "isFollowing", "moderation", "moderators", "name", "parentCategoryId", "permalink", "photoUrl", "position", "status", "visibility" ]
+      },
+      "communityChildCategoryWithGroupsJSONArray" : {
+        "type" : [ "null", "array" ],
+        "items" : {
+          "$ref" : "./CommunityCategory.json#/components/schemas/communityManagerChildCategoryWithGroupsJSON"
+        }
+      },
+      "communityManagerForumJSONForSetup" : {
+        "type" : [ "null", "object" ],
+        "additionalProperties" : false,
+        "properties" : {
+          "name" : {
+            "type" : [ "string", "null" ],
+            "maxLength" : 200,
+            "minLength" : 0,
+            "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
+          },
+          "parentCategoryId" : {
+            "type" : [ "string", "null", "integer" ],
+            "format" : "int64",
+            "pattern" : "([0-9]+)"
+          },
+          "id" : {
+            "type" : [ "string", "null", "integer" ],
+            "format" : "int64",
+            "pattern" : "([0-9]+)"
+          },
+          "position" : {
+            "type" : [ "string", "null", "integer" ],
+            "format" : "int32",
+            "pattern" : "([0-9]+)"
+          },
+          "status" : {
+            "type" : [ "string", "null" ],
+            "enum" : [ "ENABLED", "LOCKED", "DISABLED" ],
+            "maxLength" : 100,
+            "minLength" : 0
+          }
+        },
+        "required" : [ "id", "name", "parentCategoryId", "position", "status" ]
+      },
+      "communityForumForSetupJSONArray" : {
+        "type" : [ "null", "array" ],
+        "items" : {
+          "$ref" : "./CommunityCategory.json#/components/schemas/communityManagerForumJSONForSetup"
+        }
+      },
+      "communityManagerCategoryJSONForSetup" : {
+        "type" : [ "null", "object" ],
+        "additionalProperties" : false,
+        "properties" : {
+          "photoUrl" : {
+            "type" : [ "string", "null" ],
+            "maxLength" : 500,
+            "minLength" : 0,
+            "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
+          },
+          "departmentId" : {
+            "type" : [ "string", "null", "integer" ],
+            "format" : "int64",
+            "pattern" : "([0-9]+)"
+          },
+          "name" : {
+            "type" : [ "string", "null" ],
+            "maxLength" : 200,
+            "minLength" : 0,
+            "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
+          },
+          "description" : {
+            "type" : [ "string", "null" ],
+            "maxLength" : 100,
+            "minLength" : 0
+          },
+          "childCount" : {
+            "type" : [ "string", "null", "integer" ],
+            "format" : "int32",
+            "pattern" : "([0-9]+)"
+          },
+          "id" : {
+            "type" : [ "string", "null", "integer" ],
+            "format" : "int64",
+            "pattern" : "([0-9]+)"
+          },
+          "position" : {
+            "type" : [ "string", "null", "integer" ],
+            "format" : "int32",
+            "pattern" : "([0-9]+)"
+          },
+          "permalink" : {
+            "type" : [ "string", "null" ],
+            "maxLength" : 250,
+            "minLength" : 0,
+            "pattern" : "[a-zA-Z0-9%\\-._/?\\P{InBasicLatin}]*"
+          },
+          "status" : {
+            "type" : [ "string", "null" ],
+            "enum" : [ "ENABLED", "LOCKED", "DISABLED" ],
+            "maxLength" : 100,
+            "minLength" : 0
+          },
+          "child" : {
+            "$ref" : "./CommunityCategory.json#/components/schemas/communityForumForSetupJSONArray"
+          },
+          "associatedDepartmentIds" : {
+            "type" : [ "null", "array" ],
+            "items" : {
+              "type" : [ "string", "null", "integer" ],
+              "format" : "int64",
+              "pattern" : "([0-9]+)"
+            },
+            "uniqueItems" : false
+          }
+        },
+        "required" : [ "associatedDepartmentIds", "child", "childCount", "departmentId", "description", "id", "name", "permalink", "photoUrl", "position", "status" ]
+      },
+      "communityCategoryForSetupJSONArray" : {
+        "type" : [ "null", "array" ],
+        "items" : {
+          "$ref" : "./CommunityCategory.json#/components/schemas/communityManagerCategoryJSONForSetup"
+        }
+      },
+      "communityManagerChildCategoryJSON" : {
+        "type" : [ "null", "object" ],
+        "additionalProperties" : false,
+        "properties" : {
+          "isFollowing" : {
+            "type" : [ "boolean", "null" ]
+          },
+          "visibility" : {
+            "type" : [ "string", "null" ],
+            "maxLength" : 200,
+            "minLength" : 0,
+            "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
+          },
+          "departmentId" : {
+            "type" : [ "string", "null", "integer" ],
+            "format" : "int64",
+            "pattern" : "([0-9]+)"
+          },
+          "description" : {
+            "type" : [ "string", "null" ],
+            "maxLength" : 100,
+            "minLength" : 0
+          },
+          "canAutoConvertTicket" : {
+            "type" : [ "boolean", "null" ]
+          },
+          "helpCenterId" : {
+            "type" : [ "string", "null", "integer" ],
+            "format" : "int64",
+            "pattern" : "([0-9]+)"
+          },
+          "associatedDepartmentIds" : {
+            "type" : [ "null", "array" ],
+            "items" : {
+              "type" : [ "string", "null", "integer" ],
+              "format" : "int64",
+              "pattern" : "([0-9]+)"
+            },
+            "uniqueItems" : false
+          },
+          "photoUrl" : {
+            "type" : [ "string", "null" ],
+            "maxLength" : 500,
+            "minLength" : 0,
+            "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
+          },
+          "permissions" : {
+            "type" : [ "null", "array" ],
+            "items" : {
+              "type" : [ "string", "null" ],
+              "enum" : [ "POST", "RESPOND" ],
+              "maxLength" : 100,
+              "minLength" : 0
+            },
+            "uniqueItems" : false
+          },
+          "moderation" : {
+            "type" : [ "string", "null" ],
+            "maxLength" : 200,
+            "minLength" : 0,
+            "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
+          },
+          "name" : {
+            "type" : [ "string", "null" ],
+            "maxLength" : 200,
+            "minLength" : 0,
+            "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
+          },
+          "parentCategoryId" : {
+            "type" : [ "string", "null", "integer" ],
+            "format" : "int64",
+            "pattern" : "([0-9]+)"
+          },
+          "id" : {
+            "type" : [ "string", "null", "integer" ],
+            "format" : "int64",
+            "pattern" : "([0-9]+)"
+          },
+          "position" : {
+            "type" : [ "string", "null", "integer" ],
+            "format" : "int32",
+            "pattern" : "([0-9]+)"
+          },
+          "permalink" : {
+            "type" : [ "string", "null" ],
+            "maxLength" : 250,
+            "minLength" : 0,
+            "pattern" : "[a-zA-Z0-9%\\-._/?\\P{InBasicLatin}]*"
+          },
+          "status" : {
+            "type" : [ "string", "null" ],
+            "enum" : [ "ENABLED", "LOCKED", "DISABLED" ],
+            "maxLength" : 100,
+            "minLength" : 0
+          },
+          "moderators" : {
+            "$ref" : "./CommunityCategory.json#/components/schemas/communityCategoryModeratorJSONArray"
+          },
+          "child" : {
+            "type" : [ "null", "array" ],
+            "items" : {
+              "type" : [ "null", "object" ],
+              "additionalProperties" : false
+            },
+            "uniqueItems" : false
+          }
+        },
+        "required" : [ "associatedDepartmentIds", "canAutoConvertTicket", "child", "departmentId", "description", "helpCenterId", "id", "isFollowing", "moderation", "moderators", "name", "parentCategoryId", "permalink", "permissions", "photoUrl", "position", "status", "visibility" ]
+      },
+      "communityChildCategoryJSONArray" : {
+        "type" : [ "null", "array" ],
+        "items" : {
+          "$ref" : "./CommunityCategory.json#/components/schemas/communityManagerChildCategoryJSON"
+        }
+      },
+      "communityManagerListCategoryJSON" : {
+        "type" : [ "null", "object" ],
+        "additionalProperties" : false,
+        "properties" : {
+          "isFollowing" : {
+            "type" : [ "boolean", "null" ]
+          },
+          "visibility" : {
+            "type" : [ "string", "null" ],
+            "maxLength" : 200,
+            "minLength" : 0,
+            "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
+          },
+          "departmentId" : {
+            "type" : [ "string", "null", "integer" ],
+            "format" : "int64",
+            "pattern" : "([0-9]+)"
+          },
+          "description" : {
+            "type" : [ "string", "null" ],
+            "maxLength" : 100,
+            "minLength" : 0
+          },
+          "canAutoConvertTicket" : {
+            "type" : [ "boolean", "null" ]
+          },
+          "helpCenterId" : {
+            "type" : [ "string", "null", "integer" ],
+            "format" : "int64",
+            "pattern" : "([0-9]+)"
+          },
+          "associatedDepartmentIds" : {
+            "type" : [ "null", "array" ],
+            "items" : {
+              "type" : [ "string", "null", "integer" ],
+              "format" : "int64",
+              "pattern" : "([0-9]+)"
+            },
+            "uniqueItems" : false
+          },
+          "photoUrl" : {
+            "type" : [ "string", "null" ],
+            "maxLength" : 500,
+            "minLength" : 0,
+            "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
+          },
+          "permissions" : {
+            "type" : [ "null", "array" ],
+            "items" : {
+              "type" : [ "string", "null" ],
+              "enum" : [ "POST", "RESPOND" ],
+              "maxLength" : 100,
+              "minLength" : 0
+            },
+            "uniqueItems" : false
+          },
+          "moderation" : {
+            "type" : [ "string", "null" ],
+            "maxLength" : 200,
+            "minLength" : 0,
+            "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
+          },
+          "name" : {
+            "type" : [ "string", "null" ],
+            "maxLength" : 200,
+            "minLength" : 0,
+            "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
+          },
+          "parentCategoryId" : {
+            "type" : [ "string", "null", "integer" ],
+            "format" : "int64",
+            "pattern" : "([0-9]+)"
+          },
+          "id" : {
+            "type" : [ "string", "null", "integer" ],
+            "format" : "int64",
+            "pattern" : "([0-9]+)"
+          },
+          "position" : {
+            "type" : [ "string", "null", "integer" ],
+            "format" : "int32",
+            "pattern" : "([0-9]+)"
+          },
+          "permalink" : {
+            "type" : [ "string", "null" ],
+            "maxLength" : 250,
+            "minLength" : 0,
+            "pattern" : "[a-zA-Z0-9%\\-._/?\\P{InBasicLatin}]*"
+          },
+          "status" : {
+            "type" : [ "string", "null" ],
+            "enum" : [ "ENABLED", "LOCKED", "DISABLED" ],
+            "maxLength" : 100,
+            "minLength" : 0
+          },
+          "moderators" : {
+            "$ref" : "./CommunityCategory.json#/components/schemas/communityCategoryModeratorJSONArray"
+          },
+          "child" : {
+            "$ref" : "./CommunityCategory.json#/components/schemas/communityChildCategoryJSONArray"
+          }
+        },
+        "required" : [ "associatedDepartmentIds", "canAutoConvertTicket", "child", "departmentId", "description", "helpCenterId", "id", "isFollowing", "moderation", "moderators", "name", "parentCategoryId", "permalink", "permissions", "permissions", "photoUrl", "position", "status", "visibility" ]
+      },
+      "communityCategoryJSONArray" : {
+        "type" : [ "null", "array" ],
+        "items" : {
+          "$ref" : "./CommunityCategory.json#/components/schemas/communityManagerListCategoryJSON"
+        }
+      },
+      "categoryFollowersDetails" : {
+        "type" : [ "null", "object" ],
+        "additionalProperties" : false,
+        "properties" : {
+          "photoUrl" : {
+            "type" : [ "string", "null" ],
+            "maxLength" : 400,
+            "minLength" : 0,
+            "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
+          },
+          "contactId" : {
+            "type" : [ "string", "null", "integer" ],
+            "format" : "int64",
+            "pattern" : "([0-9]+)"
+          },
+          "name" : {
+            "type" : [ "string", "null" ],
+            "maxLength" : 200,
+            "minLength" : 0,
+            "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
+          },
+          "id" : {
+            "type" : [ "string", "null", "integer" ],
+            "format" : "int64",
+            "pattern" : "([0-9]+)"
+          },
+          "label" : {
+            "$ref" : "./Label.json#/components/schemas/labelMetaResponse"
+          },
+          "type" : {
+            "type" : [ "string", "null" ],
+            "enum" : [ "END_USER", "AGENT" ],
+            "maxLength" : 100,
+            "minLength" : 0
+          },
+          "email" : {
+            "type" : [ "string", "null" ],
+            "maxLength" : 100,
+            "minLength" : 0,
+            "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$"
+          }
+        },
+        "required" : [ "contactId", "email", "id", "label", "name", "photoUrl", "type" ]
+      },
+      "categoryFollowersDetailsData" : {
+        "type" : [ "null", "array" ],
+        "items" : {
+          "$ref" : "./CommunityCategory.json#/components/schemas/categoryFollowersDetails"
+        }
+      },
+      "permissionObject": {
+        "type": "object",
+        "nullable": true,
+        "additionalProperties": false,
+        "description": "Permission object defining visibility rules. When permission=GROUPS, groupIds must contain at least one item; otherwise, groupIds must be null.",
+        "properties": {
+          "permission": {
+            "type": "string",
+            "nullable": true,
+            "description": "Defines the visibility level for the content.",
+            "enum": ["ALL_USERS", "LOGGED_IN_USERS", "MODERATORS", "GROUPS", "NONE"],
+            "maxLength": 100,
+            "minLength": 0,
+            "pattern": "^[-0-9a-zA-Z_.$@?,:'/!\\s]+$"
+          },
+          "groupIds": {
+            "type": "array",
+            "nullable": true,
+            "description": "When permission=GROUPS, list of HelpcenterGroups.id (must have at least one entry). For other permission types, should be null.",
+            "items": {
+              "type": "string",
+              "pattern": "^[0-9]+$"
+            },
+            "minItems": 0,
+            "uniqueItems": false
+          }
+        },
+        "required": ["permission", "groupIds"]
+      }
+    ,
+      "communityGetCategoryJSON": {
+        "type": [ "null", "object" ],
+        "additionalProperties": false,
+        "properties": {
+          "id": {
+            "type": [ "string", "null", "integer" ],
+            "format": "int64",
+            "pattern": "([0-9]+)"
+          },
+          "name": {
+            "type": [ "string", "null" ],
+            "maxLength": 200,
+            "minLength": 0,
+            "pattern": "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
+          },
+          "description": {
+            "type": [ "string", "null" ],
+            "maxLength": 100,
+            "minLength": 0
+          },
+          "parentCategoryId": {
+            "type": [ "string", "null", "integer" ],
+            "format": "int64",
+            "pattern": "([0-9]+)"
+          },
+          "visibility": {
+            "type": [ "string", "null" ],
+            "maxLength": 200,
+            "minLength": 0,
+            "pattern": "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
+          },
+          "moderation": {
+            "type": [ "string", "null" ],
+            "maxLength": 200,
+            "minLength": 0,
+            "pattern": "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
+          },
+          "status": {
+            "type": [ "string", "null" ],
+            "enum": [ "ENABLED", "LOCKED", "DISABLED" ],
+            "maxLength": 100,
+            "minLength": 0
+          },
+          "position": {
+            "type": [ "string", "null", "integer" ],
+            "format": "int32",
+            "pattern": "([0-9]+)"
+          },
+          "moderators": {
+            "$ref": "./CommunityCategory.json#/components/schemas/communityCategoryModeratorJSONArray"
+          },
+          "canAutoConvertTicket": {
+            "type": [ "boolean", "null" ]
+          },
+          "departmentId": {
+            "type": [ "string", "null", "integer" ],
+            "format": "int64",
+            "pattern": "([0-9]+)"
+          },
+          "photoUrl": {
+            "type": [ "string", "null" ],
+            "maxLength": 500,
+            "minLength": 0,
+            "pattern": "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
+          },
+          "permalink": {
+            "type": [ "string", "null" ],
+            "maxLength": 250,
+            "minLength": 0,
+            "pattern": "[a-zA-Z0-9%\\-._/?\\P{InBasicLatin}]*"
+          },
+          "commentCount": {
+            "type": [ "string", "null", "integer" ],
+            "format": "int32",
+            "pattern": "([0-9]+)"
+          },
+          "postCount": {
+            "type": [ "string", "null", "integer" ],
+            "format": "int32",
+            "pattern": "([0-9]+)"
+          },
+          "followersCount": {
+            "type": [ "string", "null", "integer" ],
+            "format": "int32",
+            "pattern": "([0-9]+)"
+          },
+          "isFollowing": {
+            "type": [ "boolean", "null" ]
+          },
+          "post": {
+            "$ref": "./CommunityCategory.json#/components/schemas/permissionObject"
+          },
+          "respond": {
+            "$ref": "./CommunityCategory.json#/components/schemas/permissionObject"
+          },
+          "view": {
+            "$ref": "./CommunityCategory.json#/components/schemas/permissionObject"
+          },
+          "permissions": {
+            "type": [ "null", "array" ],
+            "items": {
+              "type": [ "string", "null" ],
+              "enum": [ "POST", "RESPOND" ],
+              "maxLength": 100,
+              "minLength": 0
+            },
+            "uniqueItems": false
+          },
+          "associatedDepartmentIds": {
+            "type": [ "null", "array" ],
+            "items": {
+              "type": [ "string", "null", "integer" ],
+              "format": "int64",
+              "pattern": "([0-9]+)"
+            },
+            "uniqueItems": false
+          },
+          "deparmentIdForTicketCreation": {
+            "type": [ "string", "null", "integer" ],
+            "format": "int64",
+            "pattern": "([0-9]+)"
+          },
+          "childs": {
+            "type": [ "null", "array" ],
+            "items": {
+              "$ref": "./CommunityCategory.json#/components/schemas/communityManagerChildCategoryJSON"
+            },
+            "uniqueItems": false
+          }
+        },
+        "required": ["id","name","description","parentCategoryId","visibility","moderation","status","position","moderators","canAutoConvertTicket","departmentId","photoUrl","permalink","commentCount","postCount","followersCount","isFollowing","post","respond","view","permissions","associatedDepartmentIds","deparmentIdForTicketCreation","childs"]
+      }
+    },
+    "responses" : {
+      "listAllCommunityCategoriesForSetup" : {
+        "description" : "listAllCommunityCategoriesForSetup template definitions",
+        "content" : {
+          "application/json" : {
+            "schema" : {
+              "type" : [ "null", "object" ],
+              "additionalProperties" : false,
+              "properties" : {
+                "categories" : {
+                  "$ref" : "./CommunityCategory.json#/components/schemas/communityCategoryForSetupJSONArray"
+                }
+              },
+              "required" : [ "categories" ]
+            },
+            "examples" : {
+              "Valid responses Definitions" : {
+                "value" : {
+                  "categories" : [ {
+                    "photoUrl" : null,
+                    "departmentId" : "2000000012968",
+                    "name" : "Category 1",
+                    "description" : "Category 1",
+                    "childCount" : "1",
+                    "id" : "4000000000017",
+                    "position" : "1",
+                    "permalink" : "category-1",
+                    "associatedDepatmentIds" : [ "2000000012968", "2000000012970", "2000000012972" ],
+                    "status" : "ENABLED",
+                    "child" : [ {
+                      "name" : "forum - 1",
+                      "parentCategoryId" : "146173000000003025",
+                      "id" : "4000000000065",
+                      "position" : "1",
+                      "status" : "ENABLED"
+                    } ]
+                  }, {
+                    "photoUrl" : null,
+                    "departmentId" : null,
+                    "name" : "Dep 2",
+                    "description" : "",
+                    "childCount" : "0",
+                    "id" : "4000000002005",
+                    "position" : "2",
+                    "permalink" : "dep-2",
+                    "status" : "ENABLED"
+                  } ]
+                }
+              }
+            }
+          }
+        },
+        "x-custom-response-attributes" : {
+          "disable-safe-headers" : "[]"
+        }
+      },
+      "listAllCommunityCategories" : {
+        "description" : "listAllCommunityCategories template definitions",
+        "content" : {
+          "application/json" : {
+            "schema" : {
+              "type" : [ "null", "object" ],
+              "additionalProperties" : false,
+              "properties" : {
+                "categories" : {
+                  "$ref" : "./CommunityCategory.json#/components/schemas/communityCategoryJSONArray"
+                }
+              },
+              "required" : [ "categories" ]
+            },
+            "examples" : {
+              "Valid responses Definitions" : {
+                "value" : {
+                  "categories" : [ {
+                    "isFollowing" : true,
+                    "visibility" : "LOGGED_IN_USERS",
+                    "departmentId" : "2000000012968",
+                    "description" : "category",
+                    "canAutoConvertTicket" : false,
+                    "photoUrl" : null,
+                    "permissions" : [ "POST", "RESPOND" ],
+                    "moderation" : "NONE",
+                    "name" : "category",
+                    "parentCategoryId" : null,
+                    "id" : "4000000000017",
+                    "position" : "1",
+                    "permalink" : "category",
+                    "child" : [ {
+                      "isFollowing" : false,
+                      "visibility" : null,
+                      "departmentId" : null,
+                      "description" : "Forum 1",
+                      "canAutoConvertTicket" : null,
+                      "photoUrl" : null,
+                      "permissions" : [ "POST", "RESPOND" ],
+                      "moderation" : null,
+                      "name" : "forum 1",
+                      "parentCategoryId" : "4000000000017",
+                      "id" : "4000000000033",
+                      "position" : "1",
+                      "permalink" : "forum-1",
+                      "child" : [ ],
+                      "moderators" : [ ],
+                      "status" : "ENABLED"
+                    } ],
+                    "moderators" : [ {
+                      "photoUrl" : null,
+                      "name" : "User 1",
+                      "id" : "2000000016079",
+                      "type" : "AGENT"
+                    } ],
+                    "status" : "ENABLED"
+                  }, {
+                    "isFollowing" : false,
+                    "visibility" : "LOGGED_IN_USERS",
+                    "departmentId" : null,
+                    "description" : "",
+                    "canAutoConvertTicket" : true,
+                    "photoUrl" : null,
+                    "permissions" : [ "POST", "RESPOND" ],
+                    "moderation" : "FIRST_POST",
+                    "name" : "Dep 2",
+                    "parentCategoryId" : null,
+                    "id" : "4000000002005",
+                    "position" : "2",
+                    "permalink" : "dep-2",
+                    "child" : [ ],
+                    "moderators" : [ ],
+                    "status" : "ENABLED"
+                  } ]
+                }
+              }
+            }
+          }
+        },
+        "x-custom-response-attributes" : {
+          "disable-safe-headers" : "[]"
+        }
+      },
+      "communityCategorySecondaryPermalinks" : {
+        "description" : "communityCategorySecondaryPermalinks template definitions",
+        "content" : {
+          "application/json" : {
+            "schema" : {
+              "type" : [ "null", "object" ],
+              "additionalProperties" : false,
+              "properties" : {
+                "primaryPermalink" : {
+                  "type" : [ "string", "null" ],
+                  "maxLength" : 250,
+                  "minLength" : 0,
+                  "pattern" : "[a-zA-Z0-9%\\-._/?\\P{InBasicLatin}]*"
+                },
+                "secondaryPermalinks" : {
+                  "type" : [ "null", "array" ],
+                  "items" : {
+                    "type" : [ "string", "null" ],
+                    "maxLength" : 250,
+                    "minLength" : 0,
+                    "pattern" : "[a-zA-Z0-9%\\-._/?\\P{InBasicLatin}]*"
+                  },
+                  "uniqueItems" : false
+                }
+              },
+              "required" : [ "primaryPermalink", "secondaryPermalinks" ]
+            },
+            "examples" : {
+              "Valid responses Definitions" : {
+                "value" : {
+                  "secondayPermalinks" : [ "category-secondary-peramalink-updated", "category-secondary-peramalink-updated1", "category-secondary-peramalink-updated2" ],
+                  "primaryPermalink" : "category-secondary-peramalink"
+                }
+              }
+            }
+          }
+        },
+        "x-custom-response-attributes" : {
+          "disable-safe-headers" : "[]"
+        }
+      },
+      "listAllCommunityCategoryFollowers" : {
+        "description" : "listAllCommunityCategoryFollowers template definitions",
+        "content" : {
+          "application/json" : {
+            "schema" : {
+              "type" : [ "null", "object" ],
+              "additionalProperties" : false,
+              "properties" : {
+                "data" : {
+                  "$ref" : "./CommunityCategory.json#/components/schemas/categoryFollowersDetailsData"
+                }
+              },
+              "required" : [ "data" ]
+            },
+            "examples" : {
+              "Valid responses Definitions" : {
+                "value" : {
+                  "data" : [ {
+                    "photoUrl" : "https://desk.zoho.com/api/v1/agents/7000000015971/photo?orgId=123456",
+                    "name" : "user 3",
+                    "id" : "7000000015971",
+                    "label" : {
+                      "preferences" : {
+                        "shape" : "RECTANGLE",
+                        "bgColor" : "#23F123",
+                        "textColor" : "#2CA123"
+                      },
+                      "name" : "Admin",
+                      "id" : "6000000158001",
+                      "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
+                    },
+                    "type" : "AGENT"
+                  }, {
+                    "photoUrl" : "https://desk.zoho.com/api/v1/agents/7000000015972/photo?orgId=123456",
+                    "name" : "user 2",
+                    "id" : "7000000015972",
+                    "label" : {
+                      "preferences" : {
+                        "shape" : "RECTANGLE",
+                        "bgColor" : "#23F123",
+                        "textColor" : "#2CA123"
+                      },
+                      "name" : "Admin",
+                      "id" : "6000000158001",
+                      "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
+                    },
+                    "type" : "AGENT"
+                  } ]
+                }
+              }
+            }
+          }
+        },
+        "x-custom-response-attributes" : {
+          "disable-safe-headers" : "[]"
+        }
+      },
+      "getACategoryByPermalinkResponse" : {
+        "description" : "communityCategorySecondaryPermalinks template definitions",
+        "content" : {
+          "application/json" : {
+            "schema" : {
+              "ref" : "#/components/schemas/communityGetCategoryJSON"
+            },
+            "examples" : {
+              "Valid responses Definitions" : {
+                "value" : {
+                  "id": "20628000000020011",
+                  "name": "new dep",
+                  "description" :"description",
+                  "parentCategoryId": "null",
+                  "visibility" :"ALL_USERS",
+                  "moderation" : "NONE",
+                  "status" :"ENABLED",
+                  "position": "1",
+                  "moderators":
+                  [
+                    {
+                      "id": "7000000015971",
+                      "name": "user 2",
+                      "photoUrl": "https://desk.zoho.com/api/v1/agents/7000000015971/photo?orgId=123456",
+                      "type":"AGENT"
+                    },
+                    {
+                      "id": "7000000015972",
+                      "name": "user 3",
+                      "photoUrl": "https://desk.zoho.com/api/v1/agents/7000000015972/photo?orgId=123456",
+                      "type":"AGENT"
+                    }
+                  ],
+                  "canAutoConvertTicket" :true,
+                  "departmentId" :"20628000000020011",
+                  "photoUrl" :null,
+                  "permalink" :"new-dep",
+                  "commentCount": "491",
+                  "postCount": "246",
+                  "followersCount": "38",
+                  "isFollowing" :"true",
+                  "post": {
+                    "permission": "ALL_USERS",
+                    "groupIds": []
+                  },
+                  "respond": {
+                    "permission": "ALL_USERS",
+                    "groupIds": []
+                  },
+                  "view": {
+                    "permission": "ALL_USERS",
+                    "groupIds": []
+                  },
+                  "permissions": ["POST","RESPOND"],
+                  "associatedDepartmentIds": [
+                    "20628000000020011"
+                  ],
+                  "deparmentIdForTicketCreation": "20628000000020011",
+
+                  "childs":
+                  [
+                    {
+                      "isFollowing": false,
+                      "photoUrl": null,
+                      "child": [],
+                      "moderators": [],
+                      "parentCategoryId": "4000000003037",
+                      "visibility": "ALL_USERS",
+                      "moderation": null,
+                      "departmentId": null,
+                      "canAutoConvertTicket": null,
+                      "name": "forum",
+                      "id": "4000000012009",
+                      "description": "forum 1",
+                      "status": "ENABLED",
+                      "position": "1",
+                      "commentCount": "491",
+                      "postCount": "246",
+                      "followersCount": "38",
+                      "permalink": "forum-43",
+                      "post": {
+                        "permission": "ALL_USERS",
+                        "groupIds": []
+                      },
+                      "respond": {
+                        "permission": "ALL_USERS",
+                        "groupIds": []
+                      },
+                      "view": {
+                        "permission": "ALL_USERS",
+                        "groupIds": []
+                      },
+                      "permissions": ["POST","RESPOND"],
+                      "associatedDepartmentIds": [
+                        "20628000000020011"
+                      ],
+                      "deparmentIdForTicketCreation": "20628000000020011"
+                    }
+                  ]
+                }
+              }
+            }
+          }
+        },
+        "x-custom-response-attributes" : {
+          "disable-safe-headers" : "[]"
+        }
+      }
+    },
+    "parameters" : {
+      "categoryId" : {
+        "name" : "categoryId",
+        "in" : "path",
+        "required" : true,
+        "style" : "simple",
+        "explode" : false,
+        "schema" : {
+          "type" : [ "string", "null", "integer" ],
+          "format" : "int64",
+          "pattern" : "([0-9]+)"
+        }
+      },
+      "permalink" : {
+        "name" : "permalink",
+        "in" : "query",
+        "description" : "Permalink of the category or forum to fetch",
+        "required" : true,
+        "schema" : {
+          "type" : [ "string", "null" ],
+          "minLength" : 1,
+          "maxLength" : 1000,
+          "pattern" : "[a-zA-Z0-9%\\-._/?\\P{InBasicLatin}]+"
+        }
+
+      },
+      "include" : {
+        "name" : "include",
+        "in" : "query",
+        "description" : "Additional information related to the category or forum. Values allowed are: @postCount@, @followersCount@, and @commentCount@.",
+        "required" : false,
+        "style" : "simple",
+        "explode" : true,
+        "schema" : {
+          "type" : [ "null", "string" ],
+          "enum" : [ "postCount","followersCount","commentCount","groups" ],
+          "maxLength" : 100,
+          "minLength" : 0
+        }
+      }
+    },
+    "requestBodies" : {
+      "addSecondaryPermalinkJSON" : {
+        "content" : {
+          "application/json" : {
+            "schema" : {
+              "type" : [ "null", "object" ],
+              "additionalProperties" : false,
+              "properties" : {
+                "useOldPermalinkForRedirection" : {
+                  "type" : [ "boolean", "null" ],
+                  "description" : "Key that defines whether the primary permalink of the category/forum must be used for redirection or not. Setting @TRUE@ adds the primary permalink to the 301 list and setting @FALSE@ overwrites the primary permalink."
+                },
+                "permalink" : {
+                  "type" : [ "string", "null" ],
+                  "description" : "Permalink of the category or forum",
+                  "maxLength" : 250,
+                  "minLength" : 0,
+                  "pattern" : "[a-zA-Z0-9%\\-._/?\\P{InBasicLatin}]*"
+                }
+              },
+              "required" : [ "permalink", "useOldPermalinkForRedirection" ]
+            },
+            "examples" : {
+              "Valid requestBody Definitions" : {
+                "value" : {
+                  "useOldPermalinkForRedirection" : "false",
+                  "permalink" : "new-dep-updated-permalink"
+                }
+              }
+            }
+          }
+        },
+        "x-custom-request-body-attributes" : {
+          "non-empty" : false,
+          "allow-invalid" : false
+        }
+      }
+    },
+    "securitySchemes" : {
+      "cookie-auth" : {
+        "$ref" : "../common/Common.json#/components/securitySchemes/cookie-auth"
+      },
+      "org-oauth" : {
+        "$ref" : "../common/Common.json#/components/securitySchemes/org-oauth"
+      },
+      "iam-oauth2-schema" : {
+        "$ref" : "../common/Common.json#/components/securitySchemes/iam-oauth2-schema"
+      }
+    }
+  },
+  "x-entity" : "CommunityCategory"
+}