agent-generator-cli 1.0.0 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (766) hide show
  1. package/README.md +2 -22
  2. package/install-extension.js +89 -0
  3. package/main.js +45 -7
  4. package/package.json +21 -8
  5. package/source/api-data-generators/.idea/api-data-generators.iml +9 -0
  6. package/source/api-data-generators/.idea/misc.xml +6 -0
  7. package/source/api-data-generators/.idea/modules.xml +8 -0
  8. package/source/api-data-generators/.idea/vcs.xml +6 -0
  9. package/source/api-data-generators/portal/ArticleComment/test_data_generation_configurations.json +318 -0
  10. package/source/api-data-generators/portal/ArticleFeedback/test_data_generation_configurations.json +32 -0
  11. package/source/api-data-generators/portal/AsapMobile/test_data_generation_configurations.json +21 -0
  12. package/source/api-data-generators/portal/AsapWeb/test_data_generation_configurations.json +18 -0
  13. package/source/api-data-generators/portal/Category/test_data_generation_configurations.json +39 -0
  14. package/source/api-data-generators/portal/Comment/test_data_generation_configurations.json +157 -0
  15. package/source/api-data-generators/portal/Community/test_data_generation_configurations.json +46 -0
  16. package/source/api-data-generators/portal/CommunityUser/test_data_generation_configurations.json +16 -0
  17. package/source/api-data-generators/portal/Contact/test_data_generation_configurations.json +33 -0
  18. package/source/api-data-generators/portal/Department/test_data_generation_configurations.json +13 -0
  19. package/source/api-data-generators/portal/Extension/test_data_generation_configurations.json +91 -0
  20. package/source/api-data-generators/portal/FeedbackWidget/test_data_generation_configurations.json +18 -0
  21. package/source/api-data-generators/portal/FileExport/test_data_generation_configurations.json +42 -0
  22. package/source/api-data-generators/portal/Followers/test_data_generation_configurations.json +92 -0
  23. package/source/api-data-generators/portal/Gamification/test_data_generation_configurations.json +51 -0
  24. package/source/api-data-generators/portal/HelpCenters/test_data_generation_configurations.json +11 -0
  25. package/source/api-data-generators/portal/Helpcenter/test_data_generation_configurations.json +41 -0
  26. package/source/api-data-generators/portal/HelpcenterGroups/test_data_generation_configurations.json +18 -0
  27. package/source/api-data-generators/portal/KBRootCategory/test_data_generation_configurations.json +76 -0
  28. package/source/api-data-generators/portal/KbCategory/test_data_generation_configurations.json +51 -0
  29. package/source/api-data-generators/portal/KbSection/test_data_generation_configurations.json +25 -0
  30. package/source/api-data-generators/portal/KnowledgeBase/test_data_generation_configurations.json +26 -0
  31. package/source/api-data-generators/portal/Label/test_data_generation_configurations.json +18 -0
  32. package/source/api-data-generators/portal/Layout/test_data_generation_configurations.json +17 -0
  33. package/source/api-data-generators/portal/LayoutRules/test_data_generation_configurations.json +17 -0
  34. package/source/api-data-generators/portal/NewAsapMobile/test_data_generation_configurations.json +21 -0
  35. package/source/api-data-generators/portal/Permalink/test_data_generation_configurations.json +32 -0
  36. package/source/api-data-generators/portal/Product/test_data_generation_configurations.json +43 -0
  37. package/source/api-data-generators/portal/Solution/test_data_generation_configurations.json +631 -0
  38. package/source/api-data-generators/portal/Thread/test_data_generation_configurations.json +70 -0
  39. package/source/api-data-generators/portal/Ticket/test_data_generation_configurations.json +294 -0
  40. package/source/api-data-generators/portal/TicketComment/test_data_generation_configurations.json +58 -0
  41. package/source/api-data-generators/portal/TicketCount/test_data_generation_configurations.json +74 -0
  42. package/source/api-data-generators/portal/TicketStatusMapping/test_data_generation_configurations.json +11 -0
  43. package/source/api-data-generators/portal/TicketTemplate/test_data_generation_configurations.json +24 -0
  44. package/source/api-data-generators/portal/Topic/test_data_generation_configurations.json +259 -0
  45. package/source/api-data-generators/portal/Translation/test_data_generation_configurations.json +6 -0
  46. package/source/api-data-generators/portal/ValidationRules/test_data_generation_configurations.json +14 -0
  47. package/source/api-data-generators/portal/View/test_data_generation_configurations.json +19 -0
  48. package/source/api-data-generators/support/Account/test_data_generation_configurations.json +265 -0
  49. package/source/api-data-generators/support/AccountAttachment/test_data_generation_configurations.json +48 -0
  50. package/source/api-data-generators/support/AccountComments/test_data_generation_configurations.json +47 -0
  51. package/source/api-data-generators/support/AccountContactMappingInfo/test_data_generation_configurations.json +14 -0
  52. package/source/api-data-generators/support/AccountFollowers/test_data_generation_configurations.json +52 -0
  53. package/source/api-data-generators/support/AccountSla/test_data_generation_configurations.json +33 -0
  54. package/source/api-data-generators/support/AccountTimeEntry/test_data_generation_configurations.json +45 -0
  55. package/source/api-data-generators/support/ActiveCalls/test_data_generation_configurations.json +38 -0
  56. package/source/api-data-generators/support/Activity/test_data_generation_configurations.json +50 -0
  57. package/source/api-data-generators/support/ActorsAPI/test_data_generation_configurations.json +22 -0
  58. package/source/api-data-generators/support/Agent/test_data_generation_configurations.json +217 -0
  59. package/source/api-data-generators/support/AgentPresence/test_data_generation_configurations.json +30 -0
  60. package/source/api-data-generators/support/AgentSignatures/test_data_generation_configurations.json +31 -0
  61. package/source/api-data-generators/support/AgentTimeEntry/test_data_generation_configurations.json +36 -0
  62. package/source/api-data-generators/support/AntiSpamInfo/test_data_generation_configurations.json +32 -0
  63. package/source/api-data-generators/support/ApiCreditNotificationRule/test_data_generation_configurations.json +49 -0
  64. package/source/api-data-generators/support/ArchivedView/test_data_generation_configurations.json +66 -0
  65. package/source/api-data-generators/support/Article/test_data_generation_configurations.json +294 -0
  66. package/source/api-data-generators/support/ArticleAttachment/test_data_generation_configurations.json +150 -0
  67. package/source/api-data-generators/support/ArticleComment/test_data_generation_configurations.json +238 -0
  68. package/source/api-data-generators/support/ArticleFeedback/test_data_generation_configurations.json +147 -0
  69. package/source/api-data-generators/support/ArticleFeedbackResolution/test_data_generation_configurations.json +56 -0
  70. package/source/api-data-generators/support/ArticleStatistics/test_data_generation_configurations.json +397 -0
  71. package/source/api-data-generators/support/ArticleTranslation/test_data_generation_configurations.json +1123 -0
  72. package/source/api-data-generators/support/ArticleVersion/test_data_generation_configurations.json +26 -0
  73. package/source/api-data-generators/support/ArticleViews/test_data_generation_configurations.json +26 -0
  74. package/source/api-data-generators/support/Asap/test_data_generation_configurations.json +49 -0
  75. package/source/api-data-generators/support/AuditLog/test_data_generation_configurations.json +58 -0
  76. package/source/api-data-generators/support/AutomationAlerts/test_data_generation_configurations.json +27 -0
  77. package/source/api-data-generators/support/AutomationEngine/test_data_generation_configurations.json +20 -0
  78. package/source/api-data-generators/support/AutomationFeatureCount/test_data_generation_configurations.json +13 -0
  79. package/source/api-data-generators/support/AutomationFieldUpdates/test_data_generation_configurations.json +24 -0
  80. package/source/api-data-generators/support/AutomationTask/test_data_generation_configurations.json +29 -0
  81. package/source/api-data-generators/support/Backup/test_data_generation_configurations.json +115 -0
  82. package/source/api-data-generators/support/Badge/test_data_generation_configurations.json +64 -0
  83. package/source/api-data-generators/support/Bot/test_data_generation_configurations.json +288 -0
  84. package/source/api-data-generators/support/BotInference/test_data_generation_configurations.json +119 -0
  85. package/source/api-data-generators/support/BugInteg/test_data_generation_configurations.json +37 -0
  86. package/source/api-data-generators/support/BulkAction/test_data_generation_configurations.json +26 -0
  87. package/source/api-data-generators/support/BulkImport/test_data_generation_configurations.json +211 -0
  88. package/source/api-data-generators/support/BulkUpdate/test_data_generation_configurations.json +40 -0
  89. package/source/api-data-generators/support/BulkWrite/test_data_generation_configurations.json +32 -0
  90. package/source/api-data-generators/support/BusinessHour/test_data_generation_configurations.json +72 -0
  91. package/source/api-data-generators/support/Call/test_data_generation_configurations.json +247 -0
  92. package/source/api-data-generators/support/CallComments/test_data_generation_configurations.json +51 -0
  93. package/source/api-data-generators/support/CallHistory/test_data_generation_configurations.json +65 -0
  94. package/source/api-data-generators/support/CallTimeEntry/test_data_generation_configurations.json +77 -0
  95. package/source/api-data-generators/support/CallTimer/test_data_generation_configurations.json +14 -0
  96. package/source/api-data-generators/support/Channel/test_data_generation_configurations.json +44 -0
  97. package/source/api-data-generators/support/Chart/test_data_generation_configurations.json +35 -0
  98. package/source/api-data-generators/support/ChatTicket/test_data_generation_configurations.json +185 -0
  99. package/source/api-data-generators/support/Common/test_data_generation_configurations.json +43 -0
  100. package/source/api-data-generators/support/Community/test_data_generation_configurations.json +313 -0
  101. package/source/api-data-generators/support/CommunityAttachment/test_data_generation_configurations.json +16 -0
  102. package/source/api-data-generators/support/CommunityCategory/test_data_generation_configurations.json +121 -0
  103. package/source/api-data-generators/support/CommunityComment/test_data_generation_configurations.json +350 -0
  104. package/source/api-data-generators/support/CommunityInitPermissions/test_data_generation_configurations.json +16 -0
  105. package/source/api-data-generators/support/CommunityPreferences/test_data_generation_configurations.json +19 -0
  106. package/source/api-data-generators/support/CommunityTopic/test_data_generation_configurations.json +509 -0
  107. package/source/api-data-generators/support/CommunityTopicInsights/test_data_generation_configurations.json +32 -0
  108. package/source/api-data-generators/support/CommunityUser/test_data_generation_configurations.json +63 -0
  109. package/source/api-data-generators/support/Contact/test_data_generation_configurations.json +370 -0
  110. package/source/api-data-generators/support/ContactAttachment/test_data_generation_configurations.json +44 -0
  111. package/source/api-data-generators/support/ContactComments/test_data_generation_configurations.json +47 -0
  112. package/source/api-data-generators/support/ContactFollowers/test_data_generation_configurations.json +52 -0
  113. package/source/api-data-generators/support/ContactProfile/test_data_generation_configurations.json +11 -0
  114. package/source/api-data-generators/support/ContactTimeEntry/test_data_generation_configurations.json +45 -0
  115. package/source/api-data-generators/support/Contract/test_data_generation_configurations.json +184 -0
  116. package/source/api-data-generators/support/ContractAttachment/test_data_generation_configurations.json +30 -0
  117. package/source/api-data-generators/support/CreateTicket/test_data_generation_configurations.json +93 -0
  118. package/source/api-data-generators/support/Criteria/test_data_generation_configurations.json +19 -0
  119. package/source/api-data-generators/support/CrmInteg/test_data_generation_configurations.json +202 -0
  120. package/source/api-data-generators/support/CustomAction/test_data_generation_configurations.json +56 -0
  121. package/source/api-data-generators/support/CustomActionRuleMapping/test_data_generation_configurations.json +334 -0
  122. package/source/api-data-generators/support/CustomButton/test_data_generation_configurations.json +113 -0
  123. package/source/api-data-generators/support/CustomFunctionExecutionLogs/test_data_generation_configurations.json +68 -0
  124. package/source/api-data-generators/support/CustomFunctionGallery/test_data_generation_configurations.json +16 -0
  125. package/source/api-data-generators/support/CustomFunctions/test_data_generation_configurations.json +270 -0
  126. package/source/api-data-generators/support/CustomTheme/test_data_generation_configurations.json +70 -0
  127. package/source/api-data-generators/support/CustomView/test_data_generation_configurations.json +486 -0
  128. package/source/api-data-generators/support/CustomerHappiness/test_data_generation_configurations.json +77 -0
  129. package/source/api-data-generators/support/DashboardComponent/test_data_generation_configurations.json +305 -0
  130. package/source/api-data-generators/support/DashboardFolder/test_data_generation_configurations.json +126 -0
  131. package/source/api-data-generators/support/DashboardMetrics/test_data_generation_configurations.json +205 -0
  132. package/source/api-data-generators/support/Dashboards/test_data_generation_configurations.json +90 -0
  133. package/source/api-data-generators/support/DataChips/test_data_generation_configurations.json +33 -0
  134. package/source/api-data-generators/support/DataSync/test_data_generation_configurations.json +228 -0
  135. package/source/api-data-generators/support/DeleteTicket/test_data_generation_configurations.json +44 -0
  136. package/source/api-data-generators/support/Department/test_data_generation_configurations.json +156 -0
  137. package/source/api-data-generators/support/DependencyMappings/test_data_generation_configurations.json +50 -0
  138. package/source/api-data-generators/support/DirectAssignRuleTarget/test_data_generation_configurations.json +17 -0
  139. package/source/api-data-generators/support/DirectAssignmentRules/test_data_generation_configurations.json +37 -0
  140. package/source/api-data-generators/support/DisplayEntity/test_data_generation_configurations.json +45 -0
  141. package/source/api-data-generators/support/DomainMapping/test_data_generation_configurations.json +6 -0
  142. package/source/api-data-generators/support/EmailFailureAlert/test_data_generation_configurations.json +21 -0
  143. package/source/api-data-generators/support/EmailTemplates/test_data_generation_configurations.json +106 -0
  144. package/source/api-data-generators/support/EntityBlueprints/test_data_generation_configurations.json +205 -0
  145. package/source/api-data-generators/support/Event/test_data_generation_configurations.json +196 -0
  146. package/source/api-data-generators/support/EventComments/test_data_generation_configurations.json +45 -0
  147. package/source/api-data-generators/support/EventTimeEntry/test_data_generation_configurations.json +77 -0
  148. package/source/api-data-generators/support/EventTimer/test_data_generation_configurations.json +14 -0
  149. package/source/api-data-generators/support/Extension/test_data_generation_configurations.json +689 -0
  150. package/source/api-data-generators/support/FbManager/test_data_generation_configurations.json +64 -0
  151. package/source/api-data-generators/support/Feature/test_data_generation_configurations.json +61 -0
  152. package/source/api-data-generators/support/FeatureFile/test_data_generation_configurations.json +49 -0
  153. package/source/api-data-generators/support/FeatureFolder/test_data_generation_configurations.json +44 -0
  154. package/source/api-data-generators/support/FeaturePermission/test_data_generation_configurations.json +108 -0
  155. package/source/api-data-generators/support/FederatedLogin/test_data_generation_configurations.json +39 -0
  156. package/source/api-data-generators/support/FeedsAPIs/test_data_generation_configurations.json +54 -0
  157. package/source/api-data-generators/support/Field/test_data_generation_configurations.json +1031 -0
  158. package/source/api-data-generators/support/FieldPrediction/test_data_generation_configurations.json +564 -0
  159. package/source/api-data-generators/support/FileExport/test_data_generation_configurations.json +36 -0
  160. package/source/api-data-generators/support/Finance/test_data_generation_configurations.json +180 -0
  161. package/source/api-data-generators/support/Followers/test_data_generation_configurations.json +60 -0
  162. package/source/api-data-generators/support/GC_Bots/test_data_generation_configurations.json +26 -0
  163. package/source/api-data-generators/support/GC_Guide/test_data_generation_configurations.json +240 -0
  164. package/source/api-data-generators/support/GenericAction/test_data_generation_configurations.json +16 -0
  165. package/source/api-data-generators/support/GenericActionMapping/test_data_generation_configurations.json +216 -0
  166. package/source/api-data-generators/support/GoogleAnalytics/test_data_generation_configurations.json +168 -0
  167. package/source/api-data-generators/support/GoogleChat/test_data_generation_configurations.json +29 -0
  168. package/source/api-data-generators/support/Helpcenter/test_data_generation_configurations.json +98 -0
  169. package/source/api-data-generators/support/HelpcenterAutoTranslateSetting/test_data_generation_configurations.json +11 -0
  170. package/source/api-data-generators/support/HelpcenterGroups/test_data_generation_configurations.json +93 -0
  171. package/source/api-data-generators/support/HelpcenterPages/test_data_generation_configurations.json +34 -0
  172. package/source/api-data-generators/support/HelpcenterPreference/test_data_generation_configurations.json +18 -0
  173. package/source/api-data-generators/support/HelpcenterUpload/test_data_generation_configurations.json +25 -0
  174. package/source/api-data-generators/support/HolidayList/test_data_generation_configurations.json +65 -0
  175. package/source/api-data-generators/support/IMCannedMessage/test_data_generation_configurations.json +155 -0
  176. package/source/api-data-generators/support/IMCannedMessageTranslation/test_data_generation_configurations.json +92 -0
  177. package/source/api-data-generators/support/IMTemplateMessage/test_data_generation_configurations.json +22 -0
  178. package/source/api-data-generators/support/IM_AddOn/test_data_generation_configurations.json +19 -0
  179. package/source/api-data-generators/support/IM_Bot/test_data_generation_configurations.json +143 -0
  180. package/source/api-data-generators/support/IM_Broadcast/test_data_generation_configurations.json +39 -0
  181. package/source/api-data-generators/support/IM_Channel/test_data_generation_configurations.json +312 -0
  182. package/source/api-data-generators/support/IM_ChannelPreference/test_data_generation_configurations.json +35 -0
  183. package/source/api-data-generators/support/IM_Contact/test_data_generation_configurations.json +16 -0
  184. package/source/api-data-generators/support/IM_Integration/test_data_generation_configurations.json +32 -0
  185. package/source/api-data-generators/support/IM_Message/test_data_generation_configurations.json +297 -0
  186. package/source/api-data-generators/support/IM_Metrics/test_data_generation_configurations.json +38 -0
  187. package/source/api-data-generators/support/IM_Search/test_data_generation_configurations.json +56 -0
  188. package/source/api-data-generators/support/IM_Session/test_data_generation_configurations.json +149 -0
  189. package/source/api-data-generators/support/IM_TimeSeriesMetrics/test_data_generation_configurations.json +77 -0
  190. package/source/api-data-generators/support/IM_ZiaGpt/test_data_generation_configurations.json +52 -0
  191. package/source/api-data-generators/support/Import/test_data_generation_configurations.json +229 -0
  192. package/source/api-data-generators/support/InlineImage/test_data_generation_configurations.json +16 -0
  193. package/source/api-data-generators/support/IntegModule/test_data_generation_configurations.json +90 -0
  194. package/source/api-data-generators/support/Integrations/test_data_generation_configurations.json +25 -0
  195. package/source/api-data-generators/support/InteractiveTours/test_data_generation_configurations.json +66 -0
  196. package/source/api-data-generators/support/JWT/test_data_generation_configurations.json +49 -0
  197. package/source/api-data-generators/support/KBCategoryUser/test_data_generation_configurations.json +23 -0
  198. package/source/api-data-generators/support/KBRecycleBin/test_data_generation_configurations.json +131 -0
  199. package/source/api-data-generators/support/KBRootCategory/test_data_generation_configurations.json +214 -0
  200. package/source/api-data-generators/support/KBRootCategoryTranslation/test_data_generation_configurations.json +30 -0
  201. package/source/api-data-generators/support/KBSection/test_data_generation_configurations.json +173 -0
  202. package/source/api-data-generators/support/KPIWidget/test_data_generation_configurations.json +21 -0
  203. package/source/api-data-generators/support/KbCategory/test_data_generation_configurations.json +93 -0
  204. package/source/api-data-generators/support/Label/test_data_generation_configurations.json +103 -0
  205. package/source/api-data-generators/support/Layout/test_data_generation_configurations.json +503 -0
  206. package/source/api-data-generators/support/LayoutRuleCriteria/test_data_generation_configurations.json +19 -0
  207. package/source/api-data-generators/support/LayoutRules/test_data_generation_configurations.json +334 -0
  208. package/source/api-data-generators/support/License/test_data_generation_configurations.json +60 -0
  209. package/source/api-data-generators/support/Livecall/test_data_generation_configurations.json +72 -0
  210. package/source/api-data-generators/support/LookupRecord/test_data_generation_configurations.json +34 -0
  211. package/source/api-data-generators/support/Macros/test_data_generation_configurations.json +184 -0
  212. package/source/api-data-generators/support/MailReplyAddress/test_data_generation_configurations.json +32 -0
  213. package/source/api-data-generators/support/MassAction/test_data_generation_configurations.json +38 -0
  214. package/source/api-data-generators/support/Message/test_data_generation_configurations.json +38 -0
  215. package/source/api-data-generators/support/MicrosoftTeams/test_data_generation_configurations.json +50 -0
  216. package/source/api-data-generators/support/Misc/test_data_generation_configurations.json +16 -0
  217. package/source/api-data-generators/support/Module/test_data_generation_configurations.json +96 -0
  218. package/source/api-data-generators/support/NewCriteria/test_data_generation_configurations.json +26 -0
  219. package/source/api-data-generators/support/NewFeatureFields/test_data_generation_configurations.json +19 -0
  220. package/source/api-data-generators/support/NewTicketHistory/test_data_generation_configurations.json +20 -0
  221. package/source/api-data-generators/support/NotificationRules/test_data_generation_configurations.json +27 -0
  222. package/source/api-data-generators/support/OEmbedData/test_data_generation_configurations.json +19 -0
  223. package/source/api-data-generators/support/Onboarding/test_data_generation_configurations.json +29 -0
  224. package/source/api-data-generators/support/Organization/test_data_generation_configurations.json +79 -0
  225. package/source/api-data-generators/support/PBGroup/test_data_generation_configurations.json +109 -0
  226. package/source/api-data-generators/support/PBGroupAgents/test_data_generation_configurations.json +66 -0
  227. package/source/api-data-generators/support/PBPlatform/test_data_generation_configurations.json +113 -0
  228. package/source/api-data-generators/support/PBX/test_data_generation_configurations.json +28 -0
  229. package/source/api-data-generators/support/PBXConfig/test_data_generation_configurations.json +17 -0
  230. package/source/api-data-generators/support/PBXPhoneNumbers/test_data_generation_configurations.json +54 -0
  231. package/source/api-data-generators/support/PBXPreference/test_data_generation_configurations.json +54 -0
  232. package/source/api-data-generators/support/PageSense/test_data_generation_configurations.json +77 -0
  233. package/source/api-data-generators/support/PendingApproval/test_data_generation_configurations.json +14 -0
  234. package/source/api-data-generators/support/Permalink/test_data_generation_configurations.json +32 -0
  235. package/source/api-data-generators/support/PhoneAgents/test_data_generation_configurations.json +66 -0
  236. package/source/api-data-generators/support/PinnedConversation/test_data_generation_configurations.json +64 -0
  237. package/source/api-data-generators/support/Pipeline_Service/test_data_generation_configurations.json +32 -0
  238. package/source/api-data-generators/support/Product/test_data_generation_configurations.json +196 -0
  239. package/source/api-data-generators/support/ProductAttachment/test_data_generation_configurations.json +48 -0
  240. package/source/api-data-generators/support/Profile/test_data_generation_configurations.json +59 -0
  241. package/source/api-data-generators/support/QueueView/test_data_generation_configurations.json +37 -0
  242. package/source/api-data-generators/support/Records/test_data_generation_configurations.json +239 -0
  243. package/source/api-data-generators/support/Recyclebin/test_data_generation_configurations.json +52 -0
  244. package/source/api-data-generators/support/RemoteAuth/test_data_generation_configurations.json +52 -0
  245. package/source/api-data-generators/support/Report/test_data_generation_configurations.json +538 -0
  246. package/source/api-data-generators/support/ReportChart/test_data_generation_configurations.json +28 -0
  247. package/source/api-data-generators/support/ReportFolder/test_data_generation_configurations.json +100 -0
  248. package/source/api-data-generators/support/Resources/test_data_generation_configurations.json +29 -0
  249. package/source/api-data-generators/support/Role/test_data_generation_configurations.json +84 -0
  250. package/source/api-data-generators/support/RoundRobin/test_data_generation_configurations.json +58 -0
  251. package/source/api-data-generators/support/RoundRobinTarget/test_data_generation_configurations.json +50 -0
  252. package/source/api-data-generators/support/RoutingPreference/test_data_generation_configurations.json +29 -0
  253. package/source/api-data-generators/support/SLAMetaInfo/test_data_generation_configurations.json +22 -0
  254. package/source/api-data-generators/support/Saml/test_data_generation_configurations.json +42 -0
  255. package/source/api-data-generators/support/Sandbox/test_data_generation_configurations.json +92 -0
  256. package/source/api-data-generators/support/SandboxChangeset/test_data_generation_configurations.json +46 -0
  257. package/source/api-data-generators/support/SandboxDeployment/test_data_generation_configurations.json +50 -0
  258. package/source/api-data-generators/support/SandboxDeploymentLogs/test_data_generation_configurations.json +22 -0
  259. package/source/api-data-generators/support/SavedFilters/test_data_generation_configurations.json +203 -0
  260. package/source/api-data-generators/support/Schedule/test_data_generation_configurations.json +172 -0
  261. package/source/api-data-generators/support/ScheduleReplyInfo/test_data_generation_configurations.json +182 -0
  262. package/source/api-data-generators/support/Search/test_data_generation_configurations.json +636 -0
  263. package/source/api-data-generators/support/SearchInteg/test_data_generation_configurations.json +32 -0
  264. package/source/api-data-generators/support/Setup/test_data_generation_configurations.json +32 -0
  265. package/source/api-data-generators/support/SharedSnippet/test_data_generation_configurations.json +62 -0
  266. package/source/api-data-generators/support/Signature/test_data_generation_configurations.json +24 -0
  267. package/source/api-data-generators/support/Skill/test_data_generation_configurations.json +164 -0
  268. package/source/api-data-generators/support/SkillConfiguration/test_data_generation_configurations.json +21 -0
  269. package/source/api-data-generators/support/SkillType/test_data_generation_configurations.json +60 -0
  270. package/source/api-data-generators/support/Slack/test_data_generation_configurations.json +51 -0
  271. package/source/api-data-generators/support/SmsTemplates/test_data_generation_configurations.json +40 -0
  272. package/source/api-data-generators/support/Snippets/test_data_generation_configurations.json +47 -0
  273. package/source/api-data-generators/support/SocialInteg/test_data_generation_configurations.json +22 -0
  274. package/source/api-data-generators/support/SocialPosts/test_data_generation_configurations.json +223 -0
  275. package/source/api-data-generators/support/SocialTwitterConversations/test_data_generation_configurations.json +22 -0
  276. package/source/api-data-generators/support/StarredTemplates/test_data_generation_configurations.json +76 -0
  277. package/source/api-data-generators/support/SubjectAccessRequest/test_data_generation_configurations.json +104 -0
  278. package/source/api-data-generators/support/Supervise/test_data_generation_configurations.json +43 -0
  279. package/source/api-data-generators/support/SupportPlan/test_data_generation_configurations.json +65 -0
  280. package/source/api-data-generators/support/Tab/test_data_generation_configurations.json +29 -0
  281. package/source/api-data-generators/support/Target/test_data_generation_configurations.json +97 -0
  282. package/source/api-data-generators/support/Task/test_data_generation_configurations.json +219 -0
  283. package/source/api-data-generators/support/TaskAttachment/test_data_generation_configurations.json +42 -0
  284. package/source/api-data-generators/support/TaskComments/test_data_generation_configurations.json +45 -0
  285. package/source/api-data-generators/support/TaskTimeEntry/test_data_generation_configurations.json +87 -0
  286. package/source/api-data-generators/support/TaskTimer/test_data_generation_configurations.json +27 -0
  287. package/source/api-data-generators/support/Team/test_data_generation_configurations.json +115 -0
  288. package/source/api-data-generators/support/TemplateFolders/test_data_generation_configurations.json +72 -0
  289. package/source/api-data-generators/support/Thread/test_data_generation_configurations.json +383 -0
  290. package/source/api-data-generators/support/Ticket/test_data_generation_configurations.json +694 -0
  291. package/source/api-data-generators/support/TicketApprovals/test_data_generation_configurations.json +66 -0
  292. package/source/api-data-generators/support/TicketAttachment/test_data_generation_configurations.json +58 -0
  293. package/source/api-data-generators/support/TicketComment/test_data_generation_configurations.json +82 -0
  294. package/source/api-data-generators/support/TicketCount/test_data_generation_configurations.json +43 -0
  295. package/source/api-data-generators/support/TicketFollowers/test_data_generation_configurations.json +65 -0
  296. package/source/api-data-generators/support/TicketMetrics/test_data_generation_configurations.json +16 -0
  297. package/source/api-data-generators/support/TicketTag/test_data_generation_configurations.json +99 -0
  298. package/source/api-data-generators/support/TicketTemplate/test_data_generation_configurations.json +475 -0
  299. package/source/api-data-generators/support/TicketTimeEntry/test_data_generation_configurations.json +110 -0
  300. package/source/api-data-generators/support/TicketTimer/test_data_generation_configurations.json +48 -0
  301. package/source/api-data-generators/support/TicketWithChildren/test_data_generation_configurations.json +91 -0
  302. package/source/api-data-generators/support/TimeTracking/test_data_generation_configurations.json +46 -0
  303. package/source/api-data-generators/support/TranslationLanguages/test_data_generation_configurations.json +68 -0
  304. package/source/api-data-generators/support/Upload/test_data_generation_configurations.json +54 -0
  305. package/source/api-data-generators/support/User/test_data_generation_configurations.json +100 -0
  306. package/source/api-data-generators/support/UserAuthentication/test_data_generation_configurations.json +49 -0
  307. package/source/api-data-generators/support/UserPresence/test_data_generation_configurations.json +19 -0
  308. package/source/api-data-generators/support/ValidationRuleCriteria/test_data_generation_configurations.json +19 -0
  309. package/source/api-data-generators/support/ValidationRules/test_data_generation_configurations.json +321 -0
  310. package/source/api-data-generators/support/Webhook/test_data_generation_configurations.json +501 -0
  311. package/source/api-data-generators/support/Widget/test_data_generation_configurations.json +166 -0
  312. package/source/api-data-generators/support/ZIAAnswerbotInference/test_data_generation_configurations.json +26 -0
  313. package/source/api-data-generators/support/ZIADocumentData/test_data_generation_configurations.json +38 -0
  314. package/source/api-data-generators/support/ZIAVectorSearch/test_data_generation_configurations.json +22 -0
  315. package/source/api-data-generators/support/ZiaGPT/test_data_generation_configurations.json +19 -0
  316. package/source/api-data-generators/support/ZiaScheduler/test_data_generation_configurations.json +22 -0
  317. package/source/api-data-generators/support/ZiapoweredbyGPT/test_data_generation_configurations.json +33 -0
  318. package/source/api-data-generators/support/Zwitch/test_data_generation_configurations.json +71 -0
  319. package/source/api-data-generators/support/blueprintDrafts/test_data_generation_configurations.json +859 -0
  320. package/source/api-data-generators/support/blueprintTransitions/test_data_generation_configurations.json +26 -0
  321. package/source/api-data-generators/support/blueprints/test_data_generation_configurations.json +652 -0
  322. package/source/api-data-generators/support/borrow_book/test_data_generation_configurations.json +21 -0
  323. package/source/api-data-generators/support/zlabsnlp/test_data_generation_configurations.json +50 -0
  324. package/source/openapi-specifications/v1.0/common/Common.json +587 -0
  325. package/source/openapi-specifications/v1.0/portal/Account.json +183 -0
  326. package/source/openapi-specifications/v1.0/portal/ArticleComment.json +1103 -0
  327. package/source/openapi-specifications/v1.0/portal/ArticleFeedback.json +133 -0
  328. package/source/openapi-specifications/v1.0/portal/AsapMobile.json +712 -0
  329. package/source/openapi-specifications/v1.0/portal/AsapWeb.json +91 -0
  330. package/source/openapi-specifications/v1.0/portal/Attachment.json +122 -0
  331. package/source/openapi-specifications/v1.0/portal/Captcha.json +334 -0
  332. package/source/openapi-specifications/v1.0/portal/Category.json +1061 -0
  333. package/source/openapi-specifications/v1.0/portal/Comment.json +1546 -0
  334. package/source/openapi-specifications/v1.0/portal/Community.json +235 -0
  335. package/source/openapi-specifications/v1.0/portal/CommunityUser.json +296 -0
  336. package/source/openapi-specifications/v1.0/portal/Contact.json +536 -0
  337. package/source/openapi-specifications/v1.0/portal/CustomerHappiness.json +163 -0
  338. package/source/openapi-specifications/v1.0/portal/Department.json +246 -0
  339. package/source/openapi-specifications/v1.0/portal/Extension.json +1122 -0
  340. package/source/openapi-specifications/v1.0/portal/FeedbackWidget.json +96 -0
  341. package/source/openapi-specifications/v1.0/portal/Field.json +1239 -0
  342. package/source/openapi-specifications/v1.0/portal/FileExport.json +313 -0
  343. package/source/openapi-specifications/v1.0/portal/Followers.json +802 -0
  344. package/source/openapi-specifications/v1.0/portal/Gamification.json +819 -0
  345. package/source/openapi-specifications/v1.0/portal/HashTags.json +61 -0
  346. package/source/openapi-specifications/v1.0/portal/HelpCenterUser.json +605 -0
  347. package/source/openapi-specifications/v1.0/portal/HelpCenterUserPreference.json +148 -0
  348. package/source/openapi-specifications/v1.0/portal/Helpcenter.json +920 -0
  349. package/source/openapi-specifications/v1.0/portal/HelpcenterGroups.json +118 -0
  350. package/source/openapi-specifications/v1.0/portal/HelpcenterPages.json +184 -0
  351. package/source/openapi-specifications/v1.0/portal/KBCategoryTranslation.json +70 -0
  352. package/source/openapi-specifications/v1.0/portal/KBRootCategory.json +1310 -0
  353. package/source/openapi-specifications/v1.0/portal/KbCategory.json +1525 -0
  354. package/source/openapi-specifications/v1.0/portal/KbSection.json +515 -0
  355. package/source/openapi-specifications/v1.0/portal/Label.json +172 -0
  356. package/source/openapi-specifications/v1.0/portal/Layout.json +303 -0
  357. package/source/openapi-specifications/v1.0/portal/LayoutRules.json +375 -0
  358. package/source/openapi-specifications/v1.0/portal/Mentions.json +580 -0
  359. package/source/openapi-specifications/v1.0/portal/NewAsapMobile.json +699 -0
  360. package/source/openapi-specifications/v1.0/portal/Permalink.json +265 -0
  361. package/source/openapi-specifications/v1.0/portal/Placeholders.json +57 -0
  362. package/source/openapi-specifications/v1.0/portal/Product.json +401 -0
  363. package/source/openapi-specifications/v1.0/portal/Solution.json +3766 -0
  364. package/source/openapi-specifications/v1.0/portal/Thread.json +821 -0
  365. package/source/openapi-specifications/v1.0/portal/Ticket.json +2636 -0
  366. package/source/openapi-specifications/v1.0/portal/TicketComment.json +822 -0
  367. package/source/openapi-specifications/v1.0/portal/TicketCount.json +336 -0
  368. package/source/openapi-specifications/v1.0/portal/TicketExport.json +609 -0
  369. package/source/openapi-specifications/v1.0/portal/TicketField.json +358 -0
  370. package/source/openapi-specifications/v1.0/portal/TicketForm.json +517 -0
  371. package/source/openapi-specifications/v1.0/portal/TicketStatusMapping.json +155 -0
  372. package/source/openapi-specifications/v1.0/portal/TicketTemplate.json +409 -0
  373. package/source/openapi-specifications/v1.0/portal/TicketsViewCount.json +175 -0
  374. package/source/openapi-specifications/v1.0/portal/Topic.json +4079 -0
  375. package/source/openapi-specifications/v1.0/portal/Translation.json +174 -0
  376. package/source/openapi-specifications/v1.0/portal/Upload.json +156 -0
  377. package/source/openapi-specifications/v1.0/portal/ValidationRules.json +309 -0
  378. package/source/openapi-specifications/v1.0/portal/View.json +353 -0
  379. package/source/openapi-specifications/v1.0/portal/Widget.json +218 -0
  380. package/source/openapi-specifications/v1.0/support/AEAdminTool.json +354 -0
  381. package/source/openapi-specifications/v1.0/support/Account.json +3206 -0
  382. package/source/openapi-specifications/v1.0/support/AccountAttachment.json +484 -0
  383. package/source/openapi-specifications/v1.0/support/AccountComments.json +794 -0
  384. package/source/openapi-specifications/v1.0/support/AccountContactMappingInfo.json +227 -0
  385. package/source/openapi-specifications/v1.0/support/AccountDeduplication.json +578 -0
  386. package/source/openapi-specifications/v1.0/support/AccountFollowers.json +350 -0
  387. package/source/openapi-specifications/v1.0/support/AccountSla.json +341 -0
  388. package/source/openapi-specifications/v1.0/support/AccountTimeEntry.json +1152 -0
  389. package/source/openapi-specifications/v1.0/support/ActiveCalls.json +573 -0
  390. package/source/openapi-specifications/v1.0/support/Activity.json +1400 -0
  391. package/source/openapi-specifications/v1.0/support/Actor.json +88 -0
  392. package/source/openapi-specifications/v1.0/support/ActorsAPI.json +304 -0
  393. package/source/openapi-specifications/v1.0/support/AdminTool.json +489 -0
  394. package/source/openapi-specifications/v1.0/support/Agent.json +6685 -0
  395. package/source/openapi-specifications/v1.0/support/AgentPresence.json +567 -0
  396. package/source/openapi-specifications/v1.0/support/AgentRoom.json +1997 -0
  397. package/source/openapi-specifications/v1.0/support/AgentSignatures.json +359 -0
  398. package/source/openapi-specifications/v1.0/support/AgentTimeEntry.json +1402 -0
  399. package/source/openapi-specifications/v1.0/support/AntiSpamInfo.json +510 -0
  400. package/source/openapi-specifications/v1.0/support/ApiCreditNotificationRule.json +1189 -0
  401. package/source/openapi-specifications/v1.0/support/ApiDashboard.json +543 -0
  402. package/source/openapi-specifications/v1.0/support/ApplicationFlags.json +155 -0
  403. package/source/openapi-specifications/v1.0/support/ArchivedView.json +469 -0
  404. package/source/openapi-specifications/v1.0/support/Article.json +5060 -0
  405. package/source/openapi-specifications/v1.0/support/ArticleAttachment.json +544 -0
  406. package/source/openapi-specifications/v1.0/support/ArticleComment.json +1929 -0
  407. package/source/openapi-specifications/v1.0/support/ArticleExternalImageUrlResponse.json +56 -0
  408. package/source/openapi-specifications/v1.0/support/ArticleFeedback.json +1314 -0
  409. package/source/openapi-specifications/v1.0/support/ArticleFeedbackResolution.json +513 -0
  410. package/source/openapi-specifications/v1.0/support/ArticleHistory.json +2510 -0
  411. package/source/openapi-specifications/v1.0/support/ArticleStatistics.json +3053 -0
  412. package/source/openapi-specifications/v1.0/support/ArticleTranslation.json +7530 -0
  413. package/source/openapi-specifications/v1.0/support/ArticleVersion.json +184 -0
  414. package/source/openapi-specifications/v1.0/support/ArticleViews.json +564 -0
  415. package/source/openapi-specifications/v1.0/support/Asap.json +1525 -0
  416. package/source/openapi-specifications/v1.0/support/AsapModule.json +246 -0
  417. package/source/openapi-specifications/v1.0/support/AsapStatus.json +199 -0
  418. package/source/openapi-specifications/v1.0/support/AssistInteg.json +613 -0
  419. package/source/openapi-specifications/v1.0/support/AttachmentRestriction.json +786 -0
  420. package/source/openapi-specifications/v1.0/support/AuditLog.json +1122 -0
  421. package/source/openapi-specifications/v1.0/support/AutomatedSummaryForChats.json +702 -0
  422. package/source/openapi-specifications/v1.0/support/AutomationAlerts.json +868 -0
  423. package/source/openapi-specifications/v1.0/support/AutomationEngine.json +1181 -0
  424. package/source/openapi-specifications/v1.0/support/AutomationFeatureCount.json +207 -0
  425. package/source/openapi-specifications/v1.0/support/AutomationFieldUpdates.json +809 -0
  426. package/source/openapi-specifications/v1.0/support/AutomationTask.json +1054 -0
  427. package/source/openapi-specifications/v1.0/support/Backup.json +2845 -0
  428. package/source/openapi-specifications/v1.0/support/Badge.json +544 -0
  429. package/source/openapi-specifications/v1.0/support/Bot.json +2103 -0
  430. package/source/openapi-specifications/v1.0/support/BotInference.json +1071 -0
  431. package/source/openapi-specifications/v1.0/support/BotResources.json +175 -0
  432. package/source/openapi-specifications/v1.0/support/BotStaticResources.json +541 -0
  433. package/source/openapi-specifications/v1.0/support/Bot_UserInfo.json +63 -0
  434. package/source/openapi-specifications/v1.0/support/Bots.json +58 -0
  435. package/source/openapi-specifications/v1.0/support/BugInteg.json +481 -0
  436. package/source/openapi-specifications/v1.0/support/BulkAction.json +150 -0
  437. package/source/openapi-specifications/v1.0/support/BulkImport.json +2845 -0
  438. package/source/openapi-specifications/v1.0/support/BulkUpdate.json +743 -0
  439. package/source/openapi-specifications/v1.0/support/BulkWrite.json +678 -0
  440. package/source/openapi-specifications/v1.0/support/BusinessHour.json +1344 -0
  441. package/source/openapi-specifications/v1.0/support/Call.json +3839 -0
  442. package/source/openapi-specifications/v1.0/support/CallComments.json +721 -0
  443. package/source/openapi-specifications/v1.0/support/CallHistory.json +936 -0
  444. package/source/openapi-specifications/v1.0/support/CallTimeEntry.json +1745 -0
  445. package/source/openapi-specifications/v1.0/support/CallTimer.json +285 -0
  446. package/source/openapi-specifications/v1.0/support/Channel.json +730 -0
  447. package/source/openapi-specifications/v1.0/support/Chart.json +422 -0
  448. package/source/openapi-specifications/v1.0/support/ChatTicket.json +553 -0
  449. package/source/openapi-specifications/v1.0/support/ClientAction.json +1834 -0
  450. package/source/openapi-specifications/v1.0/support/ClientEvent.json +780 -0
  451. package/source/openapi-specifications/v1.0/support/CliqIntegJsonMapping.json +1123 -0
  452. package/source/openapi-specifications/v1.0/support/CloudAttachment.json +528 -0
  453. package/source/openapi-specifications/v1.0/support/CommonMassActionError.json +44 -0
  454. package/source/openapi-specifications/v1.0/support/CommonMassActionResponse.json +94 -0
  455. package/source/openapi-specifications/v1.0/support/Community.json +2545 -0
  456. package/source/openapi-specifications/v1.0/support/CommunityAttachment.json +249 -0
  457. package/source/openapi-specifications/v1.0/support/CommunityCategory.json +1896 -0
  458. package/source/openapi-specifications/v1.0/support/CommunityCategoryLogo.json +145 -0
  459. package/source/openapi-specifications/v1.0/support/CommunityComment.json +2492 -0
  460. package/source/openapi-specifications/v1.0/support/CommunityInitPermissions.json +129 -0
  461. package/source/openapi-specifications/v1.0/support/CommunityPreferences.json +343 -0
  462. package/source/openapi-specifications/v1.0/support/CommunitySearch.json +78 -0
  463. package/source/openapi-specifications/v1.0/support/CommunityTopic.json +6005 -0
  464. package/source/openapi-specifications/v1.0/support/CommunityTopicInsights.json +310 -0
  465. package/source/openapi-specifications/v1.0/support/CommunityUser.json +822 -0
  466. package/source/openapi-specifications/v1.0/support/Composite.json +414 -0
  467. package/source/openapi-specifications/v1.0/support/Contact.json +4691 -0
  468. package/source/openapi-specifications/v1.0/support/ContactAttachment.json +484 -0
  469. package/source/openapi-specifications/v1.0/support/ContactComments.json +769 -0
  470. package/source/openapi-specifications/v1.0/support/ContactDeduplication.json +683 -0
  471. package/source/openapi-specifications/v1.0/support/ContactFollowers.json +350 -0
  472. package/source/openapi-specifications/v1.0/support/ContactProfile.json +195 -0
  473. package/source/openapi-specifications/v1.0/support/ContactTimeEntry.json +1157 -0
  474. package/source/openapi-specifications/v1.0/support/Contract.json +2877 -0
  475. package/source/openapi-specifications/v1.0/support/ContractAttachment.json +307 -0
  476. package/source/openapi-specifications/v1.0/support/Conversation.json +570 -0
  477. package/source/openapi-specifications/v1.0/support/CountriesAndLanguages.json +5279 -0
  478. package/source/openapi-specifications/v1.0/support/CreditCycle.json +124 -0
  479. package/source/openapi-specifications/v1.0/support/Criteria.json +1014 -0
  480. package/source/openapi-specifications/v1.0/support/CriteriaValue.json +50 -0
  481. package/source/openapi-specifications/v1.0/support/CrmInteg.json +5938 -0
  482. package/source/openapi-specifications/v1.0/support/CustomAction.json +2106 -0
  483. package/source/openapi-specifications/v1.0/support/CustomActionRuleMapping.json +1327 -0
  484. package/source/openapi-specifications/v1.0/support/CustomButton.json +1898 -0
  485. package/source/openapi-specifications/v1.0/support/CustomFunctionExecutionLogs.json +883 -0
  486. package/source/openapi-specifications/v1.0/support/CustomFunctionGallery.json +329 -0
  487. package/source/openapi-specifications/v1.0/support/CustomFunctionReRun.json +317 -0
  488. package/source/openapi-specifications/v1.0/support/CustomFunctionZiaCopilot.json +379 -0
  489. package/source/openapi-specifications/v1.0/support/CustomFunctions.json +3457 -0
  490. package/source/openapi-specifications/v1.0/support/CustomModuleAdminTool.json +81 -0
  491. package/source/openapi-specifications/v1.0/support/CustomTheme.json +7391 -0
  492. package/source/openapi-specifications/v1.0/support/CustomView.json +3478 -0
  493. package/source/openapi-specifications/v1.0/support/CustomerHappiness.json +464 -0
  494. package/source/openapi-specifications/v1.0/support/DBThrottle.json +334 -0
  495. package/source/openapi-specifications/v1.0/support/DashboardComponent.json +1163 -0
  496. package/source/openapi-specifications/v1.0/support/DashboardFolder.json +1258 -0
  497. package/source/openapi-specifications/v1.0/support/DashboardMetrics.json +2310 -0
  498. package/source/openapi-specifications/v1.0/support/Dashboards.json +1219 -0
  499. package/source/openapi-specifications/v1.0/support/DataChips.json +477 -0
  500. package/source/openapi-specifications/v1.0/support/DataImport.json +1099 -0
  501. package/source/openapi-specifications/v1.0/support/DataSync.json +1246 -0
  502. package/source/openapi-specifications/v1.0/support/DatasetEntry.json +153 -0
  503. package/source/openapi-specifications/v1.0/support/Department.json +1971 -0
  504. package/source/openapi-specifications/v1.0/support/DependencyMappings.json +656 -0
  505. package/source/openapi-specifications/v1.0/support/DirectAssignRuleTarget.json +232 -0
  506. package/source/openapi-specifications/v1.0/support/DirectAssignmentRules.json +722 -0
  507. package/source/openapi-specifications/v1.0/support/DisplayEntity.json +91 -0
  508. package/source/openapi-specifications/v1.0/support/DomainMapping.json +1143 -0
  509. package/source/openapi-specifications/v1.0/support/EmailFailureAlert.json +306 -0
  510. package/source/openapi-specifications/v1.0/support/EmailTemplates.json +1491 -0
  511. package/source/openapi-specifications/v1.0/support/EntityBlueprints.json +572 -0
  512. package/source/openapi-specifications/v1.0/support/Event.json +3607 -0
  513. package/source/openapi-specifications/v1.0/support/EventComments.json +737 -0
  514. package/source/openapi-specifications/v1.0/support/EventTimeEntry.json +1520 -0
  515. package/source/openapi-specifications/v1.0/support/EventTimer.json +285 -0
  516. package/source/openapi-specifications/v1.0/support/Expression.json +43 -0
  517. package/source/openapi-specifications/v1.0/support/Extension.json +7152 -0
  518. package/source/openapi-specifications/v1.0/support/ExtensionOrg.json +129 -0
  519. package/source/openapi-specifications/v1.0/support/FAQ.json +142 -0
  520. package/source/openapi-specifications/v1.0/support/FAQTranslation.json +178 -0
  521. package/source/openapi-specifications/v1.0/support/FbManager.json +1147 -0
  522. package/source/openapi-specifications/v1.0/support/Feature.json +691 -0
  523. package/source/openapi-specifications/v1.0/support/FeatureFile.json +435 -0
  524. package/source/openapi-specifications/v1.0/support/FeatureFolder.json +576 -0
  525. package/source/openapi-specifications/v1.0/support/FeaturePermission.json +492 -0
  526. package/source/openapi-specifications/v1.0/support/FederatedLogin.json +318 -0
  527. package/source/openapi-specifications/v1.0/support/FeedsAPIs.json +198 -0
  528. package/source/openapi-specifications/v1.0/support/Field.json +7493 -0
  529. package/source/openapi-specifications/v1.0/support/FieldDetails.json +139 -0
  530. package/source/openapi-specifications/v1.0/support/FieldPermissions.json +113 -0
  531. package/source/openapi-specifications/v1.0/support/FieldPrediction.json +3831 -0
  532. package/source/openapi-specifications/v1.0/support/FileExport.json +324 -0
  533. package/source/openapi-specifications/v1.0/support/Finance.json +4290 -0
  534. package/source/openapi-specifications/v1.0/support/Followers.json +875 -0
  535. package/source/openapi-specifications/v1.0/support/FormulaFunctions.json +47 -0
  536. package/source/openapi-specifications/v1.0/support/GC_Bots.json +138 -0
  537. package/source/openapi-specifications/v1.0/support/GC_Guide.json +1536 -0
  538. package/source/openapi-specifications/v1.0/support/GC_GuideHistories.json +58 -0
  539. package/source/openapi-specifications/v1.0/support/GC_GuideHistory.json +79 -0
  540. package/source/openapi-specifications/v1.0/support/GC_Guides.json +89 -0
  541. package/source/openapi-specifications/v1.0/support/GC_Info.json +208 -0
  542. package/source/openapi-specifications/v1.0/support/GC_Status.json +69 -0
  543. package/source/openapi-specifications/v1.0/support/GC_UserInfo.json +79 -0
  544. package/source/openapi-specifications/v1.0/support/GenericAction.json +1888 -0
  545. package/source/openapi-specifications/v1.0/support/GenericActionMapping.json +1050 -0
  546. package/source/openapi-specifications/v1.0/support/GoogleAnalytics.json +1715 -0
  547. package/source/openapi-specifications/v1.0/support/GoogleChat.json +650 -0
  548. package/source/openapi-specifications/v1.0/support/HelpCenterCommon.json +44 -0
  549. package/source/openapi-specifications/v1.0/support/Help_Center_OIDC_Authentication.json +900 -0
  550. package/source/openapi-specifications/v1.0/support/Helpcenter.json +1212 -0
  551. package/source/openapi-specifications/v1.0/support/HelpcenterAutoTranslateSetting.json +331 -0
  552. package/source/openapi-specifications/v1.0/support/HelpcenterGroups.json +1496 -0
  553. package/source/openapi-specifications/v1.0/support/HelpcenterPages.json +504 -0
  554. package/source/openapi-specifications/v1.0/support/HelpcenterPreference.json +208 -0
  555. package/source/openapi-specifications/v1.0/support/HelpcenterTranslationApp.json +64 -0
  556. package/source/openapi-specifications/v1.0/support/HelpcenterUpload.json +211 -0
  557. package/source/openapi-specifications/v1.0/support/HolidayList.json +731 -0
  558. package/source/openapi-specifications/v1.0/support/IMAPAddress.json +1091 -0
  559. package/source/openapi-specifications/v1.0/support/IMCannedMessage.json +1357 -0
  560. package/source/openapi-specifications/v1.0/support/IMCannedMessagePlaceHolders.json +169 -0
  561. package/source/openapi-specifications/v1.0/support/IMCannedMessageTranslation.json +624 -0
  562. package/source/openapi-specifications/v1.0/support/IMTemplateMessage.json +597 -0
  563. package/source/openapi-specifications/v1.0/support/IM_AddOn.json +841 -0
  564. package/source/openapi-specifications/v1.0/support/IM_AttachmentMessage.json +64 -0
  565. package/source/openapi-specifications/v1.0/support/IM_Bot.json +1007 -0
  566. package/source/openapi-specifications/v1.0/support/IM_BotService.json +357 -0
  567. package/source/openapi-specifications/v1.0/support/IM_Broadcast.json +323 -0
  568. package/source/openapi-specifications/v1.0/support/IM_Channel.json +2849 -0
  569. package/source/openapi-specifications/v1.0/support/IM_ChannelPreference.json +502 -0
  570. package/source/openapi-specifications/v1.0/support/IM_Contact.json +165 -0
  571. package/source/openapi-specifications/v1.0/support/IM_Efc.json +188 -0
  572. package/source/openapi-specifications/v1.0/support/IM_Integration.json +1269 -0
  573. package/source/openapi-specifications/v1.0/support/IM_IntegrationService.json +454 -0
  574. package/source/openapi-specifications/v1.0/support/IM_LayoutView.json +625 -0
  575. package/source/openapi-specifications/v1.0/support/IM_License.json +225 -0
  576. package/source/openapi-specifications/v1.0/support/IM_Message.json +1371 -0
  577. package/source/openapi-specifications/v1.0/support/IM_Metrics.json +462 -0
  578. package/source/openapi-specifications/v1.0/support/IM_Search.json +547 -0
  579. package/source/openapi-specifications/v1.0/support/IM_Session.json +1397 -0
  580. package/source/openapi-specifications/v1.0/support/IM_TemplateButton.json +142 -0
  581. package/source/openapi-specifications/v1.0/support/IM_TemplateFooter.json +83 -0
  582. package/source/openapi-specifications/v1.0/support/IM_TemplateHeader.json +86 -0
  583. package/source/openapi-specifications/v1.0/support/IM_TemplateItems.json +73 -0
  584. package/source/openapi-specifications/v1.0/support/IM_TimeSeriesMetrics.json +435 -0
  585. package/source/openapi-specifications/v1.0/support/IM_TwilioPhoneNumber.json +202 -0
  586. package/source/openapi-specifications/v1.0/support/IM_WhatsApp_Integrations.json +193 -0
  587. package/source/openapi-specifications/v1.0/support/IM_ZiaGpt.json +489 -0
  588. package/source/openapi-specifications/v1.0/support/Import.json +1844 -0
  589. package/source/openapi-specifications/v1.0/support/IncrementalDocuments.json +395 -0
  590. package/source/openapi-specifications/v1.0/support/Inference.json +307 -0
  591. package/source/openapi-specifications/v1.0/support/InlineImage.json +97 -0
  592. package/source/openapi-specifications/v1.0/support/IntegModule.json +938 -0
  593. package/source/openapi-specifications/v1.0/support/Integrations.json +1264 -0
  594. package/source/openapi-specifications/v1.0/support/InteractiveTours.json +539 -0
  595. package/source/openapi-specifications/v1.0/support/JWT.json +535 -0
  596. package/source/openapi-specifications/v1.0/support/KBCategoryPermalink.json +208 -0
  597. package/source/openapi-specifications/v1.0/support/KBCategoryUser.json +241 -0
  598. package/source/openapi-specifications/v1.0/support/KBPreference.json +323 -0
  599. package/source/openapi-specifications/v1.0/support/KBRecycleBin.json +2316 -0
  600. package/source/openapi-specifications/v1.0/support/KBRootCategory.json +2839 -0
  601. package/source/openapi-specifications/v1.0/support/KBRootCategoryTranslation.json +570 -0
  602. package/source/openapi-specifications/v1.0/support/KBSection.json +1941 -0
  603. package/source/openapi-specifications/v1.0/support/KBTranslationMassActionResponse.json +169 -0
  604. package/source/openapi-specifications/v1.0/support/KPIWidget.json +206 -0
  605. package/source/openapi-specifications/v1.0/support/KbBot.json +511 -0
  606. package/source/openapi-specifications/v1.0/support/KbCategory.json +1618 -0
  607. package/source/openapi-specifications/v1.0/support/KbCategoryLogo.json +124 -0
  608. package/source/openapi-specifications/v1.0/support/Label.json +1251 -0
  609. package/source/openapi-specifications/v1.0/support/Layout.json +8042 -0
  610. package/source/openapi-specifications/v1.0/support/LayoutRuleCriteria.json +491 -0
  611. package/source/openapi-specifications/v1.0/support/LayoutRules.json +1422 -0
  612. package/source/openapi-specifications/v1.0/support/LensInteg.json +86 -0
  613. package/source/openapi-specifications/v1.0/support/LicenseFeaturePlan.json +548 -0
  614. package/source/openapi-specifications/v1.0/support/LicenseInfo.json +1231 -0
  615. package/source/openapi-specifications/v1.0/support/LicenseTool.json +165 -0
  616. package/source/openapi-specifications/v1.0/support/Livecall.json +954 -0
  617. package/source/openapi-specifications/v1.0/support/LookupRecord.json +174 -0
  618. package/source/openapi-specifications/v1.0/support/Macros.json +1960 -0
  619. package/source/openapi-specifications/v1.0/support/MailReplyAddress.json +1263 -0
  620. package/source/openapi-specifications/v1.0/support/MassAction.json +1151 -0
  621. package/source/openapi-specifications/v1.0/support/MassActionError.json +55 -0
  622. package/source/openapi-specifications/v1.0/support/MassActionResponse.json +89 -0
  623. package/source/openapi-specifications/v1.0/support/Mentions.json +491 -0
  624. package/source/openapi-specifications/v1.0/support/Message.json +685 -0
  625. package/source/openapi-specifications/v1.0/support/Microsoft.json +887 -0
  626. package/source/openapi-specifications/v1.0/support/MicrosoftTeams.json +574 -0
  627. package/source/openapi-specifications/v1.0/support/Microsoft_PowerBI.json +903 -0
  628. package/source/openapi-specifications/v1.0/support/Misc.json +214 -0
  629. package/source/openapi-specifications/v1.0/support/Module.json +1625 -0
  630. package/source/openapi-specifications/v1.0/support/NewCriteria.json +1863 -0
  631. package/source/openapi-specifications/v1.0/support/NewFeatureFields.json +204 -0
  632. package/source/openapi-specifications/v1.0/support/NewTicketHistory.json +150 -0
  633. package/source/openapi-specifications/v1.0/support/NotificationRules.json +441 -0
  634. package/source/openapi-specifications/v1.0/support/OEmbedData.json +233 -0
  635. package/source/openapi-specifications/v1.0/support/Onboarding.json +282 -0
  636. package/source/openapi-specifications/v1.0/support/Organization.json +1391 -0
  637. package/source/openapi-specifications/v1.0/support/PBGroup.json +634 -0
  638. package/source/openapi-specifications/v1.0/support/PBGroupAgents.json +433 -0
  639. package/source/openapi-specifications/v1.0/support/PBPlatform.json +1447 -0
  640. package/source/openapi-specifications/v1.0/support/PBX.json +550 -0
  641. package/source/openapi-specifications/v1.0/support/PBXConfig.json +219 -0
  642. package/source/openapi-specifications/v1.0/support/PBXPhoneNumbers.json +443 -0
  643. package/source/openapi-specifications/v1.0/support/PBXPreference.json +314 -0
  644. package/source/openapi-specifications/v1.0/support/PageSense.json +1505 -0
  645. package/source/openapi-specifications/v1.0/support/PendingApproval.json +279 -0
  646. package/source/openapi-specifications/v1.0/support/Permalink.json +393 -0
  647. package/source/openapi-specifications/v1.0/support/PhoneAgents.json +1014 -0
  648. package/source/openapi-specifications/v1.0/support/PhoneMenu.json +118 -0
  649. package/source/openapi-specifications/v1.0/support/PinnedConversation.json +1115 -0
  650. package/source/openapi-specifications/v1.0/support/Pipeline_Info.json +232 -0
  651. package/source/openapi-specifications/v1.0/support/Pipeline_Service.json +499 -0
  652. package/source/openapi-specifications/v1.0/support/Product.json +1861 -0
  653. package/source/openapi-specifications/v1.0/support/ProductAttachment.json +485 -0
  654. package/source/openapi-specifications/v1.0/support/Profile.json +4236 -0
  655. package/source/openapi-specifications/v1.0/support/ProjectsInteg.json +989 -0
  656. package/source/openapi-specifications/v1.0/support/QueryStore.json +238 -0
  657. package/source/openapi-specifications/v1.0/support/QueueView.json +335 -0
  658. package/source/openapi-specifications/v1.0/support/RatelimitAdminTool.json +1204 -0
  659. package/source/openapi-specifications/v1.0/support/Records.json +1509 -0
  660. package/source/openapi-specifications/v1.0/support/Recyclebin.json +669 -0
  661. package/source/openapi-specifications/v1.0/support/RemoteAuth.json +401 -0
  662. package/source/openapi-specifications/v1.0/support/Report.json +6491 -0
  663. package/source/openapi-specifications/v1.0/support/ReportChart.json +254 -0
  664. package/source/openapi-specifications/v1.0/support/ReportFolder.json +1076 -0
  665. package/source/openapi-specifications/v1.0/support/ReportIntegration.json +202 -0
  666. package/source/openapi-specifications/v1.0/support/RequestFlags.json +358 -0
  667. package/source/openapi-specifications/v1.0/support/Resources.json +335 -0
  668. package/source/openapi-specifications/v1.0/support/ResponseHelpCenterUser.json +128 -0
  669. package/source/openapi-specifications/v1.0/support/Role.json +996 -0
  670. package/source/openapi-specifications/v1.0/support/RoundRobin.json +796 -0
  671. package/source/openapi-specifications/v1.0/support/RoundRobinTarget.json +381 -0
  672. package/source/openapi-specifications/v1.0/support/RoutingPreference.json +615 -0
  673. package/source/openapi-specifications/v1.0/support/RuleGroup.json +1630 -0
  674. package/source/openapi-specifications/v1.0/support/SLAMetaInfo.json +227 -0
  675. package/source/openapi-specifications/v1.0/support/Saml.json +565 -0
  676. package/source/openapi-specifications/v1.0/support/Sandbox.json +1075 -0
  677. package/source/openapi-specifications/v1.0/support/SandboxChangeset.json +501 -0
  678. package/source/openapi-specifications/v1.0/support/SandboxDeployment.json +428 -0
  679. package/source/openapi-specifications/v1.0/support/SandboxDeploymentLogs.json +295 -0
  680. package/source/openapi-specifications/v1.0/support/SandboxSourceOrganization.json +268 -0
  681. package/source/openapi-specifications/v1.0/support/SavedFilters.json +652 -0
  682. package/source/openapi-specifications/v1.0/support/Schedule.json +2077 -0
  683. package/source/openapi-specifications/v1.0/support/ScheduleReplyInfo.json +2271 -0
  684. package/source/openapi-specifications/v1.0/support/Search.json +12600 -0
  685. package/source/openapi-specifications/v1.0/support/SearchInteg.json +2254 -0
  686. package/source/openapi-specifications/v1.0/support/Setup.json +1766 -0
  687. package/source/openapi-specifications/v1.0/support/SharedSnippet.json +1110 -0
  688. package/source/openapi-specifications/v1.0/support/SharingRule.json +287 -0
  689. package/source/openapi-specifications/v1.0/support/Signature.json +354 -0
  690. package/source/openapi-specifications/v1.0/support/Skill.json +2164 -0
  691. package/source/openapi-specifications/v1.0/support/SkillConfiguration.json +269 -0
  692. package/source/openapi-specifications/v1.0/support/SkillType.json +807 -0
  693. package/source/openapi-specifications/v1.0/support/Slack.json +957 -0
  694. package/source/openapi-specifications/v1.0/support/SmsTemplates.json +514 -0
  695. package/source/openapi-specifications/v1.0/support/Snippets.json +918 -0
  696. package/source/openapi-specifications/v1.0/support/SocialBrands.json +427 -0
  697. package/source/openapi-specifications/v1.0/support/SocialInteg.json +336 -0
  698. package/source/openapi-specifications/v1.0/support/SocialPosts.json +2460 -0
  699. package/source/openapi-specifications/v1.0/support/SocialTwitterConversations.json +337 -0
  700. package/source/openapi-specifications/v1.0/support/StarredTemplates.json +690 -0
  701. package/source/openapi-specifications/v1.0/support/Statistics.json +125 -0
  702. package/source/openapi-specifications/v1.0/support/SubjectAccessRequest.json +2419 -0
  703. package/source/openapi-specifications/v1.0/support/Supervise.json +774 -0
  704. package/source/openapi-specifications/v1.0/support/SupportEmailAddress.json +188 -0
  705. package/source/openapi-specifications/v1.0/support/SupportEmailDomain.json +293 -0
  706. package/source/openapi-specifications/v1.0/support/SupportPlan.json +1109 -0
  707. package/source/openapi-specifications/v1.0/support/Tab.json +606 -0
  708. package/source/openapi-specifications/v1.0/support/Target.json +1311 -0
  709. package/source/openapi-specifications/v1.0/support/TargetFunctions.json +130 -0
  710. package/source/openapi-specifications/v1.0/support/Task.json +4006 -0
  711. package/source/openapi-specifications/v1.0/support/TaskAttachment.json +443 -0
  712. package/source/openapi-specifications/v1.0/support/TaskComments.json +706 -0
  713. package/source/openapi-specifications/v1.0/support/TaskTimeEntry.json +1756 -0
  714. package/source/openapi-specifications/v1.0/support/TaskTimer.json +441 -0
  715. package/source/openapi-specifications/v1.0/support/Team.json +1383 -0
  716. package/source/openapi-specifications/v1.0/support/TemplateFolders.json +1069 -0
  717. package/source/openapi-specifications/v1.0/support/Theme.json +152 -0
  718. package/source/openapi-specifications/v1.0/support/Thread.json +3545 -0
  719. package/source/openapi-specifications/v1.0/support/Ticket.json +9495 -0
  720. package/source/openapi-specifications/v1.0/support/TicketApprovals.json +855 -0
  721. package/source/openapi-specifications/v1.0/support/TicketAttachment.json +562 -0
  722. package/source/openapi-specifications/v1.0/support/TicketComment.json +1444 -0
  723. package/source/openapi-specifications/v1.0/support/TicketCount.json +690 -0
  724. package/source/openapi-specifications/v1.0/support/TicketFollowers.json +454 -0
  725. package/source/openapi-specifications/v1.0/support/TicketHistory.json +414 -0
  726. package/source/openapi-specifications/v1.0/support/TicketMetrics.json +369 -0
  727. package/source/openapi-specifications/v1.0/support/TicketRealTime.json +178 -0
  728. package/source/openapi-specifications/v1.0/support/TicketTag.json +1513 -0
  729. package/source/openapi-specifications/v1.0/support/TicketTemplate.json +907 -0
  730. package/source/openapi-specifications/v1.0/support/TicketTimeEntry.json +1681 -0
  731. package/source/openapi-specifications/v1.0/support/TicketTimer.json +1205 -0
  732. package/source/openapi-specifications/v1.0/support/TimeTracking.json +1212 -0
  733. package/source/openapi-specifications/v1.0/support/TrainingCourses.json +614 -0
  734. package/source/openapi-specifications/v1.0/support/TrainingIntegration.json +163 -0
  735. package/source/openapi-specifications/v1.0/support/TranslationLanguages.json +2772 -0
  736. package/source/openapi-specifications/v1.0/support/Upload.json +620 -0
  737. package/source/openapi-specifications/v1.0/support/User.json +1409 -0
  738. package/source/openapi-specifications/v1.0/support/UserAuthentication.json +617 -0
  739. package/source/openapi-specifications/v1.0/support/UserPresence.json +763 -0
  740. package/source/openapi-specifications/v1.0/support/ValidationRuleCriteria.json +107 -0
  741. package/source/openapi-specifications/v1.0/support/ValidationRules.json +1173 -0
  742. package/source/openapi-specifications/v1.0/support/Webhook.json +1330 -0
  743. package/source/openapi-specifications/v1.0/support/WhatsAppDetails.json +132 -0
  744. package/source/openapi-specifications/v1.0/support/WhatsAppMigration.json +143 -0
  745. package/source/openapi-specifications/v1.0/support/WhatsAppTemplateTags.json +132 -0
  746. package/source/openapi-specifications/v1.0/support/Widget.json +3023 -0
  747. package/source/openapi-specifications/v1.0/support/WmsDomain.json +104 -0
  748. package/source/openapi-specifications/v1.0/support/ZIAAnswerbotInference.json +756 -0
  749. package/source/openapi-specifications/v1.0/support/ZIADocumentData.json +989 -0
  750. package/source/openapi-specifications/v1.0/support/ZIASolutionService.json +135 -0
  751. package/source/openapi-specifications/v1.0/support/ZIAVectorSearch.json +376 -0
  752. package/source/openapi-specifications/v1.0/support/ZiaDCMigration.json +159 -0
  753. package/source/openapi-specifications/v1.0/support/ZiaGPT.json +3229 -0
  754. package/source/openapi-specifications/v1.0/support/ZiaScheduler.json +453 -0
  755. package/source/openapi-specifications/v1.0/support/Zwitch.json +1543 -0
  756. package/source/openapi-specifications/v1.0/support/blueprintChartData.json +201 -0
  757. package/source/openapi-specifications/v1.0/support/blueprintConnections.json +75 -0
  758. package/source/openapi-specifications/v1.0/support/blueprintCriteria.json +255 -0
  759. package/source/openapi-specifications/v1.0/support/blueprintDrafts.json +1677 -0
  760. package/source/openapi-specifications/v1.0/support/blueprintStates.json +284 -0
  761. package/source/openapi-specifications/v1.0/support/blueprintStrictModeConfig.json +91 -0
  762. package/source/openapi-specifications/v1.0/support/blueprintTransitions.json +1546 -0
  763. package/source/openapi-specifications/v1.0/support/blueprints.json +2992 -0
  764. package/source/openapi-specifications/v1.0/support/errors.json +80 -0
  765. package/source/openapi-specifications/v1.0/support/zlabsnlp.json +416 -0
  766. package/.github/agents/Generators.agent.md +0 -121
