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,1618 @@
1
+ {
2
+ "openapi" : "3.1.0",
3
+ "info" : {
4
+ "title" : "KbCategory",
5
+ "version" : "1.0.0",
6
+ "x-clan-group" : "helpCenter",
7
+ "x-module-group" : "kb"
8
+ },
9
+ "paths" : {
10
+ "/api/v1/kbCategory/{categoryId}/articles" : {
11
+ "get" : {
12
+ "tags" : [ "KbCategory" ],
13
+ "summary" : "Get Articles under a category",
14
+ "description" : "API gets the list of child section along with articles under given category",
15
+ "operationId" : "getArticlesUnderCategory",
16
+ "parameters" : [ {
17
+ "name" : "limit",
18
+ "in" : "query",
19
+ "description" : "the limit index",
20
+ "required" : false,
21
+ "style" : "form",
22
+ "explode" : true,
23
+ "schema" : {
24
+ "type" : [ "string", "null", "integer" ],
25
+ "format" : "int32",
26
+ "description" : "the limit index",
27
+ "maximum" : 10,
28
+ "minimum" : 1,
29
+ "pattern" : "([0-9]+)"
30
+ }
31
+ }, {
32
+ "name" : "from",
33
+ "in" : "query",
34
+ "description" : "The from index. from starts with 1, not 0.",
35
+ "required" : false,
36
+ "style" : "form",
37
+ "explode" : true,
38
+ "schema" : {
39
+ "type" : [ "string", "null", "integer" ],
40
+ "format" : "int32",
41
+ "description" : "The from index. from starts with 1, not 0.",
42
+ "pattern" : "([0-9]+)"
43
+ }
44
+ }, {
45
+ "name" : "articleCount",
46
+ "in" : "query",
47
+ "description" : "Number of articles",
48
+ "required" : false,
49
+ "style" : "form",
50
+ "explode" : true,
51
+ "schema" : {
52
+ "type" : [ "string", "null", "integer" ],
53
+ "format" : "int32",
54
+ "description" : "Number of articles",
55
+ "pattern" : "([0-9]+)"
56
+ }
57
+ }, {
58
+ "name" : "sortBy",
59
+ "in" : "query",
60
+ "description" : "The sortBy param for the list articles",
61
+ "required" : false,
62
+ "style" : "form",
63
+ "explode" : true,
64
+ "schema" : {
65
+ "type" : [ "string", "null" ],
66
+ "description" : "The sortBy param for the list articles",
67
+ "enum" : [ "createdTime", "mostliked", "mostviewed", "modifiedTime", "mostunliked" ],
68
+ "maxLength" : 100,
69
+ "minLength" : 0
70
+ }
71
+ }, {
72
+ "name" : "locale",
73
+ "in" : "query",
74
+ "description" : "Locale of the article",
75
+ "required" : false,
76
+ "style" : "form",
77
+ "explode" : true,
78
+ "schema" : {
79
+ "type" : [ "string", "null" ],
80
+ "description" : "Locale of the article",
81
+ "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" ],
82
+ "maxLength" : 100,
83
+ "minLength" : 0,
84
+ "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)",
85
+ "x-audience" : [ "company-internal" ]
86
+ }
87
+ }, {
88
+ "$ref" : "#/components/parameters/categoryId"
89
+ }, {
90
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
91
+ }, {
92
+ "name" : "isTemplate",
93
+ "in" : "query",
94
+ "description" : "Is it a template",
95
+ "required" : false,
96
+ "style" : "form",
97
+ "explode" : true,
98
+ "schema" : {
99
+ "type" : "boolean",
100
+ "default" : false,
101
+ "description" : "To search the article template",
102
+ "x-audience" : [ "company-internal" ]
103
+ }
104
+ } ],
105
+ "responses" : {
106
+ "422" : {
107
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
108
+ },
109
+ "200" : {
110
+ "$ref" : "#/components/responses/articleCategoryDataResponse"
111
+ }
112
+ },
113
+ "security" : [ {
114
+ "org-oauth" : [ "accessAll.ALL" ]
115
+ }, {
116
+ "iam-oauth2-schema" : [ "Desk.articles.READ" ]
117
+ } ],
118
+ "x-audience" : [ "company-internal" ],
119
+ "x-custom-url-attribute" : {
120
+ "security" : {
121
+ "throttle" : {
122
+ "policy" : "ReadAPI_Stringent_UserPolicy"
123
+ },
124
+ "extraparams" : {
125
+ "disable" : true,
126
+ "ignore" : false
127
+ },
128
+ "authentication" : { }
129
+ },
130
+ "clan-group" : "helpCenter",
131
+ "apihash" : "211f4d424087eb4ce60d8cb63f55a498",
132
+ "module-group" : "kb",
133
+ "apimethod" : "com.zoho.desk.helpcenter.articles.rest.support.ArticleService.getArticlesUnderCategory"
134
+ }
135
+ }
136
+ },
137
+ "/api/v1/kbCategory/{categoryId}/repositionArticles" : {
138
+ "get" : {
139
+ "tags" : [ "KbCategory" ],
140
+ "summary" : "Get articles for manual sorting",
141
+ "description" : "This API lists the positions of help articles to enable manual sorting. Only leaf categories that have a maximum of 1000 articles can be repositioned.",
142
+ "operationId" : "getArticlesForRepositioning",
143
+ "parameters" : [ {
144
+ "$ref" : "#/components/parameters/categoryId"
145
+ }, {
146
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
147
+ } ],
148
+ "responses" : {
149
+ "204" : {
150
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
151
+ },
152
+ "200" : {
153
+ "$ref" : "./Article.json#/components/responses/listAllArticleForRepositioning"
154
+ }
155
+ },
156
+ "security" : [ {
157
+ "org-oauth" : [ "accessAll.ALL" ]
158
+ }, {
159
+ "iam-oauth2-schema" : [ "Desk.articles.READ" ]
160
+ } ],
161
+ "x-audience" : [ "external-public" ],
162
+ "x-custom-url-attribute" : {
163
+ "security" : {
164
+ "throttle" : {
165
+ "inline" : [ {
166
+ "scope" : "APPSERVER",
167
+ "rules" : [ {
168
+ "duration" : 60000,
169
+ "lock-period" : 600000,
170
+ "threshold" : 30,
171
+ "hip" : false
172
+ }, {
173
+ "duration" : 3600000,
174
+ "lock-period" : 1800000,
175
+ "threshold" : 150,
176
+ "hip" : false
177
+ } ],
178
+ "window" : "ROLLING",
179
+ "key" : "url.path+user.zuid"
180
+ } ]
181
+ },
182
+ "extraparams" : {
183
+ "disable" : true,
184
+ "ignore" : false
185
+ },
186
+ "authentication" : { }
187
+ },
188
+ "clan-group" : "helpCenter",
189
+ "apihash" : "4e9d199ca69ae492e581338013d2555e",
190
+ "module-group" : "kb",
191
+ "apimethod" : "com.zoho.desk.helpcenter.articles.rest.support.ArticleService.getRepositionArticles"
192
+ }
193
+ },
194
+ "post" : {
195
+ "tags" : [ "KbCategory" ],
196
+ "summary" : "Update article position",
197
+ "description" : "This API helps you manually sort articles in your knowledge base. Only leaf categories that have a maximum of 1000 articles can be repositioned.",
198
+ "operationId" : "updateKBArticlesRepositioning",
199
+ "parameters" : [ {
200
+ "$ref" : "#/components/parameters/categoryId"
201
+ }, {
202
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
203
+ } ],
204
+ "requestBody" : {
205
+ "$ref" : "./Article.json#/components/requestBodies/articleIdsJson"
206
+ },
207
+ "responses" : {
208
+ "422" : {
209
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
210
+ },
211
+ "204" : {
212
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
213
+ }
214
+ },
215
+ "security" : [ {
216
+ "org-oauth" : [ "accessAll.ALL" ]
217
+ }, {
218
+ "iam-oauth2-schema" : [ "Desk.articles.UPDATE" ]
219
+ } ],
220
+ "x-audience" : [ "external-public" ],
221
+ "x-custom-url-attribute" : {
222
+ "security" : {
223
+ "throttle" : {
224
+ "inline" : [ {
225
+ "scope" : "APPSERVER",
226
+ "rules" : [ {
227
+ "duration" : 60000,
228
+ "lock-period" : 600000,
229
+ "threshold" : 30,
230
+ "hip" : false
231
+ }, {
232
+ "duration" : 3600000,
233
+ "lock-period" : 1800000,
234
+ "threshold" : 150,
235
+ "hip" : false
236
+ } ],
237
+ "window" : "ROLLING",
238
+ "key" : "url.path+user.zuid"
239
+ } ]
240
+ },
241
+ "extraparams" : {
242
+ "disable" : true,
243
+ "ignore" : false
244
+ },
245
+ "authentication" : { }
246
+ },
247
+ "clan-group" : "helpCenter",
248
+ "apihash" : "46fad587460e8e5393c8d0fe545e1547",
249
+ "module-group" : "kb",
250
+ "apimethod" : "com.zoho.desk.helpcenter.articles.rest.support.ArticleService.repositionArticles"
251
+ }
252
+ }
253
+ },
254
+ "/api/v1/kbCategory" : {
255
+ "get" : {
256
+ "tags" : [ "KbCategory" ],
257
+ "operationId" : "listAllCategory",
258
+ "parameters" : [ {
259
+ "name" : "departmentId",
260
+ "in" : "query",
261
+ "description" : "To get individual department details",
262
+ "required" : false,
263
+ "style" : "form",
264
+ "explode" : true,
265
+ "schema" : {
266
+ "type" : [ "string", "null", "integer" ],
267
+ "format" : "int64",
268
+ "description" : "To get individual department details",
269
+ "pattern" : "([0-9]+)"
270
+ }
271
+ }, {
272
+ "name" : "reviewOwnerId",
273
+ "in" : "query",
274
+ "description" : "Review Owner user Id to get the topics where this user has review permission",
275
+ "required" : false,
276
+ "style" : "form",
277
+ "explode" : true,
278
+ "schema" : {
279
+ "type" : [ "string", "null", "integer" ],
280
+ "format" : "int64",
281
+ "description" : "Review Owner user Id to get the topics where this user has review permission",
282
+ "pattern" : "([0-9]+)"
283
+ }
284
+ }, {
285
+ "name" : "sortBy",
286
+ "in" : "query",
287
+ "description" : "Sort based on categoryname or sortorder. Allowed values are @categoryname@ and @sortorder@",
288
+ "required" : false,
289
+ "style" : "form",
290
+ "explode" : true,
291
+ "schema" : {
292
+ "type" : [ "string", "null" ],
293
+ "description" : "Sort based on categoryname or sortorder. Allowed values are @categoryname@ and @sortorder@",
294
+ "enum" : [ "categoryname", "sortorder" ],
295
+ "maxLength" : 100,
296
+ "minLength" : 0,
297
+ "x-audience" : [ "company-internal" ]
298
+ }
299
+ }, {
300
+ "name" : "categoryId",
301
+ "in" : "path",
302
+ "description" : "To get individual category details",
303
+ "required" : true,
304
+ "style" : "simple",
305
+ "explode" : false,
306
+ "schema" : {
307
+ "type" : [ "string", "null", "integer" ],
308
+ "format" : "int64",
309
+ "description" : "To get individual category details",
310
+ "pattern" : "([0-9]+)",
311
+ "x-audience" : [ "company-internal" ]
312
+ }
313
+ }, {
314
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
315
+ } ],
316
+ "responses" : {
317
+ "204" : {
318
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
319
+ },
320
+ "200" : {
321
+ "$ref" : "#/components/responses/listAllCategoryResponse"
322
+ }
323
+ },
324
+ "security" : [ {
325
+ "org-oauth" : [ "accessAll.ALL" ]
326
+ }, {
327
+ "iam-oauth2-schema" : [ "Desk.articles.READ" ]
328
+ } ],
329
+ "x-audience" : [ "company-internal" ],
330
+ "x-custom-url-attribute" : {
331
+ "security" : {
332
+ "throttle" : {
333
+ "inline" : [ {
334
+ "scope" : "APPSERVER",
335
+ "rules" : [ {
336
+ "duration" : 60000,
337
+ "lock-period" : 600000,
338
+ "threshold" : 50,
339
+ "hip" : false
340
+ } ],
341
+ "window" : "ROLLING",
342
+ "key" : "url.path+user.zuid"
343
+ } ]
344
+ },
345
+ "extraparams" : {
346
+ "disable" : true,
347
+ "ignore" : false
348
+ },
349
+ "authentication" : { }
350
+ },
351
+ "clan-group" : "helpCenter",
352
+ "apihash" : "ba92e57c6504fc800e8117c9b1563527",
353
+ "module-group" : "kb",
354
+ "apimethod" : "com.zoho.desk.helpcenter.kbcategories.rest.support.TopicService.getTopic"
355
+ }
356
+ },
357
+ "post" : {
358
+ "tags" : [ "KbCategory" ],
359
+ "operationId" : "createCategory",
360
+ "parameters" : [ {
361
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
362
+ } ],
363
+ "requestBody" : {
364
+ "$ref" : "#/components/requestBodies/categoryJson"
365
+ },
366
+ "responses" : {
367
+ "422" : {
368
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
369
+ },
370
+ "200" : {
371
+ "$ref" : "#/components/responses/categoryWithReviewResponse"
372
+ }
373
+ },
374
+ "security" : [ {
375
+ "org-oauth" : [ "accessAll.ALL" ]
376
+ }, {
377
+ "iam-oauth2-schema" : [ "Desk.articles.CREATE" ]
378
+ } ],
379
+ "x-audience" : [ "company-internal" ],
380
+ "x-custom-url-attribute" : {
381
+ "security" : {
382
+ "throttle" : {
383
+ "inline" : [ {
384
+ "scope" : "APPSERVER",
385
+ "rules" : [ {
386
+ "duration" : 60000,
387
+ "lock-period" : 600000,
388
+ "threshold" : 20,
389
+ "hip" : false
390
+ } ],
391
+ "window" : "ROLLING",
392
+ "key" : "url.path+user.zuid"
393
+ } ]
394
+ },
395
+ "extraparams" : {
396
+ "disable" : true,
397
+ "ignore" : false
398
+ },
399
+ "authentication" : { }
400
+ },
401
+ "clan-group" : "helpCenter",
402
+ "apihash" : "ad35891a628828dc07a3a1484f535284",
403
+ "module-group" : "kb",
404
+ "apimethod" : "com.zoho.desk.helpcenter.kbcategories.rest.support.TopicService.createCategory"
405
+ }
406
+ }
407
+ },
408
+ "/api/v1/kbCategories/breadCrumbTree" : {
409
+ "get": {
410
+ "tags": [
411
+ "KbCategory"
412
+ ],
413
+ "summary": "",
414
+ "description": "",
415
+ "operationId": "getBreadCrumbTree",
416
+ "parameters": [
417
+ {
418
+ "name": "categoryIds",
419
+ "in": "query",
420
+ "required": true,
421
+ "style": "simple",
422
+ "explode": true,
423
+ "schema": {
424
+ "type": [
425
+ "null",
426
+ "array"
427
+ ],
428
+ "description": "",
429
+ "items": {
430
+ "type": [
431
+ "string",
432
+ "null",
433
+ "integer"
434
+ ],
435
+ "format": "int64",
436
+ "description": "",
437
+ "pattern": "([0-9]+)",
438
+ "x-custom-parameters-attributes": {}
439
+ },
440
+ "maxItems": 20,
441
+ "minItems": 1,
442
+ "uniqueItems": false,
443
+ "x-custom-parameters-attributes": {}
444
+ }
445
+ },
446
+ {
447
+ "name": "locale",
448
+ "in": "query",
449
+ "required": false,
450
+ "schema": {
451
+ "type": [ "string", "null" ],
452
+ "description": "",
453
+ "enum": [
454
+ "en",
455
+ "ja",
456
+ "zh",
457
+ "es",
458
+ "de",
459
+ "fr",
460
+ "tr",
461
+ "ru",
462
+ "pt",
463
+ "it",
464
+ "nl",
465
+ "da",
466
+ "sv",
467
+ "pl",
468
+ "ar",
469
+ "he",
470
+ "af",
471
+ "cs",
472
+ "fr-ca",
473
+ "bg",
474
+ "fi",
475
+ "el",
476
+ "hu",
477
+ "id",
478
+ "nb",
479
+ "ro",
480
+ "th",
481
+ "uk",
482
+ "vi",
483
+ "ur",
484
+ "hi",
485
+ "te",
486
+ "kn",
487
+ "ta",
488
+ "mr",
489
+ "ko",
490
+ "fa",
491
+ "bn",
492
+ "gu",
493
+ "ms",
494
+ "ml",
495
+ "en-gb",
496
+ "sk",
497
+ "hr",
498
+ "sl",
499
+ "zh_TW",
500
+ "zh-tw",
501
+ "ca",
502
+ "ka",
503
+ "kk",
504
+ "my",
505
+ "km",
506
+ "pt-br"
507
+ ],
508
+ "maxLength": 100,
509
+ "minLength": 0,
510
+ "pattern": "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)",
511
+ "x-custom-parameters-attributes": {}
512
+ }
513
+ }
514
+ ],
515
+ "security": [
516
+ {
517
+ "jwt-oauth": [
518
+ "basic"
519
+ ]
520
+ }
521
+ ],
522
+ "responses": {
523
+ "200": {
524
+ "$ref": "#/components/responses/breadCrumbTreeResponse"
525
+ },
526
+ "422" : {
527
+ "$ref" : "../common/Common.json#/components/responses/unprocessableEntityErrorResponse"
528
+ }
529
+ }
530
+ }
531
+ }
532
+ },
533
+ "components" : {
534
+ "schemas" : {
535
+ "groupJson" : {
536
+ "type" : [ "null", "object" ],
537
+ "additionalProperties" : false,
538
+ "properties" : {
539
+ "name" : {
540
+ "type" : [ "string", "null" ],
541
+ "maxLength" : 100,
542
+ "minLength" : 0,
543
+ "pattern" : "[0-9a-zA-Z_\\-\\&\\.\\$\\@\\^\\(\\)\\{\\}\\~\\=\\-\\|\\*\\+\\?\\[\\]\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+"
544
+ },
545
+ "id" : {
546
+ "type" : [ "string", "null", "integer" ],
547
+ "format" : "int64",
548
+ "pattern" : "([0-9]+)"
549
+ },
550
+ "logoUrl" : {
551
+ "type" : [ "string", "null" ],
552
+ "maxLength" : 200,
553
+ "minLength" : 0,
554
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
555
+ }
556
+ },
557
+ "required" : [ "id", "logoUrl", "name" ]
558
+ },
559
+ "groupJsonArr" : {
560
+ "type" : [ "null", "array" ],
561
+ "items" : {
562
+ "$ref" : "./KbCategory.json#/components/schemas/groupJson"
563
+ }
564
+ },
565
+ "solutionCommonResponseWithLocale" : {
566
+ "type" : [ "null", "object" ],
567
+ "additionalProperties" : false,
568
+ "properties" : {
569
+ "webUrl" : {
570
+ "type" : [ "string", "null" ],
571
+ "maxLength" : 500,
572
+ "minLength" : 0,
573
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
574
+ },
575
+ "id" : {
576
+ "type" : [ "string", "null", "integer" ],
577
+ "format" : "int64",
578
+ "pattern" : "([0-9]+)"
579
+ },
580
+ "title" : {
581
+ "type" : [ "string", "null" ],
582
+ "maxLength" : 500,
583
+ "minLength" : 0
584
+ },
585
+ "permalink" : {
586
+ "type" : [ "string", "null" ],
587
+ "maxLength" : 300,
588
+ "minLength" : 0,
589
+ "pattern" : "[A-Za-z0-9%\\-+\\/=\\P{InBasicLatin}]+"
590
+ },
591
+ "locale" : {
592
+ "type" : [ "string", "null" ],
593
+ "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" ],
594
+ "maxLength" : 100,
595
+ "minLength" : 0,
596
+ "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)",
597
+ "x-custom-parameters-attributes" : {
598
+ "removeExif" : false,
599
+ "filterMatchedContent" : false,
600
+ "antivirus" : false,
601
+ "replacementString" : "",
602
+ "allowInvalid" : false,
603
+ "descrption" : "Locale of the article",
604
+ "secret" : false,
605
+ "preserveCharsLimit" : 10,
606
+ "trim" : false,
607
+ "internalParam" : true,
608
+ "preserveChars" : "0,5",
609
+ "importUrl" : false,
610
+ "decrypt" : false
611
+ }
612
+ },
613
+ "categoryId" : {
614
+ "type" : [ "string", "null", "integer" ],
615
+ "format" : "int64",
616
+ "pattern" : "([0-9]+)"
617
+ }
618
+ },
619
+ "required" : [ "categoryId", "id", "locale", "permalink", "title", "webUrl" ]
620
+ },
621
+ "articleJson" : {
622
+ "type" : [ "null", "array" ],
623
+ "items" : {
624
+ "$ref" : "./KbCategory.json#/components/schemas/solutionCommonResponseWithLocale"
625
+ }
626
+ },
627
+ "articleUnderCategory" : {
628
+ "type" : [ "null", "object" ],
629
+ "additionalProperties" : false,
630
+ "properties" : {
631
+ "name" : {
632
+ "type" : [ "string", "null" ],
633
+ "maxLength" : 100,
634
+ "minLength" : 0
635
+ },
636
+ "description" : {
637
+ "type" : [ "string", "null" ],
638
+ "maxLength" : 100,
639
+ "minLength" : 0,
640
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
641
+ },
642
+ "id" : {
643
+ "type" : [ "string", "null", "integer" ],
644
+ "format" : "int64",
645
+ "pattern" : "([0-9]+)"
646
+ },
647
+ "permalink" : {
648
+ "type" : [ "string", "null" ],
649
+ "maxLength" : 100,
650
+ "minLength" : 0,
651
+ "pattern" : "[a-z0-9\\/%\\-\\P{InBasicLatin}]+"
652
+ },
653
+ "articles" : {
654
+ "$ref" : "./KbCategory.json#/components/schemas/articleJson"
655
+ },
656
+ "logoUrl" : {
657
+ "type" : [ "string", "null" ],
658
+ "maxLength" : 255,
659
+ "minLength" : 0,
660
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
661
+ }
662
+ },
663
+ "required" : [ "articles", "description", "id", "logoUrl", "name", "permalink" ]
664
+ },
665
+ "articleCategoryDataArray" : {
666
+ "type" : [ "null", "array" ],
667
+ "items" : {
668
+ "$ref" : "./KbCategory.json#/components/schemas/articleUnderCategory"
669
+ }
670
+ },
671
+ "associatedDepartmentsArr" : {
672
+ "type" : [ "null", "array" ],
673
+ "items" : {
674
+ "type" : [ "string", "null", "integer" ],
675
+ "format" : "int64",
676
+ "pattern" : "([0-9]+)",
677
+ "x-custom-parameters-attributes" : {
678
+ "removeExif" : false,
679
+ "filterMatchedContent" : false,
680
+ "antivirus" : false,
681
+ "replacementString" : "",
682
+ "allowInvalid" : false,
683
+ "descrption" : "ID of the department to associate with the category",
684
+ "secret" : false,
685
+ "preserveCharsLimit" : 10,
686
+ "trim" : false,
687
+ "internalParam" : false,
688
+ "preserveChars" : "0,5",
689
+ "importUrl" : false,
690
+ "decrypt" : false
691
+ }
692
+ }
693
+ },
694
+ "commonCategoryResponse" : {
695
+ "type" : [ "null", "object" ],
696
+ "additionalProperties" : false,
697
+ "properties" : {
698
+ "articleViewType" : {
699
+ "type" : [ "string", "null" ],
700
+ "enum" : [ "LISTVIEW", "OVERVIEW" ],
701
+ "maxLength" : 100,
702
+ "minLength" : 0,
703
+ "x-custom-parameters-attributes" : {
704
+ "removeExif" : false,
705
+ "filterMatchedContent" : false,
706
+ "antivirus" : false,
707
+ "replacementString" : "",
708
+ "allowInvalid" : false,
709
+ "descrption" : "View to apply while listing help articles. Values allowed are: LISTVIEW and OVERVIEW.",
710
+ "secret" : false,
711
+ "preserveCharsLimit" : 10,
712
+ "trim" : false,
713
+ "internalParam" : false,
714
+ "preserveChars" : "0,5",
715
+ "importUrl" : false,
716
+ "decrypt" : false
717
+ }
718
+ },
719
+ "visibility" : {
720
+ "type" : [ "string", "null" ],
721
+ "enum" : [ "ALL_USERS", "AGENTS", "GROUP_USERS", "PRIVATE_IP", "NONE" ],
722
+ "maxLength" : 100,
723
+ "minLength" : 0,
724
+ "x-custom-parameters-attributes" : {
725
+ "removeExif" : false,
726
+ "filterMatchedContent" : false,
727
+ "antivirus" : false,
728
+ "replacementString" : "",
729
+ "allowInvalid" : false,
730
+ "descrption" : "Visibility setting of the category. Values allowed are: AGENTS, GROUP_USERS, ALL_USERS, and NONE.",
731
+ "secret" : false,
732
+ "preserveCharsLimit" : 10,
733
+ "trim" : false,
734
+ "internalParam" : false,
735
+ "preserveChars" : "0,5",
736
+ "importUrl" : false,
737
+ "decrypt" : false
738
+ }
739
+ },
740
+ "level" : {
741
+ "type" : [ "string", "null", "integer" ],
742
+ "format" : "int32",
743
+ "pattern" : "([0-9]+)",
744
+ "x-custom-parameters-attributes" : {
745
+ "removeExif" : false,
746
+ "filterMatchedContent" : false,
747
+ "antivirus" : false,
748
+ "replacementString" : "",
749
+ "allowInvalid" : false,
750
+ "descrption" : "Navigation depth of the category",
751
+ "secret" : false,
752
+ "preserveCharsLimit" : 10,
753
+ "trim" : false,
754
+ "internalParam" : false,
755
+ "preserveChars" : "0,5",
756
+ "importUrl" : false,
757
+ "decrypt" : false
758
+ }
759
+ },
760
+ "departmentId" : {
761
+ "type" : [ "string", "null", "integer" ],
762
+ "format" : "int64",
763
+ "pattern" : "([0-9]+)",
764
+ "x-custom-parameters-attributes" : {
765
+ "removeExif" : false,
766
+ "filterMatchedContent" : false,
767
+ "antivirus" : false,
768
+ "replacementString" : "",
769
+ "allowInvalid" : false,
770
+ "descrption" : "ID of the department to associate with the category",
771
+ "secret" : false,
772
+ "preserveCharsLimit" : 10,
773
+ "trim" : false,
774
+ "internalParam" : false,
775
+ "preserveChars" : "0,5",
776
+ "importUrl" : false,
777
+ "decrypt" : false
778
+ }
779
+ },
780
+ "description" : {
781
+ "type" : [ "string", "null" ],
782
+ "maxLength" : 100,
783
+ "minLength" : 0,
784
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+",
785
+ "x-custom-parameters-attributes" : {
786
+ "removeExif" : false,
787
+ "filterMatchedContent" : false,
788
+ "antivirus" : false,
789
+ "replacementString" : "",
790
+ "allowInvalid" : false,
791
+ "descrption" : "A brief description of the category",
792
+ "secret" : false,
793
+ "preserveCharsLimit" : 10,
794
+ "trim" : false,
795
+ "internalParam" : false,
796
+ "preserveChars" : "0,5",
797
+ "importUrl" : false,
798
+ "decrypt" : false
799
+ }
800
+ },
801
+ "groups" : {
802
+ "$ref" : "./KbCategory.json#/components/schemas/groupJsonArr"
803
+ },
804
+ "logoUrl" : {
805
+ "type" : [ "string", "null" ],
806
+ "maxLength" : 255,
807
+ "minLength" : 0,
808
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
809
+ },
810
+ "associatedDepartments" : {
811
+ "$ref" : "./KbCategory.json#/components/schemas/associatedDepartmentsArr"
812
+ },
813
+ "rootCategoryId" : {
814
+ "type" : [ "string", "null", "integer" ],
815
+ "format" : "int64",
816
+ "pattern" : "([0-9]+)"
817
+ },
818
+ "childOrder" : {
819
+ "type" : [ "null", "array" ],
820
+ "items" : {
821
+ "type" : [ "string", "null", "integer" ],
822
+ "format" : "int64",
823
+ "pattern" : "([0-9]+)",
824
+ "x-custom-parameters-attributes" : [ ]
825
+ },
826
+ "uniqueItems" : false
827
+ },
828
+ "encryptedWorkspaceId" : {
829
+ "type" : [ "string", "null" ],
830
+ "maxLength" : 255,
831
+ "minLength" : 0
832
+ },
833
+ "helpcenterId" : {
834
+ "type" : [ "string", "null", "integer" ],
835
+ "format" : "int64",
836
+ "pattern" : "([0-9]+)",
837
+ "x-custom-parameters-attributes" : {
838
+ "removeExif" : false,
839
+ "filterMatchedContent" : false,
840
+ "antivirus" : false,
841
+ "replacementString" : "",
842
+ "allowInvalid" : false,
843
+ "descrption" : "ID of the help center to which the knowledge base belongs",
844
+ "secret" : false,
845
+ "preserveCharsLimit" : 10,
846
+ "trim" : false,
847
+ "internalParam" : false,
848
+ "preserveChars" : "0,5",
849
+ "importUrl" : false,
850
+ "decrypt" : false
851
+ }
852
+ },
853
+ "name" : {
854
+ "type" : [ "string", "null" ],
855
+ "maxLength" : 100,
856
+ "minLength" : 0,
857
+ "x-custom-parameters-attributes" : {
858
+ "removeExif" : false,
859
+ "filterMatchedContent" : false,
860
+ "antivirus" : false,
861
+ "replacementString" : "",
862
+ "allowInvalid" : false,
863
+ "descrption" : "Name of the category",
864
+ "secret" : false,
865
+ "preserveCharsLimit" : 10,
866
+ "trim" : false,
867
+ "internalParam" : false,
868
+ "preserveChars" : "0,5",
869
+ "importUrl" : false,
870
+ "decrypt" : false
871
+ }
872
+ },
873
+ "createdTime" : {
874
+ "type" : [ "string", "null" ],
875
+ "maxLength" : 100,
876
+ "minLength" : 0,
877
+ "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))"
878
+ },
879
+ "parentCategoryId" : {
880
+ "type" : [ "string", "null", "integer" ],
881
+ "format" : "int64",
882
+ "pattern" : "([0-9]+)",
883
+ "x-custom-parameters-attributes" : {
884
+ "removeExif" : false,
885
+ "filterMatchedContent" : false,
886
+ "antivirus" : false,
887
+ "replacementString" : "",
888
+ "allowInvalid" : false,
889
+ "descrption" : "ID of the parent category",
890
+ "secret" : false,
891
+ "preserveCharsLimit" : 10,
892
+ "trim" : false,
893
+ "internalParam" : false,
894
+ "preserveChars" : "0,5",
895
+ "importUrl" : false,
896
+ "decrypt" : false
897
+ }
898
+ },
899
+ "id" : {
900
+ "type" : [ "string", "null", "integer" ],
901
+ "format" : "int64",
902
+ "pattern" : "([0-9]+)",
903
+ "x-custom-parameters-attributes" : {
904
+ "removeExif" : false,
905
+ "filterMatchedContent" : false,
906
+ "antivirus" : false,
907
+ "replacementString" : "",
908
+ "allowInvalid" : false,
909
+ "descrption" : "Unique ID of the category",
910
+ "secret" : false,
911
+ "preserveCharsLimit" : 10,
912
+ "trim" : false,
913
+ "internalParam" : false,
914
+ "preserveChars" : "0,5",
915
+ "importUrl" : false,
916
+ "decrypt" : false
917
+ }
918
+ },
919
+ "articlesCount" : {
920
+ "type" : [ "string", "null", "integer" ],
921
+ "format" : "int32",
922
+ "pattern" : "([0-9]+)",
923
+ "x-custom-parameters-attributes" : {
924
+ "removeExif" : false,
925
+ "filterMatchedContent" : false,
926
+ "antivirus" : false,
927
+ "replacementString" : "",
928
+ "allowInvalid" : false,
929
+ "descrption" : "Number of help articles under the category",
930
+ "secret" : false,
931
+ "preserveCharsLimit" : 10,
932
+ "trim" : false,
933
+ "internalParam" : false,
934
+ "preserveChars" : "0,5",
935
+ "importUrl" : false,
936
+ "decrypt" : false
937
+ }
938
+ },
939
+ "permalink" : {
940
+ "type" : [ "string", "null" ],
941
+ "maxLength" : 100,
942
+ "minLength" : 0,
943
+ "pattern" : "[a-z0-9\\/%\\-\\P{InBasicLatin}]+"
944
+ },
945
+ "featuredCategory" : {
946
+ "type" : [ "boolean", "null" ],
947
+ "x-custom-parameters-attributes" : {
948
+ "removeExif" : false,
949
+ "filterMatchedContent" : false,
950
+ "antivirus" : false,
951
+ "replacementString" : "",
952
+ "allowInvalid" : false,
953
+ "descrption" : "Key that specifies whether the category must be featured in the help center or not",
954
+ "secret" : false,
955
+ "preserveCharsLimit" : 10,
956
+ "trim" : false,
957
+ "internalParam" : false,
958
+ "preserveChars" : "0,5",
959
+ "importUrl" : false,
960
+ "decrypt" : false
961
+ }
962
+ },
963
+ "order" : {
964
+ "type" : [ "string", "null", "integer" ],
965
+ "format" : "int32",
966
+ "pattern" : "([0-9]+)",
967
+ "x-custom-parameters-attributes" : {
968
+ "removeExif" : false,
969
+ "filterMatchedContent" : false,
970
+ "antivirus" : false,
971
+ "replacementString" : "",
972
+ "allowInvalid" : false,
973
+ "descrption" : "Position of the category in the overall order of categories of the same level",
974
+ "secret" : false,
975
+ "preserveCharsLimit" : 10,
976
+ "trim" : false,
977
+ "internalParam" : false,
978
+ "preserveChars" : "0,5",
979
+ "importUrl" : false,
980
+ "decrypt" : false
981
+ }
982
+ },
983
+ "isVisibleInHC" : {
984
+ "type" : [ "boolean", "null" ],
985
+ "x-custom-parameters-attributes" : {
986
+ "removeExif" : false,
987
+ "filterMatchedContent" : false,
988
+ "antivirus" : false,
989
+ "replacementString" : "",
990
+ "allowInvalid" : false,
991
+ "descrption" : "Key that specifies whether the category must be visible in the help center or not",
992
+ "secret" : false,
993
+ "preserveCharsLimit" : 10,
994
+ "trim" : false,
995
+ "internalParam" : false,
996
+ "preserveChars" : "0,5",
997
+ "importUrl" : false,
998
+ "decrypt" : false
999
+ }
1000
+ },
1001
+ "workspaceId" : {
1002
+ "type" : [ "string", "null" ],
1003
+ "maxLength" : 100,
1004
+ "minLength" : 0,
1005
+ "pattern" : "^([a-zA-Z0-9]{37}|-1)$",
1006
+ "x-custom-parameters-attributes" : {
1007
+ "removeExif" : false,
1008
+ "filterMatchedContent" : false,
1009
+ "antivirus" : false,
1010
+ "replacementString" : "",
1011
+ "allowInvalid" : false,
1012
+ "descrption" : "ID of the Zoho Workdrive folder (Gallery) associated with the category",
1013
+ "secret" : false,
1014
+ "preserveCharsLimit" : 10,
1015
+ "trim" : false,
1016
+ "internalParam" : false,
1017
+ "preserveChars" : "0,5",
1018
+ "importUrl" : false,
1019
+ "decrypt" : false
1020
+ }
1021
+ }
1022
+ },
1023
+ "required" : [ "articleViewType", "articlesCount", "associatedDepartments", "childOrder", "createdTime", "departmentId", "description", "encryptedWorkspaceId", "featuredCategory", "groups", "helpcenterId", "id", "isVisibleInHC", "level", "logoUrl", "name", "order", "parentCategoryId", "permalink", "rootCategoryId", "visibility", "workspaceId" ]
1024
+ },
1025
+ "childCategoryResponse" : {
1026
+ "additionalProperties" : false,
1027
+ "allOf" : [ {
1028
+ "$ref" : "./KbCategory.json#/components/schemas/commonCategoryResponse"
1029
+ }, {
1030
+ "type" : [ "null", "object" ],
1031
+ "properties" : {
1032
+ "child" : {
1033
+ "type" : [ "null", "array" ],
1034
+ "items" : {
1035
+ "type" : [ "null", "object" ],
1036
+ "additionalProperties" : false,
1037
+ "x-custom-parameters-attributes" : [ ]
1038
+ },
1039
+ "uniqueItems" : false
1040
+ }
1041
+ },
1042
+ "required" : [ "child" ]
1043
+ } ]
1044
+ },
1045
+ "childCategoryResponseData" : {
1046
+ "type" : [ "null", "array" ],
1047
+ "items" : {
1048
+ "$ref" : "./KbCategory.json#/components/schemas/childCategoryResponse"
1049
+ }
1050
+ },
1051
+ "reviewOwnerDetails" : {
1052
+ "type" : [ "null", "object" ],
1053
+ "additionalProperties" : false,
1054
+ "properties" : {
1055
+ "photoURL" : {
1056
+ "type" : [ "string", "null" ],
1057
+ "maxLength" : 100,
1058
+ "minLength" : 0,
1059
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1060
+ },
1061
+ "name" : {
1062
+ "type" : [ "string", "null" ],
1063
+ "maxLength" : 50,
1064
+ "minLength" : 0
1065
+ },
1066
+ "id" : {
1067
+ "type" : [ "string", "null", "integer" ],
1068
+ "format" : "int64",
1069
+ "pattern" : "([0-9]+)",
1070
+ "x-custom-parameters-attributes" : {
1071
+ "removeExif" : false,
1072
+ "filterMatchedContent" : false,
1073
+ "antivirus" : false,
1074
+ "replacementString" : "",
1075
+ "allowInvalid" : false,
1076
+ "descrption" : "Unique ID of the category",
1077
+ "secret" : false,
1078
+ "preserveCharsLimit" : 10,
1079
+ "trim" : false,
1080
+ "internalParam" : false,
1081
+ "preserveChars" : "0,5",
1082
+ "importUrl" : false,
1083
+ "decrypt" : false
1084
+ }
1085
+ }
1086
+ },
1087
+ "required" : [ "id", "name", "photoURL" ]
1088
+ },
1089
+ "reviewOwnerArr" : {
1090
+ "type" : [ "null", "array" ],
1091
+ "items" : {
1092
+ "$ref" : "./KbCategory.json#/components/schemas/reviewOwnerDetails"
1093
+ }
1094
+ },
1095
+ "reviewOwners" : {
1096
+ "type" : [ "null", "array" ],
1097
+ "items" : {
1098
+ "type" : [ "string", "null", "integer" ],
1099
+ "format" : "int64",
1100
+ "pattern" : "([0-9]+)",
1101
+ "x-custom-parameters-attributes" : {
1102
+ "removeExif" : false,
1103
+ "filterMatchedContent" : false,
1104
+ "antivirus" : false,
1105
+ "replacementString" : "",
1106
+ "allowInvalid" : false,
1107
+ "descrption" : "Unique ID of the category",
1108
+ "secret" : false,
1109
+ "preserveCharsLimit" : 10,
1110
+ "trim" : false,
1111
+ "internalParam" : false,
1112
+ "preserveChars" : "0,5",
1113
+ "importUrl" : false,
1114
+ "decrypt" : false
1115
+ }
1116
+ }
1117
+ },
1118
+ "categoryResponse" : {
1119
+ "additionalProperties" : false,
1120
+ "allOf" : [ {
1121
+ "$ref" : "./KbCategory.json#/components/schemas/commonCategoryResponse"
1122
+ }, {
1123
+ "type" : [ "null", "object" ],
1124
+ "properties" : {
1125
+ "child" : {
1126
+ "$ref" : "./KbCategory.json#/components/schemas/childCategoryResponseData"
1127
+ },
1128
+ "rootCategoryId" : {
1129
+ "type" : [ "string", "null", "integer" ],
1130
+ "format" : "int64",
1131
+ "pattern" : "([0-9]+)"
1132
+ }
1133
+ },
1134
+ "required" : [ "child", "rootCategoryId" ]
1135
+ } ]
1136
+ },
1137
+ "data" : {
1138
+ "type" : [ "null", "array" ],
1139
+ "items" : {
1140
+ "$ref" : "./KbCategory.json#/components/schemas/categoryResponse"
1141
+ }
1142
+ },
1143
+ "categoryPathResponseJson": {
1144
+ "type": [
1145
+ "null",
1146
+ "object"
1147
+ ],
1148
+ "additionalProperties": false,
1149
+ "properties": {
1150
+ "path": {
1151
+ "type": [
1152
+ "string",
1153
+ "null"
1154
+ ],
1155
+ "description": "",
1156
+ "maxLength": 100,
1157
+ "minLength": 0,
1158
+ "x-custom-parameters-attributes": {}
1159
+ },
1160
+ "id": {
1161
+ "type": [
1162
+ "string",
1163
+ "null",
1164
+ "integer"
1165
+ ],
1166
+ "format": "int64",
1167
+ "description": "",
1168
+ "pattern": "([0-9]+)",
1169
+ "x-custom-parameters-attributes": {}
1170
+ }
1171
+ },
1172
+ "required": [
1173
+ "id",
1174
+ "path"
1175
+ ]
1176
+ },
1177
+ "categoryPathResponseJsonArr": {
1178
+ "type": [
1179
+ "null",
1180
+ "array"
1181
+ ],
1182
+ "items": {
1183
+ "$ref": "#/components/schemas/categoryPathResponseJson"
1184
+ }
1185
+ },
1186
+ "commonCategoryTreeResponse": {
1187
+ "type": [
1188
+ "null",
1189
+ "object"
1190
+ ],
1191
+ "additionalProperties": false,
1192
+ "properties": {
1193
+ "breadCrumb": {
1194
+ "type": [
1195
+ "string",
1196
+ "null"
1197
+ ],
1198
+ "description": "",
1199
+ "maxLength": 100,
1200
+ "minLength": 0,
1201
+ "x-custom-parameters-attributes": {}
1202
+ },
1203
+ "name": {
1204
+ "type": [
1205
+ "string",
1206
+ "null"
1207
+ ],
1208
+ "description": "",
1209
+ "maxLength": 100,
1210
+ "minLength": 0,
1211
+ "x-custom-parameters-attributes": {}
1212
+ },
1213
+ "description": {
1214
+ "type": [
1215
+ "string",
1216
+ "null"
1217
+ ],
1218
+ "description": "",
1219
+ "maxLength": 100,
1220
+ "minLength": 0,
1221
+ "pattern": "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+",
1222
+ "x-custom-parameters-attributes": {}
1223
+ },
1224
+ "id": {
1225
+ "type": [
1226
+ "string",
1227
+ "null",
1228
+ "integer"
1229
+ ],
1230
+ "format": "int64",
1231
+ "description": "",
1232
+ "pattern": "([0-9]+)",
1233
+ "x-custom-parameters-attributes": {}
1234
+ },
1235
+ "permalink": {
1236
+ "type": [
1237
+ "string",
1238
+ "null"
1239
+ ],
1240
+ "description": "",
1241
+ "maxLength": 100,
1242
+ "minLength": 0,
1243
+ "pattern": "[a-z0-9\\/%\\-\\P{InBasicLatin}]+",
1244
+ "x-custom-parameters-attributes": {}
1245
+ }
1246
+ },
1247
+ "required": [
1248
+ "breadCrumb",
1249
+ "description",
1250
+ "id",
1251
+ "name",
1252
+ "permalink"
1253
+ ]
1254
+ },
1255
+ "categoryTreeResponseJson": {
1256
+ "additionalProperties": false,
1257
+ "allOf": [
1258
+ {
1259
+ "$ref": "#/components/schemas/commonCategoryTreeResponse"
1260
+ },
1261
+ {
1262
+ "type": [
1263
+ "null",
1264
+ "object"
1265
+ ],
1266
+ "properties": {
1267
+ "children": {
1268
+ "$ref": "#/components/schemas/breadCrumbChildCategoryResponseArr"
1269
+ }
1270
+ },
1271
+ "required": [
1272
+ "children"
1273
+ ]
1274
+ }
1275
+ ]
1276
+ },
1277
+ "categoryTreeResponseJsonArr": {
1278
+ "type": [
1279
+ "null",
1280
+ "array"
1281
+ ],
1282
+ "items": {
1283
+ "$ref": "#/components/schemas/categoryTreeResponseJson"
1284
+ }
1285
+ },
1286
+ "breadCrumbChildCategoryResponseData": {
1287
+ "additionalProperties": false,
1288
+ "allOf": [
1289
+ {
1290
+ "$ref": "#/components/schemas/commonCategoryTreeResponse"
1291
+ },
1292
+ {
1293
+ "type": [
1294
+ "null",
1295
+ "object"
1296
+ ],
1297
+ "properties": {
1298
+ "children": {
1299
+ "type": [
1300
+ "null",
1301
+ "array"
1302
+ ],
1303
+ "description": "",
1304
+ "items": {
1305
+ "type": [
1306
+ "null",
1307
+ "object"
1308
+ ],
1309
+ "additionalProperties": false,
1310
+ "description": "",
1311
+ "x-custom-parameters-attributes": {}
1312
+ },
1313
+ "uniqueItems": false,
1314
+ "x-custom-parameters-attributes": {}
1315
+ }
1316
+ },
1317
+ "required": [
1318
+ "children"
1319
+ ]
1320
+ }
1321
+ ]
1322
+ },
1323
+ "breadCrumbChildCategoryResponseArr": {
1324
+ "type": [
1325
+ "null",
1326
+ "array"
1327
+ ],
1328
+ "items": {
1329
+ "$ref": "#/components/schemas/breadCrumbChildCategoryResponseData"
1330
+ }
1331
+ }
1332
+ },
1333
+ "responses" : {
1334
+ "articleCategoryDataResponse" : {
1335
+ "description" : "articleCategoryDataResponse template definitions",
1336
+ "content" : {
1337
+ "application/json" : {
1338
+ "schema" : {
1339
+ "type" : [ "null", "object" ],
1340
+ "additionalProperties" : false,
1341
+ "properties" : {
1342
+ "data" : {
1343
+ "$ref" : "./KbCategory.json#/components/schemas/articleCategoryDataArray"
1344
+ }
1345
+ },
1346
+ "required" : [ "data" ]
1347
+ },
1348
+ "examples" : {
1349
+ "Valid responses Definitions" : {
1350
+ "value" : {
1351
+ "data" : [ {
1352
+ "name" : "Hellooo",
1353
+ "description" : "dataset",
1354
+ "id" : "46582000007093472",
1355
+ "permalink" : "Hellooo",
1356
+ "articles" : [ {
1357
+ "webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Solutions/dv/46582000011400068/en",
1358
+ "id" : "46582000011400068",
1359
+ "locale" : "en",
1360
+ "permalink" : "quick-edit-modifiedby",
1361
+ "title" : "Quick edit modifiedBy",
1362
+ "categoryId" : "46582000007108339"
1363
+ }, {
1364
+ "webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Solutions/dv/46582000010701399/en",
1365
+ "id" : "46582000010701399",
1366
+ "locale" : "en",
1367
+ "permalink" : "new-article",
1368
+ "title" : "New Article ",
1369
+ "categoryId" : "46582000007108339"
1370
+ }, {
1371
+ "webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Solutions/dv/46582000010675070/en",
1372
+ "id" : "46582000010675070",
1373
+ "locale" : "en",
1374
+ "permalink" : "checking-line",
1375
+ "title" : "Checking Line",
1376
+ "categoryId" : "46582000007108339"
1377
+ }, {
1378
+ "webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Solutions/dv/46582000010675005/en",
1379
+ "id" : "46582000010675005",
1380
+ "locale" : "en",
1381
+ "permalink" : "line-up",
1382
+ "title" : "Line Up",
1383
+ "categoryId" : "46582000007108339"
1384
+ }, {
1385
+ "webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Solutions/dv/46582000010443001/en",
1386
+ "id" : "46582000010443001",
1387
+ "locale" : "en",
1388
+ "permalink" : "sample-article",
1389
+ "title" : "sample article",
1390
+ "categoryId" : "46582000007108339"
1391
+ }, {
1392
+ "webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Solutions/dv/46582000007118040/en",
1393
+ "id" : "46582000007118040",
1394
+ "locale" : "en",
1395
+ "permalink" : "sample",
1396
+ "title" : "sample",
1397
+ "categoryId" : "46582000007108339"
1398
+ } ],
1399
+ "logoUrl" : "https://static.zohocdn.com/desk/app/fonts/block.4339707c19ff2c38330b.svg"
1400
+ } ]
1401
+ }
1402
+ }
1403
+ }
1404
+ }
1405
+ },
1406
+ "x-custom-response-attributes" : {
1407
+ "disable-safe-headers" : "[]"
1408
+ }
1409
+ },
1410
+ "categoryWithReviewResponse" : {
1411
+ "description" : "categoryWithReviewResponse template definitions",
1412
+ "content" : {
1413
+ "application/json" : {
1414
+ "schema" : {
1415
+ "additionalProperties" : false,
1416
+ "allOf" : [ {
1417
+ "$ref" : "./KbCategory.json#/components/schemas/commonCategoryResponse"
1418
+ }, {
1419
+ "type" : [ "null", "object" ],
1420
+ "properties" : {
1421
+ "reviewOwners" : {
1422
+ "$ref" : "./KbCategory.json#/components/schemas/reviewOwnerArr"
1423
+ },
1424
+ "isReview" : {
1425
+ "type" : [ "boolean", "null" ],
1426
+ "x-custom-parameters-attributes" : {
1427
+ "removeExif" : false,
1428
+ "filterMatchedContent" : false,
1429
+ "antivirus" : false,
1430
+ "replacementString" : "",
1431
+ "allowInvalid" : false,
1432
+ "descrption" : "Key that specifies whether review must be enabled for the category or not",
1433
+ "secret" : false,
1434
+ "preserveCharsLimit" : 10,
1435
+ "trim" : false,
1436
+ "internalParam" : false,
1437
+ "preserveChars" : "0,5",
1438
+ "importUrl" : false,
1439
+ "decrypt" : false
1440
+ }
1441
+ },
1442
+ "child" : {
1443
+ "$ref" : "./KbCategory.json#/components/schemas/childCategoryResponseData"
1444
+ }
1445
+ },
1446
+ "required" : [ "child", "isReview", "reviewOwners" ]
1447
+ } ]
1448
+ },
1449
+ "examples" : {
1450
+ "Valid responses Definitions" : {
1451
+ "value" : null
1452
+ }
1453
+ }
1454
+ }
1455
+ },
1456
+ "x-custom-response-attributes" : {
1457
+ "disable-safe-headers" : "[]"
1458
+ }
1459
+ },
1460
+ "listAllCategoryResponse" : {
1461
+ "description" : "listAllCategoryResponse template definitions",
1462
+ "content" : {
1463
+ "application/json" : {
1464
+ "schema" : {
1465
+ "type" : [ "null", "object" ],
1466
+ "additionalProperties" : false,
1467
+ "properties" : {
1468
+ "data" : {
1469
+ "$ref" : "./KbCategory.json#/components/schemas/data"
1470
+ }
1471
+ },
1472
+ "required" : [ "data" ]
1473
+ },
1474
+ "examples" : {
1475
+ "Valid responses Definitions" : {
1476
+ "value" : null
1477
+ }
1478
+ }
1479
+ }
1480
+ },
1481
+ "x-custom-response-attributes" : {
1482
+ "disable-safe-headers" : "[]"
1483
+ }
1484
+ },
1485
+ "breadCrumbTreeResponse": {
1486
+ "description": "breadCrumbTreeResponse template definitions",
1487
+ "content": {
1488
+ "application/json": {
1489
+ "schema": {
1490
+ "type": [
1491
+ "null",
1492
+ "object"
1493
+ ],
1494
+ "additionalProperties": false,
1495
+ "properties": {
1496
+ "categoryPath": {
1497
+ "$ref": "#/components/schemas/categoryPathResponseJsonArr"
1498
+ },
1499
+ "categoryTree": {
1500
+ "$ref": "#/components/schemas/categoryTreeResponseJsonArr"
1501
+ }
1502
+ },
1503
+ "required": [
1504
+ "categoryPath",
1505
+ "categoryTree"
1506
+ ]
1507
+ },
1508
+ "examples": {
1509
+ "Valid responses Definitions": {
1510
+ "value": {}
1511
+ }
1512
+ }
1513
+ }
1514
+ },
1515
+ "x-custom-response-attributes": {}
1516
+ }
1517
+ },
1518
+ "parameters" : {
1519
+ "categoryId" : {
1520
+ "name" : "categoryId",
1521
+ "in" : "path",
1522
+ "description" : "To get individual category details",
1523
+ "required" : true,
1524
+ "style" : "simple",
1525
+ "explode" : false,
1526
+ "schema" : {
1527
+ "type" : [ "string", "null", "integer" ],
1528
+ "format" : "int64",
1529
+ "description" : "To get individual category details",
1530
+ "pattern" : "([0-9]+)"
1531
+ }
1532
+ }
1533
+ },
1534
+ "requestBodies" : {
1535
+ "categoryJson" : {
1536
+ "content" : {
1537
+ "application/json" : {
1538
+ "schema" : {
1539
+ "type" : [ "null", "object" ],
1540
+ "additionalProperties" : false,
1541
+ "properties" : {
1542
+ "articleViewType" : {
1543
+ "type" : [ "string", "null" ],
1544
+ "description" : "View to apply while listing help articles. Values allowed are: LISTVIEW and OVERVIEW.",
1545
+ "enum" : [ "LISTVIEW", "OVERVIEW" ],
1546
+ "maxLength" : 100,
1547
+ "minLength" : 0
1548
+ },
1549
+ "reviewOwners" : {
1550
+ "$ref" : "./KbCategory.json#/components/schemas/reviewOwners"
1551
+ },
1552
+ "name" : {
1553
+ "type" : [ "string", "null" ],
1554
+ "description" : "Name of the category",
1555
+ "maxLength" : 100,
1556
+ "minLength" : 0
1557
+ },
1558
+ "isReview" : {
1559
+ "type" : [ "boolean", "null" ],
1560
+ "description" : "Key that specifies whether review must be enabled for the category or not"
1561
+ },
1562
+ "description" : {
1563
+ "type" : [ "string", "null" ],
1564
+ "description" : "A brief description of the category",
1565
+ "maxLength" : 100,
1566
+ "minLength" : 0,
1567
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1568
+ },
1569
+ "logo" : {
1570
+ "type" : [ "string", "null", "integer" ],
1571
+ "format" : "int64",
1572
+ "description" : "Logo for the category",
1573
+ "pattern" : "([0-9]+)"
1574
+ },
1575
+ "parentCategoryId" : {
1576
+ "type" : [ "string", "null", "integer" ],
1577
+ "format" : "int64",
1578
+ "description" : "ID of the parent category",
1579
+ "pattern" : "([0-9]+)"
1580
+ },
1581
+ "featuredCategory" : {
1582
+ "type" : [ "boolean", "null" ],
1583
+ "description" : "Key that specifies whether the category must be featured in the help center or not"
1584
+ },
1585
+ "isVisibleInHC" : {
1586
+ "type" : [ "boolean", "null" ],
1587
+ "description" : "Key that specifies whether the category must be visible in the help center or not"
1588
+ }
1589
+ },
1590
+ "required" : [ "featuredCategory", "isVisibleInHC", "name", "parentCategoryId" ]
1591
+ },
1592
+ "examples" : {
1593
+ "Valid requestBody Definitions" : {
1594
+ "value" : null
1595
+ }
1596
+ }
1597
+ }
1598
+ },
1599
+ "x-custom-request-body-attributes" : {
1600
+ "non-empty" : false,
1601
+ "allow-invalid" : false
1602
+ }
1603
+ }
1604
+ },
1605
+ "securitySchemes" : {
1606
+ "cookie-auth" : {
1607
+ "$ref" : "../common/Common.json#/components/securitySchemes/cookie-auth"
1608
+ },
1609
+ "org-oauth" : {
1610
+ "$ref" : "../common/Common.json#/components/securitySchemes/org-oauth"
1611
+ },
1612
+ "iam-oauth2-schema" : {
1613
+ "$ref" : "../common/Common.json#/components/securitySchemes/iam-oauth2-schema"
1614
+ }
1615
+ }
1616
+ },
1617
+ "x-entity" : "KbCategory"
1618
+ }