agent-generator 1.0.3 → 1.0.5

package/source/openapi-specifications/v1.0/portal/Mentions.json

@@ -1,580 +0,0 @@
-{
-  "openapi" : "3.1.0",
-  "info" : {
-    "title" : "Mentions",
-    "version" : "1.0.0"
-  },
-  "paths" : {
-    "/portal/api/mentions" : {
-      "get" : {
-        "tags" : [ "Mentions" ],
-        "summary" : "Get Mentions",
-        "description" : "This API lists users based on the entity or search string",
-        "operationId" : "getMentions",
-        "parameters" : [ {
-          "name" : "searchStr",
-          "in" : "query",
-          "description" : "String to search for users by first name or last name. The string must contain at least two character",
-          "required" : false,
-          "style" : "form",
-          "explode" : true,
-          "schema" : {
-            "type" : [ "string", "null" ],
-            "description" : "String to search for users by first name or last name. The string must contain at least two character",
-            "maxLength" : 100,
-            "minLength" : 0,
-            "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
-          }
-        }, {
-          "name" : "entityType",
-          "in" : "query",
-          "description" : "Type of the entity. Values allowed are: @kbCategory@, @communityTopics@, @communityComments@ and @communityCategories@.",
-          "required" : false,
-          "style" : "form",
-          "explode" : true,
-          "schema" : {
-            "type" : [ "string", "null" ],
-            "description" : "Type of the entity. Values allowed are: @kbCategory@, @communityTopics@, @communityComments@ and @communityCategories@.",
-            "enum" : [ "communityTopics", "communityComments", "communityCategories", "kbCategory" ],
-            "maxLength" : 100,
-            "minLength" : 0
-          }
-        }, {
-          "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",
-            "maximum" : 100,
-            "minimum" : 1,
-            "pattern" : "([0-9]+)"
-          }
-        }, {
-          "name" : "entityId",
-          "in" : "query",
-          "description" : "ID of the entity to be fetched",
-          "required" : false,
-          "style" : "form",
-          "explode" : true,
-          "schema" : {
-            "type" : [ "string", "null", "integer" ],
-            "format" : "int64",
-            "description" : "ID of the entity to be fetched",
-            "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",
-            "maximum" : 90,
-            "minimum" : 1,
-            "pattern" : "([0-9]+)"
-          }
-        }, {
-          "name" : "type",
-          "in" : "query",
-          "description" : "Type of the user. Values allowed are: @SUPPORTREP@ and @ENDUSER@.",
-          "required" : true,
-          "style" : "form",
-          "explode" : true,
-          "schema" : {
-            "type" : [ "string", "null" ],
-            "description" : "Type of the user. Values allowed are: @SUPPORTREP@ and @ENDUSER@.",
-            "enum" : [ "SUPPORTREP", "ENDUSER", "GROUPS" ],
-            "maxLength" : 100,
-            "minLength" : 0
-          }
-        }, {
-          "$ref" : "../common/Common.json#/components/parameters/portalId"
-        } ],
-        "responses" : {
-          "404" : {
-            "$ref" : "../common/Common.json#/components/responses/urlNotFoundErrorResponse"
-          },
-          "200" : {
-            "$ref" : "#/components/responses/getMentionsData"
-          },
-          "422" : {
-            "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
-          },
-          "500" : {
-            "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
-          },
-          "403" : {
-            "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
-          }
-        },
-        "security" : [ {
-          "jwt-oauth" : [ "jwt-oauth" ]
-        } ],
-        "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" : { }
-          },
-          "apimethod" : "com.zoho.desk.helpcenter.mentions.MentionRestService.getMentionsForPortal"
-        }
-      }
-    }
-  },
-  "components" : {
-    "schemas" : {
-      "mentionDetails" : {
-        "type" : [ "object", "null" ],
-        "additionalProperties" : false,
-        "properties" : {
-          "photoUrl" : {
-            "type" : [ "string", "null" ],
-            "maxLength" : 100,
-            "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])+"
-          },
-          "id" : {
-            "type" : [ "string", "null", "integer" ],
-            "format" : "int64",
-            "pattern" : "([0-9]+)"
-          },
-          "type" : {
-            "type" : [ "string", "null" ],
-            "enum" : [ "ENDUSER", "SUPPORTREP" ],
-            "maxLength" : 100,
-            "minLength" : 0,
-            "x-custom-parameters-attributes" : {
-              "removeExif" : false,
-              "replacementString" : "",
-              "filterMatchedContent" : false,
-              "antivirus" : false,
-              "allowInvalid" : false,
-              "descrption" : "Type of the user. Values allowed are: @SUPPORTREP@ and @ENDUSER@.",
-              "secret" : false,
-              "preserveCharsLimit" : 10,
-              "trim" : false,
-              "internalParam" : false,
-              "preserveChars" : "0,5",
-              "importUrl" : false,
-              "decrypt" : false
-            }
-          },
-          "zuid" : {
-            "type" : [ "string", "null", "integer" ],
-            "format" : "int64",
-            "pattern" : "([0-9]+)"
-          }
-        },
-        "required" : [ "id", "name", "photoUrl", "type", "zuid" ]
-      },
-      "getMentionsDataArray" : {
-        "type" : [ "array", "null" ],
-        "items" : {
-          "$ref" : "./Mentions.json#/components/schemas/mentionDetails"
-        }
-      },
-      "mentionGroupDetails" : {
-        "type" : [ "object", "null" ],
-        "additionalProperties" : false,
-        "properties" : {
-          "name" : {
-            "type" : [ "string", "null" ],
-            "maxLength" : 100,
-            "minLength" : 0,
-            "pattern" : "[0-9a-zA-Z_\\-\\&\\.\\$\\@\\^\\(\\)\\{\\}\\~\\=\\-\\|\\*\\+\\?\\[\\]\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+"
-          },
-          "id" : {
-            "type" : [ "string", "null", "integer" ],
-            "format" : "int64",
-            "pattern" : "([0-9]+)"
-          },
-          "logoUrl" : {
-            "type" : [ "string", "null" ],
-            "maxLength" : 200,
-            "minLength" : 0,
-            "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
-          }
-        },
-        "required" : [ "id", "logoUrl", "name" ]
-      },
-      "getGroupMentionsDataArray" : {
-        "type" : [ "array", "null" ],
-        "items" : {
-          "$ref" : "./Mentions.json#/components/schemas/mentionGroupDetails"
-        }
-      },
-      "mentionsData" : {
-        "type" : [ "object", "null" ],
-        "additionalProperties" : false,
-        "properties" : {
-          "groups" : {
-            "$ref" : "./Mentions.json#/components/schemas/getGroupMentionsDataArray"
-          },
-          "users" : {
-            "$ref" : "./Mentions.json#/components/schemas/getMentionsDataArray"
-          }
-        },
-        "required" : [ "groups", "users" ]
-      },
-      "mentionedUserDetailsWithOffset" : {
-        "type" : [ "object", "null" ],
-        "additionalProperties" : false,
-        "properties" : {
-          "photoUrl" : {
-            "type" : [ "string", "null" ],
-            "maxLength" : 250,
-            "minLength" : 0,
-            "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
-          },
-          "offSet" : {
-            "type" : [ "string", "null", "integer" ],
-            "format" : "int32",
-            "pattern" : "([0-9]+)"
-          },
-          "webUrl" : {
-            "type" : [ "string", "null" ],
-            "maxLength" : 250,
-            "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])+"
-          },
-          "length" : {
-            "type" : [ "string", "null", "integer" ],
-            "format" : "int32",
-            "pattern" : "([0-9]+)"
-          },
-          "id" : {
-            "type" : [ "string", "null", "integer" ],
-            "format" : "int64",
-            "pattern" : "([0-9]+)"
-          },
-          "label" : {
-            "$ref" : "./Label.json#/components/schemas/labelMetaResponse"
-          },
-          "type" : {
-            "type" : [ "string", "null" ],
-            "maxLength" : 200,
-            "minLength" : 0,
-            "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
-          },
-          "zuid" : {
-            "type" : [ "string", "null", "integer" ],
-            "format" : "int64",
-            "pattern" : "([0-9]+)"
-          },
-          "kbRole" : {
-            "type" : [ "string", "null" ],
-            "enum" : [ "REVIEWER" ],
-            "maxLength" : 100,
-            "minLength" : 0
-          }
-        },
-        "required" : [ "id", "kbRole", "label", "length", "name", "offSet", "photoUrl", "type", "webUrl", "zuid" ]
-      },
-      "mentionedUserDetailsWithOffsetList" : {
-        "type" : [ "array", "null" ],
-        "items" : {
-          "$ref" : "./Mentions.json#/components/schemas/mentionedUserDetailsWithOffset"
-        }
-      },
-      "mentionedGroupDetailsWithOffset" : {
-        "type" : [ "object", "null" ],
-        "additionalProperties" : false,
-        "properties" : {
-          "offset" : {
-            "type" : [ "string", "null", "integer" ],
-            "format" : "int32",
-            "pattern" : "([0-9]+)"
-          },
-          "name" : {
-            "type" : [ "string", "null" ],
-            "maxLength" : 100,
-            "minLength" : 0,
-            "pattern" : "[0-9a-zA-Z_\\-\\&\\.\\$\\@\\^\\(\\)\\{\\}\\~\\=\\-\\|\\*\\+\\?\\[\\]\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+"
-          },
-          "length" : {
-            "type" : [ "string", "null", "integer" ],
-            "format" : "int32",
-            "pattern" : "([0-9]+)"
-          },
-          "id" : {
-            "type" : [ "string", "null", "integer" ],
-            "format" : "int64",
-            "pattern" : "([0-9]+)"
-          },
-          "logoUrl" : {
-            "type" : [ "string", "null" ],
-            "maxLength" : 200,
-            "minLength" : 0,
-            "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
-          }
-        },
-        "required" : [ "id", "length", "logoUrl", "name", "offset" ]
-      },
-      "mentionedGroupDetailsWithOffsetList" : {
-        "type" : [ "array", "null" ],
-        "items" : {
-          "$ref" : "./Mentions.json#/components/schemas/mentionedGroupDetailsWithOffset"
-        }
-      },
-      "offsetDetails" : {
-        "type" : [ "object", "null" ],
-        "additionalProperties" : false,
-        "properties" : {
-          "offset" : {
-            "type" : [ "string", "null", "integer" ],
-            "format" : "int32",
-            "pattern" : "([0-9]+)"
-          },
-          "length" : {
-            "type" : [ "string", "null", "integer" ],
-            "format" : "int32",
-            "pattern" : "([0-9]+)"
-          }
-        },
-        "required" : [ "length", "offset" ]
-      },
-      "offsetArray" : {
-        "type" : [ "array", "null" ],
-        "items" : {
-          "$ref" : "./Mentions.json#/components/schemas/offsetDetails"
-        }
-      },
-      "mentionedUserDetails" : {
-        "type" : [ "object", "null" ],
-        "additionalProperties" : false,
-        "properties" : {
-          "photoUrl" : {
-            "type" : [ "string", "null" ],
-            "maxLength" : 100,
-            "minLength" : 0,
-            "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
-          },
-          "offsets" : {
-            "$ref" : "./Mentions.json#/components/schemas/offsetArray"
-          },
-          "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]+)"
-          },
-          "type" : {
-            "type" : [ "string", "null" ],
-            "enum" : [ "ENDUSER", "SUPPORTREP" ],
-            "maxLength" : 100,
-            "minLength" : 0,
-            "x-custom-parameters-attributes" : {
-              "removeExif" : false,
-              "replacementString" : "",
-              "filterMatchedContent" : false,
-              "antivirus" : false,
-              "allowInvalid" : false,
-              "descrption" : "",
-              "secret" : false,
-              "preserveCharsLimit" : 10,
-              "trim" : false,
-              "internalParam" : false,
-              "preserveChars" : "0,5",
-              "importUrl" : false,
-              "decrypt" : false
-            }
-          },
-          "mentionStatus" : {
-            "type" : [ "string", "null" ],
-            "enum" : [ "ACTIVE", "INACTIVE", "NOT_FOUND", "DELETED" ],
-            "maxLength" : 100,
-            "minLength" : 0
-          },
-          "zuid" : {
-            "type" : [ "string", "null", "integer" ],
-            "format" : "int64",
-            "pattern" : "([0-9]+)"
-          }
-        },
-        "required" : [ "id", "mentionStatus", "name", "offsets", "photoUrl", "type", "zuid" ]
-      },
-      "getMentionsUserDataArray" : {
-        "type" : [ "array", "null" ],
-        "items" : {
-          "$ref" : "./Mentions.json#/components/schemas/mentionedUserDetails"
-        }
-      },
-      "mentionedGroupDetails" : {
-        "type" : [ "object", "null" ],
-        "additionalProperties" : false,
-        "properties" : {
-          "offsets" : {
-            "$ref" : "./Mentions.json#/components/schemas/offsetArray"
-          },
-          "name" : {
-            "type" : [ "string", "null" ],
-            "maxLength" : 100,
-            "minLength" : 0,
-            "pattern" : "[0-9a-zA-Z_\\-\\&\\.\\$\\@\\^\\(\\)\\{\\}\\~\\=\\-\\|\\*\\+\\?\\[\\]\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+"
-          },
-          "id" : {
-            "type" : [ "string", "null", "integer" ],
-            "format" : "int64",
-            "pattern" : "([0-9]+)"
-          },
-          "mentionStatus" : {
-            "type" : [ "string", "null" ],
-            "enum" : [ "ACTIVE", "INACTIVE", "NOT_FOUND", "DELETED" ],
-            "maxLength" : 100,
-            "minLength" : 0
-          },
-          "logoUrl" : {
-            "type" : [ "string", "null" ],
-            "maxLength" : 200,
-            "minLength" : 0,
-            "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
-          }
-        },
-        "required" : [ "id", "logoUrl", "mentionStatus", "name", "offsets" ]
-      },
-      "getMentionsGroupDataArray" : {
-        "type" : [ "array", "null" ],
-        "items" : {
-          "$ref" : "./Mentions.json#/components/schemas/mentionedGroupDetails"
-        }
-      },
-      "mentionedObj" : {
-        "type" : [ "object", "null" ],
-        "additionalProperties" : false,
-        "properties" : {
-          "groups" : {
-            "$ref" : "./Mentions.json#/components/schemas/getMentionsGroupDataArray"
-          },
-          "users" : {
-            "$ref" : "./Mentions.json#/components/schemas/getMentionsUserDataArray"
-          }
-        },
-        "required" : [ "groups", "users" ]
-      }
-    },
-    "responses" : {
-      "getMentionsData" : {
-        "description" : "getMentionsData template definitions",
-        "content" : {
-          "application/json" : {
-            "schema" : {
-              "type" : [ "object", "null" ],
-              "additionalProperties" : false,
-              "properties" : {
-                "data" : {
-                  "$ref" : "./Mentions.json#/components/schemas/mentionsData"
-                }
-              },
-              "required" : [ "data" ]
-            },
-            "examples" : {
-              "Valid responses Definitions" : {
-                "value" : {
-                  "data" : {
-                    "groups" : [ {
-                      "name" : "Group 1",
-                      "id" : "70000000234971",
-                      "logoUrl" : null
-                    } ],
-                    "users" : [ {
-                      "photoUrl" : "https://desk.zoho.com/api/v1/agents/7000000015971/photo?orgId=123456",
-                      "name" : "user 1",
-                      "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 3",
-                      "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" : "[]"
-        }
-      }
-    },
-    "parameters" : { },
-    "securitySchemes" : {
-      "cookie-auth" : {
-        "$ref" : "../common/Common.json#/components/securitySchemes/cookie-auth"
-      },
-      "org-oauth" : {
-        "$ref" : "../common/Common.json#/components/securitySchemes/org-oauth"
-      },
-      "jwt-oauth" : {
-        "$ref" : "../common/Common.json#/components/securitySchemes/jwt-oauth"
-      },
-      "iam-oauth2-schema" : {
-        "$ref" : "../common/Common.json#/components/securitySchemes/iam-oauth2-schema"
-      }
-    }
-  },
-  "x-entity" : "Mentions"
-}