agent-generator 1.0.3 → 1.0.4

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

@@ -1,515 +0,0 @@
-{
-  "openapi" : "3.1.0",
-  "info" : {
-    "title" : "KbSection",
-    "version" : "1.0.0"
-  },
-  "paths" : {
-    "/portal/api/kbRootCategories/{rootCategoryId}/sections" : {
-      "get" : {
-        "tags" : [ "KbSection" ],
-        "summary" : "List kb sections",
-        "description" : "To fetch kb sections under the root category",
-        "operationId" : "listAllSections",
-        "parameters" : [ {
-          "name" : "include",
-          "in" : "query",
-          "description" : "Include extra data in response. Allowed values are @@articlesCount@@, @@followersCount@@",
-          "required" : false,
-          "style" : "simple",
-          "explode" : true,
-          "schema" : {
-            "type" : [ "null", "array" ],
-            "description" : "Include extra data in response. Allowed values are @@articlesCount@@, @@followersCount@@",
-            "items" : {
-              "type" : [ "string", "null" ],
-              "enum" : [ "articlesCount", "followersCount" ],
-              "maxLength" : 100,
-              "minLength" : 0,
-              "x-custom-parameters-attributes" : [ ]
-            },
-            "uniqueItems" : true
-          }
-        }, {
-          "name" : "visibility",
-          "in" : "query",
-          "description" : "Filter by visibility of a section in helpcenter",
-          "required" : false,
-          "style" : "form",
-          "explode" : true,
-          "schema" : {
-            "type" : [ "string", "null" ],
-            "description" : "Filter by visibility of a section in helpcenter",
-            "enum" : [ "ALL_USERS", "GROUP_USERS", "PRIVATE_IP", "NONE" ],
-            "maxLength" : 100,
-            "minLength" : 0,
-            "x-custom-parameters-attributes" : {
-              "split" : ","
-            }
-          }
-        }, {
-          "name" : "limit",
-          "in" : "query",
-          "description" : "No. of records to fetch. Default value will be 30",
-          "required" : false,
-          "style" : "form",
-          "explode" : true,
-          "schema" : {
-            "type" : [ "string", "null", "integer" ],
-            "format" : "int32",
-            "description" : "No. of records to fetch. Default value will be 30",
-            "maximum" : 50,
-            "minimum" : 1,
-            "pattern" : "([0-9]+)"
-          }
-        }, {
-          "name" : "sortBy",
-          "in" : "query",
-          "description" : "Sort order of the categories. Allowed values : name, order",
-          "required" : false,
-          "style" : "form",
-          "explode" : true,
-          "schema" : {
-            "type" : [ "string", "null" ],
-            "description" : "Sort order of the categories. Allowed values : name, order",
-            "enum" : [ "name", "order" ],
-            "maxLength" : 100,
-            "minLength" : 0
-          }
-        }, {
-          "name" : "from",
-          "in" : "query",
-          "description" : "The from index. Default value will be 1",
-          "required" : false,
-          "style" : "form",
-          "explode" : true,
-          "schema" : {
-            "type" : [ "string", "null", "integer" ],
-            "format" : "int32",
-            "description" : "The from index. Default value will be 1",
-            "minimum" : 1,
-            "pattern" : "([0-9]+)"
-          }
-        }, {
-          "name" : "parentCategoryId",
-          "in" : "query",
-          "description" : "Filter kbsections under particular parent category",
-          "required" : false,
-          "style" : "form",
-          "explode" : true,
-          "schema" : {
-            "type" : [ "string", "null", "integer" ],
-            "format" : "int64",
-            "description" : "Filter kbsections under particular parent category",
-            "pattern" : "([0-9]+)"
-          }
-        }, {
-          "name" : "locale",
-          "in" : "query",
-          "description" : "Locale of the kbSections. Default will be helpcenter primary locale",
-          "required" : false,
-          "style" : "form",
-          "explode" : true,
-          "schema" : {
-            "type" : [ "string", "null" ],
-            "description" : "Locale of the kbSections. Default will be helpcenter primary locale",
-            "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ],
-            "maxLength" : 100,
-            "minLength" : 0,
-            "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)"
-          }
-        }, {
-          "name" : "rootCategoryId",
-          "in" : "path",
-          "required" : true,
-          "style" : "simple",
-          "explode" : false,
-          "schema" : {
-            "type" : [ "string", "null", "integer" ],
-            "format" : "int64",
-            "pattern" : "([0-9]+)"
-          }
-        }, {
-          "$ref" : "../common/Common.json#/components/parameters/portalId"
-        } ],
-        "responses" : {
-          "401" : {
-            "$ref" : "../common/Common.json#/components/responses/unauthorizedErrorResponse"
-          },
-          "200" : {
-            "$ref" : "#/components/responses/listAllSectionsResponse"
-          }
-        },
-        "security" : [ {
-          "jwt-oauth" : [ "jwt-oauth" ]
-        } ],
-        "x-audience" : [ "external-public" ],
-        "x-custom-url-attribute" : {
-          "security" : {
-            "throttle" : {
-              "inline" : [ {
-                "scope" : "APPSERVER",
-                "rules" : [ {
-                  "duration" : 60000,
-                  "lock-period" : 300000,
-                  "threshold" : 10,
-                  "hip" : false
-                }, {
-                  "duration" : 3600000,
-                  "lock-period" : 900000,
-                  "threshold" : 50,
-                  "hip" : false
-                } ],
-                "window" : "ROLLING",
-                "key" : "url.path+user.remoteip"
-              } ]
-            },
-            "extraparams" : {
-              "disable" : true,
-              "ignore" : false
-            },
-            "authentication" : { }
-          },
-          "apimethod" : "com.zoho.desk.helpcenter.kbcategory.rest.PortalKBCategoryService.getKbSections"
-        }
-      }
-    },
-    "/portal/api/kbSections/{sectionId}" : {
-      "get" : {
-        "tags" : [ "KbSection" ],
-        "operationId" : "getASection",
-        "parameters" : [ {
-          "name" : "sectionId",
-          "in" : "path",
-          "required" : true,
-          "style" : "simple",
-          "explode" : false,
-          "schema" : {
-            "type" : [ "string", "null", "integer" ],
-            "format" : "int64",
-            "pattern" : "([0-9]+)"
-          }
-        }, {
-          "$ref" : "../common/Common.json#/components/parameters/portalId"
-        } ],
-        "responses" : {
-          "401" : {
-            "$ref" : "../common/Common.json#/components/responses/unauthorizedErrorResponse"
-          },
-          "200" : {
-            "$ref" : "#/components/responses/sectionSingleObjectResponse"
-          }
-        },
-        "security" : [ {
-          "jwt-oauth" : [ "jwt-oauth" ]
-        } ],
-        "x-audience" : [ "external-public" ],
-        "x-custom-url-attribute" : {
-          "security" : {
-            "throttle" : {
-              "inline" : [ {
-                "scope" : "APPSERVER",
-                "rules" : [ {
-                  "duration" : 60000,
-                  "lock-period" : 300000,
-                  "threshold" : 100,
-                  "hip" : false
-                }, {
-                  "duration" : 3600000,
-                  "lock-period" : 900000,
-                  "threshold" : 300,
-                  "hip" : false
-                } ],
-                "window" : "ROLLING",
-                "key" : "url.path+user.remoteip"
-              } ]
-            },
-            "extraparams" : {
-              "disable" : true,
-              "ignore" : false
-            },
-            "authentication" : { }
-          },
-          "apimethod" : "com.zoho.desk.helpcenter.kbcategory.rest.PortalKBCategoryService.getASection"
-        }
-      }
-    }
-  },
-  "components" : {
-    "schemas" : {
-      "sectionResponse" : {
-        "type" : [ "object", "null" ],
-        "additionalProperties" : false,
-        "properties" : {
-          "isFollowing" : {
-            "type" : [ "boolean", "null" ]
-          },
-          "visibility" : {
-            "type" : [ "string", "null" ],
-            "enum" : [ "ALL_USERS", "AGENTS", "GROUP_USERS", "PRIVATE_IP", "NONE" ],
-            "maxLength" : 100,
-            "minLength" : 0,
-            "x-custom-parameters-attributes" : {
-              "removeExif" : false,
-              "replacementString" : "",
-              "filterMatchedContent" : false,
-              "antivirus" : false,
-              "allowInvalid" : false,
-              "descrption" : "Filter by visibility of a section in helpcenter",
-              "secret" : false,
-              "preserveCharsLimit" : 10,
-              "split" : ",",
-              "trim" : false,
-              "internalParam" : false,
-              "preserveChars" : "0,5",
-              "importUrl" : false,
-              "decrypt" : false
-            }
-          },
-          "description" : {
-            "type" : [ "string", "null" ],
-            "maxLength" : 100,
-            "minLength" : 0,
-            "pattern" : "[0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]*"
-          },
-          "translatedDescription" : {
-            "type" : [ "string", "null" ],
-            "maxLength" : 100,
-            "minLength" : 0,
-            "pattern" : "[0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]*"
-          },
-          "locale" : {
-            "type" : [ "string", "null" ],
-            "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ],
-            "maxLength" : 100,
-            "minLength" : 0,
-            "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)"
-          },
-          "translatedName" : {
-            "type" : [ "string", "null" ],
-            "maxLength" : 100,
-            "minLength" : 0
-          },
-          "logoUrl" : {
-            "type" : [ "string", "null" ],
-            "maxLength" : 255,
-            "minLength" : 0,
-            "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
-          },
-          "rootCategoryId" : {
-            "type" : [ "string", "null", "integer" ],
-            "format" : "int64",
-            "pattern" : "([0-9]+)"
-          },
-          "webUrl" : {
-            "type" : [ "string", "null" ],
-            "maxLength" : 255,
-            "minLength" : 3,
-            "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
-          },
-          "name" : {
-            "type" : [ "string", "null" ],
-            "maxLength" : 100,
-            "minLength" : 0
-          },
-          "parentCategoryId" : {
-            "type" : [ "string", "null", "integer" ],
-            "format" : "int64",
-            "pattern" : "([0-9]+)",
-            "x-custom-parameters-attributes" : {
-              "removeExif" : false,
-              "replacementString" : "",
-              "filterMatchedContent" : false,
-              "antivirus" : false,
-              "allowInvalid" : false,
-              "descrption" : "Filter kbsections under particular parent category",
-              "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]+)"
-          },
-          "permalink" : {
-            "type" : [ "string", "null" ],
-            "maxLength" : 100,
-            "minLength" : 0,
-            "pattern" : "[a-z0-9\\/%\\-\\P{InBasicLatin}]+"
-          },
-          "order" : {
-            "type" : [ "string", "null", "integer" ],
-            "format" : "int32",
-            "pattern" : "([0-9]+)"
-          }
-        },
-        "required" : [ "description", "id", "isFollowing", "locale", "logoUrl", "name", "order", "parentCategoryId", "permalink", "rootCategoryId", "translatedDescription", "translatedName", "visibility", "webUrl" ]
-      },
-      "sectionData" : {
-        "type" : [ "array", "null" ],
-        "items" : {
-          "$ref" : "./KbSection.json#/components/schemas/sectionResponse"
-        }
-      },
-      "categoryTranslationList" : {
-        "type" : [ "array", "null" ],
-        "items" : {
-          "$ref" : "./KBCategoryTranslation.json#/components/schemas/categoryTranslation"
-        }
-      }
-    },
-    "responses" : {
-      "listAllSectionsResponse" : {
-        "description" : "listAllSectionsResponse template definitions",
-        "content" : {
-          "application/json" : {
-            "schema" : {
-              "allOf" : [ {
-                "type" : "object",
-                "properties" : {
-                  "data" : {
-                    "type" : "array",
-                    "items" : {
-                      "type" : "object",
-                      "properties" : {
-                        "followersCount" : {
-                          "type" : [ "string", "null", "integer" ],
-                          "format" : "int32",
-                          "pattern" : "([0-9]+)"
-                        },
-                        "articlesCount" : {
-                          "type" : [ "string", "null", "integer" ],
-                          "format" : "int32",
-                          "pattern" : "([0-9]+)"
-                        }
-                      }
-                    }
-                  }
-                }
-              }, {
-                "type" : [ "object", "null" ],
-                "additionalProperties" : false,
-                "properties" : {
-                  "data" : {
-                    "$ref" : "./KbSection.json#/components/schemas/sectionData"
-                  }
-                },
-                "required" : [ "data" ]
-              } ]
-            },
-            "examples" : {
-              "Valid responses Definitions" : {
-                "value" : {
-                  "data" : [ {
-                    "isFollowing" : false,
-                    "visibility" : "ALL_USERS",
-                    "description" : "Engineering zone",
-                    "translatedDescription" : "Engineering zone",
-                    "translatedName" : "Japanese title",
-                    "locale" : "ja",
-                    "logoUrl" : "https://desk.zoho.com/support/App/build/fonts/certificate.svg",
-                    "rootCategoryId" : "4000000081037",
-                    "webUrl" : "https://desk.zoho.com/portal/solosolo/ja/kb/terminus/technical-analysis/description-permalink",
-                    "name" : "Description",
-                    "parentCategoryId" : "4000002852112",
-                    "followersCount" : "23",
-                    "id" : "4000002852130",
-                    "articlesCount" : "5",
-                    "permalink" : "description-permalink",
-                    "order" : "1"
-                  } ]
-                }
-              }
-            }
-          }
-        },
-        "x-custom-response-attributes" : {
-          "disable-safe-headers" : "[]"
-        }
-      },
-      "sectionSingleObjectResponse" : {
-        "description" : "sectionSingleObjectResponse template definitions",
-        "content" : {
-          "application/json" : {
-            "schema" : {
-              "type" : [ "object", "null" ],
-              "additionalProperties" : false,
-              "properties" : {
-                "isFollowing" : {
-                  "type" : [ "boolean", "null" ]
-                },
-                "visibility" : {
-                  "type" : [ "string", "null" ],
-                  "enum" : [ "ALL_USERS", "AGENTS", "GROUP_USERS", "PRIVATE_IP", "NONE" ],
-                  "maxLength" : 100,
-                  "minLength" : 0
-                },
-                "translations" : {
-                  "$ref" : "./KbSection.json#/components/schemas/categoryTranslationList"
-                },
-                "name" : {
-                  "type" : [ "string", "null" ],
-                  "maxLength" : 100,
-                  "minLength" : 0
-                },
-                "description" : {
-                  "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]+)"
-                },
-                "followersCount" : {
-                  "type" : [ "string", "null", "integer" ],
-                  "format" : "int32",
-                  "pattern" : "([0-9]+)"
-                },
-                "logoUrl" : {
-                  "type" : [ "string", "null" ],
-                  "maxLength" : 255,
-                  "minLength" : 0,
-                  "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
-                }
-              },
-              "required" : [ "description", "followersCount", "id", "isFollowing", "logoUrl", "name", "translations", "visibility" ]
-            },
-            "examples" : {
-              "Valid responses Definitions" : {
-                "value" : null
-              }
-            }
-          }
-        },
-        "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" : "KbSection"
-}

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

@@ -1,172 +0,0 @@
-{
-  "openapi" : "3.1.0",
-  "info" : {
-    "title" : "Label",
-    "version" : "1.0.0"
-  },
-  "paths" : {
-    "/portal/api/users/{userId}/labels" : {
-      "get" : {
-        "tags" : [ "Label" ],
-        "summary" : "",
-        "description" : "",
-        "operationId" : "getUserLabels",
-        "parameters" : [ {
-          "name" : "userId",
-          "in" : "path",
-          "required" : true,
-          "style" : "simple",
-          "explode" : false,
-          "schema" : {
-            "type" : [ "string", "null", "integer" ],
-            "format" : "int64",
-            "description" : "",
-            "pattern" : "([0-9]+)",
-            "x-custom-parameters-attributes" : { }
-          }
-        }, {
-          "$ref" : "../common/Common.json#/components/parameters/portalId"
-        } ],
-        "responses" : {
-          "200" : {
-            "$ref" : "#/components/responses/userLabelListViewResponse"
-          },
-          "400" : {
-            "$ref" : "../common/Common.json#/components/responses/badRequestErrorResponse"
-          },
-          "403" : {
-            "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
-          }
-        },
-        "security" : [ {
-          "jwt-oauth" : [ "basic" ]
-        } ]
-      }
-    }
-  },
-  "components" : {
-    "schemas" : {
-      "labelPreferenceResponse" : {
-        "type" : [ "null", "object" ],
-        "additionalProperties" : false,
-        "properties" : {
-          "bgColor" : {
-            "type" : [ "string", "null" ],
-            "description" : "",
-            "maxLength" : 100,
-            "minLength" : 0,
-            "pattern" : "^#?(([a-fA-F0-9]){3}){1,2}$",
-            "x-custom-parameters-attributes" : { }
-          },
-          "shape" : {
-            "type" : [ "string", "null" ],
-            "description" : "",
-            "enum" : [ "ROUNDED", "RECTANGLE" ],
-            "maxLength" : 100,
-            "minLength" : 0,
-            "x-custom-parameters-attributes" : { }
-          },
-          "textColor" : {
-            "type" : [ "string", "null" ],
-            "description" : "",
-            "maxLength" : 100,
-            "minLength" : 0,
-            "pattern" : "^#?(([a-fA-F0-9]){3}){1,2}$",
-            "x-custom-parameters-attributes" : { }
-          }
-        },
-        "required" : [ "bgColor", "shape", "textColor" ]
-      },
-      "labelMetaResponse" : {
-        "type" : [ "null", "object" ],
-        "additionalProperties" : false,
-        "properties" : {
-          "preferences" : {
-            "$ref" : "./Label.json#/components/schemas/labelPreferenceResponse"
-          },
-          "name" : {
-            "type" : [ "string", "null" ],
-            "description" : "",
-            "maxLength" : 100,
-            "minLength" : 0,
-            "pattern" : "[0-9a-zA-Z_\\-\\&\\.\\$\\@\\^\\(\\)\\{\\}\\~\\=\\-\\|\\*\\+\\?\\[\\]\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+",
-            "x-custom-parameters-attributes" : { }
-          },
-          "id" : {
-            "type" : [ "string", "null", "integer" ],
-            "format" : "int64",
-            "description" : "",
-            "pattern" : "([0-9]+)",
-            "x-custom-parameters-attributes" : { }
-          },
-          "logoUrl" : {
-            "type" : [ "string", "null" ],
-            "description" : "",
-            "maxLength" : 200,
-            "minLength" : 0,
-            "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)",
-            "x-custom-parameters-attributes" : { }
-          }
-        },
-        "required" : [ "id", "logoUrl", "name", "preferences" ]
-      },
-      "userLabelMetaResponse" : {
-        "additionalProperties" : false,
-        "allOf" : [ {
-          "$ref" : "./Label.json#/components/schemas/labelMetaResponse"
-        }, {
-          "type" : [ "null", "object" ],
-          "properties" : {
-            "isPrimary" : {
-              "type" : [ "boolean", "null" ],
-              "description" : "",
-              "x-custom-parameters-attributes" : { }
-            }
-          },
-          "required" : [ "isPrimary" ]
-        } ]
-      },
-      "userLabelData" : {
-        "type" : [ "null", "array" ],
-        "items" : {
-          "$ref" : "./Label.json#/components/schemas/userLabelMetaResponse"
-        }
-      }
-    },
-    "responses" : {
-      "userLabelListViewResponse" : {
-        "description" : "userLabelListViewResponse template definitions",
-        "content" : {
-          "application/json" : {
-            "schema" : {
-              "type" : [ "null", "object" ],
-              "additionalProperties" : false,
-              "properties" : {
-                "data" : {
-                  "$ref" : "./Label.json#/components/schemas/userLabelData"
-                }
-              },
-              "required" : [ "data" ]
-            },
-            "examples" : {
-              "Valid responses Definitions" : {
-                "value" : { }
-              }
-            }
-          }
-        },
-        "x-custom-response-attributes" : { }
-      }
-    },
-    "parameters" : { },
-    "securitySchemes" : {
-      "cookie-auth" : {
-        "$ref" : "../common/Common.json#/components/securitySchemes/cookie-auth"
-      },
-      "jwt-oauth" : {
-        "$ref" : "../common/Common.json#/components/securitySchemes/jwt-oauth"
-      }
-    }
-  },
-  "x-entity" : "Label"
-}