@@ -0,0 +1,1929 @@
1
+ {
2
+ "openapi" : "3.1.0",
3
+ "info" : {
4
+ "title" : "ArticleComment",
5
+ "version" : "1.0.0",
6
+ "x-clan-group" : "helpCenter",
7
+ "x-module-group" : "kb"
8
+ },
9
+ "paths" : {
10
+ "/api/v1/articles/{articleId}/translations/{locale}/comments" : {
11
+ "get" : {
12
+ "tags" : [ "ArticleComment" ],
13
+ "summary" : "List all translation comments",
14
+ "description" : "This API lists a particular number of comments recorded on an article translation, based on the limit specified.",
15
+ "operationId" : "getArticleTranslationComments",
16
+ "parameters" : [ {
17
+ "name" : "include",
18
+ "in" : "query",
19
+ "description" : "Allowed values: ticket",
20
+ "required" : false,
21
+ "style" : "simple",
22
+ "explode" : true,
23
+ "schema" : {
24
+ "type" : "array",
25
+ "description" : "Allowed values @ticket@",
26
+ "items" : {
27
+ "type" : "string",
28
+ "enum" : [ "ticket" ]
29
+ },
30
+ "uniqueItems" : true
31
+ }
32
+ }, {
33
+ "name" : "limit",
34
+ "in" : "query",
35
+ "description" : "No. of comments to fetch",
36
+ "required" : false,
37
+ "style" : "form",
38
+ "explode" : true,
39
+ "schema" : {
40
+ "type" : [ "string", "null", "integer" ],
41
+ "format" : "int32",
42
+ "description" : "No. of comments to fetch",
43
+ "maximum" : 50,
44
+ "minimum" : 1,
45
+ "pattern" : "([0-9]+)"
46
+ }
47
+ }, {
48
+ "name" : "from",
49
+ "in" : "query",
50
+ "description" : "Index number starting from which the comments must be fetched",
51
+ "required" : false,
52
+ "style" : "form",
53
+ "explode" : true,
54
+ "schema" : {
55
+ "type" : [ "string", "null", "integer" ],
56
+ "format" : "int32",
57
+ "description" : "Index number starting from which the comments must be fetched",
58
+ "minimum" : 1,
59
+ "pattern" : "([0-9]+)"
60
+ }
61
+ }, {
62
+ "name" : "sortBy",
63
+ "in" : "query",
64
+ "description" : "Sort comments by the @commentedTime@ attribute. The default sorting order is ascending. @-commentedTime@ denotes descending order of sorting.",
65
+ "required" : false,
66
+ "style" : "form",
67
+ "explode" : true,
68
+ "schema" : {
69
+ "type" : "string",
70
+ "description" : "Sort comments by the @commentedTime@ attribute. The default sorting order is ascending. @-commentedTime@ denotes descending order of sorting.",
71
+ "enum" : [ "commentedTime" ]
72
+ }
73
+ }, {
74
+ "$ref" : "#/components/parameters/articleId"
75
+ }, {
76
+ "$ref" : "#/components/parameters/locale"
77
+ }, {
78
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
79
+ } ],
80
+ "responses" : {
81
+ "200" : {
82
+ "$ref" : "#/components/responses/listOfComments"
83
+ }
84
+ },
85
+ "security" : [ {
86
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
87
+ }, {
88
+ "iam-oauth2-schema" : [ "Desk.articles.READ" ]
89
+ } ],
90
+ "x-audience" : [ "external-public" ],
91
+ "x-custom-url-attribute" : {
92
+ "security" : {
93
+ "throttle" : {
94
+ "policy" : "ReadAPI_Standard_UserPolicy"
95
+ },
96
+ "extraparams" : {
97
+ "disable" : true,
98
+ "ignore" : false
99
+ },
100
+ "authentication" : { }
101
+ },
102
+ "clan-group" : "helpCenter",
103
+ "apihash" : "6a0029b5f9ed63565be76e98fc6f8a06",
104
+ "module-group" : "kb",
105
+ "apimethod" : "com.zoho.desk.helpcenter.articles.rest.support.ArticleService.getTranslationComments"
106
+ }
107
+ },
108
+ "post" : {
109
+ "tags" : [ "ArticleComment" ],
110
+ "summary" : "Create a translation comment",
111
+ "description" : "This API adds a comment to an article translation.",
112
+ "operationId" : "createArticleTranslationComment",
113
+ "parameters" : [ {
114
+ "$ref" : "#/components/parameters/articleId"
115
+ }, {
116
+ "$ref" : "#/components/parameters/locale"
117
+ }, {
118
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
119
+ } ],
120
+ "requestBody" : {
121
+ "$ref" : "#/components/requestBodies/addCommentInput"
122
+ },
123
+ "responses" : {
124
+ "422" : {
125
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
126
+ },
127
+ "200" : {
128
+ "$ref" : "#/components/responses/commentResponse"
129
+ }
130
+ },
131
+ "security" : [ {
132
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
133
+ }, {
134
+ "iam-oauth2-schema" : [ "Desk.articles.CREATE" ]
135
+ } ],
136
+ "x-audience" : [ "external-public" ],
137
+ "x-custom-url-attribute" : {
138
+ "security" : {
139
+ "throttle" : {
140
+ "policy" : "WriteAPI_Standard_UserPolicy"
141
+ },
142
+ "extraparams" : {
143
+ "disable" : true,
144
+ "ignore" : false
145
+ },
146
+ "authentication" : { }
147
+ },
148
+ "clan-group" : "helpCenter",
149
+ "apihash" : "dade45c401b45f5018c164f28f2957da",
150
+ "module-group" : "kb",
151
+ "apimethod" : "com.zoho.desk.helpcenter.articles.rest.support.ArticleService.addTranslationComment"
152
+ }
153
+ }
154
+ },
155
+ "/api/v1/kbComments/approve" : {
156
+ "post" : {
157
+ "tags" : [ "ArticleComment" ],
158
+ "summary" : "",
159
+ "description" : "",
160
+ "operationId" : "approveComment",
161
+ "parameters" : [ {
162
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
163
+ } ],
164
+ "requestBody" : {
165
+ "$ref" : "#/components/requestBodies/commentIdsJson"
166
+ },
167
+ "responses" : {
168
+ "200" : {
169
+ "$ref" : "./CommonMassActionResponse.json#/components/responses/massActionListView"
170
+ },
171
+ "422" : {
172
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
173
+ }
174
+ },
175
+ "x-audience" : [ "company-internal" ]
176
+ }
177
+ },
178
+ "/api/v1/kbComments/moveToTrash" : {
179
+ "post" : {
180
+ "tags" : [ "ArticleComment" ],
181
+ "summary" : "Move article translations comments to recycle bin",
182
+ "description" : "This API move the article comments to recyclebin.",
183
+ "operationId" : "moveToTrashComment",
184
+ "parameters" : [ {
185
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
186
+ } ],
187
+ "requestBody" : {
188
+ "$ref" : "#/components/requestBodies/commentIdsJson"
189
+ },
190
+ "responses" : {
191
+ "422" : {
192
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
193
+ },
194
+ "200" : {
195
+ "$ref" : "./MassActionResponse.json#/components/responses/massActionListResponse"
196
+ }
197
+ },
198
+ "security" : [ {
199
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
200
+ }, {
201
+ "iam-oauth2-schema" : [ "Desk.articles.UPDATE" ]
202
+ } ],
203
+ "x-audience" : [ "company-internal" ],
204
+ "x-custom-url-attribute" : {
205
+ "security" : {
206
+ "throttle" : {
207
+ "policy" : "WriteAPI_Stringent_UserPolicy"
208
+ },
209
+ "extraparams" : {
210
+ "disable" : true,
211
+ "ignore" : false
212
+ },
213
+ "authentication" : { }
214
+ },
215
+ "clan-group" : "helpCenter",
216
+ "apihash" : "51d91cdc8924d1a3eae45af75921f777",
217
+ "module-group" : "kb",
218
+ "apimethod" : "com.zoho.desk.helpcenter.recyclebin.RecycleBinService.moveArticleCommentsToTrash"
219
+ }
220
+ }
221
+ },
222
+ "/api/v1/kbComments/moderatedComments" : {
223
+ "get" : {
224
+ "tags" : [ "ArticleComment" ],
225
+ "summary" : "List moderated kb comments",
226
+ "description" : "To fetch list of kb comments that has been moderated earlier",
227
+ "operationId" : "getModeratedComments",
228
+ "parameters" : [ {
229
+ "$ref" : "#/components/parameters/locale_query"
230
+ }, {
231
+ "$ref" : "#/components/parameters/limit"
232
+ }, {
233
+ "$ref" : "#/components/parameters/from"
234
+ }, {
235
+ "$ref" : "#/components/parameters/commentedBy"
236
+ }, {
237
+ "name" : "sortBy",
238
+ "in" : "query",
239
+ "description" : "Sorts the listing comments based on the commentedTime. @commentedTime@ Ascending Order (default). @-commentedTime@ Descending Order",
240
+ "required" : false,
241
+ "style" : "form",
242
+ "explode" : true,
243
+ "schema" : {
244
+ "type" : [ "string", "null" ],
245
+ "description" : "Sorts the listing comments based on the commentedTime. @commentedTime@ Ascending Order (default). @-commentedTime@ Descending Order",
246
+ "enum" : [ "commentedTime" ],
247
+ "maxLength" : 100,
248
+ "minLength" : 0
249
+ }
250
+ }, {
251
+ "$ref" : "#/components/parameters/categoryId"
252
+ }, {
253
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
254
+ } ],
255
+ "responses" : {
256
+ "422" : {
257
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
258
+ },
259
+ "200" : {
260
+ "$ref" : "#/components/responses/listOfModeratedComments"
261
+ }
262
+ },
263
+ "security" : [ {
264
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
265
+ }, {
266
+ "iam-oauth2-schema" : [ "Desk.articles.READ" ]
267
+ } ],
268
+ "x-audience" : [ "company-internal" ],
269
+ "x-custom-url-attribute" : {
270
+ "security" : {
271
+ "throttle" : {
272
+ "policy" : "ReadAPI_Standard_UserPolicy"
273
+ },
274
+ "extraparams" : {
275
+ "disable" : true,
276
+ "ignore" : false
277
+ },
278
+ "authentication" : { }
279
+ },
280
+ "clan-group" : "helpCenter",
281
+ "apihash" : "d4303acde159ac1146c620de61a217c2",
282
+ "module-group" : "kb",
283
+ "apimethod" : "com.zoho.desk.helpcenter.articles.rest.support.comments.ArticleCommentService.getModerationComments"
284
+ }
285
+ }
286
+ },
287
+ "/api/v1/kbComments/moderatedComments/count" : {
288
+ "get" : {
289
+ "tags" : [ "ArticleComment" ],
290
+ "summary" : "Moderated kb comments count",
291
+ "description" : "To Fetch moderated articles comment count",
292
+ "operationId" : "getModeratedCommentsCount",
293
+ "parameters" : [ {
294
+ "$ref" : "#/components/parameters/locale_query"
295
+ }, {
296
+ "$ref" : "#/components/parameters/categoryId"
297
+ }, {
298
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
299
+ }, {
300
+ "$ref" : "#/components/parameters/commentedBy"
301
+ } ],
302
+ "responses" : {
303
+ "422" : {
304
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
305
+ },
306
+ "200" : {
307
+ "$ref" : "./HelpCenterCommon.json#/components/responses/countJson"
308
+ }
309
+ },
310
+ "security" : [ {
311
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
312
+ }, {
313
+ "iam-oauth2-schema" : [ "Desk.articles.READ" ]
314
+ } ],
315
+ "x-audience" : [ "company-internal" ],
316
+ "x-custom-url-attribute" : {
317
+ "security" : {
318
+ "throttle" : {
319
+ "policy" : "ReadAPI_Stringent_UserPolicy"
320
+ },
321
+ "extraparams" : {
322
+ "disable" : true,
323
+ "ignore" : false
324
+ },
325
+ "authentication" : { }
326
+ },
327
+ "clan-group" : "helpCenter",
328
+ "apihash" : "d4303acde159ac1146c620de61a217c2",
329
+ "module-group" : "kb",
330
+ "apimethod" : "com.zoho.desk.helpcenter.articles.rest.support.comments.ArticleCommentService.obtainModeratedArticleCommentsCount"
331
+ }
332
+ }
333
+ },
334
+ "/api/v1/articles/{articleId}/translations/{locale}/comments/{commentId}/convertAsTicket" : {
335
+ "post" : {
336
+ "tags" : [ "ArticleComment" ],
337
+ "summary" : "Convert Article Translation comment as Ticket",
338
+ "description" : "This API converts the comment content to ticket to respective department configured for the Root category",
339
+ "operationId" : "convertArticleCommentAsTicket",
340
+ "parameters" : [ {
341
+ "$ref" : "#/components/parameters/articleId"
342
+ }, {
343
+ "$ref" : "#/components/parameters/commentId"
344
+ }, {
345
+ "$ref" : "#/components/parameters/locale"
346
+ }, {
347
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
348
+ } ],
349
+ "responses" : {
350
+ "422" : {
351
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
352
+ },
353
+ "200" : {
354
+ "$ref" : "#/components/responses/ticketMetaResponse"
355
+ }
356
+ },
357
+ "security" : [ {
358
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
359
+ }, {
360
+ "iam-oauth2-schema" : [ "Desk.articles.CREATE" ]
361
+ } ],
362
+ "x-audience" : [ "company-internal" ],
363
+ "x-custom-url-attribute" : {
364
+ "security" : {
365
+ "throttle" : {
366
+ "policy" : "WriteAPI_Standard_UserPolicy"
367
+ },
368
+ "extraparams" : {
369
+ "disable" : true,
370
+ "ignore" : false
371
+ },
372
+ "authentication" : { }
373
+ },
374
+ "clan-group" : "helpCenter",
375
+ "apihash" : "eda2e4e94a4fa4ab7ec79b6e579b9218",
376
+ "module-group" : "kb",
377
+ "apimethod" : "com.zoho.desk.helpcenter.articles.rest.support.ArticleService.convertCommentAsTicket"
378
+ }
379
+ }
380
+ },
381
+ "/api/v1/articles/{articleId}/translations/{locale}/comments/{commentId}" : {
382
+ "get" : {
383
+ "tags" : [ "ArticleComment" ],
384
+ "summary" : "Get a article translation comment",
385
+ "description" : "This API fetches an article translation comment from the portal.",
386
+ "operationId" : "getArticleTranslationComment",
387
+ "parameters" : [ {
388
+ "$ref" : "#/components/parameters/articleId"
389
+ }, {
390
+ "$ref" : "#/components/parameters/commentId"
391
+ }, {
392
+ "$ref" : "#/components/parameters/locale"
393
+ }, {
394
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
395
+ } ],
396
+ "responses" : {
397
+ "200" : {
398
+ "$ref" : "#/components/responses/commentResponse"
399
+ }
400
+ },
401
+ "security" : [ {
402
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
403
+ }, {
404
+ "iam-oauth2-schema" : [ "Desk.articles.READ" ]
405
+ } ],
406
+ "x-audience" : [ "external-public" ],
407
+ "x-custom-url-attribute" : {
408
+ "security" : {
409
+ "throttle" : {
410
+ "policy" : "ReadAPI_Lenient_UserPolicy"
411
+ },
412
+ "extraparams" : {
413
+ "disable" : true,
414
+ "ignore" : false
415
+ },
416
+ "authentication" : { }
417
+ },
418
+ "clan-group" : "helpCenter",
419
+ "apihash" : "8075c1af9321474980bf9ad2d5c126a2",
420
+ "module-group" : "kb",
421
+ "apimethod" : "com.zoho.desk.helpcenter.articles.rest.support.ArticleService.getTranslationComment"
422
+ }
423
+ },
424
+ "delete" : {
425
+ "tags" : [ "ArticleComment" ],
426
+ "summary" : "Delete a translation comment",
427
+ "description" : "This API deletes an existing article translation comment.",
428
+ "operationId" : "deleteArticleTranslationComments",
429
+ "parameters" : [ {
430
+ "$ref" : "#/components/parameters/articleId"
431
+ }, {
432
+ "$ref" : "#/components/parameters/commentId"
433
+ }, {
434
+ "$ref" : "#/components/parameters/locale"
435
+ }, {
436
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
437
+ } ],
438
+ "responses" : {
439
+ "204" : {
440
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
441
+ }
442
+ },
443
+ "security" : [ {
444
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
445
+ }, {
446
+ "iam-oauth2-schema" : [ "Desk.articles.DELETE" ]
447
+ } ],
448
+ "x-audience" : [ "external-public" ],
449
+ "x-custom-url-attribute" : {
450
+ "security" : {
451
+ "throttle" : {
452
+ "policy" : "WriteAPI_Standard_UserPolicy"
453
+ },
454
+ "extraparams" : {
455
+ "disable" : true,
456
+ "ignore" : false
457
+ },
458
+ "authentication" : { }
459
+ },
460
+ "clan-group" : "helpCenter",
461
+ "apihash" : "785bffe28950f392efa8892f4bafe039",
462
+ "module-group" : "kb",
463
+ "apimethod" : "com.zoho.desk.helpcenter.articles.rest.support.ArticleService.deleteTranslationComment"
464
+ }
465
+ },
466
+ "patch" : {
467
+ "tags" : [ "ArticleComment" ],
468
+ "summary" : "Update a translation comment",
469
+ "description" : "This API updates an existing article translation comment.",
470
+ "operationId" : "updateArticleTranslationComment",
471
+ "parameters" : [ {
472
+ "$ref" : "#/components/parameters/articleId"
473
+ }, {
474
+ "$ref" : "#/components/parameters/commentId"
475
+ }, {
476
+ "$ref" : "#/components/parameters/locale"
477
+ }, {
478
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
479
+ } ],
480
+ "requestBody" : {
481
+ "$ref" : "#/components/requestBodies/updateCommentInput"
482
+ },
483
+ "responses" : {
484
+ "422" : {
485
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
486
+ },
487
+ "200" : {
488
+ "$ref" : "#/components/responses/commentResponse"
489
+ }
490
+ },
491
+ "security" : [ {
492
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
493
+ }, {
494
+ "iam-oauth2-schema" : [ "Desk.articles.UPDATE" ]
495
+ } ],
496
+ "x-audience" : [ "external-public" ],
497
+ "x-custom-url-attribute" : {
498
+ "security" : {
499
+ "throttle" : {
500
+ "policy" : "WriteAPI_Standard_UserPolicy"
501
+ },
502
+ "extraparams" : {
503
+ "disable" : true,
504
+ "ignore" : false
505
+ },
506
+ "authentication" : { }
507
+ },
508
+ "clan-group" : "helpCenter",
509
+ "apihash" : "66988268055691dc019744229ebf2785",
510
+ "module-group" : "kb",
511
+ "apimethod" : "com.zoho.desk.helpcenter.articles.rest.support.ArticleService.editTranslationComment"
512
+ }
513
+ }
514
+ }
515
+ },
516
+ "components" : {
517
+ "schemas" : {
518
+ "groupMentionResponse" : {
519
+ "type" : [ "null", "object" ],
520
+ "additionalProperties" : false,
521
+ "properties" : {
522
+ "offSet" : {
523
+ "type" : [ "string", "null", "integer" ],
524
+ "format" : "int32",
525
+ "pattern" : "([0-9]+)"
526
+ },
527
+ "name" : {
528
+ "type" : [ "string", "null" ],
529
+ "maxLength" : 100,
530
+ "minLength" : 0,
531
+ "pattern" : "[0-9a-zA-Z_\\-\\&\\.\\$\\@\\^\\(\\)\\{\\}\\~\\=\\-\\|\\*\\+\\?\\[\\]\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+"
532
+ },
533
+ "length" : {
534
+ "type" : [ "string", "null", "integer" ],
535
+ "format" : "int32",
536
+ "pattern" : "([0-9]+)"
537
+ },
538
+ "id" : {
539
+ "type" : [ "string", "null", "integer" ],
540
+ "format" : "int64",
541
+ "pattern" : "([0-9]+)"
542
+ },
543
+ "logoUrl" : {
544
+ "type" : [ "string", "null" ],
545
+ "maxLength" : 200,
546
+ "minLength" : 0,
547
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
548
+ }
549
+ },
550
+ "required" : [ "id", "length", "logoUrl", "name", "offSet" ]
551
+ },
552
+ "mentionGroupListResponse" : {
553
+ "type" : [ "null", "array" ],
554
+ "items" : {
555
+ "$ref" : "./ArticleComment.json#/components/schemas/groupMentionResponse"
556
+ }
557
+ },
558
+ "mentionedEndUser" : {
559
+ "type" : [ "null", "object" ],
560
+ "additionalProperties" : false,
561
+ "properties" : {
562
+ "id" : {
563
+ "type" : [ "string", "null", "integer" ],
564
+ "format" : "int64",
565
+ "pattern" : "([0-9]+)"
566
+ },
567
+ "name" : {
568
+ "type" : [ "string", "null" ],
569
+ "maxLength" : 100,
570
+ "minLength" : 0
571
+ },
572
+ "photoURL" : {
573
+ "type" : [ "string", "null" ],
574
+ "maxLength" : 200,
575
+ "minLength" : 0,
576
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
577
+ },
578
+ "email" : {
579
+ "type" : [ "string", "null" ],
580
+ "maxLength" : 100,
581
+ "minLength" : 0,
582
+ "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$"
583
+ },
584
+ "firstName" : {
585
+ "type" : [ "string", "null" ],
586
+ "maxLength" : 50,
587
+ "minLength" : 0
588
+ },
589
+ "lastName" : {
590
+ "type" : [ "string", "null" ],
591
+ "maxLength" : 50,
592
+ "minLength" : 0
593
+ },
594
+ "type" : {
595
+ "type" : [ "string", "null" ],
596
+ "enum" : [ "END_USER", "AGENT", "TEAM", "TICKET", "ACTIVITY" ],
597
+ "maxLength" : 100,
598
+ "minLength" : 0
599
+ }
600
+ },
601
+ "required" : [ "email", "firstName", "id", "lastName", "name", "photoURL", "type" ]
602
+ },
603
+ "commenter" : {
604
+ "type" : [ "null", "object" ],
605
+ "additionalProperties" : false,
606
+ "properties" : {
607
+ "photoURL" : {
608
+ "type" : [ "string", "null" ],
609
+ "maxLength" : 200,
610
+ "minLength" : 0,
611
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
612
+ },
613
+ "firstName" : {
614
+ "type" : [ "string", "null" ],
615
+ "maxLength" : 50,
616
+ "minLength" : 0
617
+ },
618
+ "lastName" : {
619
+ "type" : [ "string", "null" ],
620
+ "maxLength" : 50,
621
+ "minLength" : 0
622
+ },
623
+ "webUrl" : {
624
+ "type" : [ "string", "null" ],
625
+ "maxLength" : 255,
626
+ "minLength" : 3,
627
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
628
+ },
629
+ "name" : {
630
+ "type" : [ "string", "null" ],
631
+ "maxLength" : 100,
632
+ "minLength" : 0
633
+ },
634
+ "roleName" : {
635
+ "type" : [ "string", "null" ],
636
+ "maxLength" : 100,
637
+ "minLength" : 0
638
+ },
639
+ "id" : {
640
+ "type" : [ "string", "null", "integer" ],
641
+ "format" : "int64",
642
+ "pattern" : "([0-9]+)"
643
+ },
644
+ "label" : {
645
+ "$ref" : "./Label.json#/components/schemas/labelMetaResponse"
646
+ },
647
+ "type" : {
648
+ "type" : [ "string", "null" ],
649
+ "enum" : [ "END_USER", "AGENT", "TEAM", "TICKET", "ACTIVITY" ],
650
+ "maxLength" : 100,
651
+ "minLength" : 0
652
+ },
653
+ "email" : {
654
+ "type" : [ "string", "null" ],
655
+ "maxLength" : 100,
656
+ "minLength" : 0,
657
+ "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$"
658
+ },
659
+ "kbRole" : {
660
+ "type" : [ "string", "null" ],
661
+ "enum" : [ "REVIEWER", null ],
662
+ "maxLength" : 100,
663
+ "minLength" : 0
664
+ }
665
+ },
666
+ "required" : [ "email", "firstName", "id", "kbRole", "label", "lastName", "name", "photoURL", "roleName", "type", "webUrl" ]
667
+ },
668
+ "mentionEndUserResponse" : {
669
+ "additionalProperties" : false,
670
+ "allOf" : [ {
671
+ "$ref" : "./ArticleComment.json#/components/schemas/mentionedEndUser"
672
+ }, {
673
+ "$ref" : "./ArticleComment.json#/components/schemas/commonUserDetails"
674
+ } ]
675
+ },
676
+ "commonUserDetails" : {
677
+ "type" : [ "null", "object" ],
678
+ "additionalProperties" : false,
679
+ "properties" : {
680
+ "offSet" : {
681
+ "type" : [ "string", "null", "integer" ],
682
+ "format" : "int32",
683
+ "pattern" : "([0-9]+)"
684
+ },
685
+ "webUrl" : {
686
+ "type" : [ "string", "null" ],
687
+ "maxLength" : 255,
688
+ "minLength" : 3,
689
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
690
+ },
691
+ "length" : {
692
+ "type" : [ "string", "null", "integer" ],
693
+ "format" : "int32",
694
+ "pattern" : "([0-9]+)"
695
+ },
696
+ "label" : {
697
+ "$ref" : "./Label.json#/components/schemas/labelMetaResponse"
698
+ },
699
+ "zuid" : {
700
+ "type" : [ "string", "null", "integer" ],
701
+ "format" : "int32",
702
+ "pattern" : "([0-9]+)"
703
+ },
704
+ "kbRole" : {
705
+ "type" : [ "string", "null" ],
706
+ "enum" : [ "REVIEWER", null ],
707
+ "maxLength" : 100,
708
+ "minLength" : 0
709
+ }
710
+ },
711
+ "required" : [ "kbRole", "label", "length", "offSet", "webUrl", "zuid" ]
712
+ },
713
+ "mentionsResponse" : {
714
+ "additionalProperties" : false,
715
+ "allOf" : [ {
716
+ "$ref" : "./ArticleComment.json#/components/schemas/commenter"
717
+ }, {
718
+ "$ref" : "./ArticleComment.json#/components/schemas/commonUserDetails"
719
+ } ]
720
+ },
721
+ "mentionUserListResponse" : {
722
+ "type" : [ "null", "array" ],
723
+ "items" : {
724
+ "$ref" : "./ArticleComment.json#/components/schemas/mentionsResponse"
725
+ }
726
+ },
727
+ "endUserMentionListResponse" : {
728
+ "type" : [ "null", "array" ],
729
+ "items" : {
730
+ "$ref" : "./ArticleComment.json#/components/schemas/mentionEndUserResponse"
731
+ }
732
+ },
733
+ "endUserMentionObjResponse" : {
734
+ "type" : [ "null", "object" ],
735
+ "additionalProperties" : false,
736
+ "properties" : {
737
+ "groups" : {
738
+ "$ref" : "./ArticleComment.json#/components/schemas/mentionGroupListResponse"
739
+ },
740
+ "users" : {
741
+ "$ref" : "./ArticleComment.json#/components/schemas/endUserMentionListResponse"
742
+ }
743
+ },
744
+ "required" : [ "groups", "users" ]
745
+ },
746
+ "mentionObjResponse" : {
747
+ "type" : [ "null", "object" ],
748
+ "additionalProperties" : false,
749
+ "properties" : {
750
+ "groups" : {
751
+ "$ref" : "./ArticleComment.json#/components/schemas/mentionGroupListResponse"
752
+ },
753
+ "users" : {
754
+ "$ref" : "./ArticleComment.json#/components/schemas/mentionUserListResponse"
755
+ }
756
+ },
757
+ "required" : [ "groups", "users" ]
758
+ },
759
+ "hashtagsResponse" : {
760
+ "type" : [ "null", "object" ],
761
+ "additionalProperties" : false,
762
+ "properties" : {
763
+ "offSet" : {
764
+ "type" : [ "string", "null", "integer" ],
765
+ "format" : "int32",
766
+ "pattern" : "([0-9]+)"
767
+ },
768
+ "length" : {
769
+ "type" : [ "string", "null", "integer" ],
770
+ "format" : "int32",
771
+ "pattern" : "([0-9]+)"
772
+ },
773
+ "headerValue" : {
774
+ "type" : [ "string", "null" ],
775
+ "maxLength" : 100,
776
+ "minLength" : 0
777
+ },
778
+ "headerId" : {
779
+ "type" : [ "string", "null" ],
780
+ "maxLength" : 100,
781
+ "minLength" : 0
782
+ }
783
+ },
784
+ "required" : [ "headerId", "headerValue", "length", "offSet" ]
785
+ },
786
+ "hashtags" : {
787
+ "type" : [ "null", "array" ],
788
+ "items" : {
789
+ "$ref" : "./ArticleComment.json#/components/schemas/hashtagsResponse"
790
+ }
791
+ },
792
+ "ticketMetaResponse" : {
793
+ "type" : [ "null", "object" ],
794
+ "additionalProperties" : false,
795
+ "properties" : {
796
+ "ticketNumber" : {
797
+ "type" : [ "string", "null", "integer" ],
798
+ "format" : "int32",
799
+ "pattern" : "([0-9]+)"
800
+ },
801
+ "isTrashed" : {
802
+ "type" : [ "boolean", "null" ]
803
+ },
804
+ "webUrl" : {
805
+ "type" : [ "string", "null" ],
806
+ "maxLength" : 500,
807
+ "minLength" : 0,
808
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
809
+ },
810
+ "id" : {
811
+ "type" : [ "string", "null", "integer" ],
812
+ "format" : "int64",
813
+ "pattern" : "([0-9]+)"
814
+ }
815
+ },
816
+ "required" : [ "id", "isTrashed", "ticketNumber", "webUrl" ]
817
+ },
818
+ "attachmentsResponse" : {
819
+ "type" : [ "null", "object" ],
820
+ "additionalProperties" : false,
821
+ "properties" : {
822
+ "previewurl" : {
823
+ "type" : [ "string", "null" ],
824
+ "maxLength" : 16000000,
825
+ "minLength" : 0,
826
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
827
+ },
828
+ "size" : {
829
+ "type" : [ "string", "null", "integer" ],
830
+ "format" : "int64",
831
+ "pattern" : "([0-9]+)"
832
+ },
833
+ "name" : {
834
+ "type" : [ "string", "null" ],
835
+ "maxLength" : 100,
836
+ "minLength" : 0
837
+ },
838
+ "id" : {
839
+ "type" : [ "string", "null", "integer" ],
840
+ "format" : "int64",
841
+ "pattern" : "([0-9]+)"
842
+ },
843
+ "href" : {
844
+ "type" : [ "string", "null" ],
845
+ "maxLength" : 16000000,
846
+ "minLength" : 0,
847
+ "pattern" : "https?:\\/\\/([a-zA-Z0-9\\.-]+)(:\\d{1,5})?(\\/[a-zA-Z0-9\\/\\.-]+)?\\?(x-service=([a-zA-Z0-9]+)&event-id=([a-f0-9]+)&x-cli-msg=\\{\\\\?\"s\\\\?\":(\\d),\\\\?\"portalname\\\\?\":\\\\?\"([a-zA-Z0-9]+)\\\\?\"\\}|orgId=(\\d+))"
848
+ }
849
+ },
850
+ "required" : [ "href", "id", "name", "previewurl", "size" ]
851
+ },
852
+ "attachments" : {
853
+ "type" : [ "null", "array" ],
854
+ "items" : {
855
+ "$ref" : "./ArticleComment.json#/components/schemas/attachmentsResponse"
856
+ }
857
+ },
858
+ "moderationCommentListArray" : {
859
+ "type" : [ "null", "array" ],
860
+ "items" : {
861
+ "$ref" : "./ArticleComment.json#/components/schemas/moderationCommentResponse"
862
+ }
863
+ },
864
+ "moderationCommentResponse" : {
865
+ "type" : [ "null", "object" ],
866
+ "additionalProperties" : false,
867
+ "properties" : {
868
+ "modifiedTime" : {
869
+ "type" : [ "string", "null" ],
870
+ "maxLength" : 100,
871
+ "minLength" : 0,
872
+ "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
873
+ },
874
+ "hashtags" : {
875
+ "$ref" : "./ArticleComment.json#/components/schemas/hashtags"
876
+ },
877
+ "commentedTime" : {
878
+ "type" : [ "string", "null" ],
879
+ "maxLength" : 100,
880
+ "minLength" : 0,
881
+ "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
882
+ },
883
+ "content" : {
884
+ "type" : [ "string", "null" ],
885
+ "maxLength" : 32000,
886
+ "minLength" : 0,
887
+ "x-custom-parameters-attributes" : {
888
+ "removeExif" : false,
889
+ "filterMatchedContent" : false,
890
+ "antivirus" : false,
891
+ "replacementString" : "",
892
+ "allowInvalid" : false,
893
+ "descrption" : "Content of the comment. To retrieve or set user mentions, use this code format: AGENT : _zsu[@user:{zuid}]zsu_, Enduser : _zsu[@enduser:{zuid}]zsu_, Group : _zsu[@group:{groupid}]zsu_, HashTag : _zsh[#{HEADER_DATA}]zsh_.",
894
+ "secret" : false,
895
+ "preserveCharsLimit" : 10,
896
+ "trim" : false,
897
+ "internalParam" : false,
898
+ "preserveChars" : "0,5",
899
+ "xss" : "antisamyfilter_kbcommentspolicy",
900
+ "importUrl" : false,
901
+ "decrypt" : false
902
+ }
903
+ },
904
+ "commenterId" : {
905
+ "type" : [ "string", "null", "integer" ],
906
+ "format" : "int64",
907
+ "pattern" : "([0-9]+)"
908
+ },
909
+ "commenter" : {
910
+ "$ref" : "./ArticleComment.json#/components/schemas/commenter"
911
+ },
912
+ "mentions" : {
913
+ "$ref" : "./ArticleComment.json#/components/schemas/endUserMentionObjResponse"
914
+ },
915
+ "isPublic" : {
916
+ "type" : [ "boolean", "null" ],
917
+ "x-custom-parameters-attributes" : {
918
+ "removeExif" : false,
919
+ "filterMatchedContent" : false,
920
+ "antivirus" : false,
921
+ "replacementString" : "",
922
+ "allowInvalid" : false,
923
+ "descrption" : "Visibility of the comment, which can be set only at the time of commenting. ",
924
+ "secret" : false,
925
+ "preserveCharsLimit" : 10,
926
+ "trim" : false,
927
+ "internalParam" : false,
928
+ "preserveChars" : "0,5",
929
+ "importUrl" : false,
930
+ "decrypt" : false
931
+ }
932
+ },
933
+ "id" : {
934
+ "type" : [ "string", "null", "integer" ],
935
+ "format" : "int64",
936
+ "pattern" : "([0-9]+)"
937
+ },
938
+ "contentType" : {
939
+ "type" : [ "string", "null" ],
940
+ "enum" : [ "plainText", "html" ],
941
+ "maxLength" : 100,
942
+ "minLength" : 0,
943
+ "x-custom-parameters-attributes" : {
944
+ "removeExif" : false,
945
+ "filterMatchedContent" : false,
946
+ "antivirus" : false,
947
+ "replacementString" : "",
948
+ "allowInvalid" : false,
949
+ "descrption" : "Used to denote the content-type which maybe @html@ or @plainText@. The default type is @html@.",
950
+ "secret" : false,
951
+ "preserveCharsLimit" : 10,
952
+ "trim" : false,
953
+ "internalParam" : false,
954
+ "preserveChars" : "0,5",
955
+ "importUrl" : false,
956
+ "decrypt" : false
957
+ }
958
+ },
959
+ "status" : {
960
+ "type" : [ "string", "null" ],
961
+ "enum" : [ "PUBLISHED", "AWAITINGAPPROVAL" ],
962
+ "maxLength" : 100,
963
+ "minLength" : 0
964
+ },
965
+ "articleTranslationId" : {
966
+ "type" : [ "string", "null", "integer" ],
967
+ "format" : "int64",
968
+ "pattern" : "([0-9]+)"
969
+ },
970
+ "categoryId" : {
971
+ "type" : [ "string", "null", "integer" ],
972
+ "format" : "int64",
973
+ "pattern" : "([0-9]+)"
974
+ },
975
+ "rootCategoryId" : {
976
+ "type" : [ "string", "null", "integer" ],
977
+ "format" : "int64",
978
+ "pattern" : "([0-9]+)"
979
+ },
980
+ "category" : {
981
+ "$ref" : "./ArticleComment.json#/components/schemas/categoryResponse"
982
+ },
983
+ "articleTranslation" : {
984
+ "$ref" : "./ArticleComment.json#/components/schemas/articleTranslationResponseWithWebUrl"
985
+ }
986
+ },
987
+ "required" : [ "articleTranslation", "articleTranslationId", "category", "categoryId", "commentedTime", "commenter", "commenterId", "content", "contentType", "hashtags", "id", "isPublic", "mentions", "modifiedTime", "rootCategoryId", "status" ]
988
+ },
989
+ "articleTranslationResponse" : {
990
+ "type" : [ "null", "object" ],
991
+ "additionalProperties" : false,
992
+ "properties" : {
993
+ "id" : {
994
+ "type" : [ "string", "null", "integer" ],
995
+ "format" : "int64",
996
+ "pattern" : "([0-9]+)"
997
+ },
998
+ "locale" : {
999
+ "type" : [ "string", "null" ],
1000
+ "maxLength" : 10,
1001
+ "minLength" : 0
1002
+ },
1003
+ "translationId" : {
1004
+ "type" : [ "string", "null", "integer" ],
1005
+ "format" : "int64",
1006
+ "pattern" : "([0-9]+)"
1007
+ },
1008
+ "title" : {
1009
+ "type" : [ "string", "null" ],
1010
+ "maxLength" : 1000,
1011
+ "minLength" : 0,
1012
+ "x-custom-parameters-attributes" : {
1013
+ "removeExif" : false,
1014
+ "filterMatchedContent" : false,
1015
+ "antivirus" : false,
1016
+ "replacementString" : "",
1017
+ "allowInvalid" : false,
1018
+ "descrption" : "Title of the article translation.",
1019
+ "secret" : false,
1020
+ "preserveCharsLimit" : 10,
1021
+ "trim" : false,
1022
+ "internalParam" : false,
1023
+ "preserveChars" : "0,5",
1024
+ "importUrl" : false,
1025
+ "decrypt" : false
1026
+ }
1027
+ }
1028
+ },
1029
+ "required" : [ "id", "locale", "title", "translationId" ]
1030
+ },
1031
+ "articleTranslationResponseWithWebUrl" : {
1032
+ "allOf" : [ {
1033
+ "$ref" : "#/components/schemas/articleTranslationResponse"
1034
+ }, {
1035
+ "type" : [ "null", "object" ],
1036
+ "additionalProperties" : false,
1037
+ "properties" : {
1038
+ "webUrl" : {
1039
+ "type" : [ "string", "null" ],
1040
+ "maxLength" : 500,
1041
+ "minLength" : 0,
1042
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
1043
+ }
1044
+ },
1045
+ "required" : [ "webUrl" ]
1046
+ } ]
1047
+ },
1048
+ "categoryResponse" : {
1049
+ "type" : [ "null", "object" ],
1050
+ "additionalProperties" : false,
1051
+ "properties" : {
1052
+ "id" : {
1053
+ "type" : [ "string", "null", "integer" ],
1054
+ "format" : "int64",
1055
+ "pattern" : "([0-9]+)"
1056
+ },
1057
+ "name" : {
1058
+ "type" : [ "string", "null" ],
1059
+ "maxLength" : 100,
1060
+ "minLength" : 0
1061
+ },
1062
+ "locale" : {
1063
+ "type" : [ "string", "null" ],
1064
+ "maxLength" : 2,
1065
+ "minLength" : 0
1066
+ }
1067
+ }
1068
+ },
1069
+ "commentListLiteResponse" : {
1070
+ "type" : [ "null", "object" ],
1071
+ "additionalProperties" : false,
1072
+ "properties" : {
1073
+ "status" : {
1074
+ "type" : [ "string", "null" ],
1075
+ "enum" : [ "PUBLISHED", "AWAITINGAPPROVAL" ],
1076
+ "maxLength" : 100,
1077
+ "minLength" : 0
1078
+ },
1079
+ "ticketId" : {
1080
+ "type" : [ "string", "null", "integer" ],
1081
+ "format" : "int64",
1082
+ "pattern" : "([0-9]+)"
1083
+ },
1084
+ "id" : {
1085
+ "type" : [ "string", "null", "integer" ],
1086
+ "format" : "int64",
1087
+ "pattern" : "([0-9]+)"
1088
+ },
1089
+ "isPublic" : {
1090
+ "type" : [ "boolean", "null" ],
1091
+ "x-custom-parameters-attributes" : {
1092
+ "removeExif" : false,
1093
+ "filterMatchedContent" : false,
1094
+ "antivirus" : false,
1095
+ "replacementString" : "",
1096
+ "allowInvalid" : false,
1097
+ "descrption" : "Visibility of the comment, which can be set only at the time of commenting. ",
1098
+ "secret" : false,
1099
+ "preserveCharsLimit" : 10,
1100
+ "trim" : false,
1101
+ "internalParam" : false,
1102
+ "preserveChars" : "0,5",
1103
+ "importUrl" : false,
1104
+ "decrypt" : false
1105
+ }
1106
+ },
1107
+ "ticket" : {
1108
+ "$ref" : "./ArticleComment.json#/components/schemas/ticketMetaResponse"
1109
+ },
1110
+ "isTrashed" : {
1111
+ "type" : [ "boolean", "null" ]
1112
+ }
1113
+ }
1114
+ },
1115
+ "commentListResponse" : {
1116
+ "type" : [ "null", "object" ],
1117
+ "additionalProperties" : false,
1118
+ "properties" : {
1119
+ "modifiedTime" : {
1120
+ "type" : [ "string", "null" ],
1121
+ "maxLength" : 100,
1122
+ "minLength" : 0,
1123
+ "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
1124
+ },
1125
+ "attachments" : {
1126
+ "$ref" : "./ArticleComment.json#/components/schemas/attachments"
1127
+ },
1128
+ "hashtags" : {
1129
+ "$ref" : "./ArticleComment.json#/components/schemas/hashtags"
1130
+ },
1131
+ "commentedTime" : {
1132
+ "type" : [ "string", "null" ],
1133
+ "maxLength" : 100,
1134
+ "minLength" : 0,
1135
+ "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
1136
+ },
1137
+ "commenterName" : {
1138
+ "type" : [ "string", "null" ],
1139
+ "maxLength" : 100,
1140
+ "minLength" : 0
1141
+ },
1142
+ "content" : {
1143
+ "type" : [ "string", "null" ],
1144
+ "maxLength" : 32000,
1145
+ "minLength" : 0,
1146
+ "x-custom-parameters-attributes" : {
1147
+ "removeExif" : false,
1148
+ "filterMatchedContent" : false,
1149
+ "antivirus" : false,
1150
+ "replacementString" : "",
1151
+ "allowInvalid" : false,
1152
+ "descrption" : "Content of the comment. To retrieve or set user mentions, use this code format: AGENT : _zsu[@user:{zuid}]zsu_, Enduser : _zsu[@enduser:{zuid}]zsu_, Group : _zsu[@group:{groupid}]zsu_, HashTag : _zsh[#{HEADER_DATA}]zsh_.",
1153
+ "secret" : false,
1154
+ "preserveCharsLimit" : 10,
1155
+ "trim" : false,
1156
+ "internalParam" : false,
1157
+ "preserveChars" : "0,5",
1158
+ "xss" : "antisamyfilter_kbcommentspolicy",
1159
+ "importUrl" : false,
1160
+ "decrypt" : false
1161
+ }
1162
+ },
1163
+ "commenterId" : {
1164
+ "type" : [ "string", "null", "integer" ],
1165
+ "format" : "int64",
1166
+ "pattern" : "([0-9]+)"
1167
+ },
1168
+ "commenter" : {
1169
+ "$ref" : "./ArticleComment.json#/components/schemas/commenter"
1170
+ },
1171
+ "impersonatedUser" : {
1172
+ "$ref" : "./TicketComment.json#/components/schemas/impersonatedUser"
1173
+ },
1174
+ "encodedContent" : {
1175
+ "type" : [ "string", "null" ],
1176
+ "maxLength" : 100,
1177
+ "minLength" : 0
1178
+ },
1179
+ "mentions" : {
1180
+ "$ref" : "./ArticleComment.json#/components/schemas/mentionObjResponse"
1181
+ },
1182
+ "isPublic" : {
1183
+ "type" : [ "boolean", "null" ],
1184
+ "x-custom-parameters-attributes" : {
1185
+ "removeExif" : false,
1186
+ "filterMatchedContent" : false,
1187
+ "antivirus" : false,
1188
+ "replacementString" : "",
1189
+ "allowInvalid" : false,
1190
+ "descrption" : "Visibility of the comment, which can be set only at the time of commenting. ",
1191
+ "secret" : false,
1192
+ "preserveCharsLimit" : 10,
1193
+ "trim" : false,
1194
+ "internalParam" : false,
1195
+ "preserveChars" : "0,5",
1196
+ "importUrl" : false,
1197
+ "decrypt" : false
1198
+ }
1199
+ },
1200
+ "id" : {
1201
+ "type" : [ "string", "null", "integer" ],
1202
+ "format" : "int64",
1203
+ "pattern" : "([0-9]+)"
1204
+ },
1205
+ "contentType" : {
1206
+ "type" : [ "string", "null" ],
1207
+ "enum" : [ "plainText", "html" ],
1208
+ "maxLength" : 100,
1209
+ "minLength" : 0,
1210
+ "x-custom-parameters-attributes" : {
1211
+ "removeExif" : false,
1212
+ "filterMatchedContent" : false,
1213
+ "antivirus" : false,
1214
+ "replacementString" : "",
1215
+ "allowInvalid" : false,
1216
+ "descrption" : "Used to denote the content-type which maybe @html@ or @plainText@. The default type is @html@.",
1217
+ "secret" : false,
1218
+ "preserveCharsLimit" : 10,
1219
+ "trim" : false,
1220
+ "internalParam" : false,
1221
+ "preserveChars" : "0,5",
1222
+ "importUrl" : false,
1223
+ "decrypt" : false
1224
+ }
1225
+ },
1226
+ "ticketId" : {
1227
+ "type" : [ "string", "null", "integer" ],
1228
+ "format" : "int64",
1229
+ "pattern" : "([0-9]+)"
1230
+ },
1231
+ "status" : {
1232
+ "type" : [ "string", "null" ],
1233
+ "enum" : [ "PUBLISHED", "AWAITINGAPPROVAL" ],
1234
+ "maxLength" : 100,
1235
+ "minLength" : 0
1236
+ }
1237
+ },
1238
+ "required" : [ "attachments", "commentedTime", "commenter", "commenterId", "commenterName", "content", "contentType", "encodedContent", "hashtags", "id", "impersonatedUser", "isPublic", "mentions", "modifiedTime", "status", "ticketId" ]
1239
+ },
1240
+ "commentListResponseArray" : {
1241
+ "type" : [ "null", "array" ],
1242
+ "items" : {
1243
+ "$ref" : "./ArticleComment.json#/components/schemas/commentListResponse"
1244
+ }
1245
+ },
1246
+ "commentListLiteResponseArray" : {
1247
+ "type" : [ "null", "array" ],
1248
+ "items" : {
1249
+ "$ref" : "./ArticleComment.json#/components/schemas/commentListLiteResponse"
1250
+ }
1251
+ }
1252
+ },
1253
+ "responses" : {
1254
+ "commentResponse" : {
1255
+ "description" : "commentResponse template definitions",
1256
+ "content" : {
1257
+ "application/json" : {
1258
+ "schema" : {
1259
+ "additionalProperties" : false,
1260
+ "allOf" : [ {
1261
+ "$ref" : "./ArticleComment.json#/components/schemas/commentListResponse"
1262
+ }, {
1263
+ "type" : [ "null", "object" ],
1264
+ "properties" : {
1265
+ "ticket" : {
1266
+ "$ref" : "./ArticleComment.json#/components/schemas/ticketMetaResponse"
1267
+ }
1268
+ },
1269
+ "required" : [ "ticket" ]
1270
+ } ]
1271
+ },
1272
+ "examples" : {
1273
+ "Valid responses Definitions" : {
1274
+ "value" : {
1275
+ "modifiedTime" : 1652101829000,
1276
+ "attachments" : [ {
1277
+ "previewurl" : "https://desk.zoho.com/api/v1/articles/46582000006958052/translations/en/attachments/nmhny14ce774984eb4b15891e1cbe274e612c/content?orgId=57044830",
1278
+ "size" : "35594",
1279
+ "name" : "Zoho desk introduction.jpg",
1280
+ "id" : "4658200041001",
1281
+ "href" : "https://downloadserver.zoho.com/webdownload?x-service=desk&event-id=b45a36decdceb443ccb4d3445f29c9966de7dee89041ea315318c4f358836a09e07add42e10810f8961c3f92bf853"
1282
+ } ],
1283
+ "tickets" : {
1284
+ "ticketNumber" : "115",
1285
+ "isTrashed" : "false",
1286
+ "webUrl" : "https://desk.zoho.com/agent/zohocorp/desk/tickets/details/5000000114001",
1287
+ "id" : "5000000114001"
1288
+ },
1289
+ "hashtags" : [ {
1290
+ "offset" : "47",
1291
+ "length" : "33",
1292
+ "headerValue" : "Introduction",
1293
+ "headerId" : "Sample_header"
1294
+ } ],
1295
+ "commentedTime" : 1652072940000,
1296
+ "commenterName" : "Jack",
1297
+ "content" : "<div>Changed Sample content zsu[@user:695624]zsu&nbsp; zsh[#sample_header:Introduction]zsh&nbsp;</div>",
1298
+ "commenterId" : "4658200004039",
1299
+ "commenter" : {
1300
+ "firstName" : "",
1301
+ "lastName" : "Jack",
1302
+ "photoURL" : "https://desk.zoho.com/api/v1/agents/4658200004039/photo?orgId=292828",
1303
+ "webUrl" : "https://desk.zoho.com/support/arunice/ShowHomePage.do#setup/users-control/agents/1000000000351",
1304
+ "roleName" : "CEO",
1305
+ "name" : "Jack",
1306
+ "id" : "4658200004039",
1307
+ "label" : {
1308
+ "preferences" : {
1309
+ "shape" : "RECTANGLE",
1310
+ "bgColor" : "#5C6368",
1311
+ "textColor" : "#FFFFFF"
1312
+ },
1313
+ "name" : "MVP",
1314
+ "id" : "5000000081007",
1315
+ "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/35531135311?portalId=3153815r1fnf113131rf31n9"
1316
+ },
1317
+ "type" : "AGENT",
1318
+ "email" : "Jack@gmail.com",
1319
+ "kbRole" : "REVIEWER"
1320
+ },
1321
+ "mentions" : {
1322
+ "groups" : [ {
1323
+ "offSet" : "260",
1324
+ "name" : "MVP",
1325
+ "length" : "28",
1326
+ "id" : "5000000113025",
1327
+ "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/4658200004039?portalId=292828341431fq"
1328
+ } ],
1329
+ "users" : [ {
1330
+ "firstName" : "",
1331
+ "lastName" : "Cristiano",
1332
+ "photoURL" : "https://desk.zoho.com/api/v1/agents/4658200044017/photo?orgId=292828",
1333
+ "webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#setup/users-control/agents/5000000000347",
1334
+ "length" : "28",
1335
+ "name" : "Cristiano",
1336
+ "id" : "4658200044017",
1337
+ "label" : {
1338
+ "preferences" : {
1339
+ "shape" : "ROUNDED",
1340
+ "bgColor" : "#CE6785",
1341
+ "textColor" : "#FFFFFF"
1342
+ },
1343
+ "name" : "Prime user",
1344
+ "id" : "5000000081001",
1345
+ "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/35531135311?portalId=3153815r1fnf113131rf31n8"
1346
+ },
1347
+ "type" : "AGENT",
1348
+ "email" : "Cristiano@gmail.com",
1349
+ "zuid" : "695624",
1350
+ "kbRole" : "REVIEWER"
1351
+ } ]
1352
+ },
1353
+ "isPublic" : true,
1354
+ "id" : "4658200041003",
1355
+ "contentType" : "html",
1356
+ "ticketId" : "5000000114001",
1357
+ "status" : "PUBLISHED"
1358
+ }
1359
+ }
1360
+ }
1361
+ }
1362
+ },
1363
+ "x-custom-response-attributes" : {
1364
+ "disable-safe-headers" : "[]"
1365
+ }
1366
+ },
1367
+ "ticketMetaResponse" : {
1368
+ "description" : "ticketMetaResponse template definitions",
1369
+ "content" : {
1370
+ "application/json" : {
1371
+ "schema" : {
1372
+ "type" : [ "null", "object" ],
1373
+ "additionalProperties" : false,
1374
+ "properties" : {
1375
+ "ticketNumber" : {
1376
+ "type" : [ "string", "null", "integer" ],
1377
+ "format" : "int32",
1378
+ "pattern" : "([0-9]+)"
1379
+ },
1380
+ "isTrashed" : {
1381
+ "type" : [ "boolean", "null" ]
1382
+ },
1383
+ "webUrl" : {
1384
+ "type" : [ "string", "null" ],
1385
+ "maxLength" : 500,
1386
+ "minLength" : 0,
1387
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&amp;%\\$#_@]*)?$)"
1388
+ },
1389
+ "id" : {
1390
+ "type" : [ "string", "null", "integer" ],
1391
+ "format" : "int64",
1392
+ "pattern" : "([0-9]+)"
1393
+ }
1394
+ },
1395
+ "required" : [ "id", "isTrashed", "ticketNumber", "webUrl" ]
1396
+ },
1397
+ "examples" : {
1398
+ "Valid responses Definitions" : {
1399
+ "value" : {
1400
+ "ticketNumber" : "115",
1401
+ "isTrashed" : "false",
1402
+ "webUrl" : "https://desk.zoho.com/agent/zohocorp/desk/tickets/details/5000000114001",
1403
+ "id" : "5000000114001"
1404
+ }
1405
+ }
1406
+ }
1407
+ }
1408
+ },
1409
+ "x-custom-response-attributes" : {
1410
+ "disable-safe-headers" : "[]"
1411
+ }
1412
+ },
1413
+ "listOfModeratedComments" : {
1414
+ "description" : "listOfModeratedComments template definitions",
1415
+ "content" : {
1416
+ "application/json" : {
1417
+ "schema" : {
1418
+ "type" : [ "null", "object" ],
1419
+ "additionalProperties" : false,
1420
+ "properties" : {
1421
+ "data" : {
1422
+ "$ref" : "./ArticleComment.json#/components/schemas/moderationCommentListArray"
1423
+ }
1424
+ },
1425
+ "required" : [ "data" ]
1426
+ },
1427
+ "examples" : {
1428
+ "Valid responses Definitions" : {
1429
+ "value" : {
1430
+ "hashtags" : [ {
1431
+ "offSet" : "5",
1432
+ "length" : "28",
1433
+ "headerId" : "superstar",
1434
+ "headerValue" : "superstar"
1435
+ }, {
1436
+ "offSet" : "82",
1437
+ "length" : "44",
1438
+ "headerId" : "christanao",
1439
+ "headerValue" : "Thideer Thalapthy"
1440
+ } ],
1441
+ "categoryId" : "2000000501003",
1442
+ "id" : "2000000502121",
1443
+ "commenterId" : "2000000101060",
1444
+ "isPublic" : true,
1445
+ "rootCategoryId" : "2000000501003",
1446
+ "status" : "AWAITINGAPPROVAL",
1447
+ "modifiedTime" : "2025-06-12T12:05:36.000Z",
1448
+ "articleTranslation" : {
1449
+ "translationId" : "2000000501032",
1450
+ "title" : "Moderation Article",
1451
+ "id" : "2000000501030",
1452
+ "locale" : "en"
1453
+ },
1454
+ "commentedTime" : "2025-06-12T12:05:36.000Z",
1455
+ "articleTranslationId" : "2000000501032",
1456
+ "commenter" : {
1457
+ "kbRole" : null,
1458
+ "id" : "2000000101060",
1459
+ "firstName" : "",
1460
+ "lastName" : "christiano",
1461
+ "email" : "christiano@gmail.com",
1462
+ "photoURL" : null,
1463
+ "roleName" : "PortalUser",
1464
+ "webUrl" : "https://test.portal.com/support/mac1/ShowHomePage.do#Contacts/dv/2000000101022",
1465
+ "name" : "christiano",
1466
+ "label" : null,
1467
+ "type" : "END_USER"
1468
+ },
1469
+ "mentions" : {
1470
+ "users" : [ {
1471
+ "name" : "christiano",
1472
+ "id" : "2000000101060",
1473
+ "webUrl" : "https://test.portal.com/support/mac1/ShowHomePage.do#Contacts/dv/2000000101022",
1474
+ "offSet" : "175",
1475
+ "length" : "27",
1476
+ "photoURL" : null,
1477
+ "firstName" : "",
1478
+ "lastName" : "christiano",
1479
+ "zuid" : "1029068935",
1480
+ "email" : "christiano@gmail.com",
1481
+ "kbRole" : null,
1482
+ "type" : "END_USER",
1483
+ "label" : null
1484
+ } ],
1485
+ "groups" : [ ]
1486
+ },
1487
+ "content" : "<div>zsh[#superstar:superstar]zsh<span>&nbsp;</span><br></div><div><br></div><div>zsh[#christanao:Thideer Thalapthy]zsh<span>&nbsp;</span><br></div><div><br></div><div>zsu[@enduser:1029068935]zsu<span>&nbsp; please check this</span><br></div>",
1488
+ "contentType" : "html",
1489
+ "category" : {
1490
+ "name" : "Moderation CAtegory",
1491
+ "id" : "2000000501003",
1492
+ "locale" : "en"
1493
+ }
1494
+ }
1495
+ }
1496
+ }
1497
+ }
1498
+ }
1499
+ },
1500
+ "listOfComments" : {
1501
+ "description" : "listOfComments template definitions",
1502
+ "content" : {
1503
+ "application/json" : {
1504
+ "schema" : {
1505
+ "allOf" : [ {
1506
+ "type" : "object",
1507
+ "properties" : {
1508
+ "data" : {
1509
+ "type" : "array",
1510
+ "items" : {
1511
+ "type" : "object",
1512
+ "properties" : {
1513
+ "ticket" : {
1514
+ "type" : [ "null", "object" ],
1515
+ "additionalProperties" : false,
1516
+ "maxProperties" : 4,
1517
+ "minProperties" : 4,
1518
+ "properties" : {
1519
+ "ticketNumber" : {
1520
+ "type" : [ "string", "null", "integer" ],
1521
+ "format" : "int32",
1522
+ "pattern" : "([0-9]+)"
1523
+ },
1524
+ "isTrashed" : {
1525
+ "type" : [ "boolean", "null" ]
1526
+ },
1527
+ "webUrl" : {
1528
+ "type" : [ "string", "null" ],
1529
+ "maxLength" : 500,
1530
+ "minLength" : 0,
1531
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&amp;%\\$#_@]*)?$)"
1532
+ },
1533
+ "id" : {
1534
+ "type" : [ "string", "null", "integer" ],
1535
+ "format" : "int64",
1536
+ "pattern" : "([0-9]+)"
1537
+ }
1538
+ },
1539
+ "required" : [ "id", "isTrashed", "ticketNumber", "webUrl" ]
1540
+ }
1541
+ }
1542
+ }
1543
+ }
1544
+ }
1545
+ }, {
1546
+ "type" : [ "null", "object" ],
1547
+ "additionalProperties" : false,
1548
+ "properties" : {
1549
+ "data" : {
1550
+ "$ref" : "./ArticleComment.json#/components/schemas/commentListResponseArray"
1551
+ }
1552
+ },
1553
+ "required" : [ "data" ]
1554
+ } ]
1555
+ },
1556
+ "examples" : {
1557
+ "Valid responses Definitions" : {
1558
+ "value" : {
1559
+ "data" : [ {
1560
+ "modifiedTime" : 1652101829000,
1561
+ "attachments" : [ {
1562
+ "previewurl" : "https://desk.zoho.com/api/v1/articles/46582000006958052/translations/en/attachments/nmhny14ce774984eb4b15891e1cbe274e612c/content?orgId=57044830",
1563
+ "size" : "35594",
1564
+ "name" : "Zoho desk introduction.jpg",
1565
+ "id" : "4658200041001",
1566
+ "href" : "https://downloadserver.zoho.com/webdownload?x-service=desk&event-id=b45a36decdceb443ccb4d3445f29c9966de7dee89041ea315318c4f358836a09e07add42e10810f8961c3f92bf853"
1567
+ } ],
1568
+ "tickets" : {
1569
+ "ticketNumber" : "115",
1570
+ "isTrashed" : "false",
1571
+ "webUrl" : "https://desk.zoho.com/agent/zohocorp/desk/tickets/details/5000000114001",
1572
+ "id" : "5000000114001"
1573
+ },
1574
+ "hashtags" : [ {
1575
+ "offset" : "47",
1576
+ "length" : "33",
1577
+ "headerValue" : "Introduction",
1578
+ "headerId" : "Sample_header"
1579
+ } ],
1580
+ "commentedTime" : 1652072940000,
1581
+ "commenterName" : "Jack",
1582
+ "content" : "<div>Changed Sample content zsu[@user:695624]zsu&nbsp; zsh[#sample_header:Introduction]zsh&nbsp;</div>",
1583
+ "commenterId" : "4658200004039",
1584
+ "commenter" : {
1585
+ "firstName" : "",
1586
+ "lastName" : "Jack",
1587
+ "photoURL" : "https://desk.zoho.com/api/v1/agents/4658200004039/photo?orgId=292828",
1588
+ "webUrl" : "https://desk.zoho.com/support/arunice/ShowHomePage.do#setup/users-control/agents/1000000000351",
1589
+ "roleName" : "CEO",
1590
+ "name" : "Jack",
1591
+ "id" : "4658200004039",
1592
+ "label" : {
1593
+ "preferences" : {
1594
+ "shape" : "RECTANGLE",
1595
+ "bgColor" : "#5C6368",
1596
+ "textColor" : "#FFFFFF"
1597
+ },
1598
+ "name" : "MVP",
1599
+ "id" : "5000000081007",
1600
+ "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/35531135311?portalId=3153815r1fnf113131rf31n9"
1601
+ },
1602
+ "type" : "AGENT",
1603
+ "email" : "Jack@gmail.com",
1604
+ "kbRole" : "REVIEWER"
1605
+ },
1606
+ "mentions" : {
1607
+ "groups" : [ {
1608
+ "offSet" : "260",
1609
+ "name" : "MVP",
1610
+ "length" : "28",
1611
+ "id" : "5000000113025",
1612
+ "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/4658200004039?portalId=292828341431fq"
1613
+ } ],
1614
+ "users" : [ {
1615
+ "firstName" : "",
1616
+ "lastName" : "Cristiano",
1617
+ "photoURL" : "https://desk.zoho.com/api/v1/agents/4658200044017/photo?orgId=292828",
1618
+ "webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#setup/users-control/agents/5000000000347",
1619
+ "length" : "28",
1620
+ "name" : "Cristiano",
1621
+ "id" : "4658200044017",
1622
+ "label" : {
1623
+ "preferences" : {
1624
+ "shape" : "ROUNDED",
1625
+ "bgColor" : "#CE6785",
1626
+ "textColor" : "#FFFFFF"
1627
+ },
1628
+ "name" : "Prime user",
1629
+ "id" : "5000000081001",
1630
+ "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/35531135311?portalId=3153815r1fnf113131rf31n8"
1631
+ },
1632
+ "type" : "AGENT",
1633
+ "email" : "Cristiano@gmail.com",
1634
+ "zuid" : "695624",
1635
+ "kbRole" : "REVIEWER"
1636
+ } ]
1637
+ },
1638
+ "isPublic" : true,
1639
+ "id" : "4658200041003",
1640
+ "contentType" : "html",
1641
+ "ticketId" : "5000000114001",
1642
+ "status" : "PUBLISHED"
1643
+ } ]
1644
+ }
1645
+ }
1646
+ }
1647
+ }
1648
+ },
1649
+ "x-custom-response-attributes" : {
1650
+ "disable-safe-headers" : "[]"
1651
+ }
1652
+ }
1653
+ },
1654
+ "parameters" : {
1655
+ "articleId" : {
1656
+ "name" : "articleId",
1657
+ "in" : "path",
1658
+ "required" : true,
1659
+ "style" : "simple",
1660
+ "explode" : false,
1661
+ "schema" : {
1662
+ "type" : [ "string", "null", "integer" ],
1663
+ "format" : "int64",
1664
+ "pattern" : "([0-9]+)"
1665
+ }
1666
+ },
1667
+ "commentId" : {
1668
+ "name" : "commentId",
1669
+ "in" : "path",
1670
+ "required" : true,
1671
+ "style" : "simple",
1672
+ "explode" : false,
1673
+ "schema" : {
1674
+ "type" : [ "string", "null", "integer" ],
1675
+ "format" : "int64",
1676
+ "pattern" : "([0-9]+)"
1677
+ }
1678
+ },
1679
+ "locale" : {
1680
+ "name" : "locale",
1681
+ "in" : "path",
1682
+ "required" : true,
1683
+ "style" : "simple",
1684
+ "explode" : false,
1685
+ "schema" : {
1686
+ "type" : [ "string", "null" ],
1687
+ "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" ],
1688
+ "maxLength" : 100,
1689
+ "minLength" : 0,
1690
+ "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)"
1691
+ }
1692
+ },
1693
+ "locale_query" : {
1694
+ "name" : "locale",
1695
+ "in" : "query",
1696
+ "description" : "Fetches the moderated comments based on the specified language.",
1697
+ "required" : false,
1698
+ "style" : "form",
1699
+ "explode" : true,
1700
+ "schema" : {
1701
+ "type" : [ "string", "null" ],
1702
+ "description" : "Fetches the moderated comments based on the specified language.",
1703
+ "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" ],
1704
+ "maxLength" : 100,
1705
+ "minLength" : 0,
1706
+ "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)"
1707
+ }
1708
+ },
1709
+ "limit" : {
1710
+ "name" : "limit",
1711
+ "in" : "query",
1712
+ "description" : "Limits the maximum number of comments to fetch.",
1713
+ "required" : false,
1714
+ "style" : "form",
1715
+ "explode" : true,
1716
+ "schema" : {
1717
+ "type" : [ "string", "null", "integer" ],
1718
+ "format" : "int32",
1719
+ "description" : "Limits the maximum number of comments to fetch.",
1720
+ "maximum" : 50,
1721
+ "pattern" : "([0-9]+)"
1722
+ }
1723
+ },
1724
+ "from" : {
1725
+ "name" : "from",
1726
+ "in" : "query",
1727
+ "description" : "Index number starting from which the moderated comments must be fetched",
1728
+ "required" : false,
1729
+ "style" : "form",
1730
+ "explode" : true,
1731
+ "schema" : {
1732
+ "type" : [ "string", "null", "integer" ],
1733
+ "format" : "int32",
1734
+ "description" : "Index number starting from which the moderated comments must be fetched",
1735
+ "pattern" : "([0-9]+)"
1736
+ }
1737
+ },
1738
+ "commentedBy" : {
1739
+ "name" : "commentedBy",
1740
+ "in" : "query",
1741
+ "description" : "Fetches only the comments made by the specified user (ID).",
1742
+ "required" : false,
1743
+ "style" : "form",
1744
+ "explode" : true,
1745
+ "schema" : {
1746
+ "type" : [ "string", "null", "integer" ],
1747
+ "format" : "int64",
1748
+ "description" : "Fetches only the comments made by the specified user (ID).",
1749
+ "pattern" : "([0-9]+)"
1750
+ }
1751
+ },
1752
+ "categoryId" : {
1753
+ "name" : "categoryId",
1754
+ "in" : "query",
1755
+ "description" : "Fetches only the comments made by the specified category (ID).",
1756
+ "required" : false,
1757
+ "style" : "form",
1758
+ "explode" : true,
1759
+ "schema" : {
1760
+ "type" : [ "string", "null", "integer" ],
1761
+ "format" : "int64",
1762
+ "description" : "Fetches only the comments made by the specified category (ID).",
1763
+ "pattern" : "([0-9]+)"
1764
+ }
1765
+ }
1766
+ },
1767
+ "requestBodies" : {
1768
+ "addCommentInput" : {
1769
+ "content" : {
1770
+ "application/json" : {
1771
+ "schema" : {
1772
+ "type" : [ "null", "object" ],
1773
+ "additionalProperties" : false,
1774
+ "properties" : {
1775
+ "isPublic" : {
1776
+ "type" : [ "boolean", "null" ],
1777
+ "description" : "Visibility of the comment, which can be set only at the time of commenting. "
1778
+ },
1779
+ "attachmentIds" : {
1780
+ "type" : [ "null", "array" ],
1781
+ "items" : {
1782
+ "type" : [ "string", "null", "integer" ],
1783
+ "format" : "int64",
1784
+ "pattern" : "([0-9]+)",
1785
+ "x-custom-parameters-attributes" : [ { } ]
1786
+ },
1787
+ "uniqueItems" : false
1788
+ },
1789
+ "contentType" : {
1790
+ "type" : [ "string", "null" ],
1791
+ "description" : "Used to denote the content-type which maybe @html@ or @plainText@. The default type is @html@.",
1792
+ "enum" : [ "plainText", "html" ],
1793
+ "maxLength" : 100,
1794
+ "minLength" : 0
1795
+ },
1796
+ "content" : {
1797
+ "type" : [ "string", "null" ],
1798
+ "description" : "Content of the comment. To retrieve or set user mentions, use this code format: AGENT : _zsu[@user:{zuid}]zsu_, Enduser : _zsu[@enduser:{zuid}]zsu_, Group : _zsu[@group:{groupid}]zsu_, HashTag : _zsh[#{HEADER_DATA}]zsh_.",
1799
+ "maxLength" : 32000,
1800
+ "minLength" : 0,
1801
+ "x-custom-parameters-attributes" : {
1802
+ "xss" : "antisamyfilter_kbcommentspolicy"
1803
+ }
1804
+ }
1805
+ },
1806
+ "required" : [ "content", "contentType", "isPublic" ]
1807
+ },
1808
+ "examples" : {
1809
+ "Valid requestBody Definitions" : {
1810
+ "value" : {
1811
+ "isPublic" : "false",
1812
+ "attachmentIds" : [ "4658200041001" ],
1813
+ "contentType" : "html",
1814
+ "content" : "<div>Sample content zsu[@user:695624]zsu&nbsp; zsh[#sample_header:Introduction]zsh&nbsp;</div>"
1815
+ }
1816
+ }
1817
+ }
1818
+ }
1819
+ },
1820
+ "x-custom-request-body-attributes" : {
1821
+ "non-empty" : false,
1822
+ "allow-invalid" : false
1823
+ }
1824
+ },
1825
+ "commentIdsJson" : {
1826
+ "content" : {
1827
+ "application/json" : {
1828
+ "schema" : {
1829
+ "type" : [ "null", "object" ],
1830
+ "additionalProperties" : false,
1831
+ "properties" : {
1832
+ "ids" : {
1833
+ "type" : [ "null", "array" ],
1834
+ "items" : {
1835
+ "type" : [ "string", "null", "integer" ],
1836
+ "format" : "int64",
1837
+ "pattern" : "([0-9]+)",
1838
+ "x-custom-parameters-attributes" : [ { } ]
1839
+ },
1840
+ "uniqueItems" : false
1841
+ }
1842
+ },
1843
+ "required" : [ "ids" ]
1844
+ },
1845
+ "examples" : {
1846
+ "Valid requestBody Definitions" : {
1847
+ "value" : {
1848
+ "ids" : [ "2000000117009", "2000000116060" ]
1849
+ }
1850
+ }
1851
+ }
1852
+ }
1853
+ },
1854
+ "x-custom-request-body-attributes" : {
1855
+ "non-empty" : false,
1856
+ "allow-invalid" : false
1857
+ }
1858
+ },
1859
+ "updateCommentInput" : {
1860
+ "content" : {
1861
+ "application/json" : {
1862
+ "schema" : {
1863
+ "type" : [ "null", "object" ],
1864
+ "additionalProperties" : false,
1865
+ "properties" : {
1866
+ "isPublic" : {
1867
+ "type" : [ "boolean", "null" ],
1868
+ "description" : "Visibility of the comment, which can be set only at the time of commenting. "
1869
+ },
1870
+ "attachmentIds" : {
1871
+ "type" : [ "null", "array" ],
1872
+ "items" : {
1873
+ "type" : [ "string", "null", "integer" ],
1874
+ "format" : "int64",
1875
+ "pattern" : "([0-9]+)",
1876
+ "x-custom-parameters-attributes" : [ { } ]
1877
+ },
1878
+ "uniqueItems" : false
1879
+ },
1880
+ "contentType" : {
1881
+ "type" : [ "string", "null" ],
1882
+ "description" : "Used to denote the content-type which maybe @html@ or @plainText@. The default type is @html@.",
1883
+ "enum" : [ "plainText", "html" ],
1884
+ "maxLength" : 100,
1885
+ "minLength" : 0
1886
+ },
1887
+ "content" : {
1888
+ "type" : [ "string", "null" ],
1889
+ "description" : "Content of the comment. To retrieve or set user mentions, use this code format: AGENT : _zsu[@user:{zuid}]zsu_, Enduser : _zsu[@enduser:{zuid}]zsu_, Group : _zsu[@group:{groupid}]zsu_, HashTag : _zsh[#{HEADER_DATA}]zsh_.",
1890
+ "maxLength" : 32000,
1891
+ "minLength" : 0,
1892
+ "x-custom-parameters-attributes" : {
1893
+ "xss" : "antisamyfilter_kbcommentspolicy"
1894
+ }
1895
+ }
1896
+ }
1897
+ },
1898
+ "examples" : {
1899
+ "Valid requestBody Definitions" : {
1900
+ "value" : {
1901
+ "isPublic" : true,
1902
+ "attachmentIds" : [ "4658200041001" ],
1903
+ "contentType" : "html",
1904
+ "content" : "<div>Changed Sample content zsu[@user:695624]zsu&nbsp; zsh[#sample_header:Introduction]zsh&nbsp;</div>"
1905
+ }
1906
+ }
1907
+ }
1908
+ }
1909
+ },
1910
+ "x-custom-request-body-attributes" : {
1911
+ "non-empty" : false,
1912
+ "allow-invalid" : false
1913
+ }
1914
+ }
1915
+ },
1916
+ "securitySchemes" : {
1917
+ "cookie-auth" : {
1918
+ "$ref" : "../common/Common.json#/components/securitySchemes/cookie-auth"
1919
+ },
1920
+ "org-oauth" : {
1921
+ "$ref" : "../common/Common.json#/components/securitySchemes/org-oauth"
1922
+ },
1923
+ "iam-oauth2-schema" : {
1924
+ "$ref" : "../common/Common.json#/components/securitySchemes/iam-oauth2-schema"
1925
+ }
1926
+ }
1927
+ },
1928
+ "x-entity" : "ArticleComment"
1929
+ }