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,1941 +0,0 @@
1
- {
2
- "openapi" : "3.1.0",
3
- "info" : {
4
- "title" : "KBSection",
5
- "version" : "1.0.0",
6
- "x-clan-group" : "helpCenter",
7
- "x-module-group" : "kb"
8
- },
9
- "paths" : {
10
- "/api/v1/kbSections" : {
11
- "post" : {
12
- "tags" : [ "KBSection" ],
13
- "summary" : "Create a KB section",
14
- "description" : "This API creates a section in your helpdesk",
15
- "operationId" : "addKBSection",
16
- "parameters" : [ {
17
- "$ref" : "../common/Common.json#/components/parameters/orgId"
18
- } ],
19
- "requestBody" : {
20
- "$ref" : "#/components/requestBodies/createCategoryJson"
21
- },
22
- "responses" : {
23
- "422" : {
24
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
25
- },
26
- "200" : {
27
- "$ref" : "#/components/responses/sectionResponse"
28
- }
29
- },
30
- "security" : [ {
31
- "org-oauth" : [ "Desk.accessAll.ALL" ]
32
- }, {
33
- "iam-oauth2-schema" : [ "Desk.articles.CREATE" ]
34
- } ],
35
- "x-audience" : [ "external-public" ],
36
- "x-custom-url-attribute" : {
37
- "security" : {
38
- "throttle" : {
39
- "inline" : [ {
40
- "scope" : "APPSERVER",
41
- "rules" : [ {
42
- "duration" : 60000,
43
- "lock-period" : 600000,
44
- "threshold" : 25,
45
- "hip" : false
46
- }, {
47
- "duration" : 3600000,
48
- "lock-period" : 1800000,
49
- "threshold" : 200,
50
- "hip" : false
51
- } ],
52
- "window" : "ROLLING",
53
- "key" : "url.path+user.zuid"
54
- } ]
55
- },
56
- "extraparams" : {
57
- "disable" : true,
58
- "ignore" : false
59
- },
60
- "authentication" : { }
61
- },
62
- "clan-group" : "helpCenter",
63
- "apihash" : "ca35b5a5724ab5dac8bf9b0fc8b9f19d",
64
- "module-group" : "kb",
65
- "apimethod" : "com.zoho.desk.helpcenter.kbcategory.rest.KbCategoryService.addASection"
66
- }
67
- }
68
- },
69
- "/api/v1/kbSections/{sectionId}/translations/{locale}/permalinks" : {
70
- "get" : {
71
- "tags" : [ "KBSection" ],
72
- "summary" : "Get permalinks of a section translation",
73
- "description" : "This API fetches permalinks of a sections translation",
74
- "operationId" : "getSecondaryPermalinks",
75
- "parameters" : [ {
76
- "$ref" : "#/components/parameters/sectionId"
77
- }, {
78
- "$ref" : "#/components/parameters/locale"
79
- }, {
80
- "$ref" : "../common/Common.json#/components/parameters/orgId"
81
- } ],
82
- "responses" : {
83
- "422" : {
84
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
85
- },
86
- "200" : {
87
- "$ref" : "./KBCategoryPermalink.json#/components/responses/permalinkJsonDataArrayWithOldResponse"
88
- }
89
- },
90
- "security" : [ {
91
- "org-oauth" : [ "Desk.accessAll.ALL" ]
92
- }, {
93
- "iam-oauth2-schema" : [ "Desk.articles.READ" ]
94
- } ],
95
- "x-audience" : [ "company-internal" ],
96
- "x-custom-url-attribute" : {
97
- "security" : {
98
- "throttle" : {
99
- "inline" : [ {
100
- "scope" : "APPSERVER",
101
- "rules" : [ {
102
- "duration" : 60000,
103
- "lock-period" : 600000,
104
- "threshold" : 25,
105
- "hip" : false
106
- }, {
107
- "duration" : 3600000,
108
- "lock-period" : 1800000,
109
- "threshold" : 200,
110
- "hip" : false
111
- } ],
112
- "window" : "ROLLING",
113
- "key" : "url.path+user.zuid"
114
- } ]
115
- },
116
- "extraparams" : {
117
- "disable" : true,
118
- "ignore" : false
119
- },
120
- "authentication" : { }
121
- },
122
- "clan-group" : "helpCenter",
123
- "apihash" : "c885f499edcba7154981ad43ac1db39d",
124
- "module-group" : "kb",
125
- "apimethod" : "com.zoho.desk.helpcenter.kbcategory.rest.KbCategoryService.getPermalinksOfATranslationOfASection"
126
- }
127
- },
128
- "post" : {
129
- "tags" : [ "KBSection" ],
130
- "summary" : "Update permalinks of a KB section",
131
- "description" : "API updates primary and secondary permalinks of kb sub sections",
132
- "operationId" : "updateKBSectionPermalinks",
133
- "parameters" : [ {
134
- "$ref" : "#/components/parameters/sectionId"
135
- }, {
136
- "$ref" : "#/components/parameters/locale"
137
- }, {
138
- "$ref" : "../common/Common.json#/components/parameters/orgId"
139
- } ],
140
- "requestBody" : {
141
- "$ref" : "#/components/requestBodies/permalinkUpdateJson"
142
- },
143
- "responses" : {
144
- "422" : {
145
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
146
- },
147
- "200" : {
148
- "$ref" : "./KBCategoryPermalink.json#/components/responses/permalinkJsonDataArray"
149
- }
150
- },
151
- "security" : [ {
152
- "org-oauth" : [ "Desk.accessAll.ALL" ]
153
- }, {
154
- "iam-oauth2-schema" : [ "Desk.articles.UPDATE" ]
155
- } ],
156
- "x-audience" : [ "company-internal" ],
157
- "x-custom-url-attribute" : {
158
- "security" : {
159
- "throttle" : {
160
- "inline" : [ {
161
- "scope" : "APPSERVER",
162
- "rules" : [ {
163
- "duration" : 60000,
164
- "lock-period" : 300000,
165
- "threshold" : 10,
166
- "hip" : false
167
- }, {
168
- "duration" : 3600000,
169
- "lock-period" : 1200000,
170
- "threshold" : 50,
171
- "hip" : false
172
- } ],
173
- "window" : "ROLLING",
174
- "key" : "url.path+user.zuid"
175
- } ]
176
- },
177
- "extraparams" : {
178
- "disable" : true,
179
- "ignore" : false
180
- },
181
- "authentication" : { }
182
- },
183
- "clan-group" : "helpCenter",
184
- "apihash" : "bcd8bedc8acf823ed411758be28b13f2",
185
- "module-group" : "kb",
186
- "apimethod" : "com.zoho.desk.helpcenter.kbcategory.rest.KbCategoryService.updateKBSectionPermalinks"
187
- }
188
- }
189
- },
190
- "/api/v1/kbSections/reorder" : {
191
- "post" : {
192
- "tags" : [ "KBSection" ],
193
- "summary" : "Reorder sections",
194
- "description" : "This API reorders sections",
195
- "operationId" : "reorderSections",
196
- "parameters" : [ {
197
- "$ref" : "../common/Common.json#/components/parameters/orgId"
198
- } ],
199
- "requestBody" : {
200
- "$ref" : "./KBRootCategory.json#/components/requestBodies/reorderRootCategoryJson"
201
- },
202
- "responses" : {
203
- "422" : {
204
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
205
- },
206
- "204" : {
207
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
208
- }
209
- },
210
- "security" : [ {
211
- "org-oauth" : [ "Desk.accessAll.ALL" ]
212
- }, {
213
- "iam-oauth2-schema" : [ "Desk.articles.UPDATE" ]
214
- } ],
215
- "x-audience" : [ "company-internal" ],
216
- "x-custom-url-attribute" : {
217
- "security" : {
218
- "throttle" : {
219
- "inline" : [ {
220
- "scope" : "APPSERVER",
221
- "rules" : [ {
222
- "duration" : 60000,
223
- "lock-period" : 600000,
224
- "threshold" : 25,
225
- "hip" : false
226
- }, {
227
- "duration" : 3600000,
228
- "lock-period" : 1800000,
229
- "threshold" : 200,
230
- "hip" : false
231
- } ],
232
- "window" : "ROLLING",
233
- "key" : "url.path+user.zuid"
234
- } ]
235
- },
236
- "extraparams" : {
237
- "disable" : true,
238
- "ignore" : false
239
- },
240
- "authentication" : { }
241
- },
242
- "clan-group" : "helpCenter",
243
- "apihash" : "3d0dc8771c9488ff41a17c10452edeba",
244
- "module-group" : "kb",
245
- "apimethod" : "com.zoho.desk.helpcenter.kbcategory.rest.KbCategoryService.reorderSections"
246
- }
247
- }
248
- },
249
- "/api/v1/kbSections/{sectionId}/moveArticlesAndTrash" : {
250
- "post" : {
251
- "tags" : [ "KBSection" ],
252
- "summary" : "Move articles and trash a section",
253
- "description" : "This API moves all articles to another section and trashes this section in your helpdesk",
254
- "operationId" : "moveAndDeleteSection",
255
- "parameters" : [ {
256
- "$ref" : "#/components/parameters/sectionId"
257
- }, {
258
- "$ref" : "../common/Common.json#/components/parameters/orgId"
259
- } ],
260
- "requestBody" : {
261
- "$ref" : "#/components/requestBodies/moveAndDeleteCategoryRequestBody"
262
- },
263
- "responses" : {
264
- "422" : {
265
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
266
- },
267
- "204" : {
268
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
269
- }
270
- },
271
- "security" : [ {
272
- "org-oauth" : [ "Desk.accessAll.ALL" ]
273
- }, {
274
- "iam-oauth2-schema" : [ "Desk.articles.UPDATE" ]
275
- } ],
276
- "x-audience" : [ "company-internal" ],
277
- "x-custom-url-attribute" : {
278
- "security" : {
279
- "throttle" : {
280
- "inline" : [ {
281
- "scope" : "APPSERVER",
282
- "rules" : [ {
283
- "duration" : 60000,
284
- "lock-period" : 600000,
285
- "threshold" : 25,
286
- "hip" : false
287
- }, {
288
- "duration" : 3600000,
289
- "lock-period" : 1800000,
290
- "threshold" : 200,
291
- "hip" : false
292
- } ],
293
- "window" : "ROLLING",
294
- "key" : "url.path+user.zuid"
295
- } ]
296
- },
297
- "extraparams" : {
298
- "disable" : true,
299
- "ignore" : false
300
- },
301
- "authentication" : { }
302
- },
303
- "clan-group" : "helpCenter",
304
- "apihash" : "adff772ebc0e53bdc6e43ca5c9b652d7",
305
- "module-group" : "kb",
306
- "apimethod" : "com.zoho.desk.helpcenter.kbcategory.rest.KbCategoryService.moveArticlesAndMoveSectionToTrash"
307
- }
308
- }
309
- },
310
- "/api/v1/kbSections/{sectionId}" : {
311
- "get" : {
312
- "tags" : [ "KBSection" ],
313
- "summary" : "Get a KB section",
314
- "description" : "This API fetches a section in your helpdesk",
315
- "operationId" : "getKBSection",
316
- "parameters" : [ {
317
- "$ref" : "#/components/parameters/sectionId"
318
- }, {
319
- "$ref" : "../common/Common.json#/components/parameters/orgId"
320
- },{
321
- "name" : "include",
322
- "in" : "query",
323
- "required" : false,
324
- "style" : "simple",
325
- "explode" : true,
326
- "schema" : {
327
- "type" : [ "null", "array" ],
328
- "items" : {
329
- "type" : [ "string", "null" ],
330
- "enum" : [ "publicArticlesCount", "allArticlesCount", "followersCount", "portalUrl" ],
331
- "maxLength" : 100,
332
- "minLength" : 0,
333
- "x-custom-parameters-attributes" : [ ]
334
- },
335
- "uniqueItems" : true
336
- }
337
- } ],
338
- "responses" : {
339
- "200" : {
340
- "$ref" : "#/components/responses/sectionResponse"
341
- },
342
- "422" : {
343
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
344
- }
345
- },
346
- "security" : [ {
347
- "org-oauth" : [ "Desk.accessAll.ALL" ]
348
- }, {
349
- "iam-oauth2-schema" : [ "Desk.articles.READ" ]
350
- } ],
351
- "x-audience" : [ "external-public" ],
352
- "x-custom-url-attribute" : {
353
- "security" : {
354
- "throttle" : {
355
- "policy" : "ReadAPI_Lenient_UserPolicy"
356
- },
357
- "extraparams" : {
358
- "disable" : true,
359
- "ignore" : false
360
- },
361
- "authentication" : { }
362
- },
363
- "clan-group" : "helpCenter",
364
- "apihash" : "d555eb233eba7ca99109b1959ad1d4f8",
365
- "module-group" : "kb",
366
- "apimethod" : "com.zoho.desk.helpcenter.kbcategory.rest.KbCategoryService.getASection"
367
- }
368
- },
369
- "patch" : {
370
- "tags" : [ "KBSection" ],
371
- "summary" : "Update a KB section",
372
- "description" : "This API updates a section in your helpdesk",
373
- "operationId" : "updateKBSection",
374
- "parameters" : [ {
375
- "$ref" : "#/components/parameters/sectionId"
376
- }, {
377
- "$ref" : "../common/Common.json#/components/parameters/orgId"
378
- } ],
379
- "requestBody" : {
380
- "$ref" : "#/components/requestBodies/commonCategoryJson"
381
- },
382
- "responses" : {
383
- "200" : {
384
- "$ref" : "#/components/responses/sectionResponse"
385
- },
386
- "422" : {
387
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
388
- }
389
- },
390
- "security" : [ {
391
- "org-oauth" : [ "Desk.accessAll.ALL" ]
392
- }, {
393
- "iam-oauth2-schema" : [ "Desk.articles.UPDATE" ]
394
- } ],
395
- "x-audience" : [ "external-public" ],
396
- "x-custom-url-attribute" : {
397
- "security" : {
398
- "throttle" : {
399
- "inline" : [ {
400
- "scope" : "APPSERVER",
401
- "rules" : [ {
402
- "duration" : 60000,
403
- "lock-period" : 600000,
404
- "threshold" : 25,
405
- "hip" : false
406
- }, {
407
- "duration" : 3600000,
408
- "lock-period" : 1800000,
409
- "threshold" : 200,
410
- "hip" : false
411
- } ],
412
- "window" : "ROLLING",
413
- "key" : "url.path+user.zuid"
414
- } ]
415
- },
416
- "extraparams" : {
417
- "disable" : true,
418
- "ignore" : false
419
- },
420
- "authentication" : { }
421
- },
422
- "clan-group" : "helpCenter",
423
- "apihash" : "dfb5efa1339870f348873be464a87564",
424
- "module-group" : "kb",
425
- "apimethod" : "com.zoho.desk.helpcenter.kbcategory.rest.KbCategoryService.updateASection"
426
- }
427
- }
428
- },
429
- "/api/v1/kbSections/{sectionId}/move" : {
430
- "post" : {
431
- "tags" : [ "KBSection" ],
432
- "summary" : "Move a section",
433
- "description" : "This API move a section in your helpdesk",
434
- "operationId" : "moveASection",
435
- "parameters" : [ {
436
- "$ref" : "#/components/parameters/sectionId"
437
- }, {
438
- "$ref" : "../common/Common.json#/components/parameters/orgId"
439
- } ],
440
- "requestBody" : {
441
- "$ref" : "#/components/requestBodies/moveCategoryRequestBody"
442
- },
443
- "responses" : {
444
- "422" : {
445
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
446
- },
447
- "204" : {
448
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
449
- }
450
- },
451
- "security" : [ {
452
- "org-oauth" : [ "Desk.accessAll.ALL" ]
453
- }, {
454
- "iam-oauth2-schema" : [ "Desk.articles.UPDATE" ]
455
- } ],
456
- "x-audience" : [ "company-internal" ],
457
- "x-custom-url-attribute" : {
458
- "security" : {
459
- "throttle" : {
460
- "inline" : [ {
461
- "scope" : "APPSERVER",
462
- "rules" : [ {
463
- "duration" : 60000,
464
- "lock-period" : 600000,
465
- "threshold" : 25,
466
- "hip" : false
467
- }, {
468
- "duration" : 3600000,
469
- "lock-period" : 1800000,
470
- "threshold" : 200,
471
- "hip" : false
472
- } ],
473
- "window" : "ROLLING",
474
- "key" : "url.path+user.zuid"
475
- } ]
476
- },
477
- "extraparams" : {
478
- "disable" : true,
479
- "ignore" : false
480
- },
481
- "authentication" : { }
482
- },
483
- "clan-group" : "helpCenter",
484
- "apihash" : "73391ffe4a67ee6a534dc078df883c2c",
485
- "module-group" : "kb",
486
- "apimethod" : "com.zoho.desk.helpcenter.kbcategory.rest.KbCategoryService.moveASection"
487
- }
488
- }
489
- },
490
- "/api/v1/kbSections/{sectionId}/translations" : {
491
- "post" : {
492
- "tags" : [ "KBSection" ],
493
- "summary" : "Add a translation to a section",
494
- "description" : "This API adds a translation a root category in your helpdesk",
495
- "operationId" : "addASectionTranslation",
496
- "parameters" : [ {
497
- "$ref" : "#/components/parameters/sectionId"
498
- }, {
499
- "$ref" : "../common/Common.json#/components/parameters/orgId"
500
- } ],
501
- "requestBody" : {
502
- "$ref" : "#/components/requestBodies/addSectionTranslationJson"
503
- },
504
- "responses" : {
505
- "422" : {
506
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
507
- },
508
- "200" : {
509
- "$ref" : "./KBRootCategoryTranslation.json#/components/responses/rootTranslationResponse"
510
- }
511
- },
512
- "security" : [ {
513
- "org-oauth" : [ "Desk.accessAll.ALL" ]
514
- }, {
515
- "iam-oauth2-schema" : [ "Desk.articles.CREATE" ]
516
- } ],
517
- "x-audience" : [ "company-internal" ],
518
- "x-custom-url-attribute" : {
519
- "security" : {
520
- "throttle" : {
521
- "inline" : [ {
522
- "scope" : "APPSERVER",
523
- "rules" : [ {
524
- "duration" : 60000,
525
- "lock-period" : 600000,
526
- "threshold" : 25,
527
- "hip" : false
528
- }, {
529
- "duration" : 3600000,
530
- "lock-period" : 1800000,
531
- "threshold" : 200,
532
- "hip" : false
533
- } ],
534
- "window" : "ROLLING",
535
- "key" : "url.path+user.zuid"
536
- } ]
537
- },
538
- "extraparams" : {
539
- "disable" : true,
540
- "ignore" : false
541
- },
542
- "authentication" : { }
543
- },
544
- "clan-group" : "helpCenter",
545
- "apihash" : "264b1c2d0eb0b46bd3347854ac208761",
546
- "module-group" : "kb",
547
- "apimethod" : "com.zoho.desk.helpcenter.kbcategory.rest.KbCategoryService.addATranslationToSection"
548
- }
549
- }
550
- },
551
- "/api/v1/kbSections/{sectionId}/translations/{locale}/permalinks/remove" : {
552
- "post" : {
553
- "tags" : [ "KBSection" ],
554
- "summary" : "Remove a permalink of a section",
555
- "description" : "This API removes a permalink of a section translation",
556
- "operationId" : "removePermalink",
557
- "parameters" : [ {
558
- "$ref" : "#/components/parameters/sectionId"
559
- }, {
560
- "$ref" : "#/components/parameters/locale"
561
- }, {
562
- "$ref" : "../common/Common.json#/components/parameters/orgId"
563
- } ],
564
- "requestBody" : {
565
- "$ref" : "./KBRootCategory.json#/components/requestBodies/removePermalinkJson"
566
- },
567
- "responses" : {
568
- "422" : {
569
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
570
- },
571
- "204" : {
572
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
573
- }
574
- },
575
- "security" : [ {
576
- "org-oauth" : [ "Desk.accessAll.ALL" ]
577
- }, {
578
- "iam-oauth2-schema" : [ "Desk.articles.UPDATE" ]
579
- } ],
580
- "x-audience" : [ "company-internal" ],
581
- "x-custom-url-attribute" : {
582
- "security" : {
583
- "throttle" : {
584
- "inline" : [ {
585
- "scope" : "APPSERVER",
586
- "rules" : [ {
587
- "duration" : 60000,
588
- "lock-period" : 600000,
589
- "threshold" : 25,
590
- "hip" : false
591
- }, {
592
- "duration" : 3600000,
593
- "lock-period" : 1800000,
594
- "threshold" : 200,
595
- "hip" : false
596
- } ],
597
- "window" : "ROLLING",
598
- "key" : "url.path+user.zuid"
599
- } ]
600
- },
601
- "extraparams" : {
602
- "disable" : true,
603
- "ignore" : false
604
- },
605
- "authentication" : { }
606
- },
607
- "clan-group" : "helpCenter",
608
- "apihash" : "6fb489c72489caf324af700a8f075025",
609
- "module-group" : "kb",
610
- "apimethod" : "com.zoho.desk.helpcenter.kbcategory.rest.KbCategoryService.removePermalinksOfATranslationOfASection"
611
- }
612
- }
613
- },
614
- "/api/v1/kbSections/{sectionId}/translations/{locale}/permalinks/add" : {
615
- "post" : {
616
- "tags" : [ "KBSection" ],
617
- "summary" : "Add a permalink to a section",
618
- "description" : "This API fadds a permalink to a section translation",
619
- "operationId" : "addPermalink",
620
- "parameters" : [ {
621
- "$ref" : "#/components/parameters/sectionId"
622
- }, {
623
- "$ref" : "#/components/parameters/locale"
624
- }, {
625
- "$ref" : "../common/Common.json#/components/parameters/orgId"
626
- } ],
627
- "requestBody" : {
628
- "$ref" : "./KBRootCategory.json#/components/requestBodies/addPermalinkJson"
629
- },
630
- "responses" : {
631
- "422" : {
632
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
633
- },
634
- "200" : {
635
- "$ref" : "./KBCategoryPermalink.json#/components/responses/permalinkJsonDataArrayWithOldResponse"
636
- }
637
- },
638
- "security" : [ {
639
- "org-oauth" : [ "Desk.accessAll.ALL" ]
640
- }, {
641
- "iam-oauth2-schema" : [ "Desk.articles.UPDATE" ]
642
- } ],
643
- "x-audience" : [ "company-internal" ],
644
- "x-custom-url-attribute" : {
645
- "security" : {
646
- "throttle" : {
647
- "inline" : [ {
648
- "scope" : "APPSERVER",
649
- "rules" : [ {
650
- "duration" : 60000,
651
- "lock-period" : 600000,
652
- "threshold" : 25,
653
- "hip" : false
654
- }, {
655
- "duration" : 3600000,
656
- "lock-period" : 1800000,
657
- "threshold" : 200,
658
- "hip" : false
659
- } ],
660
- "window" : "ROLLING",
661
- "key" : "url.path+user.zuid"
662
- } ]
663
- },
664
- "extraparams" : {
665
- "disable" : true,
666
- "ignore" : false
667
- },
668
- "authentication" : { }
669
- },
670
- "clan-group" : "helpCenter",
671
- "apihash" : "d33b880b932c283055adfe6bf578af13",
672
- "module-group" : "kb",
673
- "apimethod" : "com.zoho.desk.helpcenter.kbcategory.rest.KbCategoryService.addPermalinksOfATranslationOfASection"
674
- }
675
- }
676
- },
677
- "/api/v1/kbSections/{sectionId}/translations/{locale}" : {
678
- "patch" : {
679
- "tags" : [ "KBSection" ],
680
- "summary" : "Update a translation of a section",
681
- "description" : "This API edits a translation of a section in your helpdesk",
682
- "operationId" : "editASectionTranslation",
683
- "parameters" : [ {
684
- "$ref" : "#/components/parameters/sectionId"
685
- }, {
686
- "$ref" : "#/components/parameters/locale"
687
- }, {
688
- "$ref" : "../common/Common.json#/components/parameters/orgId"
689
- } ],
690
- "requestBody" : {
691
- "$ref" : "#/components/requestBodies/editSectionTranslationJson"
692
- },
693
- "responses" : {
694
- "422" : {
695
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
696
- },
697
- "200" : {
698
- "$ref" : "./KBRootCategoryTranslation.json#/components/responses/rootTranslationResponse"
699
- }
700
- },
701
- "security" : [ {
702
- "org-oauth" : [ "Desk.accessAll.ALL" ]
703
- }, {
704
- "iam-oauth2-schema" : [ "Desk.articles.UPDATE" ]
705
- } ],
706
- "x-audience" : [ "company-internal" ],
707
- "x-custom-url-attribute" : {
708
- "security" : {
709
- "throttle" : {
710
- "inline" : [ {
711
- "scope" : "APPSERVER",
712
- "rules" : [ {
713
- "duration" : 60000,
714
- "lock-period" : 600000,
715
- "threshold" : 25,
716
- "hip" : false
717
- }, {
718
- "duration" : 3600000,
719
- "lock-period" : 1800000,
720
- "threshold" : 200,
721
- "hip" : false
722
- } ],
723
- "window" : "ROLLING",
724
- "key" : "url.path+user.zuid"
725
- } ]
726
- },
727
- "extraparams" : {
728
- "disable" : true,
729
- "ignore" : false
730
- },
731
- "authentication" : { }
732
- },
733
- "clan-group" : "helpCenter",
734
- "apihash" : "221190e2ec1fd242e59cbd0299a4a3a8",
735
- "module-group" : "kb",
736
- "apimethod" : "com.zoho.desk.helpcenter.kbcategory.rest.KbCategoryService.updateATranslationToSection"
737
- }
738
- }
739
- },
740
- "/api/v1/kbRootCategories/{rootCategoryId}/sections" : {
741
- "get" : {
742
- "tags" : [ "KBSection" ],
743
- "summary" : "Get kb section list",
744
- "description" : "API fetches all kb sections under the given root category",
745
- "operationId" : "listAllSections",
746
- "parameters" : [ {
747
- "name" : "include",
748
- "in" : "query",
749
- "description" : "Include params are !@portalUrl,@! !@publicArticlesCount,@! !@allArticlesCount@!",
750
- "required" : false,
751
- "style" : "simple",
752
- "explode" : true,
753
- "schema" : {
754
- "type" : [ "null", "array" ],
755
- "description" : "Include params are !@portalUrl,@! !@publicArticlesCount,@! !@allArticlesCount@!",
756
- "items" : {
757
- "type" : [ "string", "null" ],
758
- "enum" : [ "publicArticlesCount", "allArticlesCount" ],
759
- "maxLength" : 100,
760
- "minLength" : 0,
761
- "x-custom-parameters-attributes" : [ false, false, false, "", false, "Include params are !@portalUrl,@! !@publicArticlesCount,@! !@allArticlesCount@!", false, 10, ",", false, false, "0,5", false, false ]
762
- },
763
- "uniqueItems" : true
764
- }
765
- }, {
766
- "name" : "visibility",
767
- "in" : "query",
768
- "description" : "Visibility of the category. Values allowed are !@AGENTS@!, !@GROUP_USERS@!, !@ALL_USERS@!,!@NONE@! ",
769
- "required" : false,
770
- "style" : "simple",
771
- "explode" : true,
772
- "schema" : {
773
- "type" : [ "null", "array" ],
774
- "description" : "Visibility of the category. Values allowed are !@AGENTS@!, !@GROUP_USERS@!, !@ALL_USERS@!,!@NONE@! ",
775
- "items" : {
776
- "type" : [ "string", "null" ],
777
- "enum" : [ "ALL_USERS", "AGENTS", "GROUP_USERS", "NONE" ],
778
- "maxLength" : 100,
779
- "minLength" : 0,
780
- "x-custom-parameters-attributes" : [ ]
781
- },
782
- "uniqueItems" : false
783
- }
784
- }, {
785
- "name" : "isTrashed",
786
- "in" : "query",
787
- "description" : "Is category trashed flag",
788
- "required" : false,
789
- "style" : "form",
790
- "explode" : true,
791
- "schema" : {
792
- "type" : [ "boolean", "null" ],
793
- "description" : "Is category trashed flag"
794
- }
795
- }, {
796
- "name" : "limit",
797
- "in" : "query",
798
- "description" : "Number of sections to return. Default value will be 30",
799
- "required" : false,
800
- "style" : "form",
801
- "explode" : true,
802
- "schema" : {
803
- "type" : [ "string", "null", "integer" ],
804
- "format" : "int32",
805
- "description" : "Number of sections to return. Default value will be 30",
806
- "maximum" : 50,
807
- "minimum" : 1,
808
- "pattern" : "([0-9]+)"
809
- }
810
- }, {
811
- "name" : "sortBy",
812
- "in" : "query",
813
- "description" : "Sort order of the categories. Allowed values : !@name,@! !@order@!",
814
- "required" : false,
815
- "style" : "form",
816
- "explode" : true,
817
- "schema" : {
818
- "type" : [ "string", "null" ],
819
- "description" : "Sort order of the categories. Allowed values : !@name,@! !@order@!",
820
- "enum" : [ "name", "order" ],
821
- "maxLength" : 100,
822
- "minLength" : 0
823
- }
824
- }, {
825
- "name" : "from",
826
- "in" : "query",
827
- "description" : "Offset value. Default value will be 1",
828
- "required" : false,
829
- "style" : "form",
830
- "explode" : true,
831
- "schema" : {
832
- "type" : [ "string", "null", "integer" ],
833
- "format" : "int32",
834
- "description" : "Offset value. Default value will be 1",
835
- "minimum" : 1,
836
- "pattern" : "([0-9]+)"
837
- }
838
- }, {
839
- "name" : "parentCategoryId",
840
- "in" : "query",
841
- "description" : "To fetch sections under given parent categoryId",
842
- "required" : false,
843
- "style" : "form",
844
- "explode" : true,
845
- "schema" : {
846
- "type" : [ "string", "null", "integer" ],
847
- "format" : "int64",
848
- "description" : "To fetch sections under given parent categoryId",
849
- "pattern" : "([0-9]+)"
850
- }
851
- }, {
852
- "$ref" : "#/components/parameters/locale"
853
- }, {
854
- "name" : "status",
855
- "in" : "query",
856
- "description" : "Status of the category. Values - !@SHOW_IN_HELPCENTER,@! !@HIDE_IN_HELPCENTER,@! !@DISABLED@!",
857
- "required" : false,
858
- "style" : "simple",
859
- "explode" : true,
860
- "schema" : {
861
- "type" : [ "null", "array" ],
862
- "description" : "Status of the category. Values - !@SHOW_IN_HELPCENTER,@! !@HIDE_IN_HELPCENTER,@! !@DISABLED@!",
863
- "items" : {
864
- "type" : [ "string", "null" ],
865
- "enum" : [ "SHOW_IN_HELPCENTER", "HIDE_IN_HELPCENTER" ],
866
- "maxLength" : 100,
867
- "minLength" : 0,
868
- "x-custom-parameters-attributes" : [ false, false, false, "", false, "Status of the category. Values - !@SHOW_IN_HELPCENTER,@! !@HIDE_IN_HELPCENTER,@! !@DISABLED@!", false, 10, ",", false, false, "0,5", false, false ]
869
- },
870
- "uniqueItems" : false
871
- }
872
- }, {
873
- "name" : "rootCategoryId",
874
- "in" : "path",
875
- "required" : true,
876
- "style" : "simple",
877
- "explode" : false,
878
- "schema" : {
879
- "type" : [ "string", "null", "integer" ],
880
- "format" : "int64",
881
- "pattern" : "([0-9]+)"
882
- }
883
- }, {
884
- "$ref" : "../common/Common.json#/components/parameters/orgId"
885
- } ],
886
- "responses" : {
887
- "200" : {
888
- "$ref" : "#/components/responses/listAllSectionsResponse"
889
- },
890
- "401" : {
891
- "$ref" : "../common/Common.json#/components/responses/unauthorizedErrorResponse"
892
- }
893
- },
894
- "security" : [ {
895
- "org-oauth" : [ "Desk.accessAll.ALL" ]
896
- }, {
897
- "iam-oauth2-schema" : [ "Desk.articles.READ" ]
898
- } ],
899
- "x-audience" : [ "company-internal" ],
900
- "x-custom-url-attribute" : {
901
- "security" : {
902
- "throttle" : {
903
- "inline" : [ {
904
- "scope" : "APPSERVER",
905
- "rules" : [ {
906
- "duration" : 60000,
907
- "lock-period" : 600000,
908
- "threshold" : 5,
909
- "hip" : false
910
- }, {
911
- "duration" : 3600000,
912
- "lock-period" : 1800000,
913
- "threshold" : 50,
914
- "hip" : false
915
- } ],
916
- "window" : "ROLLING",
917
- "key" : "url.path+user.zuid"
918
- } ]
919
- },
920
- "extraparams" : {
921
- "disable" : true,
922
- "ignore" : false
923
- },
924
- "authentication" : { }
925
- },
926
- "clan-group" : "helpCenter",
927
- "apihash" : "e80d0bd94eea44569cf39ea6e969c027",
928
- "module-group" : "kb",
929
- "apimethod" : "com.zoho.desk.helpcenter.kbcategory.rest.KbCategoryService.getKbSections"
930
- }
931
- }
932
- }
933
- },
934
- "components" : {
935
- "schemas" : {
936
- "addSectionTranslationJson" : {
937
- "type" : [ "null", "object" ],
938
- "additionalProperties" : false,
939
- "properties" : {
940
- "name" : {
941
- "type" : [ "string", "null" ],
942
- "maxLength" : 100,
943
- "minLength" : 0,
944
- "x-custom-parameters-attributes" : {
945
- "removeExif" : false,
946
- "filterMatchedContent" : false,
947
- "antivirus" : false,
948
- "replacementString" : "",
949
- "allowInvalid" : false,
950
- "descrption" : "Section Name",
951
- "secret" : false,
952
- "preserveCharsLimit" : 10,
953
- "trim" : false,
954
- "internalParam" : false,
955
- "preserveChars" : "0,5",
956
- "importUrl" : false,
957
- "decrypt" : false
958
- }
959
- },
960
- "locale" : {
961
- "type" : [ "string", "null" ],
962
- "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" ],
963
- "maxLength" : 100,
964
- "minLength" : 0,
965
- "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)"
966
- }
967
- },
968
- "required" : [ "locale", "name" ]
969
- },
970
- "addSectionTranslationJsonArray" : {
971
- "type" : [ "null", "array" ],
972
- "items" : {
973
- "$ref" : "./KBSection.json#/components/schemas/addSectionTranslationJson"
974
- }
975
- },
976
- "commonCategoryJson" : {
977
- "type" : [ "null", "object" ],
978
- "additionalProperties" : false,
979
- "properties" : {
980
- "visibility" : {
981
- "type" : [ "string", "null" ],
982
- "description" : "Visibility of the section. Values allowed are !@AGENTS@!, !@GROUP_USERS@!, !@ALL_USERS@!,!@NONE@!,!@PRIVATE_IP@! ",
983
- "enum" : [ "ALL_USERS", "AGENTS", "GROUP_USERS", "PRIVATE_IP", "NONE" ],
984
- "maxLength" : 100,
985
- "minLength" : 0
986
- },
987
- "translations" : {
988
- "$ref" : "./KBSection.json#/components/schemas/addSectionTranslationJsonArray"
989
- },
990
- "groupIds" : {
991
- "type" : [ "null", "array" ],
992
- "items" : {
993
- "type" : [ "string", "null", "integer" ],
994
- "format" : "int64",
995
- "pattern" : "([0-9]+)",
996
- "x-custom-parameters-attributes" : [ { } ]
997
- },
998
- "uniqueItems" : false
999
- },
1000
- "name" : {
1001
- "type" : [ "string", "null" ],
1002
- "description" : "Section Name",
1003
- "maxLength" : 100,
1004
- "minLength" : 0
1005
- },
1006
- "ipAddresses" : {
1007
- "type" : [ "null", "array" ],
1008
- "items" : {
1009
- "type" : [ "string", "null" ],
1010
- "maxLength" : 100,
1011
- "minLength" : 0,
1012
- "pattern" : "^((?:(?:(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|\\*)\\.){3}(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|\\*)(/(?:[012]?[0-9]|3[012]))?)|\\*)$",
1013
- "x-custom-parameters-attributes" : [ ]
1014
- },
1015
- "uniqueItems" : false
1016
- },
1017
- "status" : {
1018
- "type" : [ "string", "null" ],
1019
- "description" : "Status of the section",
1020
- "enum" : [ "SHOW_IN_HELPCENTER", "HIDE_IN_HELPCENTER" ],
1021
- "maxLength" : 100,
1022
- "minLength" : 0
1023
- }
1024
- },
1025
- "required" : [ "groupIds", "ipAddresses", "name", "status", "translations", "visibility" ]
1026
- },
1027
- "sectionResponse" : {
1028
- "type" : [ "null", "object" ],
1029
- "additionalProperties" : false,
1030
- "properties" : {
1031
- "modifiedTime" : {
1032
- "type" : [ "string", "null" ],
1033
- "maxLength" : 100,
1034
- "minLength" : 0,
1035
- "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))"
1036
- },
1037
- "isFollowing" : {
1038
- "type" : [ "boolean", "null" ]
1039
- },
1040
- "visibility" : {
1041
- "type" : [ "string", "null" ],
1042
- "enum" : [ "ALL_USERS", "AGENTS", "GROUP_USERS", "PRIVATE_IP", "NONE" ],
1043
- "maxLength" : 100,
1044
- "minLength" : 0,
1045
- "x-custom-parameters-attributes" : {
1046
- "removeExif" : false,
1047
- "filterMatchedContent" : false,
1048
- "antivirus" : false,
1049
- "replacementString" : "",
1050
- "allowInvalid" : false,
1051
- "descrption" : "Visibility of the category. Values allowed are !@AGENTS@!, !@GROUP_USERS@!, !@ALL_USERS@!,!@NONE@! ",
1052
- "secret" : false,
1053
- "preserveCharsLimit" : 10,
1054
- "split" : ",",
1055
- "trim" : false,
1056
- "internalParam" : false,
1057
- "preserveChars" : "0,5",
1058
- "importUrl" : false,
1059
- "decrypt" : false
1060
- }
1061
- },
1062
- "description" : {
1063
- "type" : [ "string", "null" ],
1064
- "maxLength" : 100,
1065
- "minLength" : 0,
1066
- "pattern" : "[0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]*"
1067
- },
1068
- "groups" : {
1069
- "$ref" : "./KbCategory.json#/components/schemas/groupJsonArr"
1070
- },
1071
- "logoUrl" : {
1072
- "type" : [ "string", "null" ],
1073
- "maxLength" : 255,
1074
- "minLength" : 0,
1075
- "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
1076
- },
1077
- "rootCategoryId" : {
1078
- "type" : [ "string", "null", "integer" ],
1079
- "format" : "int64",
1080
- "pattern" : "([0-9]+)"
1081
- },
1082
- "isTrashed" : {
1083
- "type" : [ "boolean", "null" ],
1084
- "x-custom-parameters-attributes" : {
1085
- "removeExif" : false,
1086
- "filterMatchedContent" : false,
1087
- "antivirus" : false,
1088
- "replacementString" : "",
1089
- "allowInvalid" : false,
1090
- "descrption" : "Is category trashed flag",
1091
- "secret" : false,
1092
- "preserveCharsLimit" : 10,
1093
- "trim" : false,
1094
- "internalParam" : false,
1095
- "preserveChars" : "0,5",
1096
- "importUrl" : false,
1097
- "decrypt" : false
1098
- }
1099
- },
1100
- "createdBy" : {
1101
- "$ref" : "./ArticleTranslation.json#/components/schemas/modifiedBy"
1102
- },
1103
- "translations" : {
1104
- "$ref" : "./KBRootCategory.json#/components/schemas/rootTranslationResponseJsonArr"
1105
- },
1106
- "name" : {
1107
- "type" : [ "string", "null" ],
1108
- "maxLength" : 100,
1109
- "minLength" : 0
1110
- },
1111
- "createdTime" : {
1112
- "type" : [ "string", "null" ],
1113
- "maxLength" : 100,
1114
- "minLength" : 0,
1115
- "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))"
1116
- },
1117
- "modifiedBy" : {
1118
- "$ref" : "./ArticleTranslation.json#/components/schemas/modifiedBy"
1119
- },
1120
- "parentCategoryId" : {
1121
- "type" : [ "string", "null", "integer" ],
1122
- "format" : "int64",
1123
- "pattern" : "([0-9]+)",
1124
- "x-custom-parameters-attributes" : {
1125
- "removeExif" : false,
1126
- "filterMatchedContent" : false,
1127
- "antivirus" : false,
1128
- "replacementString" : "",
1129
- "allowInvalid" : false,
1130
- "descrption" : "To fetch sections under given parent categoryId",
1131
- "secret" : false,
1132
- "preserveCharsLimit" : 10,
1133
- "trim" : false,
1134
- "internalParam" : false,
1135
- "preserveChars" : "0,5",
1136
- "importUrl" : false,
1137
- "decrypt" : false
1138
- }
1139
- },
1140
- "ipAddresses" : {
1141
- "type" : [ "null", "array" ],
1142
- "items" : {
1143
- "type" : [ "string", "null" ],
1144
- "maxLength" : 100,
1145
- "minLength" : 0,
1146
- "pattern" : "^((?:(?:(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|\\*)\\.){3}(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|\\*)(\\/(?:[012]?[0-9]|3[012]))?)|\\*)$"
1147
- },
1148
- "uniqueItems" : false
1149
- },
1150
- "id" : {
1151
- "type" : [ "string", "null", "integer" ],
1152
- "format" : "int64",
1153
- "pattern" : "([0-9]+)"
1154
- },
1155
- "order" : {
1156
- "type" : [ "string", "null", "integer" ],
1157
- "format" : "int32",
1158
- "pattern" : "([0-9]+)"
1159
- },
1160
- "status" : {
1161
- "type" : [ "string", "null" ],
1162
- "enum" : [ "SHOW_IN_HELPCENTER", "HIDE_IN_HELPCENTER" ],
1163
- "maxLength" : 100,
1164
- "minLength" : 0,
1165
- "x-custom-parameters-attributes" : {
1166
- "removeExif" : false,
1167
- "filterMatchedContent" : false,
1168
- "antivirus" : false,
1169
- "replacementString" : "",
1170
- "allowInvalid" : false,
1171
- "descrption" : "Status of the category. Values - !@SHOW_IN_HELPCENTER,@! !@HIDE_IN_HELPCENTER,@! !@DISABLED@!",
1172
- "secret" : false,
1173
- "preserveCharsLimit" : 10,
1174
- "split" : ",",
1175
- "trim" : false,
1176
- "internalParam" : false,
1177
- "preserveChars" : "0,5",
1178
- "importUrl" : false,
1179
- "decrypt" : false
1180
- }
1181
- }
1182
- },
1183
- "required" : [ "createdBy", "createdTime", "description", "groups", "id", "ipAddresses", "isFollowing", "isTrashed", "logoUrl", "modifiedBy", "modifiedTime", "name", "order", "parentCategoryId", "rootCategoryId", "status", "translations", "visibility" ]
1184
- },
1185
- "sectionData" : {
1186
- "type" : [ "null", "array" ],
1187
- "items" : {
1188
- "$ref" : "./KBSection.json#/components/schemas/sectionResponse"
1189
- }
1190
- }
1191
- },
1192
- "responses" : {
1193
- "sectionResponse" : {
1194
- "description" : "sectionResponse template definitions",
1195
- "content" : {
1196
- "application/json" : {
1197
- "schema" : {
1198
- "type" : [ "null", "object" ],
1199
- "additionalProperties" : false,
1200
- "properties" : {
1201
- "modifiedTime" : {
1202
- "type" : [ "string", "null" ],
1203
- "maxLength" : 100,
1204
- "minLength" : 0,
1205
- "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))"
1206
- },
1207
- "isFollowing" : {
1208
- "type" : [ "boolean", "null" ]
1209
- },
1210
- "visibility" : {
1211
- "type" : [ "string", "null" ],
1212
- "enum" : [ "ALL_USERS", "AGENTS", "GROUP_USERS", "PRIVATE_IP", "NONE" ],
1213
- "maxLength" : 100,
1214
- "minLength" : 0,
1215
- "x-custom-parameters-attributes" : {
1216
- "removeExif" : false,
1217
- "filterMatchedContent" : false,
1218
- "antivirus" : false,
1219
- "replacementString" : "",
1220
- "allowInvalid" : false,
1221
- "descrption" : "Visibility of the section. Values allowed are !@AGENTS@!, !@GROUP_USERS@!, !@ALL_USERS@!,!@PRIVATE_IP@!,!@NONE@! ",
1222
- "secret" : false,
1223
- "preserveCharsLimit" : 10,
1224
- "trim" : false,
1225
- "internalParam" : false,
1226
- "preserveChars" : "0,5",
1227
- "importUrl" : false,
1228
- "decrypt" : false
1229
- }
1230
- },
1231
- "description" : {
1232
- "type" : [ "string", "null" ],
1233
- "maxLength" : 100,
1234
- "minLength" : 0,
1235
- "pattern" : "[0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]*",
1236
- "x-custom-parameters-attributes" : {
1237
- "removeExif" : false,
1238
- "filterMatchedContent" : false,
1239
- "antivirus" : false,
1240
- "replacementString" : "",
1241
- "allowInvalid" : false,
1242
- "descrption" : "A short description of the section",
1243
- "secret" : false,
1244
- "preserveCharsLimit" : 10,
1245
- "trim" : false,
1246
- "internalParam" : false,
1247
- "preserveChars" : "0,5",
1248
- "importUrl" : false,
1249
- "decrypt" : false
1250
- }
1251
- },
1252
- "groups" : {
1253
- "$ref" : "./KbCategory.json#/components/schemas/groupJsonArr"
1254
- },
1255
- "logoUrl" : {
1256
- "type" : [ "string", "null" ],
1257
- "maxLength" : 255,
1258
- "minLength" : 0,
1259
- "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
1260
- },
1261
- "rootCategoryId" : {
1262
- "type" : [ "string", "null", "integer" ],
1263
- "format" : "int64",
1264
- "pattern" : "([0-9]+)"
1265
- },
1266
- "isTrashed" : {
1267
- "type" : [ "boolean", "null" ]
1268
- },
1269
- "createdBy" : {
1270
- "$ref" : "./ArticleTranslation.json#/components/schemas/modifiedBy"
1271
- },
1272
- "translations" : {
1273
- "$ref" : "./KBRootCategory.json#/components/schemas/rootTranslationResponseJsonArr"
1274
- },
1275
- "name" : {
1276
- "type" : [ "string", "null" ],
1277
- "maxLength" : 100,
1278
- "minLength" : 0,
1279
- "x-custom-parameters-attributes" : {
1280
- "removeExif" : false,
1281
- "filterMatchedContent" : false,
1282
- "antivirus" : false,
1283
- "replacementString" : "",
1284
- "allowInvalid" : false,
1285
- "descrption" : "Section Name",
1286
- "secret" : false,
1287
- "preserveCharsLimit" : 10,
1288
- "trim" : false,
1289
- "internalParam" : false,
1290
- "preserveChars" : "0,5",
1291
- "importUrl" : false,
1292
- "decrypt" : false
1293
- }
1294
- },
1295
- "createdTime" : {
1296
- "type" : [ "string", "null" ],
1297
- "maxLength" : 100,
1298
- "minLength" : 0,
1299
- "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))"
1300
- },
1301
- "modifiedBy" : {
1302
- "$ref" : "./ArticleTranslation.json#/components/schemas/modifiedBy"
1303
- },
1304
- "parentCategoryId" : {
1305
- "type" : [ "string", "null", "integer" ],
1306
- "format" : "int64",
1307
- "pattern" : "([0-9]+)"
1308
- },
1309
- "ipAddresses" : {
1310
- "type" : [ "null", "array" ],
1311
- "items" : {
1312
- "type" : [ "string", "null" ],
1313
- "maxLength" : 100,
1314
- "minLength" : 0,
1315
- "pattern" : "^((?:(?:(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|\\*)\\.){3}(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|\\*)(\\/(?:[012]?[0-9]|3[012]))?)|\\*)$",
1316
- "x-custom-parameters-attributes" : [ ]
1317
- },
1318
- "uniqueItems" : false
1319
- },
1320
- "id" : {
1321
- "type" : [ "string", "null", "integer" ],
1322
- "format" : "int64",
1323
- "pattern" : "([0-9]+)"
1324
- },
1325
- "order" : {
1326
- "type" : [ "string", "null", "integer" ],
1327
- "format" : "int32",
1328
- "pattern" : "([0-9]+)"
1329
- },
1330
- "status" : {
1331
- "type" : [ "string", "null" ],
1332
- "enum" : [ "SHOW_IN_HELPCENTER", "HIDE_IN_HELPCENTER" ],
1333
- "maxLength" : 100,
1334
- "minLength" : 0,
1335
- "x-custom-parameters-attributes" : {
1336
- "removeExif" : false,
1337
- "filterMatchedContent" : false,
1338
- "antivirus" : false,
1339
- "replacementString" : "",
1340
- "allowInvalid" : false,
1341
- "descrption" : "Status of the section",
1342
- "secret" : false,
1343
- "preserveCharsLimit" : 10,
1344
- "trim" : false,
1345
- "internalParam" : false,
1346
- "preserveChars" : "0,5",
1347
- "importUrl" : false,
1348
- "decrypt" : false
1349
- }
1350
- },
1351
- "publicArticlesCount" : {
1352
- "$ref" : "./KBRootCategory.json#/components/schemas/countData"
1353
- },
1354
- "allArticlesCount" : {
1355
- "$ref" : "./KBRootCategory.json#/components/schemas/countData"
1356
- },
1357
- "followersCount" : {
1358
- "$ref" : "./KBRootCategory.json#/components/schemas/countData"
1359
- },
1360
- "portalUrl" : {
1361
- "$ref" : "./KBRootCategory.json#/components/schemas/urlData"
1362
- }
1363
- },
1364
- "required" : [ "createdBy", "createdTime", "description", "groups", "id", "ipAddresses", "isFollowing", "isTrashed", "logoUrl", "modifiedBy", "modifiedTime", "name", "order", "parentCategoryId", "rootCategoryId", "status", "translations", "visibility" ]
1365
- },
1366
- "examples" : {
1367
- "Valid responses Definitions" : {
1368
- "value" : {
1369
- "modifiedTime" : 1578359714000,
1370
- "isFollowing" : true,
1371
- "visibility" : "ALL_USERS",
1372
- "description" : "Section 1 description",
1373
- "groups" : [ ],
1374
- "logoUrl" : "https://desk.zoho.com/support/App/build/fonts/certificate.svg",
1375
- "rootCategoryId" : "5000000066427",
1376
- "isTrashed" : false,
1377
- "createdBy" : {
1378
- "photoURL" : null,
1379
- "name" : "Zylker",
1380
- "id" : "5000000015867",
1381
- "status" : "ACTIVE",
1382
- "zuid" : "343224"
1383
- },
1384
- "translations" : [ {
1385
- "modifiedTime" : 1578359714000,
1386
- "createdBy" : {
1387
- "photoURL" : null,
1388
- "name" : "Zylker",
1389
- "id" : "5000000015867",
1390
- "status" : "ACTIVE",
1391
- "zuid" : "343224"
1392
- },
1393
- "name" : "For Agents",
1394
- "description" : "Section 1 description",
1395
- "createdTime" : 1578359714000,
1396
- "modifiedBy" : {
1397
- "photoURL" : null,
1398
- "name" : "Zylker",
1399
- "id" : "5000000015867",
1400
- "status" : "ACTIVE",
1401
- "zuid" : "343224"
1402
- },
1403
- "id" : "5000000341019",
1404
- "permalink" : "for-agents",
1405
- "locale" : "en",
1406
- "categoryId" : "5000000341017"
1407
- } ],
1408
- "name" : "For Agents",
1409
- "createdTime" : 1578359714000,
1410
- "parentCategoryId" : "5000000340014",
1411
- "modifiedBy" : {
1412
- "photoURL" : null,
1413
- "name" : "Zylker",
1414
- "id" : "5000000015867",
1415
- "status" : "ACTIVE",
1416
- "zuid" : "343224"
1417
- },
1418
- "id" : "5000000341017",
1419
- "status" : "SHOW_IN_HELPCENTER",
1420
- "order" : "2"
1421
- }
1422
- }
1423
- }
1424
- }
1425
- },
1426
- "x-custom-response-attributes" : {
1427
- "disable-safe-headers" : "[]"
1428
- }
1429
- },
1430
- "listAllSectionsResponse" : {
1431
- "description" : "listAllSectionsResponse template definitions",
1432
- "content" : {
1433
- "application/json" : {
1434
- "schema" : {
1435
- "allOf" : [ {
1436
- "type" : "object",
1437
- "properties" : {
1438
- "data" : {
1439
- "type" : "array",
1440
- "items" : {
1441
- "type" : "object",
1442
- "properties" : {
1443
- "publicArticlesCount" : {
1444
- "type" : [ "string", "null", "integer" ],
1445
- "format" : "int32",
1446
- "pattern" : "([0-9]+)"
1447
- },
1448
- "allArticlesCount" : {
1449
- "type" : [ "string", "null", "integer" ],
1450
- "format" : "int32",
1451
- "pattern" : "([0-9]+)"
1452
- }
1453
- }
1454
- }
1455
- }
1456
- }
1457
- }, {
1458
- "type" : [ "null", "object" ],
1459
- "additionalProperties" : false,
1460
- "properties" : {
1461
- "data" : {
1462
- "$ref" : "./KBSection.json#/components/schemas/sectionData"
1463
- }
1464
- },
1465
- "required" : [ "data" ]
1466
- } ]
1467
- },
1468
- "examples" : {
1469
- "Valid responses Definitions" : {
1470
- "value" : {
1471
- "data" : [ {
1472
- "modifiedTime" : 1593593278000,
1473
- "visibility" : "ALL_USERS",
1474
- "allArticlesCount" : "12",
1475
- "groups" : [ {
1476
- "name" : "personalized members",
1477
- "id" : "40000009150332",
1478
- "logoUrl" : null
1479
- } ],
1480
- "rootCategoryId" : "4000000081037",
1481
- "publicArticlesCount" : "8",
1482
- "isTrashed" : false,
1483
- "createdBy" : {
1484
- "photoURL" : null,
1485
- "name" : "Charlie",
1486
- "id" : "4000000016508",
1487
- "status" : "ACTIVE",
1488
- "zuid" : "343224"
1489
- },
1490
- "translations" : [ {
1491
- "modifiedTime" : 1593593278000,
1492
- "createdBy" : {
1493
- "photoURL" : null,
1494
- "name" : "Charlie",
1495
- "id" : "4000000016508",
1496
- "status" : "ACTIVE",
1497
- "zuid" : "343224"
1498
- },
1499
- "portalUrl" : "https://desk.zoho.com/portal/vincent/en/kb/terminus/technical/systematic-analysis",
1500
- "name" : "Systematic analysis",
1501
- "createdTime" : 1593593278000,
1502
- "description" : "Deep technical analysis to generate report",
1503
- "modifiedBy" : {
1504
- "photoURL" : null,
1505
- "name" : "Charlie",
1506
- "id" : "4000000016508",
1507
- "status" : "ACTIVE",
1508
- "zuid" : "343224"
1509
- },
1510
- "id" : "4000002861003",
1511
- "permalink" : "systematic-analysis",
1512
- "locale" : "en",
1513
- "categoryId" : "4000002861001"
1514
- } ],
1515
- "name" : "Systematic analysis",
1516
- "createdTime" : 1593593278000,
1517
- "modifiedBy" : {
1518
- "photoURL" : null,
1519
- "name" : "Charlie",
1520
- "id" : "4000000016508",
1521
- "status" : "ACTIVE",
1522
- "zuid" : "343224"
1523
- },
1524
- "parentCategoryId" : "4000002852130",
1525
- "id" : "4000002861001",
1526
- "status" : "SHOW_IN_HELPCENTER",
1527
- "order" : "1"
1528
- }, {
1529
- "modifiedTime" : 1593593281000,
1530
- "visibility" : "ALL_USERS",
1531
- "allArticlesCount" : "29",
1532
- "groups" : [ {
1533
- "name" : "personalized members",
1534
- "id" : "40000009150332",
1535
- "logoUrl" : null
1536
- } ],
1537
- "rootCategoryId" : "4000000081037",
1538
- "publicArticlesCount" : "17",
1539
- "isTrashed" : false,
1540
- "createdBy" : {
1541
- "photoURL" : null,
1542
- "name" : "Charlie",
1543
- "id" : "4000000016508",
1544
- "status" : "ACTIVE",
1545
- "zuid" : "343224"
1546
- },
1547
- "translations" : [ {
1548
- "modifiedTime" : 1593593281000,
1549
- "createdBy" : {
1550
- "photoURL" : null,
1551
- "name" : "Charlie",
1552
- "id" : "4000000016508",
1553
- "status" : "ACTIVE",
1554
- "zuid" : "343224"
1555
- },
1556
- "portalUrl" : "https://desk.zoho.com/portal/vincent/en/kb/terminus/technical/varsity-analysis",
1557
- "name" : "Varsity analysis",
1558
- "createdTime" : 1593593281000,
1559
- "description" : "Get into statistical analysis",
1560
- "modifiedBy" : {
1561
- "photoURL" : null,
1562
- "name" : "Charlie",
1563
- "id" : "4000000016508",
1564
- "status" : "ACTIVE",
1565
- "zuid" : "343224"
1566
- },
1567
- "id" : "4000002861213",
1568
- "permalink" : "varsity-analysis",
1569
- "locale" : "en",
1570
- "categoryId" : "4000002861211"
1571
- } ],
1572
- "name" : "Varsity analysis",
1573
- "createdTime" : 1593593281000,
1574
- "modifiedBy" : {
1575
- "photoURL" : null,
1576
- "name" : "Charlie",
1577
- "id" : "4000000016508",
1578
- "status" : "ACTIVE",
1579
- "zuid" : "343224"
1580
- },
1581
- "parentCategoryId" : "4000002852130",
1582
- "id" : "4000002861211",
1583
- "status" : "SHOW_IN_HELPCENTER",
1584
- "order" : "1"
1585
- } ]
1586
- }
1587
- }
1588
- }
1589
- }
1590
- },
1591
- "x-custom-response-attributes" : {
1592
- "disable-safe-headers" : "[]"
1593
- }
1594
- }
1595
- },
1596
- "parameters" : {
1597
- "sectionId" : {
1598
- "name" : "sectionId",
1599
- "in" : "path",
1600
- "required" : true,
1601
- "style" : "simple",
1602
- "explode" : false,
1603
- "schema" : {
1604
- "type" : [ "string", "null", "integer" ],
1605
- "format" : "int64",
1606
- "pattern" : "([0-9]+)"
1607
- }
1608
- },
1609
- "locale" : {
1610
- "name" : "locale",
1611
- "in" : "path",
1612
- "description" : "Locale of the kb section translation. If no locale is given, all the locale translations will be returned",
1613
- "required" : true,
1614
- "style" : "simple",
1615
- "explode" : false,
1616
- "schema" : {
1617
- "type" : [ "string", "null" ],
1618
- "description" : "Locale of the kb section translation. If no locale is given, all the locale translations will be returned",
1619
- "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" ],
1620
- "maxLength" : 100,
1621
- "minLength" : 0,
1622
- "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)"
1623
- }
1624
- }
1625
- },
1626
- "requestBodies" : {
1627
- "createCategoryJson" : {
1628
- "content" : {
1629
- "application/json" : {
1630
- "schema" : {
1631
- "additionalProperties" : false,
1632
- "allOf" : [ {
1633
- "$ref" : "./KBSection.json#/components/schemas/commonCategoryJson"
1634
- }, {
1635
- "type" : [ "null", "object" ],
1636
- "properties" : {
1637
- "parentCategoryId" : {
1638
- "type" : [ "string", "null", "integer" ],
1639
- "format" : "int64",
1640
- "description" : "Parent id (either section or rootCategoryId) below which we need to create a section",
1641
- "pattern" : "([0-9]+)"
1642
- }
1643
- }
1644
- }, {
1645
- "type" : "object",
1646
- "required" : [ "groupIds", "ipAddresses", "name", "parentCategoryId", "status", "translations", "visibility" ]
1647
- } ]
1648
- },
1649
- "examples" : {
1650
- "Valid requestBody Definitions" : {
1651
- "value" : {
1652
- "articlePermission" : "ALL",
1653
- "translations" : [ {
1654
- "name" : "For Agents",
1655
- "description" : "Section 1 description",
1656
- "locale" : "en-us",
1657
- "permalink" : "for-agents"
1658
- } ],
1659
- "name" : "For Agents",
1660
- "description" : "Section 1 description",
1661
- "parentCategoryId" : 5000000340014,
1662
- "logoId" : "10",
1663
- "status" : "SHOW_IN_HELPCENTER"
1664
- }
1665
- }
1666
- }
1667
- }
1668
- },
1669
- "x-custom-request-body-attributes" : {
1670
- "non-empty" : false,
1671
- "allow-invalid" : false
1672
- }
1673
- },
1674
- "permalinkUpdateJson" : {
1675
- "content" : {
1676
- "application/json" : {
1677
- "schema" : {
1678
- "type" : [ "null", "object" ],
1679
- "additionalProperties" : false,
1680
- "properties" : {
1681
- "primaryPermalink" : {
1682
- "type" : [ "string", "null" ],
1683
- "description" : "Primary permalink of a translation",
1684
- "maxLength" : 300,
1685
- "minLength" : 0,
1686
- "pattern" : "[a-z0-9\\/%\\-\\P{InBasicLatin}]+"
1687
- },
1688
- "secondaryPermalinks" : {
1689
- "type" : [ "null", "array" ],
1690
- "items" : {
1691
- "type" : [ "string", "null" ],
1692
- "maxLength" : 100,
1693
- "minLength" : 0,
1694
- "x-custom-parameters-attributes" : [ ]
1695
- },
1696
- "uniqueItems" : false
1697
- }
1698
- }
1699
- },
1700
- "examples" : {
1701
- "Valid requestBody Definitions" : {
1702
- "value" : {
1703
- "primaryPermalink" : "cleaner",
1704
- "secondaryPermalinks" : [ "onida", "samsung" ]
1705
- }
1706
- }
1707
- }
1708
- }
1709
- },
1710
- "x-custom-request-body-attributes" : {
1711
- "non-empty" : false,
1712
- "allow-invalid" : false
1713
- }
1714
- },
1715
- "moveAndDeleteCategoryRequestBody" : {
1716
- "content" : {
1717
- "application/json" : {
1718
- "schema" : {
1719
- "type" : [ "null", "object" ],
1720
- "additionalProperties" : false,
1721
- "properties" : {
1722
- "targetCategoryId" : {
1723
- "type" : [ "string", "null", "integer" ],
1724
- "format" : "int64",
1725
- "description" : "Category Id to which articles need to be moved",
1726
- "pattern" : "([0-9]+)"
1727
- }
1728
- },
1729
- "required" : [ "targetCategoryId" ]
1730
- },
1731
- "examples" : {
1732
- "Valid requestBody Definitions" : {
1733
- "value" : {
1734
- "targetCategoryId" : "5000000326009"
1735
- }
1736
- }
1737
- }
1738
- }
1739
- },
1740
- "x-custom-request-body-attributes" : {
1741
- "non-empty" : false,
1742
- "allow-invalid" : false
1743
- }
1744
- },
1745
- "moveCategoryRequestBody" : {
1746
- "content" : {
1747
- "application/json" : {
1748
- "schema" : {
1749
- "type" : [ "null", "object" ],
1750
- "additionalProperties" : false,
1751
- "properties" : {
1752
- "parentCategoryId" : {
1753
- "type" : [ "string", "null", "integer" ],
1754
- "format" : "int64",
1755
- "description" : "Parent Id",
1756
- "pattern" : "([0-9]+)"
1757
- },
1758
- "position" : {
1759
- "type" : [ "string", "null", "integer" ],
1760
- "format" : "int32",
1761
- "description" : "Position of child",
1762
- "pattern" : "([0-9]+)"
1763
- }
1764
- },
1765
- "required" : [ "parentCategoryId", "position" ]
1766
- },
1767
- "examples" : {
1768
- "Valid requestBody Definitions" : {
1769
- "value" : {
1770
- "parentCategoryId" : "5000000066427",
1771
- "position" : "1"
1772
- }
1773
- }
1774
- }
1775
- }
1776
- },
1777
- "x-custom-request-body-attributes" : {
1778
- "non-empty" : false,
1779
- "allow-invalid" : false
1780
- }
1781
- },
1782
- "addSectionTranslationJson" : {
1783
- "content" : {
1784
- "application/json" : {
1785
- "schema" : {
1786
- "type" : [ "null", "object" ],
1787
- "additionalProperties" : false,
1788
- "properties" : {
1789
- "name" : {
1790
- "type" : [ "string", "null" ],
1791
- "description" : "Section Name",
1792
- "maxLength" : 100,
1793
- "minLength" : 0
1794
- },
1795
- "locale" : {
1796
- "type" : [ "string", "null" ],
1797
- "description" : "Language of the translation",
1798
- "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" ],
1799
- "maxLength" : 100,
1800
- "minLength" : 0,
1801
- "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)"
1802
- }
1803
- },
1804
- "required" : [ "locale", "name" ]
1805
- },
1806
- "examples" : {
1807
- "Valid requestBody Definitions" : {
1808
- "value" : {
1809
- "name" : "New Translation",
1810
- "description" : "New Description",
1811
- "permalink" : "new-translation-pl",
1812
- "locale" : "pl"
1813
- }
1814
- }
1815
- }
1816
- }
1817
- },
1818
- "x-custom-request-body-attributes" : {
1819
- "non-empty" : false,
1820
- "allow-invalid" : false
1821
- }
1822
- },
1823
- "commonCategoryJson" : {
1824
- "content" : {
1825
- "application/json" : {
1826
- "schema" : {
1827
- "type" : [ "null", "object" ],
1828
- "additionalProperties" : false,
1829
- "properties" : {
1830
- "visibility" : {
1831
- "type" : [ "string", "null" ],
1832
- "description" : "Visibility of the section. Values allowed are !@AGENTS@!, !@GROUP_USERS@!, !@ALL_USERS@!,!@PRIVATE_IP@!,!@NONE@! ",
1833
- "enum" : [ "ALL_USERS", "AGENTS", "GROUP_USERS", "PRIVATE_IP", "NONE" ],
1834
- "maxLength" : 100,
1835
- "minLength" : 0
1836
- },
1837
- "translations" : {
1838
- "$ref" : "./KBSection.json#/components/schemas/addSectionTranslationJsonArray"
1839
- },
1840
- "groupIds" : {
1841
- "type" : [ "null", "array" ],
1842
- "items" : {
1843
- "type" : [ "string", "null", "integer" ],
1844
- "format" : "int64",
1845
- "pattern" : "([0-9]+)",
1846
- "x-custom-parameters-attributes" : [ { } ]
1847
- },
1848
- "uniqueItems" : false
1849
- },
1850
- "name" : {
1851
- "type" : [ "string", "null" ],
1852
- "description" : "Section Name",
1853
- "maxLength" : 100,
1854
- "minLength" : 0
1855
- },
1856
- "ipAddresses" : {
1857
- "type" : [ "null", "array" ],
1858
- "items" : {
1859
- "type" : [ "string", "null" ],
1860
- "maxLength" : 100,
1861
- "minLength" : 0,
1862
- "pattern" : "^((?:(?:(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|\\*)\\.){3}(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|\\*)(/(?:[012]?[0-9]|3[012]))?)|\\*)$",
1863
- "x-custom-parameters-attributes" : [ ]
1864
- },
1865
- "uniqueItems" : false
1866
- },
1867
- "status" : {
1868
- "type" : [ "string", "null" ],
1869
- "description" : "Status of the section",
1870
- "enum" : [ "SHOW_IN_HELPCENTER", "HIDE_IN_HELPCENTER" ],
1871
- "maxLength" : 100,
1872
- "minLength" : 0
1873
- }
1874
- }
1875
- },
1876
- "examples" : {
1877
- "Valid requestBody Definitions" : {
1878
- "value" : {
1879
- "articlePermission" : "REGISTEREDUSERS",
1880
- "translations" : [ {
1881
- "name" : "section name updated",
1882
- "locale" : "pl-pl"
1883
- } ],
1884
- "status" : "HIDE_IN_HELPCENTER"
1885
- }
1886
- }
1887
- }
1888
- }
1889
- },
1890
- "x-custom-request-body-attributes" : {
1891
- "non-empty" : false,
1892
- "allow-invalid" : false
1893
- }
1894
- },
1895
- "editSectionTranslationJson" : {
1896
- "content" : {
1897
- "application/json" : {
1898
- "schema" : {
1899
- "type" : [ "null", "object" ],
1900
- "additionalProperties" : false,
1901
- "properties" : {
1902
- "name" : {
1903
- "type" : [ "string", "null" ],
1904
- "description" : "Name",
1905
- "maxLength" : 100,
1906
- "minLength" : 0
1907
- }
1908
- },
1909
- "required" : [ "name" ]
1910
- },
1911
- "examples" : {
1912
- "Valid requestBody Definitions" : {
1913
- "value" : {
1914
- "name" : "New Translation edited",
1915
- "description" : "New Description edited",
1916
- "permalink" : "new-translation-pl"
1917
- }
1918
- }
1919
- }
1920
- }
1921
- },
1922
- "x-custom-request-body-attributes" : {
1923
- "non-empty" : false,
1924
- "allow-invalid" : false
1925
- }
1926
- }
1927
- },
1928
- "securitySchemes" : {
1929
- "cookie-auth" : {
1930
- "$ref" : "../common/Common.json#/components/securitySchemes/cookie-auth"
1931
- },
1932
- "org-oauth" : {
1933
- "$ref" : "../common/Common.json#/components/securitySchemes/org-oauth"
1934
- },
1935
- "iam-oauth2-schema" : {
1936
- "$ref" : "../common/Common.json#/components/securitySchemes/iam-oauth2-schema"
1937
- }
1938
- }
1939
- },
1940
- "x-entity" : "KBSection"
1941
- }