agent-generator 1.0.3 → 1.0.5

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 (770) hide show
  1. package/install-extension.js +1 -1
  2. package/package.json +2 -4
  3. package/Generator_Patterns/Conditional.md +0 -84
  4. package/Generator_Patterns/Dynamic.md +0 -129
  5. package/Generator_Patterns/PathConfig.properties +0 -4
  6. package/Generator_Patterns/README.md +0 -118
  7. package/Generator_Patterns/Reference.md +0 -98
  8. package/Generator_Patterns/Remote.md +0 -259
  9. package/Generator_Patterns/Static.md +0 -99
  10. package/source/api-data-generators/.idea/api-data-generators.iml +0 -9
  11. package/source/api-data-generators/.idea/misc.xml +0 -6
  12. package/source/api-data-generators/.idea/modules.xml +0 -8
  13. package/source/api-data-generators/.idea/vcs.xml +0 -6
  14. package/source/api-data-generators/portal/ArticleComment/test_data_generation_configurations.json +0 -318
  15. package/source/api-data-generators/portal/ArticleFeedback/test_data_generation_configurations.json +0 -32
  16. package/source/api-data-generators/portal/AsapMobile/test_data_generation_configurations.json +0 -21
  17. package/source/api-data-generators/portal/AsapWeb/test_data_generation_configurations.json +0 -18
  18. package/source/api-data-generators/portal/Category/test_data_generation_configurations.json +0 -39
  19. package/source/api-data-generators/portal/Comment/test_data_generation_configurations.json +0 -157
  20. package/source/api-data-generators/portal/Community/test_data_generation_configurations.json +0 -46
  21. package/source/api-data-generators/portal/CommunityUser/test_data_generation_configurations.json +0 -16
  22. package/source/api-data-generators/portal/Contact/test_data_generation_configurations.json +0 -33
  23. package/source/api-data-generators/portal/Department/test_data_generation_configurations.json +0 -13
  24. package/source/api-data-generators/portal/Extension/test_data_generation_configurations.json +0 -91
  25. package/source/api-data-generators/portal/FeedbackWidget/test_data_generation_configurations.json +0 -18
  26. package/source/api-data-generators/portal/FileExport/test_data_generation_configurations.json +0 -42
  27. package/source/api-data-generators/portal/Followers/test_data_generation_configurations.json +0 -92
  28. package/source/api-data-generators/portal/Gamification/test_data_generation_configurations.json +0 -51
  29. package/source/api-data-generators/portal/HelpCenters/test_data_generation_configurations.json +0 -11
  30. package/source/api-data-generators/portal/Helpcenter/test_data_generation_configurations.json +0 -41
  31. package/source/api-data-generators/portal/HelpcenterGroups/test_data_generation_configurations.json +0 -18
  32. package/source/api-data-generators/portal/KBRootCategory/test_data_generation_configurations.json +0 -76
  33. package/source/api-data-generators/portal/KbCategory/test_data_generation_configurations.json +0 -51
  34. package/source/api-data-generators/portal/KbSection/test_data_generation_configurations.json +0 -25
  35. package/source/api-data-generators/portal/KnowledgeBase/test_data_generation_configurations.json +0 -26
  36. package/source/api-data-generators/portal/Label/test_data_generation_configurations.json +0 -18
  37. package/source/api-data-generators/portal/Layout/test_data_generation_configurations.json +0 -17
  38. package/source/api-data-generators/portal/LayoutRules/test_data_generation_configurations.json +0 -17
  39. package/source/api-data-generators/portal/NewAsapMobile/test_data_generation_configurations.json +0 -21
  40. package/source/api-data-generators/portal/Permalink/test_data_generation_configurations.json +0 -32
  41. package/source/api-data-generators/portal/Product/test_data_generation_configurations.json +0 -43
  42. package/source/api-data-generators/portal/Solution/test_data_generation_configurations.json +0 -631
  43. package/source/api-data-generators/portal/Thread/test_data_generation_configurations.json +0 -70
  44. package/source/api-data-generators/portal/Ticket/test_data_generation_configurations.json +0 -294
  45. package/source/api-data-generators/portal/TicketComment/test_data_generation_configurations.json +0 -58
  46. package/source/api-data-generators/portal/TicketCount/test_data_generation_configurations.json +0 -74
  47. package/source/api-data-generators/portal/TicketStatusMapping/test_data_generation_configurations.json +0 -11
  48. package/source/api-data-generators/portal/TicketTemplate/test_data_generation_configurations.json +0 -24
  49. package/source/api-data-generators/portal/Topic/test_data_generation_configurations.json +0 -259
  50. package/source/api-data-generators/portal/Translation/test_data_generation_configurations.json +0 -6
  51. package/source/api-data-generators/portal/ValidationRules/test_data_generation_configurations.json +0 -14
  52. package/source/api-data-generators/portal/View/test_data_generation_configurations.json +0 -19
  53. package/source/api-data-generators/support/Account/test_data_generation_configurations.json +0 -265
  54. package/source/api-data-generators/support/AccountAttachment/test_data_generation_configurations.json +0 -48
  55. package/source/api-data-generators/support/AccountComments/test_data_generation_configurations.json +0 -47
  56. package/source/api-data-generators/support/AccountContactMappingInfo/test_data_generation_configurations.json +0 -14
  57. package/source/api-data-generators/support/AccountFollowers/test_data_generation_configurations.json +0 -52
  58. package/source/api-data-generators/support/AccountSla/test_data_generation_configurations.json +0 -33
  59. package/source/api-data-generators/support/AccountTimeEntry/test_data_generation_configurations.json +0 -45
  60. package/source/api-data-generators/support/ActiveCalls/test_data_generation_configurations.json +0 -38
  61. package/source/api-data-generators/support/Activity/test_data_generation_configurations.json +0 -50
  62. package/source/api-data-generators/support/ActorsAPI/test_data_generation_configurations.json +0 -22
  63. package/source/api-data-generators/support/Agent/test_data_generation_configurations.json +0 -217
  64. package/source/api-data-generators/support/AgentPresence/test_data_generation_configurations.json +0 -30
  65. package/source/api-data-generators/support/AgentSignatures/test_data_generation_configurations.json +0 -31
  66. package/source/api-data-generators/support/AgentTimeEntry/test_data_generation_configurations.json +0 -36
  67. package/source/api-data-generators/support/AntiSpamInfo/test_data_generation_configurations.json +0 -32
  68. package/source/api-data-generators/support/ApiCreditNotificationRule/test_data_generation_configurations.json +0 -49
  69. package/source/api-data-generators/support/ArchivedView/test_data_generation_configurations.json +0 -66
  70. package/source/api-data-generators/support/Article/test_data_generation_configurations.json +0 -294
  71. package/source/api-data-generators/support/ArticleAttachment/test_data_generation_configurations.json +0 -150
  72. package/source/api-data-generators/support/ArticleComment/test_data_generation_configurations.json +0 -238
  73. package/source/api-data-generators/support/ArticleFeedback/test_data_generation_configurations.json +0 -147
  74. package/source/api-data-generators/support/ArticleFeedbackResolution/test_data_generation_configurations.json +0 -56
  75. package/source/api-data-generators/support/ArticleStatistics/test_data_generation_configurations.json +0 -397
  76. package/source/api-data-generators/support/ArticleTranslation/test_data_generation_configurations.json +0 -1123
  77. package/source/api-data-generators/support/ArticleVersion/test_data_generation_configurations.json +0 -26
  78. package/source/api-data-generators/support/ArticleViews/test_data_generation_configurations.json +0 -26
  79. package/source/api-data-generators/support/Asap/test_data_generation_configurations.json +0 -49
  80. package/source/api-data-generators/support/AuditLog/test_data_generation_configurations.json +0 -58
  81. package/source/api-data-generators/support/AutomationAlerts/test_data_generation_configurations.json +0 -27
  82. package/source/api-data-generators/support/AutomationEngine/test_data_generation_configurations.json +0 -20
  83. package/source/api-data-generators/support/AutomationFeatureCount/test_data_generation_configurations.json +0 -13
  84. package/source/api-data-generators/support/AutomationFieldUpdates/test_data_generation_configurations.json +0 -24
  85. package/source/api-data-generators/support/AutomationTask/test_data_generation_configurations.json +0 -29
  86. package/source/api-data-generators/support/Backup/test_data_generation_configurations.json +0 -115
  87. package/source/api-data-generators/support/Badge/test_data_generation_configurations.json +0 -64
  88. package/source/api-data-generators/support/Bot/test_data_generation_configurations.json +0 -288
  89. package/source/api-data-generators/support/BotInference/test_data_generation_configurations.json +0 -119
  90. package/source/api-data-generators/support/BugInteg/test_data_generation_configurations.json +0 -37
  91. package/source/api-data-generators/support/BulkAction/test_data_generation_configurations.json +0 -26
  92. package/source/api-data-generators/support/BulkImport/test_data_generation_configurations.json +0 -211
  93. package/source/api-data-generators/support/BulkUpdate/test_data_generation_configurations.json +0 -40
  94. package/source/api-data-generators/support/BulkWrite/test_data_generation_configurations.json +0 -32
  95. package/source/api-data-generators/support/BusinessHour/test_data_generation_configurations.json +0 -72
  96. package/source/api-data-generators/support/Call/test_data_generation_configurations.json +0 -247
  97. package/source/api-data-generators/support/CallComments/test_data_generation_configurations.json +0 -51
  98. package/source/api-data-generators/support/CallHistory/test_data_generation_configurations.json +0 -65
  99. package/source/api-data-generators/support/CallTimeEntry/test_data_generation_configurations.json +0 -77
  100. package/source/api-data-generators/support/CallTimer/test_data_generation_configurations.json +0 -14
  101. package/source/api-data-generators/support/Channel/test_data_generation_configurations.json +0 -44
  102. package/source/api-data-generators/support/Chart/test_data_generation_configurations.json +0 -35
  103. package/source/api-data-generators/support/ChatTicket/test_data_generation_configurations.json +0 -185
  104. package/source/api-data-generators/support/Common/test_data_generation_configurations.json +0 -43
  105. package/source/api-data-generators/support/Community/test_data_generation_configurations.json +0 -313
  106. package/source/api-data-generators/support/CommunityAttachment/test_data_generation_configurations.json +0 -16
  107. package/source/api-data-generators/support/CommunityCategory/test_data_generation_configurations.json +0 -121
  108. package/source/api-data-generators/support/CommunityComment/test_data_generation_configurations.json +0 -350
  109. package/source/api-data-generators/support/CommunityInitPermissions/test_data_generation_configurations.json +0 -16
  110. package/source/api-data-generators/support/CommunityPreferences/test_data_generation_configurations.json +0 -19
  111. package/source/api-data-generators/support/CommunityTopic/test_data_generation_configurations.json +0 -509
  112. package/source/api-data-generators/support/CommunityTopicInsights/test_data_generation_configurations.json +0 -32
  113. package/source/api-data-generators/support/CommunityUser/test_data_generation_configurations.json +0 -63
  114. package/source/api-data-generators/support/Contact/test_data_generation_configurations.json +0 -370
  115. package/source/api-data-generators/support/ContactAttachment/test_data_generation_configurations.json +0 -44
  116. package/source/api-data-generators/support/ContactComments/test_data_generation_configurations.json +0 -47
  117. package/source/api-data-generators/support/ContactFollowers/test_data_generation_configurations.json +0 -52
  118. package/source/api-data-generators/support/ContactProfile/test_data_generation_configurations.json +0 -11
  119. package/source/api-data-generators/support/ContactTimeEntry/test_data_generation_configurations.json +0 -45
  120. package/source/api-data-generators/support/Contract/test_data_generation_configurations.json +0 -184
  121. package/source/api-data-generators/support/ContractAttachment/test_data_generation_configurations.json +0 -30
  122. package/source/api-data-generators/support/CreateTicket/test_data_generation_configurations.json +0 -93
  123. package/source/api-data-generators/support/Criteria/test_data_generation_configurations.json +0 -19
  124. package/source/api-data-generators/support/CrmInteg/test_data_generation_configurations.json +0 -202
  125. package/source/api-data-generators/support/CustomAction/test_data_generation_configurations.json +0 -56
  126. package/source/api-data-generators/support/CustomActionRuleMapping/test_data_generation_configurations.json +0 -334
  127. package/source/api-data-generators/support/CustomButton/test_data_generation_configurations.json +0 -113
  128. package/source/api-data-generators/support/CustomFunctionExecutionLogs/test_data_generation_configurations.json +0 -68
  129. package/source/api-data-generators/support/CustomFunctionGallery/test_data_generation_configurations.json +0 -16
  130. package/source/api-data-generators/support/CustomFunctions/test_data_generation_configurations.json +0 -270
  131. package/source/api-data-generators/support/CustomTheme/test_data_generation_configurations.json +0 -70
  132. package/source/api-data-generators/support/CustomView/test_data_generation_configurations.json +0 -486
  133. package/source/api-data-generators/support/CustomerHappiness/test_data_generation_configurations.json +0 -77
  134. package/source/api-data-generators/support/DashboardComponent/test_data_generation_configurations.json +0 -305
  135. package/source/api-data-generators/support/DashboardFolder/test_data_generation_configurations.json +0 -126
  136. package/source/api-data-generators/support/DashboardMetrics/test_data_generation_configurations.json +0 -205
  137. package/source/api-data-generators/support/Dashboards/test_data_generation_configurations.json +0 -90
  138. package/source/api-data-generators/support/DataChips/test_data_generation_configurations.json +0 -33
  139. package/source/api-data-generators/support/DataSync/test_data_generation_configurations.json +0 -228
  140. package/source/api-data-generators/support/DeleteTicket/test_data_generation_configurations.json +0 -44
  141. package/source/api-data-generators/support/Department/test_data_generation_configurations.json +0 -156
  142. package/source/api-data-generators/support/DependencyMappings/test_data_generation_configurations.json +0 -50
  143. package/source/api-data-generators/support/DirectAssignRuleTarget/test_data_generation_configurations.json +0 -17
  144. package/source/api-data-generators/support/DirectAssignmentRules/test_data_generation_configurations.json +0 -37
  145. package/source/api-data-generators/support/DisplayEntity/test_data_generation_configurations.json +0 -45
  146. package/source/api-data-generators/support/DomainMapping/test_data_generation_configurations.json +0 -6
  147. package/source/api-data-generators/support/EmailFailureAlert/test_data_generation_configurations.json +0 -21
  148. package/source/api-data-generators/support/EmailTemplates/test_data_generation_configurations.json +0 -106
  149. package/source/api-data-generators/support/EntityBlueprints/test_data_generation_configurations.json +0 -205
  150. package/source/api-data-generators/support/Event/test_data_generation_configurations.json +0 -196
  151. package/source/api-data-generators/support/EventComments/test_data_generation_configurations.json +0 -45
  152. package/source/api-data-generators/support/EventTimeEntry/test_data_generation_configurations.json +0 -77
  153. package/source/api-data-generators/support/EventTimer/test_data_generation_configurations.json +0 -14
  154. package/source/api-data-generators/support/Extension/test_data_generation_configurations.json +0 -689
  155. package/source/api-data-generators/support/FbManager/test_data_generation_configurations.json +0 -64
  156. package/source/api-data-generators/support/Feature/test_data_generation_configurations.json +0 -61
  157. package/source/api-data-generators/support/FeatureFile/test_data_generation_configurations.json +0 -49
  158. package/source/api-data-generators/support/FeatureFolder/test_data_generation_configurations.json +0 -44
  159. package/source/api-data-generators/support/FeaturePermission/test_data_generation_configurations.json +0 -108
  160. package/source/api-data-generators/support/FederatedLogin/test_data_generation_configurations.json +0 -39
  161. package/source/api-data-generators/support/FeedsAPIs/test_data_generation_configurations.json +0 -54
  162. package/source/api-data-generators/support/Field/test_data_generation_configurations.json +0 -1031
  163. package/source/api-data-generators/support/FieldPrediction/test_data_generation_configurations.json +0 -564
  164. package/source/api-data-generators/support/FileExport/test_data_generation_configurations.json +0 -36
  165. package/source/api-data-generators/support/Finance/test_data_generation_configurations.json +0 -180
  166. package/source/api-data-generators/support/Followers/test_data_generation_configurations.json +0 -60
  167. package/source/api-data-generators/support/GC_Bots/test_data_generation_configurations.json +0 -26
  168. package/source/api-data-generators/support/GC_Guide/test_data_generation_configurations.json +0 -240
  169. package/source/api-data-generators/support/GenericAction/test_data_generation_configurations.json +0 -16
  170. package/source/api-data-generators/support/GenericActionMapping/test_data_generation_configurations.json +0 -216
  171. package/source/api-data-generators/support/GoogleAnalytics/test_data_generation_configurations.json +0 -168
  172. package/source/api-data-generators/support/GoogleChat/test_data_generation_configurations.json +0 -29
  173. package/source/api-data-generators/support/Helpcenter/test_data_generation_configurations.json +0 -98
  174. package/source/api-data-generators/support/HelpcenterAutoTranslateSetting/test_data_generation_configurations.json +0 -11
  175. package/source/api-data-generators/support/HelpcenterGroups/test_data_generation_configurations.json +0 -93
  176. package/source/api-data-generators/support/HelpcenterPages/test_data_generation_configurations.json +0 -34
  177. package/source/api-data-generators/support/HelpcenterPreference/test_data_generation_configurations.json +0 -18
  178. package/source/api-data-generators/support/HelpcenterUpload/test_data_generation_configurations.json +0 -25
  179. package/source/api-data-generators/support/HolidayList/test_data_generation_configurations.json +0 -65
  180. package/source/api-data-generators/support/IMCannedMessage/test_data_generation_configurations.json +0 -155
  181. package/source/api-data-generators/support/IMCannedMessageTranslation/test_data_generation_configurations.json +0 -92
  182. package/source/api-data-generators/support/IMTemplateMessage/test_data_generation_configurations.json +0 -22
  183. package/source/api-data-generators/support/IM_AddOn/test_data_generation_configurations.json +0 -19
  184. package/source/api-data-generators/support/IM_Bot/test_data_generation_configurations.json +0 -143
  185. package/source/api-data-generators/support/IM_Broadcast/test_data_generation_configurations.json +0 -39
  186. package/source/api-data-generators/support/IM_Channel/test_data_generation_configurations.json +0 -312
  187. package/source/api-data-generators/support/IM_ChannelPreference/test_data_generation_configurations.json +0 -35
  188. package/source/api-data-generators/support/IM_Contact/test_data_generation_configurations.json +0 -16
  189. package/source/api-data-generators/support/IM_Integration/test_data_generation_configurations.json +0 -32
  190. package/source/api-data-generators/support/IM_Message/test_data_generation_configurations.json +0 -297
  191. package/source/api-data-generators/support/IM_Metrics/test_data_generation_configurations.json +0 -38
  192. package/source/api-data-generators/support/IM_Search/test_data_generation_configurations.json +0 -56
  193. package/source/api-data-generators/support/IM_Session/test_data_generation_configurations.json +0 -149
  194. package/source/api-data-generators/support/IM_TimeSeriesMetrics/test_data_generation_configurations.json +0 -77
  195. package/source/api-data-generators/support/IM_ZiaGpt/test_data_generation_configurations.json +0 -52
  196. package/source/api-data-generators/support/Import/test_data_generation_configurations.json +0 -229
  197. package/source/api-data-generators/support/InlineImage/test_data_generation_configurations.json +0 -16
  198. package/source/api-data-generators/support/IntegModule/test_data_generation_configurations.json +0 -90
  199. package/source/api-data-generators/support/Integrations/test_data_generation_configurations.json +0 -25
  200. package/source/api-data-generators/support/InteractiveTours/test_data_generation_configurations.json +0 -66
  201. package/source/api-data-generators/support/JWT/test_data_generation_configurations.json +0 -49
  202. package/source/api-data-generators/support/KBCategoryUser/test_data_generation_configurations.json +0 -23
  203. package/source/api-data-generators/support/KBRecycleBin/test_data_generation_configurations.json +0 -131
  204. package/source/api-data-generators/support/KBRootCategory/test_data_generation_configurations.json +0 -214
  205. package/source/api-data-generators/support/KBRootCategoryTranslation/test_data_generation_configurations.json +0 -30
  206. package/source/api-data-generators/support/KBSection/test_data_generation_configurations.json +0 -173
  207. package/source/api-data-generators/support/KPIWidget/test_data_generation_configurations.json +0 -21
  208. package/source/api-data-generators/support/KbCategory/test_data_generation_configurations.json +0 -93
  209. package/source/api-data-generators/support/Label/test_data_generation_configurations.json +0 -103
  210. package/source/api-data-generators/support/Layout/test_data_generation_configurations.json +0 -503
  211. package/source/api-data-generators/support/LayoutRuleCriteria/test_data_generation_configurations.json +0 -19
  212. package/source/api-data-generators/support/LayoutRules/test_data_generation_configurations.json +0 -334
  213. package/source/api-data-generators/support/License/test_data_generation_configurations.json +0 -60
  214. package/source/api-data-generators/support/Livecall/test_data_generation_configurations.json +0 -72
  215. package/source/api-data-generators/support/LookupRecord/test_data_generation_configurations.json +0 -34
  216. package/source/api-data-generators/support/Macros/test_data_generation_configurations.json +0 -184
  217. package/source/api-data-generators/support/MailReplyAddress/test_data_generation_configurations.json +0 -32
  218. package/source/api-data-generators/support/MassAction/test_data_generation_configurations.json +0 -38
  219. package/source/api-data-generators/support/Message/test_data_generation_configurations.json +0 -38
  220. package/source/api-data-generators/support/MicrosoftTeams/test_data_generation_configurations.json +0 -50
  221. package/source/api-data-generators/support/Misc/test_data_generation_configurations.json +0 -16
  222. package/source/api-data-generators/support/Module/test_data_generation_configurations.json +0 -96
  223. package/source/api-data-generators/support/NewCriteria/test_data_generation_configurations.json +0 -26
  224. package/source/api-data-generators/support/NewFeatureFields/test_data_generation_configurations.json +0 -19
  225. package/source/api-data-generators/support/NewTicketHistory/test_data_generation_configurations.json +0 -20
  226. package/source/api-data-generators/support/NotificationRules/test_data_generation_configurations.json +0 -27
  227. package/source/api-data-generators/support/OEmbedData/test_data_generation_configurations.json +0 -19
  228. package/source/api-data-generators/support/Onboarding/test_data_generation_configurations.json +0 -29
  229. package/source/api-data-generators/support/Organization/test_data_generation_configurations.json +0 -79
  230. package/source/api-data-generators/support/PBGroup/test_data_generation_configurations.json +0 -109
  231. package/source/api-data-generators/support/PBGroupAgents/test_data_generation_configurations.json +0 -66
  232. package/source/api-data-generators/support/PBPlatform/test_data_generation_configurations.json +0 -113
  233. package/source/api-data-generators/support/PBX/test_data_generation_configurations.json +0 -28
  234. package/source/api-data-generators/support/PBXConfig/test_data_generation_configurations.json +0 -17
  235. package/source/api-data-generators/support/PBXPhoneNumbers/test_data_generation_configurations.json +0 -54
  236. package/source/api-data-generators/support/PBXPreference/test_data_generation_configurations.json +0 -54
  237. package/source/api-data-generators/support/PageSense/test_data_generation_configurations.json +0 -77
  238. package/source/api-data-generators/support/PendingApproval/test_data_generation_configurations.json +0 -14
  239. package/source/api-data-generators/support/Permalink/test_data_generation_configurations.json +0 -32
  240. package/source/api-data-generators/support/PhoneAgents/test_data_generation_configurations.json +0 -66
  241. package/source/api-data-generators/support/PinnedConversation/test_data_generation_configurations.json +0 -64
  242. package/source/api-data-generators/support/Pipeline_Service/test_data_generation_configurations.json +0 -32
  243. package/source/api-data-generators/support/Product/test_data_generation_configurations.json +0 -196
  244. package/source/api-data-generators/support/ProductAttachment/test_data_generation_configurations.json +0 -48
  245. package/source/api-data-generators/support/Profile/test_data_generation_configurations.json +0 -59
  246. package/source/api-data-generators/support/QueueView/test_data_generation_configurations.json +0 -37
  247. package/source/api-data-generators/support/Records/test_data_generation_configurations.json +0 -239
  248. package/source/api-data-generators/support/Recyclebin/test_data_generation_configurations.json +0 -52
  249. package/source/api-data-generators/support/RemoteAuth/test_data_generation_configurations.json +0 -52
  250. package/source/api-data-generators/support/Report/test_data_generation_configurations.json +0 -538
  251. package/source/api-data-generators/support/ReportChart/test_data_generation_configurations.json +0 -28
  252. package/source/api-data-generators/support/ReportFolder/test_data_generation_configurations.json +0 -100
  253. package/source/api-data-generators/support/Resources/test_data_generation_configurations.json +0 -29
  254. package/source/api-data-generators/support/Role/test_data_generation_configurations.json +0 -84
  255. package/source/api-data-generators/support/RoundRobin/test_data_generation_configurations.json +0 -58
  256. package/source/api-data-generators/support/RoundRobinTarget/test_data_generation_configurations.json +0 -50
  257. package/source/api-data-generators/support/RoutingPreference/test_data_generation_configurations.json +0 -29
  258. package/source/api-data-generators/support/SLAMetaInfo/test_data_generation_configurations.json +0 -22
  259. package/source/api-data-generators/support/Saml/test_data_generation_configurations.json +0 -42
  260. package/source/api-data-generators/support/Sandbox/test_data_generation_configurations.json +0 -92
  261. package/source/api-data-generators/support/SandboxChangeset/test_data_generation_configurations.json +0 -46
  262. package/source/api-data-generators/support/SandboxDeployment/test_data_generation_configurations.json +0 -50
  263. package/source/api-data-generators/support/SandboxDeploymentLogs/test_data_generation_configurations.json +0 -22
  264. package/source/api-data-generators/support/SavedFilters/test_data_generation_configurations.json +0 -203
  265. package/source/api-data-generators/support/Schedule/test_data_generation_configurations.json +0 -172
  266. package/source/api-data-generators/support/ScheduleReplyInfo/test_data_generation_configurations.json +0 -182
  267. package/source/api-data-generators/support/Search/test_data_generation_configurations.json +0 -636
  268. package/source/api-data-generators/support/SearchInteg/test_data_generation_configurations.json +0 -32
  269. package/source/api-data-generators/support/Setup/test_data_generation_configurations.json +0 -32
  270. package/source/api-data-generators/support/SharedSnippet/test_data_generation_configurations.json +0 -62
  271. package/source/api-data-generators/support/Signature/test_data_generation_configurations.json +0 -24
  272. package/source/api-data-generators/support/Skill/test_data_generation_configurations.json +0 -164
  273. package/source/api-data-generators/support/SkillConfiguration/test_data_generation_configurations.json +0 -21
  274. package/source/api-data-generators/support/SkillType/test_data_generation_configurations.json +0 -60
  275. package/source/api-data-generators/support/Slack/test_data_generation_configurations.json +0 -51
  276. package/source/api-data-generators/support/SmsTemplates/test_data_generation_configurations.json +0 -40
  277. package/source/api-data-generators/support/Snippets/test_data_generation_configurations.json +0 -47
  278. package/source/api-data-generators/support/SocialInteg/test_data_generation_configurations.json +0 -22
  279. package/source/api-data-generators/support/SocialPosts/test_data_generation_configurations.json +0 -223
  280. package/source/api-data-generators/support/SocialTwitterConversations/test_data_generation_configurations.json +0 -22
  281. package/source/api-data-generators/support/StarredTemplates/test_data_generation_configurations.json +0 -76
  282. package/source/api-data-generators/support/SubjectAccessRequest/test_data_generation_configurations.json +0 -104
  283. package/source/api-data-generators/support/Supervise/test_data_generation_configurations.json +0 -43
  284. package/source/api-data-generators/support/SupportPlan/test_data_generation_configurations.json +0 -65
  285. package/source/api-data-generators/support/Tab/test_data_generation_configurations.json +0 -29
  286. package/source/api-data-generators/support/Target/test_data_generation_configurations.json +0 -97
  287. package/source/api-data-generators/support/Task/test_data_generation_configurations.json +0 -219
  288. package/source/api-data-generators/support/TaskAttachment/test_data_generation_configurations.json +0 -42
  289. package/source/api-data-generators/support/TaskComments/test_data_generation_configurations.json +0 -45
  290. package/source/api-data-generators/support/TaskTimeEntry/test_data_generation_configurations.json +0 -87
  291. package/source/api-data-generators/support/TaskTimer/test_data_generation_configurations.json +0 -27
  292. package/source/api-data-generators/support/Team/test_data_generation_configurations.json +0 -115
  293. package/source/api-data-generators/support/TemplateFolders/test_data_generation_configurations.json +0 -72
  294. package/source/api-data-generators/support/Thread/test_data_generation_configurations.json +0 -383
  295. package/source/api-data-generators/support/Ticket/test_data_generation_configurations.json +0 -694
  296. package/source/api-data-generators/support/TicketApprovals/test_data_generation_configurations.json +0 -66
  297. package/source/api-data-generators/support/TicketAttachment/test_data_generation_configurations.json +0 -58
  298. package/source/api-data-generators/support/TicketComment/test_data_generation_configurations.json +0 -82
  299. package/source/api-data-generators/support/TicketCount/test_data_generation_configurations.json +0 -43
  300. package/source/api-data-generators/support/TicketFollowers/test_data_generation_configurations.json +0 -65
  301. package/source/api-data-generators/support/TicketMetrics/test_data_generation_configurations.json +0 -16
  302. package/source/api-data-generators/support/TicketTag/test_data_generation_configurations.json +0 -99
  303. package/source/api-data-generators/support/TicketTemplate/test_data_generation_configurations.json +0 -475
  304. package/source/api-data-generators/support/TicketTimeEntry/test_data_generation_configurations.json +0 -110
  305. package/source/api-data-generators/support/TicketTimer/test_data_generation_configurations.json +0 -48
  306. package/source/api-data-generators/support/TicketWithChildren/test_data_generation_configurations.json +0 -91
  307. package/source/api-data-generators/support/TimeTracking/test_data_generation_configurations.json +0 -46
  308. package/source/api-data-generators/support/TranslationLanguages/test_data_generation_configurations.json +0 -68
  309. package/source/api-data-generators/support/Upload/test_data_generation_configurations.json +0 -54
  310. package/source/api-data-generators/support/User/test_data_generation_configurations.json +0 -100
  311. package/source/api-data-generators/support/UserAuthentication/test_data_generation_configurations.json +0 -49
  312. package/source/api-data-generators/support/UserPresence/test_data_generation_configurations.json +0 -19
  313. package/source/api-data-generators/support/ValidationRuleCriteria/test_data_generation_configurations.json +0 -19
  314. package/source/api-data-generators/support/ValidationRules/test_data_generation_configurations.json +0 -321
  315. package/source/api-data-generators/support/Webhook/test_data_generation_configurations.json +0 -501
  316. package/source/api-data-generators/support/Widget/test_data_generation_configurations.json +0 -166
  317. package/source/api-data-generators/support/ZIAAnswerbotInference/test_data_generation_configurations.json +0 -26
  318. package/source/api-data-generators/support/ZIADocumentData/test_data_generation_configurations.json +0 -38
  319. package/source/api-data-generators/support/ZIAVectorSearch/test_data_generation_configurations.json +0 -22
  320. package/source/api-data-generators/support/ZiaGPT/test_data_generation_configurations.json +0 -19
  321. package/source/api-data-generators/support/ZiaScheduler/test_data_generation_configurations.json +0 -22
  322. package/source/api-data-generators/support/ZiapoweredbyGPT/test_data_generation_configurations.json +0 -33
  323. package/source/api-data-generators/support/Zwitch/test_data_generation_configurations.json +0 -71
  324. package/source/api-data-generators/support/blueprintDrafts/test_data_generation_configurations.json +0 -859
  325. package/source/api-data-generators/support/blueprintTransitions/test_data_generation_configurations.json +0 -26
  326. package/source/api-data-generators/support/blueprints/test_data_generation_configurations.json +0 -652
  327. package/source/api-data-generators/support/borrow_book/test_data_generation_configurations.json +0 -21
  328. package/source/api-data-generators/support/zlabsnlp/test_data_generation_configurations.json +0 -50
  329. package/source/openapi-specifications/v1.0/common/Common.json +0 -587
  330. package/source/openapi-specifications/v1.0/portal/Account.json +0 -183
  331. package/source/openapi-specifications/v1.0/portal/ArticleComment.json +0 -1103
  332. package/source/openapi-specifications/v1.0/portal/ArticleFeedback.json +0 -133
  333. package/source/openapi-specifications/v1.0/portal/AsapMobile.json +0 -712
  334. package/source/openapi-specifications/v1.0/portal/AsapWeb.json +0 -91
  335. package/source/openapi-specifications/v1.0/portal/Attachment.json +0 -122
  336. package/source/openapi-specifications/v1.0/portal/Captcha.json +0 -334
  337. package/source/openapi-specifications/v1.0/portal/Category.json +0 -1061
  338. package/source/openapi-specifications/v1.0/portal/Comment.json +0 -1546
  339. package/source/openapi-specifications/v1.0/portal/Community.json +0 -235
  340. package/source/openapi-specifications/v1.0/portal/CommunityUser.json +0 -296
  341. package/source/openapi-specifications/v1.0/portal/Contact.json +0 -536
  342. package/source/openapi-specifications/v1.0/portal/CustomerHappiness.json +0 -163
  343. package/source/openapi-specifications/v1.0/portal/Department.json +0 -246
  344. package/source/openapi-specifications/v1.0/portal/Extension.json +0 -1122
  345. package/source/openapi-specifications/v1.0/portal/FeedbackWidget.json +0 -96
  346. package/source/openapi-specifications/v1.0/portal/Field.json +0 -1239
  347. package/source/openapi-specifications/v1.0/portal/FileExport.json +0 -313
  348. package/source/openapi-specifications/v1.0/portal/Followers.json +0 -802
  349. package/source/openapi-specifications/v1.0/portal/Gamification.json +0 -819
  350. package/source/openapi-specifications/v1.0/portal/HashTags.json +0 -61
  351. package/source/openapi-specifications/v1.0/portal/HelpCenterUser.json +0 -605
  352. package/source/openapi-specifications/v1.0/portal/HelpCenterUserPreference.json +0 -148
  353. package/source/openapi-specifications/v1.0/portal/Helpcenter.json +0 -920
  354. package/source/openapi-specifications/v1.0/portal/HelpcenterGroups.json +0 -118
  355. package/source/openapi-specifications/v1.0/portal/HelpcenterPages.json +0 -184
  356. package/source/openapi-specifications/v1.0/portal/KBCategoryTranslation.json +0 -70
  357. package/source/openapi-specifications/v1.0/portal/KBRootCategory.json +0 -1310
  358. package/source/openapi-specifications/v1.0/portal/KbCategory.json +0 -1525
  359. package/source/openapi-specifications/v1.0/portal/KbSection.json +0 -515
  360. package/source/openapi-specifications/v1.0/portal/Label.json +0 -172
  361. package/source/openapi-specifications/v1.0/portal/Layout.json +0 -303
  362. package/source/openapi-specifications/v1.0/portal/LayoutRules.json +0 -375
  363. package/source/openapi-specifications/v1.0/portal/Mentions.json +0 -580
  364. package/source/openapi-specifications/v1.0/portal/NewAsapMobile.json +0 -699
  365. package/source/openapi-specifications/v1.0/portal/Permalink.json +0 -265
  366. package/source/openapi-specifications/v1.0/portal/Placeholders.json +0 -57
  367. package/source/openapi-specifications/v1.0/portal/Product.json +0 -401
  368. package/source/openapi-specifications/v1.0/portal/Solution.json +0 -3766
  369. package/source/openapi-specifications/v1.0/portal/Thread.json +0 -821
  370. package/source/openapi-specifications/v1.0/portal/Ticket.json +0 -2636
  371. package/source/openapi-specifications/v1.0/portal/TicketComment.json +0 -822
  372. package/source/openapi-specifications/v1.0/portal/TicketCount.json +0 -336
  373. package/source/openapi-specifications/v1.0/portal/TicketExport.json +0 -609
  374. package/source/openapi-specifications/v1.0/portal/TicketField.json +0 -358
  375. package/source/openapi-specifications/v1.0/portal/TicketForm.json +0 -517
  376. package/source/openapi-specifications/v1.0/portal/TicketStatusMapping.json +0 -155
  377. package/source/openapi-specifications/v1.0/portal/TicketTemplate.json +0 -409
  378. package/source/openapi-specifications/v1.0/portal/TicketsViewCount.json +0 -175
  379. package/source/openapi-specifications/v1.0/portal/Topic.json +0 -4079
  380. package/source/openapi-specifications/v1.0/portal/Translation.json +0 -174
  381. package/source/openapi-specifications/v1.0/portal/Upload.json +0 -156
  382. package/source/openapi-specifications/v1.0/portal/ValidationRules.json +0 -309
  383. package/source/openapi-specifications/v1.0/portal/View.json +0 -353
  384. package/source/openapi-specifications/v1.0/portal/Widget.json +0 -218
  385. package/source/openapi-specifications/v1.0/support/AEAdminTool.json +0 -354
  386. package/source/openapi-specifications/v1.0/support/Account.json +0 -3206
  387. package/source/openapi-specifications/v1.0/support/AccountAttachment.json +0 -484
  388. package/source/openapi-specifications/v1.0/support/AccountComments.json +0 -794
  389. package/source/openapi-specifications/v1.0/support/AccountContactMappingInfo.json +0 -227
  390. package/source/openapi-specifications/v1.0/support/AccountDeduplication.json +0 -578
  391. package/source/openapi-specifications/v1.0/support/AccountFollowers.json +0 -350
  392. package/source/openapi-specifications/v1.0/support/AccountSla.json +0 -341
  393. package/source/openapi-specifications/v1.0/support/AccountTimeEntry.json +0 -1152
  394. package/source/openapi-specifications/v1.0/support/ActiveCalls.json +0 -573
  395. package/source/openapi-specifications/v1.0/support/Activity.json +0 -1400
  396. package/source/openapi-specifications/v1.0/support/Actor.json +0 -88
  397. package/source/openapi-specifications/v1.0/support/ActorsAPI.json +0 -304
  398. package/source/openapi-specifications/v1.0/support/AdminTool.json +0 -489
  399. package/source/openapi-specifications/v1.0/support/Agent.json +0 -6685
  400. package/source/openapi-specifications/v1.0/support/AgentPresence.json +0 -567
  401. package/source/openapi-specifications/v1.0/support/AgentRoom.json +0 -1997
  402. package/source/openapi-specifications/v1.0/support/AgentSignatures.json +0 -359
  403. package/source/openapi-specifications/v1.0/support/AgentTimeEntry.json +0 -1402
  404. package/source/openapi-specifications/v1.0/support/AntiSpamInfo.json +0 -510
  405. package/source/openapi-specifications/v1.0/support/ApiCreditNotificationRule.json +0 -1189
  406. package/source/openapi-specifications/v1.0/support/ApiDashboard.json +0 -543
  407. package/source/openapi-specifications/v1.0/support/ApplicationFlags.json +0 -155
  408. package/source/openapi-specifications/v1.0/support/ArchivedView.json +0 -469
  409. package/source/openapi-specifications/v1.0/support/Article.json +0 -5060
  410. package/source/openapi-specifications/v1.0/support/ArticleAttachment.json +0 -544
  411. package/source/openapi-specifications/v1.0/support/ArticleComment.json +0 -1929
  412. package/source/openapi-specifications/v1.0/support/ArticleExternalImageUrlResponse.json +0 -56
  413. package/source/openapi-specifications/v1.0/support/ArticleFeedback.json +0 -1314
  414. package/source/openapi-specifications/v1.0/support/ArticleFeedbackResolution.json +0 -513
  415. package/source/openapi-specifications/v1.0/support/ArticleHistory.json +0 -2510
  416. package/source/openapi-specifications/v1.0/support/ArticleStatistics.json +0 -3053
  417. package/source/openapi-specifications/v1.0/support/ArticleTranslation.json +0 -7530
  418. package/source/openapi-specifications/v1.0/support/ArticleVersion.json +0 -184
  419. package/source/openapi-specifications/v1.0/support/ArticleViews.json +0 -564
  420. package/source/openapi-specifications/v1.0/support/Asap.json +0 -1525
  421. package/source/openapi-specifications/v1.0/support/AsapModule.json +0 -246
  422. package/source/openapi-specifications/v1.0/support/AsapStatus.json +0 -199
  423. package/source/openapi-specifications/v1.0/support/AssistInteg.json +0 -613
  424. package/source/openapi-specifications/v1.0/support/AttachmentRestriction.json +0 -786
  425. package/source/openapi-specifications/v1.0/support/AuditLog.json +0 -1122
  426. package/source/openapi-specifications/v1.0/support/AutomatedSummaryForChats.json +0 -702
  427. package/source/openapi-specifications/v1.0/support/AutomationAlerts.json +0 -868
  428. package/source/openapi-specifications/v1.0/support/AutomationEngine.json +0 -1181
  429. package/source/openapi-specifications/v1.0/support/AutomationFeatureCount.json +0 -207
  430. package/source/openapi-specifications/v1.0/support/AutomationFieldUpdates.json +0 -809
  431. package/source/openapi-specifications/v1.0/support/AutomationTask.json +0 -1054
  432. package/source/openapi-specifications/v1.0/support/Backup.json +0 -2845
  433. package/source/openapi-specifications/v1.0/support/Badge.json +0 -544
  434. package/source/openapi-specifications/v1.0/support/Bot.json +0 -2103
  435. package/source/openapi-specifications/v1.0/support/BotInference.json +0 -1071
  436. package/source/openapi-specifications/v1.0/support/BotResources.json +0 -175
  437. package/source/openapi-specifications/v1.0/support/BotStaticResources.json +0 -541
  438. package/source/openapi-specifications/v1.0/support/Bot_UserInfo.json +0 -63
  439. package/source/openapi-specifications/v1.0/support/Bots.json +0 -58
  440. package/source/openapi-specifications/v1.0/support/BugInteg.json +0 -481
  441. package/source/openapi-specifications/v1.0/support/BulkAction.json +0 -150
  442. package/source/openapi-specifications/v1.0/support/BulkImport.json +0 -2845
  443. package/source/openapi-specifications/v1.0/support/BulkUpdate.json +0 -743
  444. package/source/openapi-specifications/v1.0/support/BulkWrite.json +0 -678
  445. package/source/openapi-specifications/v1.0/support/BusinessHour.json +0 -1344
  446. package/source/openapi-specifications/v1.0/support/Call.json +0 -3839
  447. package/source/openapi-specifications/v1.0/support/CallComments.json +0 -721
  448. package/source/openapi-specifications/v1.0/support/CallHistory.json +0 -936
  449. package/source/openapi-specifications/v1.0/support/CallTimeEntry.json +0 -1745
  450. package/source/openapi-specifications/v1.0/support/CallTimer.json +0 -285
  451. package/source/openapi-specifications/v1.0/support/Channel.json +0 -730
  452. package/source/openapi-specifications/v1.0/support/Chart.json +0 -422
  453. package/source/openapi-specifications/v1.0/support/ChatTicket.json +0 -553
  454. package/source/openapi-specifications/v1.0/support/ClientAction.json +0 -1834
  455. package/source/openapi-specifications/v1.0/support/ClientEvent.json +0 -780
  456. package/source/openapi-specifications/v1.0/support/CliqIntegJsonMapping.json +0 -1123
  457. package/source/openapi-specifications/v1.0/support/CloudAttachment.json +0 -528
  458. package/source/openapi-specifications/v1.0/support/CommonMassActionError.json +0 -44
  459. package/source/openapi-specifications/v1.0/support/CommonMassActionResponse.json +0 -94
  460. package/source/openapi-specifications/v1.0/support/Community.json +0 -2545
  461. package/source/openapi-specifications/v1.0/support/CommunityAttachment.json +0 -249
  462. package/source/openapi-specifications/v1.0/support/CommunityCategory.json +0 -1896
  463. package/source/openapi-specifications/v1.0/support/CommunityCategoryLogo.json +0 -145
  464. package/source/openapi-specifications/v1.0/support/CommunityComment.json +0 -2492
  465. package/source/openapi-specifications/v1.0/support/CommunityInitPermissions.json +0 -129
  466. package/source/openapi-specifications/v1.0/support/CommunityPreferences.json +0 -343
  467. package/source/openapi-specifications/v1.0/support/CommunitySearch.json +0 -78
  468. package/source/openapi-specifications/v1.0/support/CommunityTopic.json +0 -6005
  469. package/source/openapi-specifications/v1.0/support/CommunityTopicInsights.json +0 -310
  470. package/source/openapi-specifications/v1.0/support/CommunityUser.json +0 -822
  471. package/source/openapi-specifications/v1.0/support/Composite.json +0 -414
  472. package/source/openapi-specifications/v1.0/support/Contact.json +0 -4691
  473. package/source/openapi-specifications/v1.0/support/ContactAttachment.json +0 -484
  474. package/source/openapi-specifications/v1.0/support/ContactComments.json +0 -769
  475. package/source/openapi-specifications/v1.0/support/ContactDeduplication.json +0 -683
  476. package/source/openapi-specifications/v1.0/support/ContactFollowers.json +0 -350
  477. package/source/openapi-specifications/v1.0/support/ContactProfile.json +0 -195
  478. package/source/openapi-specifications/v1.0/support/ContactTimeEntry.json +0 -1157
  479. package/source/openapi-specifications/v1.0/support/Contract.json +0 -2877
  480. package/source/openapi-specifications/v1.0/support/ContractAttachment.json +0 -307
  481. package/source/openapi-specifications/v1.0/support/Conversation.json +0 -570
  482. package/source/openapi-specifications/v1.0/support/CountriesAndLanguages.json +0 -5279
  483. package/source/openapi-specifications/v1.0/support/CreditCycle.json +0 -124
  484. package/source/openapi-specifications/v1.0/support/Criteria.json +0 -1014
  485. package/source/openapi-specifications/v1.0/support/CriteriaValue.json +0 -50
  486. package/source/openapi-specifications/v1.0/support/CrmInteg.json +0 -5938
  487. package/source/openapi-specifications/v1.0/support/CustomAction.json +0 -2106
  488. package/source/openapi-specifications/v1.0/support/CustomActionRuleMapping.json +0 -1327
  489. package/source/openapi-specifications/v1.0/support/CustomButton.json +0 -1898
  490. package/source/openapi-specifications/v1.0/support/CustomFunctionExecutionLogs.json +0 -883
  491. package/source/openapi-specifications/v1.0/support/CustomFunctionGallery.json +0 -329
  492. package/source/openapi-specifications/v1.0/support/CustomFunctionReRun.json +0 -317
  493. package/source/openapi-specifications/v1.0/support/CustomFunctionZiaCopilot.json +0 -379
  494. package/source/openapi-specifications/v1.0/support/CustomFunctions.json +0 -3457
  495. package/source/openapi-specifications/v1.0/support/CustomModuleAdminTool.json +0 -81
  496. package/source/openapi-specifications/v1.0/support/CustomTheme.json +0 -7391
  497. package/source/openapi-specifications/v1.0/support/CustomView.json +0 -3478
  498. package/source/openapi-specifications/v1.0/support/CustomerHappiness.json +0 -464
  499. package/source/openapi-specifications/v1.0/support/DBThrottle.json +0 -334
  500. package/source/openapi-specifications/v1.0/support/DashboardComponent.json +0 -1163
  501. package/source/openapi-specifications/v1.0/support/DashboardFolder.json +0 -1258
  502. package/source/openapi-specifications/v1.0/support/DashboardMetrics.json +0 -2310
  503. package/source/openapi-specifications/v1.0/support/Dashboards.json +0 -1219
  504. package/source/openapi-specifications/v1.0/support/DataChips.json +0 -477
  505. package/source/openapi-specifications/v1.0/support/DataImport.json +0 -1099
  506. package/source/openapi-specifications/v1.0/support/DataSync.json +0 -1246
  507. package/source/openapi-specifications/v1.0/support/DatasetEntry.json +0 -153
  508. package/source/openapi-specifications/v1.0/support/Department.json +0 -1971
  509. package/source/openapi-specifications/v1.0/support/DependencyMappings.json +0 -656
  510. package/source/openapi-specifications/v1.0/support/DirectAssignRuleTarget.json +0 -232
  511. package/source/openapi-specifications/v1.0/support/DirectAssignmentRules.json +0 -722
  512. package/source/openapi-specifications/v1.0/support/DisplayEntity.json +0 -91
  513. package/source/openapi-specifications/v1.0/support/DomainMapping.json +0 -1143
  514. package/source/openapi-specifications/v1.0/support/EmailFailureAlert.json +0 -306
  515. package/source/openapi-specifications/v1.0/support/EmailTemplates.json +0 -1491
  516. package/source/openapi-specifications/v1.0/support/EntityBlueprints.json +0 -572
  517. package/source/openapi-specifications/v1.0/support/Event.json +0 -3607
  518. package/source/openapi-specifications/v1.0/support/EventComments.json +0 -737
  519. package/source/openapi-specifications/v1.0/support/EventTimeEntry.json +0 -1520
  520. package/source/openapi-specifications/v1.0/support/EventTimer.json +0 -285
  521. package/source/openapi-specifications/v1.0/support/Expression.json +0 -43
  522. package/source/openapi-specifications/v1.0/support/Extension.json +0 -7152
  523. package/source/openapi-specifications/v1.0/support/ExtensionOrg.json +0 -129
  524. package/source/openapi-specifications/v1.0/support/FAQ.json +0 -142
  525. package/source/openapi-specifications/v1.0/support/FAQTranslation.json +0 -178
  526. package/source/openapi-specifications/v1.0/support/FbManager.json +0 -1147
  527. package/source/openapi-specifications/v1.0/support/Feature.json +0 -691
  528. package/source/openapi-specifications/v1.0/support/FeatureFile.json +0 -435
  529. package/source/openapi-specifications/v1.0/support/FeatureFolder.json +0 -576
  530. package/source/openapi-specifications/v1.0/support/FeaturePermission.json +0 -492
  531. package/source/openapi-specifications/v1.0/support/FederatedLogin.json +0 -318
  532. package/source/openapi-specifications/v1.0/support/FeedsAPIs.json +0 -198
  533. package/source/openapi-specifications/v1.0/support/Field.json +0 -7493
  534. package/source/openapi-specifications/v1.0/support/FieldDetails.json +0 -139
  535. package/source/openapi-specifications/v1.0/support/FieldPermissions.json +0 -113
  536. package/source/openapi-specifications/v1.0/support/FieldPrediction.json +0 -3831
  537. package/source/openapi-specifications/v1.0/support/FileExport.json +0 -324
  538. package/source/openapi-specifications/v1.0/support/Finance.json +0 -4290
  539. package/source/openapi-specifications/v1.0/support/Followers.json +0 -875
  540. package/source/openapi-specifications/v1.0/support/FormulaFunctions.json +0 -47
  541. package/source/openapi-specifications/v1.0/support/GC_Bots.json +0 -138
  542. package/source/openapi-specifications/v1.0/support/GC_Guide.json +0 -1536
  543. package/source/openapi-specifications/v1.0/support/GC_GuideHistories.json +0 -58
  544. package/source/openapi-specifications/v1.0/support/GC_GuideHistory.json +0 -79
  545. package/source/openapi-specifications/v1.0/support/GC_Guides.json +0 -89
  546. package/source/openapi-specifications/v1.0/support/GC_Info.json +0 -208
  547. package/source/openapi-specifications/v1.0/support/GC_Status.json +0 -69
  548. package/source/openapi-specifications/v1.0/support/GC_UserInfo.json +0 -79
  549. package/source/openapi-specifications/v1.0/support/GenericAction.json +0 -1888
  550. package/source/openapi-specifications/v1.0/support/GenericActionMapping.json +0 -1050
  551. package/source/openapi-specifications/v1.0/support/GoogleAnalytics.json +0 -1715
  552. package/source/openapi-specifications/v1.0/support/GoogleChat.json +0 -650
  553. package/source/openapi-specifications/v1.0/support/HelpCenterCommon.json +0 -44
  554. package/source/openapi-specifications/v1.0/support/Help_Center_OIDC_Authentication.json +0 -900
  555. package/source/openapi-specifications/v1.0/support/Helpcenter.json +0 -1212
  556. package/source/openapi-specifications/v1.0/support/HelpcenterAutoTranslateSetting.json +0 -331
  557. package/source/openapi-specifications/v1.0/support/HelpcenterGroups.json +0 -1496
  558. package/source/openapi-specifications/v1.0/support/HelpcenterPages.json +0 -504
  559. package/source/openapi-specifications/v1.0/support/HelpcenterPreference.json +0 -208
  560. package/source/openapi-specifications/v1.0/support/HelpcenterTranslationApp.json +0 -64
  561. package/source/openapi-specifications/v1.0/support/HelpcenterUpload.json +0 -211
  562. package/source/openapi-specifications/v1.0/support/HolidayList.json +0 -731
  563. package/source/openapi-specifications/v1.0/support/IMAPAddress.json +0 -1091
  564. package/source/openapi-specifications/v1.0/support/IMCannedMessage.json +0 -1357
  565. package/source/openapi-specifications/v1.0/support/IMCannedMessagePlaceHolders.json +0 -169
  566. package/source/openapi-specifications/v1.0/support/IMCannedMessageTranslation.json +0 -624
  567. package/source/openapi-specifications/v1.0/support/IMTemplateMessage.json +0 -597
  568. package/source/openapi-specifications/v1.0/support/IM_AddOn.json +0 -841
  569. package/source/openapi-specifications/v1.0/support/IM_AttachmentMessage.json +0 -64
  570. package/source/openapi-specifications/v1.0/support/IM_Bot.json +0 -1007
  571. package/source/openapi-specifications/v1.0/support/IM_BotService.json +0 -357
  572. package/source/openapi-specifications/v1.0/support/IM_Broadcast.json +0 -323
  573. package/source/openapi-specifications/v1.0/support/IM_Channel.json +0 -2849
  574. package/source/openapi-specifications/v1.0/support/IM_ChannelPreference.json +0 -502
  575. package/source/openapi-specifications/v1.0/support/IM_Contact.json +0 -165
  576. package/source/openapi-specifications/v1.0/support/IM_Efc.json +0 -188
  577. package/source/openapi-specifications/v1.0/support/IM_Integration.json +0 -1269
  578. package/source/openapi-specifications/v1.0/support/IM_IntegrationService.json +0 -454
  579. package/source/openapi-specifications/v1.0/support/IM_LayoutView.json +0 -625
  580. package/source/openapi-specifications/v1.0/support/IM_License.json +0 -225
  581. package/source/openapi-specifications/v1.0/support/IM_Message.json +0 -1371
  582. package/source/openapi-specifications/v1.0/support/IM_Metrics.json +0 -462
  583. package/source/openapi-specifications/v1.0/support/IM_Search.json +0 -547
  584. package/source/openapi-specifications/v1.0/support/IM_Session.json +0 -1397
  585. package/source/openapi-specifications/v1.0/support/IM_TemplateButton.json +0 -142
  586. package/source/openapi-specifications/v1.0/support/IM_TemplateFooter.json +0 -83
  587. package/source/openapi-specifications/v1.0/support/IM_TemplateHeader.json +0 -86
  588. package/source/openapi-specifications/v1.0/support/IM_TemplateItems.json +0 -73
  589. package/source/openapi-specifications/v1.0/support/IM_TimeSeriesMetrics.json +0 -435
  590. package/source/openapi-specifications/v1.0/support/IM_TwilioPhoneNumber.json +0 -202
  591. package/source/openapi-specifications/v1.0/support/IM_WhatsApp_Integrations.json +0 -193
  592. package/source/openapi-specifications/v1.0/support/IM_ZiaGpt.json +0 -489
  593. package/source/openapi-specifications/v1.0/support/Import.json +0 -1844
  594. package/source/openapi-specifications/v1.0/support/IncrementalDocuments.json +0 -395
  595. package/source/openapi-specifications/v1.0/support/Inference.json +0 -307
  596. package/source/openapi-specifications/v1.0/support/InlineImage.json +0 -97
  597. package/source/openapi-specifications/v1.0/support/IntegModule.json +0 -938
  598. package/source/openapi-specifications/v1.0/support/Integrations.json +0 -1264
  599. package/source/openapi-specifications/v1.0/support/InteractiveTours.json +0 -539
  600. package/source/openapi-specifications/v1.0/support/JWT.json +0 -535
  601. package/source/openapi-specifications/v1.0/support/KBCategoryPermalink.json +0 -208
  602. package/source/openapi-specifications/v1.0/support/KBCategoryUser.json +0 -241
  603. package/source/openapi-specifications/v1.0/support/KBPreference.json +0 -323
  604. package/source/openapi-specifications/v1.0/support/KBRecycleBin.json +0 -2316
  605. package/source/openapi-specifications/v1.0/support/KBRootCategory.json +0 -2839
  606. package/source/openapi-specifications/v1.0/support/KBRootCategoryTranslation.json +0 -570
  607. package/source/openapi-specifications/v1.0/support/KBSection.json +0 -1941
  608. package/source/openapi-specifications/v1.0/support/KBTranslationMassActionResponse.json +0 -169
  609. package/source/openapi-specifications/v1.0/support/KPIWidget.json +0 -206
  610. package/source/openapi-specifications/v1.0/support/KbBot.json +0 -511
  611. package/source/openapi-specifications/v1.0/support/KbCategory.json +0 -1618
  612. package/source/openapi-specifications/v1.0/support/KbCategoryLogo.json +0 -124
  613. package/source/openapi-specifications/v1.0/support/Label.json +0 -1251
  614. package/source/openapi-specifications/v1.0/support/Layout.json +0 -8042
  615. package/source/openapi-specifications/v1.0/support/LayoutRuleCriteria.json +0 -491
  616. package/source/openapi-specifications/v1.0/support/LayoutRules.json +0 -1422
  617. package/source/openapi-specifications/v1.0/support/LensInteg.json +0 -86
  618. package/source/openapi-specifications/v1.0/support/LicenseFeaturePlan.json +0 -548
  619. package/source/openapi-specifications/v1.0/support/LicenseInfo.json +0 -1231
  620. package/source/openapi-specifications/v1.0/support/LicenseTool.json +0 -165
  621. package/source/openapi-specifications/v1.0/support/Livecall.json +0 -954
  622. package/source/openapi-specifications/v1.0/support/LookupRecord.json +0 -174
  623. package/source/openapi-specifications/v1.0/support/Macros.json +0 -1960
  624. package/source/openapi-specifications/v1.0/support/MailReplyAddress.json +0 -1263
  625. package/source/openapi-specifications/v1.0/support/MassAction.json +0 -1151
  626. package/source/openapi-specifications/v1.0/support/MassActionError.json +0 -55
  627. package/source/openapi-specifications/v1.0/support/MassActionResponse.json +0 -89
  628. package/source/openapi-specifications/v1.0/support/Mentions.json +0 -491
  629. package/source/openapi-specifications/v1.0/support/Message.json +0 -685
  630. package/source/openapi-specifications/v1.0/support/Microsoft.json +0 -887
  631. package/source/openapi-specifications/v1.0/support/MicrosoftTeams.json +0 -574
  632. package/source/openapi-specifications/v1.0/support/Microsoft_PowerBI.json +0 -903
  633. package/source/openapi-specifications/v1.0/support/Misc.json +0 -214
  634. package/source/openapi-specifications/v1.0/support/Module.json +0 -1625
  635. package/source/openapi-specifications/v1.0/support/NewCriteria.json +0 -1863
  636. package/source/openapi-specifications/v1.0/support/NewFeatureFields.json +0 -204
  637. package/source/openapi-specifications/v1.0/support/NewTicketHistory.json +0 -150
  638. package/source/openapi-specifications/v1.0/support/NotificationRules.json +0 -441
  639. package/source/openapi-specifications/v1.0/support/OEmbedData.json +0 -233
  640. package/source/openapi-specifications/v1.0/support/Onboarding.json +0 -282
  641. package/source/openapi-specifications/v1.0/support/Organization.json +0 -1391
  642. package/source/openapi-specifications/v1.0/support/PBGroup.json +0 -634
  643. package/source/openapi-specifications/v1.0/support/PBGroupAgents.json +0 -433
  644. package/source/openapi-specifications/v1.0/support/PBPlatform.json +0 -1447
  645. package/source/openapi-specifications/v1.0/support/PBX.json +0 -550
  646. package/source/openapi-specifications/v1.0/support/PBXConfig.json +0 -219
  647. package/source/openapi-specifications/v1.0/support/PBXPhoneNumbers.json +0 -443
  648. package/source/openapi-specifications/v1.0/support/PBXPreference.json +0 -314
  649. package/source/openapi-specifications/v1.0/support/PageSense.json +0 -1505
  650. package/source/openapi-specifications/v1.0/support/PendingApproval.json +0 -279
  651. package/source/openapi-specifications/v1.0/support/Permalink.json +0 -393
  652. package/source/openapi-specifications/v1.0/support/PhoneAgents.json +0 -1014
  653. package/source/openapi-specifications/v1.0/support/PhoneMenu.json +0 -118
  654. package/source/openapi-specifications/v1.0/support/PinnedConversation.json +0 -1115
  655. package/source/openapi-specifications/v1.0/support/Pipeline_Info.json +0 -232
  656. package/source/openapi-specifications/v1.0/support/Pipeline_Service.json +0 -499
  657. package/source/openapi-specifications/v1.0/support/Product.json +0 -1861
  658. package/source/openapi-specifications/v1.0/support/ProductAttachment.json +0 -485
  659. package/source/openapi-specifications/v1.0/support/Profile.json +0 -4236
  660. package/source/openapi-specifications/v1.0/support/ProjectsInteg.json +0 -989
  661. package/source/openapi-specifications/v1.0/support/QueryStore.json +0 -238
  662. package/source/openapi-specifications/v1.0/support/QueueView.json +0 -335
  663. package/source/openapi-specifications/v1.0/support/RatelimitAdminTool.json +0 -1204
  664. package/source/openapi-specifications/v1.0/support/Records.json +0 -1509
  665. package/source/openapi-specifications/v1.0/support/Recyclebin.json +0 -669
  666. package/source/openapi-specifications/v1.0/support/RemoteAuth.json +0 -401
  667. package/source/openapi-specifications/v1.0/support/Report.json +0 -6491
  668. package/source/openapi-specifications/v1.0/support/ReportChart.json +0 -254
  669. package/source/openapi-specifications/v1.0/support/ReportFolder.json +0 -1076
  670. package/source/openapi-specifications/v1.0/support/ReportIntegration.json +0 -202
  671. package/source/openapi-specifications/v1.0/support/RequestFlags.json +0 -358
  672. package/source/openapi-specifications/v1.0/support/Resources.json +0 -335
  673. package/source/openapi-specifications/v1.0/support/ResponseHelpCenterUser.json +0 -128
  674. package/source/openapi-specifications/v1.0/support/Role.json +0 -996
  675. package/source/openapi-specifications/v1.0/support/RoundRobin.json +0 -796
  676. package/source/openapi-specifications/v1.0/support/RoundRobinTarget.json +0 -381
  677. package/source/openapi-specifications/v1.0/support/RoutingPreference.json +0 -615
  678. package/source/openapi-specifications/v1.0/support/RuleGroup.json +0 -1630
  679. package/source/openapi-specifications/v1.0/support/SLAMetaInfo.json +0 -227
  680. package/source/openapi-specifications/v1.0/support/Saml.json +0 -565
  681. package/source/openapi-specifications/v1.0/support/Sandbox.json +0 -1075
  682. package/source/openapi-specifications/v1.0/support/SandboxChangeset.json +0 -501
  683. package/source/openapi-specifications/v1.0/support/SandboxDeployment.json +0 -428
  684. package/source/openapi-specifications/v1.0/support/SandboxDeploymentLogs.json +0 -295
  685. package/source/openapi-specifications/v1.0/support/SandboxSourceOrganization.json +0 -268
  686. package/source/openapi-specifications/v1.0/support/SavedFilters.json +0 -652
  687. package/source/openapi-specifications/v1.0/support/Schedule.json +0 -2077
  688. package/source/openapi-specifications/v1.0/support/ScheduleReplyInfo.json +0 -2271
  689. package/source/openapi-specifications/v1.0/support/Search.json +0 -12600
  690. package/source/openapi-specifications/v1.0/support/SearchInteg.json +0 -2254
  691. package/source/openapi-specifications/v1.0/support/Setup.json +0 -1766
  692. package/source/openapi-specifications/v1.0/support/SharedSnippet.json +0 -1110
  693. package/source/openapi-specifications/v1.0/support/SharingRule.json +0 -287
  694. package/source/openapi-specifications/v1.0/support/Signature.json +0 -354
  695. package/source/openapi-specifications/v1.0/support/Skill.json +0 -2164
  696. package/source/openapi-specifications/v1.0/support/SkillConfiguration.json +0 -269
  697. package/source/openapi-specifications/v1.0/support/SkillType.json +0 -807
  698. package/source/openapi-specifications/v1.0/support/Slack.json +0 -957
  699. package/source/openapi-specifications/v1.0/support/SmsTemplates.json +0 -514
  700. package/source/openapi-specifications/v1.0/support/Snippets.json +0 -918
  701. package/source/openapi-specifications/v1.0/support/SocialBrands.json +0 -427
  702. package/source/openapi-specifications/v1.0/support/SocialInteg.json +0 -336
  703. package/source/openapi-specifications/v1.0/support/SocialPosts.json +0 -2460
  704. package/source/openapi-specifications/v1.0/support/SocialTwitterConversations.json +0 -337
  705. package/source/openapi-specifications/v1.0/support/StarredTemplates.json +0 -690
  706. package/source/openapi-specifications/v1.0/support/Statistics.json +0 -125
  707. package/source/openapi-specifications/v1.0/support/SubjectAccessRequest.json +0 -2419
  708. package/source/openapi-specifications/v1.0/support/Supervise.json +0 -774
  709. package/source/openapi-specifications/v1.0/support/SupportEmailAddress.json +0 -188
  710. package/source/openapi-specifications/v1.0/support/SupportEmailDomain.json +0 -293
  711. package/source/openapi-specifications/v1.0/support/SupportPlan.json +0 -1109
  712. package/source/openapi-specifications/v1.0/support/Tab.json +0 -606
  713. package/source/openapi-specifications/v1.0/support/Target.json +0 -1311
  714. package/source/openapi-specifications/v1.0/support/TargetFunctions.json +0 -130
  715. package/source/openapi-specifications/v1.0/support/Task.json +0 -4006
  716. package/source/openapi-specifications/v1.0/support/TaskAttachment.json +0 -443
  717. package/source/openapi-specifications/v1.0/support/TaskComments.json +0 -706
  718. package/source/openapi-specifications/v1.0/support/TaskTimeEntry.json +0 -1756
  719. package/source/openapi-specifications/v1.0/support/TaskTimer.json +0 -441
  720. package/source/openapi-specifications/v1.0/support/Team.json +0 -1383
  721. package/source/openapi-specifications/v1.0/support/TemplateFolders.json +0 -1069
  722. package/source/openapi-specifications/v1.0/support/Theme.json +0 -152
  723. package/source/openapi-specifications/v1.0/support/Thread.json +0 -3545
  724. package/source/openapi-specifications/v1.0/support/Ticket.json +0 -9495
  725. package/source/openapi-specifications/v1.0/support/TicketApprovals.json +0 -855
  726. package/source/openapi-specifications/v1.0/support/TicketAttachment.json +0 -562
  727. package/source/openapi-specifications/v1.0/support/TicketComment.json +0 -1444
  728. package/source/openapi-specifications/v1.0/support/TicketCount.json +0 -690
  729. package/source/openapi-specifications/v1.0/support/TicketFollowers.json +0 -454
  730. package/source/openapi-specifications/v1.0/support/TicketHistory.json +0 -414
  731. package/source/openapi-specifications/v1.0/support/TicketMetrics.json +0 -369
  732. package/source/openapi-specifications/v1.0/support/TicketRealTime.json +0 -178
  733. package/source/openapi-specifications/v1.0/support/TicketTag.json +0 -1513
  734. package/source/openapi-specifications/v1.0/support/TicketTemplate.json +0 -907
  735. package/source/openapi-specifications/v1.0/support/TicketTimeEntry.json +0 -1681
  736. package/source/openapi-specifications/v1.0/support/TicketTimer.json +0 -1205
  737. package/source/openapi-specifications/v1.0/support/TimeTracking.json +0 -1212
  738. package/source/openapi-specifications/v1.0/support/TrainingCourses.json +0 -614
  739. package/source/openapi-specifications/v1.0/support/TrainingIntegration.json +0 -163
  740. package/source/openapi-specifications/v1.0/support/TranslationLanguages.json +0 -2772
  741. package/source/openapi-specifications/v1.0/support/Upload.json +0 -620
  742. package/source/openapi-specifications/v1.0/support/User.json +0 -1409
  743. package/source/openapi-specifications/v1.0/support/UserAuthentication.json +0 -617
  744. package/source/openapi-specifications/v1.0/support/UserPresence.json +0 -763
  745. package/source/openapi-specifications/v1.0/support/ValidationRuleCriteria.json +0 -107
  746. package/source/openapi-specifications/v1.0/support/ValidationRules.json +0 -1173
  747. package/source/openapi-specifications/v1.0/support/Webhook.json +0 -1330
  748. package/source/openapi-specifications/v1.0/support/WhatsAppDetails.json +0 -132
  749. package/source/openapi-specifications/v1.0/support/WhatsAppMigration.json +0 -143
  750. package/source/openapi-specifications/v1.0/support/WhatsAppTemplateTags.json +0 -132
  751. package/source/openapi-specifications/v1.0/support/Widget.json +0 -3023
  752. package/source/openapi-specifications/v1.0/support/WmsDomain.json +0 -104
  753. package/source/openapi-specifications/v1.0/support/ZIAAnswerbotInference.json +0 -756
  754. package/source/openapi-specifications/v1.0/support/ZIADocumentData.json +0 -989
  755. package/source/openapi-specifications/v1.0/support/ZIASolutionService.json +0 -135
  756. package/source/openapi-specifications/v1.0/support/ZIAVectorSearch.json +0 -376
  757. package/source/openapi-specifications/v1.0/support/ZiaDCMigration.json +0 -159
  758. package/source/openapi-specifications/v1.0/support/ZiaGPT.json +0 -3229
  759. package/source/openapi-specifications/v1.0/support/ZiaScheduler.json +0 -453
  760. package/source/openapi-specifications/v1.0/support/Zwitch.json +0 -1543
  761. package/source/openapi-specifications/v1.0/support/blueprintChartData.json +0 -201
  762. package/source/openapi-specifications/v1.0/support/blueprintConnections.json +0 -75
  763. package/source/openapi-specifications/v1.0/support/blueprintCriteria.json +0 -255
  764. package/source/openapi-specifications/v1.0/support/blueprintDrafts.json +0 -1677
  765. package/source/openapi-specifications/v1.0/support/blueprintStates.json +0 -284
  766. package/source/openapi-specifications/v1.0/support/blueprintStrictModeConfig.json +0 -91
  767. package/source/openapi-specifications/v1.0/support/blueprintTransitions.json +0 -1546
  768. package/source/openapi-specifications/v1.0/support/blueprints.json +0 -2992
  769. package/source/openapi-specifications/v1.0/support/errors.json +0 -80
  770. package/source/openapi-specifications/v1.0/support/zlabsnlp.json +0 -416
@@ -1,1618 +0,0 @@
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
- }