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,2545 +0,0 @@
1
- {
2
- "openapi" : "3.1.0",
3
- "info" : {
4
- "title" : "Community",
5
- "version" : "1.0.0",
6
- "x-clan-group" : "helpCenter",
7
- "x-module-group" : "community"
8
- },
9
- "paths" : {
10
- "/api/v1/communityUsers/{communityUserId}/topics/moveToTrash" : {
11
- "post" : {
12
- "tags" : [ "Community" ],
13
- "summary" : "Trash all user topics",
14
- "description" : "This API is to trash all the topics of a user",
15
- "operationId" : "scheduleTrashAllUserTopics",
16
- "parameters" : [ {
17
- "$ref" : "#/components/parameters/communityUserId"
18
- }, {
19
- "$ref" : "../common/Common.json#/components/parameters/orgId"
20
- } ],
21
- "requestBody" : {
22
- "$ref" : "#/components/requestBodies/scheduleTrashAllUserTopicsRequest"
23
- },
24
- "responses" : {
25
- "422" : {
26
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
27
- },
28
- "200" : {
29
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
30
- }
31
- },
32
- "security" : [ {
33
- "org-oauth" : [ "Desk.accessAll.ALL" ]
34
- }, {
35
- "iam-oauth2-schema" : [ "Desk.forums.UPDATE" ]
36
- } ],
37
- "x-audience" : [ "company-internal" ],
38
- "x-custom-url-attribute" : {
39
- "security" : {
40
- "throttle" : {
41
- "inline" : [ {
42
- "scope" : "APPSERVER",
43
- "rules" : [ {
44
- "duration" : 60000,
45
- "lock-period" : 300000,
46
- "threshold" : 20,
47
- "hip" : false
48
- } ],
49
- "window" : "ROLLING",
50
- "key" : "url.path+user.zuid"
51
- } ]
52
- },
53
- "extraparams" : {
54
- "disable" : true,
55
- "ignore" : false
56
- },
57
- "authentication" : { }
58
- },
59
- "clan-group" : "helpCenter",
60
- "apihash" : "4cc974ccde38c53c2842c7b7b4a40bed",
61
- "module-group" : "community",
62
- "apimethod" : "com.zoho.desk.helpcenter.community.moderation.ModerationService.scheduleTrashUserTopics"
63
- }
64
- }
65
- },
66
- "/api/v1/community/statistics" : {
67
- "get" : {
68
- "tags" : [ "Community" ],
69
- "summary" : "Get community stats",
70
- "description" : "This API fetches the overall statistics related to the community module and displays them on the community dashboard.",
71
- "operationId" : "getStats",
72
- "parameters" : [ {
73
- "$ref" : "#/components/parameters/categoryIds"
74
- }, {
75
- "$ref" : "#/components/parameters/startTime"
76
- }, {
77
- "$ref" : "#/components/parameters/endTime"
78
- }, {
79
- "$ref" : "../common/Common.json#/components/parameters/orgId"
80
- } ],
81
- "responses" : {
82
- "422" : {
83
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
84
- },
85
- "200" : {
86
- "$ref" : "#/components/responses/getStats"
87
- }
88
- },
89
- "security" : [ {
90
- "org-oauth" : [ "Desk.accessAll.ALL" ]
91
- }, {
92
- "iam-oauth2-schema" : [ "Desk.forums.READ" ]
93
- } ],
94
- "x-audience" : [ "company-internal" ],
95
- "x-custom-url-attribute" : {
96
- "security" : {
97
- "throttle" : {
98
- "inline" : [ {
99
- "scope" : "APPSERVER",
100
- "rules" : [ {
101
- "duration" : 60000,
102
- "lock-period" : 300000,
103
- "threshold" : 50,
104
- "hip" : false
105
- } ],
106
- "window" : "ROLLING",
107
- "key" : "url.path+user.zuid"
108
- } ]
109
- },
110
- "extraparams" : {
111
- "disable" : true,
112
- "ignore" : false
113
- },
114
- "authentication" : { }
115
- },
116
- "clan-group" : "helpCenter",
117
- "apihash" : "606a9689b98df58d915ef541b894e09a",
118
- "module-group" : "community",
119
- "apimethod" : "com.zoho.desk.helpcenter.community.reports.CommunityReportService.getStats"
120
- }
121
- }
122
- },
123
- "/api/v1/community/trashAllAwaitingComments" : {
124
- "post" : {
125
- "tags" : [ "Community" ],
126
- "summary" : "Trash all comments pending moderation",
127
- "description" : "This API moves all comments that are pending moderation to trash of your help desk portal.",
128
- "operationId" : "scheduleBulkTrashOfAwaitingComments",
129
- "parameters" : [ {
130
- "$ref" : "../common/Common.json#/components/parameters/orgId"
131
- } ],
132
- "requestBody" : {
133
- "$ref" : "#/components/requestBodies/scheduleBulkApprovalOfAwaitingTopicsRequest"
134
- },
135
- "responses" : {
136
- "422" : {
137
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
138
- },
139
- "200" : {
140
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
141
- }
142
- },
143
- "security" : [ {
144
- "org-oauth" : [ "Desk.accessAll.ALL" ]
145
- }, {
146
- "iam-oauth2-schema" : [ "Desk.forums.UPDATE", "Desk.community.UPDATE" ]
147
- } ],
148
- "x-audience" : [ "company-internal" ],
149
- "x-custom-url-attribute" : {
150
- "security" : {
151
- "throttle" : {
152
- "inline" : [ {
153
- "scope" : "APPSERVER",
154
- "rules" : [ {
155
- "duration" : 60000,
156
- "lock-period" : 300000,
157
- "threshold" : 20,
158
- "hip" : false
159
- } ],
160
- "window" : "ROLLING",
161
- "key" : "url.path+user.zuid"
162
- } ]
163
- },
164
- "extraparams" : {
165
- "disable" : true,
166
- "ignore" : false
167
- },
168
- "authentication" : { }
169
- },
170
- "clan-group" : "helpCenter",
171
- "apihash" : "fd794f4c50ba2cfa5ef3f821cc03382a",
172
- "module-group" : "community",
173
- "apimethod" : "com.zoho.desk.helpcenter.community.moderation.ModerationService.scheduleBulkTrashOfAwaitingComments"
174
- }
175
- }
176
- },
177
- "/api/v1/community/topicResponseTrend" : {
178
- "get" : {
179
- "tags" : [ "Community" ],
180
- "summary" : "Get topic response trend",
181
- "description" : "This API displays the trends of topics and responses.",
182
- "operationId" : "getTopicResponseTrend",
183
- "parameters" : [ {
184
- "$ref" : "#/components/parameters/categoryIds"
185
- }, {
186
- "$ref" : "#/components/parameters/startTime"
187
- }, {
188
- "$ref" : "#/components/parameters/endTime"
189
- }, {
190
- "$ref" : "#/components/parameters/topicType"
191
- }, {
192
- "$ref" : "../common/Common.json#/components/parameters/orgId"
193
- } ],
194
- "responses" : {
195
- "422" : {
196
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
197
- },
198
- "200" : {
199
- "$ref" : "#/components/responses/getTopicResponseTrend"
200
- }
201
- },
202
- "security" : [ {
203
- "org-oauth" : [ "Desk.accessAll.ALL" ]
204
- }, {
205
- "iam-oauth2-schema" : [ "Desk.forums.READ" ]
206
- } ],
207
- "x-audience" : [ "company-internal" ],
208
- "x-custom-url-attribute" : {
209
- "security" : {
210
- "throttle" : {
211
- "inline" : [ {
212
- "scope" : "APPSERVER",
213
- "rules" : [ {
214
- "duration" : 60000,
215
- "lock-period" : 300000,
216
- "threshold" : 50,
217
- "hip" : false
218
- } ],
219
- "window" : "ROLLING",
220
- "key" : "url.path+user.zuid"
221
- } ]
222
- },
223
- "extraparams" : {
224
- "disable" : true,
225
- "ignore" : false
226
- },
227
- "authentication" : { }
228
- },
229
- "clan-group" : "helpCenter",
230
- "apihash" : "f12af6a9c351c643d984ebbfab853bcc",
231
- "module-group" : "community",
232
- "apimethod" : "com.zoho.desk.helpcenter.community.reports.CommunityReportService.getTopicResponseTrend"
233
- }
234
- }
235
- },
236
- "/api/v1/community/topicTypeResponsiveness" : {
237
- "get" : {
238
- "tags" : [ "Community" ],
239
- "summary" : "Get label-wise topic count",
240
- "description" : "This API fetches the label-wise break-up of the total number of topics that are of a particular type.",
241
- "operationId" : "getTopicTypeResponsiveness",
242
- "parameters" : [ {
243
- "$ref" : "#/components/parameters/categoryIds"
244
- }, {
245
- "$ref" : "#/components/parameters/startTime"
246
- }, {
247
- "$ref" : "#/components/parameters/endTime"
248
- }, {
249
- "$ref" : "#/components/parameters/topicType_getTopicTypeResponsiveness"
250
- }, {
251
- "$ref" : "../common/Common.json#/components/parameters/orgId"
252
- } ],
253
- "responses" : {
254
- "422" : {
255
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
256
- },
257
- "200" : {
258
- "$ref" : "#/components/responses/getTopicTypeResponsivenessResponse"
259
- }
260
- },
261
- "security" : [ {
262
- "org-oauth" : [ "Desk.accessAll.ALL" ]
263
- }, {
264
- "iam-oauth2-schema" : [ "Desk.forums.READ" ]
265
- } ],
266
- "x-audience" : [ "company-internal" ],
267
- "x-custom-url-attribute" : {
268
- "security" : {
269
- "throttle" : {
270
- "inline" : [ {
271
- "scope" : "APPSERVER",
272
- "rules" : [ {
273
- "duration" : 60000,
274
- "lock-period" : 300000,
275
- "threshold" : 50,
276
- "hip" : false
277
- } ],
278
- "window" : "ROLLING",
279
- "key" : "url.path+user.zuid"
280
- } ]
281
- },
282
- "extraparams" : {
283
- "disable" : true,
284
- "ignore" : false
285
- },
286
- "authentication" : { }
287
- },
288
- "clan-group" : "helpCenter",
289
- "apihash" : "368bc48579aed83b47ef55c4ece68553",
290
- "module-group" : "community",
291
- "apimethod" : "com.zoho.desk.helpcenter.community.reports.CommunityReportService.getTopicTypeResponsiveness"
292
- }
293
- }
294
- },
295
- "/api/v1/communityTopics/{topicId}/attachments/{attachmentId}/content" : {
296
- "get" : {
297
- "tags" : [ "Community" ],
298
- "summary" : "Get community topic attachment",
299
- "description" : "This API fetches a file attachment from a topic.",
300
- "operationId" : "getCommunityTopicAttachment",
301
- "parameters" : [ {
302
- "$ref" : "#/components/parameters/topicId"
303
- }, {
304
- "$ref" : "#/components/parameters/attachmentId"
305
- }, {
306
- "$ref" : "../common/Common.json#/components/parameters/orgId"
307
- } ],
308
- "responses" : {
309
- "200" : {
310
- "$ref" : "../common/Common.json#/components/responses/fileResponse"
311
- }
312
- },
313
- "security" : [ {
314
- "org-oauth" : [ "Desk.accessAll.ALL" ]
315
- }, {
316
- "iam-oauth2-schema" : [ "Desk.forums.READ", "Desk.community.READ" ]
317
- } ],
318
- "x-audience" : [ "external-public" ],
319
- "x-custom-url-attribute" : {
320
- "security" : {
321
- "throttle" : {
322
- "inline" : [ {
323
- "scope" : "APPSERVER",
324
- "rules" : [ {
325
- "duration" : 60000,
326
- "lock-period" : 600000,
327
- "threshold" : 50,
328
- "hip" : false
329
- } ],
330
- "window" : "ROLLING",
331
- "key" : "url.path+user.zuid"
332
- } ]
333
- },
334
- "extraparams" : {
335
- "disable" : true,
336
- "ignore" : false
337
- },
338
- "authentication" : { }
339
- },
340
- "clan-group" : "helpCenter",
341
- "apihash" : "f4da4e88fdc3a0746fd5ce88c6214c45",
342
- "module-group" : "community",
343
- "apimethod" : "com.zoho.desk.helpcenter.community.attachments.AttachmentRestService.downloadTopicAttachment"
344
- }
345
- }
346
- },
347
- "/api/v1/community/approveAllSpamComments" : {
348
- "post" : {
349
- "tags" : [ "Community" ],
350
- "summary" : "Approve all spam comments",
351
- "description" : "This API approves all comments that are marked as spam in the user community.",
352
- "operationId" : "scheduleBulkApprovalOfSpamComments",
353
- "parameters" : [ {
354
- "$ref" : "../common/Common.json#/components/parameters/orgId"
355
- } ],
356
- "requestBody" : {
357
- "$ref" : "#/components/requestBodies/scheduleBulkApprovalOfSpamComments_scheduleBulkApprovalOfAwaitingTopicsRequest"
358
- },
359
- "responses" : {
360
- "422" : {
361
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
362
- },
363
- "200" : {
364
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
365
- }
366
- },
367
- "security" : [ {
368
- "org-oauth" : [ "Desk.accessAll.ALL" ]
369
- }, {
370
- "iam-oauth2-schema" : [ "Desk.forums.UPDATE", "Desk.community.UPDATE" ]
371
- } ],
372
- "x-audience" : [ "company-internal" ],
373
- "x-custom-url-attribute" : {
374
- "security" : {
375
- "throttle" : {
376
- "inline" : [ {
377
- "scope" : "APPSERVER",
378
- "rules" : [ {
379
- "duration" : 60000,
380
- "lock-period" : 300000,
381
- "threshold" : 20,
382
- "hip" : false
383
- } ],
384
- "window" : "ROLLING",
385
- "key" : "url.path+user.zuid"
386
- } ]
387
- },
388
- "extraparams" : {
389
- "disable" : true,
390
- "ignore" : false
391
- },
392
- "authentication" : { }
393
- },
394
- "clan-group" : "helpCenter",
395
- "apihash" : "c35d87349f10889072d9bdfe801d155f",
396
- "module-group" : "community",
397
- "apimethod" : "com.zoho.desk.helpcenter.community.moderation.ModerationService.scheduleBulkApprovalOfSpamComments"
398
- }
399
- }
400
- },
401
- "/api/v1/community/topicResponsiveness" : {
402
- "get" : {
403
- "tags" : [ "Community" ],
404
- "summary" : "Get topic responsiveness stats",
405
- "description" : "TThis API fetches statistics related to users responsiveness to topics in the community module.",
406
- "operationId" : "getTopicResponsiveness",
407
- "parameters" : [ {
408
- "$ref" : "#/components/parameters/categoryIds"
409
- }, {
410
- "$ref" : "#/components/parameters/startTime"
411
- }, {
412
- "$ref" : "#/components/parameters/endTime"
413
- }, {
414
- "$ref" : "#/components/parameters/topicType"
415
- }, {
416
- "$ref" : "../common/Common.json#/components/parameters/orgId"
417
- } ],
418
- "responses" : {
419
- "422" : {
420
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
421
- },
422
- "200" : {
423
- "$ref" : "#/components/responses/getTopicResponsiveness"
424
- }
425
- },
426
- "security" : [ {
427
- "org-oauth" : [ "Desk.accessAll.ALL" ]
428
- }, {
429
- "iam-oauth2-schema" : [ "Desk.forums.READ" ]
430
- } ],
431
- "x-audience" : [ "company-internal" ],
432
- "x-custom-url-attribute" : {
433
- "security" : {
434
- "throttle" : {
435
- "inline" : [ {
436
- "scope" : "APPSERVER",
437
- "rules" : [ {
438
- "duration" : 60000,
439
- "lock-period" : 300000,
440
- "threshold" : 50,
441
- "hip" : false
442
- } ],
443
- "window" : "ROLLING",
444
- "key" : "url.path+user.zuid"
445
- } ]
446
- },
447
- "extraparams" : {
448
- "disable" : true,
449
- "ignore" : false
450
- },
451
- "authentication" : { }
452
- },
453
- "clan-group" : "helpCenter",
454
- "apihash" : "4a24aa498fbe9792b21baa905f08f937",
455
- "module-group" : "community",
456
- "apimethod" : "com.zoho.desk.helpcenter.community.reports.CommunityReportService.getTopicResponsiveness"
457
- }
458
- }
459
- },
460
- "/api/v1/community/uniqueUsersParticipationTrend" : {
461
- "get" : {
462
- "tags" : [ "Community" ],
463
- "summary" : "Get unique users participation trend",
464
- "description" : "This API displays the trend related to participation of unique users.",
465
- "operationId" : "getUniqueUserParticipationTrend",
466
- "parameters" : [ {
467
- "$ref" : "#/components/parameters/categoryIds"
468
- }, {
469
- "$ref" : "#/components/parameters/startTime"
470
- }, {
471
- "$ref" : "#/components/parameters/endTime"
472
- }, {
473
- "$ref" : "#/components/parameters/topicType"
474
- }, {
475
- "$ref" : "../common/Common.json#/components/parameters/orgId"
476
- } ],
477
- "responses" : {
478
- "422" : {
479
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
480
- },
481
- "200" : {
482
- "$ref" : "#/components/responses/getUniqueUserParticipationTrend"
483
- }
484
- },
485
- "security" : [ {
486
- "org-oauth" : [ "Desk.accessAll.ALL" ]
487
- }, {
488
- "iam-oauth2-schema" : [ "Desk.forums.READ" ]
489
- } ],
490
- "x-audience" : [ "company-internal" ],
491
- "x-custom-url-attribute" : {
492
- "security" : {
493
- "throttle" : {
494
- "inline" : [ {
495
- "scope" : "APPSERVER",
496
- "rules" : [ {
497
- "duration" : 60000,
498
- "lock-period" : 300000,
499
- "threshold" : 50,
500
- "hip" : false
501
- } ],
502
- "window" : "ROLLING",
503
- "key" : "url.path+user.zuid"
504
- } ]
505
- },
506
- "extraparams" : {
507
- "disable" : true,
508
- "ignore" : false
509
- },
510
- "authentication" : { }
511
- },
512
- "clan-group" : "helpCenter",
513
- "apihash" : "33610223a3baba94ef22f94ecc6c8071",
514
- "module-group" : "community",
515
- "apimethod" : "com.zoho.desk.helpcenter.community.reports.CommunityReportService.getUniqueUserParticipationTrend"
516
- }
517
- }
518
- },
519
- "/api/v1/community/trashAllSpamComments" : {
520
- "post" : {
521
- "tags" : [ "Community" ],
522
- "summary" : "Trash all spam comments",
523
- "description" : "This API moves all comments marked as spam to trash of your help desk portal.",
524
- "operationId" : "scheduleBulkTrashOfSpamComments",
525
- "parameters" : [ {
526
- "$ref" : "../common/Common.json#/components/parameters/orgId"
527
- } ],
528
- "requestBody" : {
529
- "$ref" : "#/components/requestBodies/scheduleBulkTrashOfSpamComments_scheduleBulkApprovalOfAwaitingTopicsRequest"
530
- },
531
- "responses" : {
532
- "422" : {
533
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
534
- },
535
- "200" : {
536
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
537
- }
538
- },
539
- "security" : [ {
540
- "org-oauth" : [ "Desk.accessAll.ALL" ]
541
- }, {
542
- "iam-oauth2-schema" : [ "Desk.forums.UPDATE", "Desk.community.UPDATE" ]
543
- } ],
544
- "x-audience" : [ "company-internal" ],
545
- "x-custom-url-attribute" : {
546
- "security" : {
547
- "throttle" : {
548
- "inline" : [ {
549
- "scope" : "APPSERVER",
550
- "rules" : [ {
551
- "duration" : 60000,
552
- "lock-period" : 300000,
553
- "threshold" : 20,
554
- "hip" : false
555
- } ],
556
- "window" : "ROLLING",
557
- "key" : "url.path+user.zuid"
558
- } ]
559
- },
560
- "extraparams" : {
561
- "disable" : true,
562
- "ignore" : false
563
- },
564
- "authentication" : { }
565
- },
566
- "clan-group" : "helpCenter",
567
- "apihash" : "6940fc84f3509fb2008ebb857619007b",
568
- "module-group" : "community",
569
- "apimethod" : "com.zoho.desk.helpcenter.community.moderation.ModerationService.scheduleBulkTrashOfSpamComments"
570
- }
571
- }
572
- },
573
- "/api/v1/communityTopics/{topicId}/voters/trend" : {
574
- "get" : {
575
- "tags" : [ "Community" ],
576
- "summary" : "Topic voters trend",
577
- "description" : "To get trend of voters of a topic",
578
- "operationId" : "getCommunityTopicVotersTrend",
579
- "parameters" : [ {
580
- "name" : "startTime",
581
- "in" : "query",
582
- "description" : "Starting time of the time range for which the statistics should be fetched. The value must be expressed according to the GMT time zone.",
583
- "required" : false,
584
- "style" : "form",
585
- "explode" : true,
586
- "schema" : {
587
- "type" : [ "string", "null" ],
588
- "description" : "Starting time of the time range for which the statistics should be fetched. The value must be expressed according to the GMT time zone.",
589
- "maxLength" : 100,
590
- "minLength" : 0,
591
- "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))"
592
- }
593
- }, {
594
- "name" : "endTime",
595
- "in" : "query",
596
- "description" : "Ending time of the time range for which the statistics should be fetched. The value must be expressed according to the GMT time zone.",
597
- "required" : false,
598
- "style" : "form",
599
- "explode" : true,
600
- "schema" : {
601
- "type" : [ "string", "null" ],
602
- "description" : "Ending time of the time range for which the statistics should be fetched. The value must be expressed according to the GMT time zone.",
603
- "maxLength" : 100,
604
- "minLength" : 0,
605
- "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))"
606
- }
607
- }, {
608
- "$ref" : "#/components/parameters/topicId"
609
- }, {
610
- "$ref" : "../common/Common.json#/components/parameters/orgId"
611
- } ],
612
- "responses" : {
613
- "200" : {
614
- "$ref" : "#/components/responses/topicVoterTrendResponse"
615
- }
616
- },
617
- "security" : [ {
618
- "org-oauth" : [ "Desk.accessAll.ALL" ]
619
- }, {
620
- "iam-oauth2-schema" : [ "Desk.forums.READ", "Desk.community.READ" ]
621
- } ],
622
- "x-audience" : [ "external-public" ],
623
- "x-custom-url-attribute" : {
624
- "security" : {
625
- "throttle" : {
626
- "inline" : [ {
627
- "scope" : "APPSERVER",
628
- "rules" : [ {
629
- "duration" : 60000,
630
- "lock-period" : 300000,
631
- "threshold" : 25,
632
- "hip" : false
633
- }, {
634
- "duration" : 1800000,
635
- "lock-period" : 900000,
636
- "threshold" : 300,
637
- "hip" : false
638
- } ],
639
- "window" : "ROLLING",
640
- "key" : "url.path+user.zuid"
641
- } ]
642
- },
643
- "extraparams" : {
644
- "disable" : true,
645
- "ignore" : false
646
- },
647
- "authentication" : { }
648
- },
649
- "clan-group" : "helpCenter",
650
- "apihash" : "a37b3bc3de14ce4193e90ee2bef1f339",
651
- "module-group" : "community",
652
- "apimethod" : "com.zoho.desk.helpcenter.community.reports.CommunityReportService.getTopicVoteTrend"
653
- }
654
- }
655
- },
656
- "/api/v1/community/topicTypeTrend" : {
657
- "get" : {
658
- "tags" : [ "Community" ],
659
- "summary" : "Get topic type trend",
660
- "description" : "This API displays the trend related to topic types (announcement, discussion, idea, problem, and question), on the community dashboard.",
661
- "operationId" : "getTopicTypeTrend",
662
- "parameters" : [ {
663
- "$ref" : "#/components/parameters/categoryIds"
664
- }, {
665
- "$ref" : "#/components/parameters/startTime"
666
- }, {
667
- "$ref" : "#/components/parameters/endTime"
668
- }, {
669
- "$ref" : "../common/Common.json#/components/parameters/orgId"
670
- } ],
671
- "responses" : {
672
- "422" : {
673
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
674
- },
675
- "200" : {
676
- "$ref" : "#/components/responses/getTopicTypeTrendResponse"
677
- }
678
- },
679
- "security" : [ {
680
- "org-oauth" : [ "Desk.accessAll.ALL" ]
681
- }, {
682
- "iam-oauth2-schema" : [ "Desk.forums.READ" ]
683
- } ],
684
- "x-audience" : [ "company-internal" ],
685
- "x-custom-url-attribute" : {
686
- "security" : {
687
- "throttle" : {
688
- "inline" : [ {
689
- "scope" : "APPSERVER",
690
- "rules" : [ {
691
- "duration" : 60000,
692
- "lock-period" : 300000,
693
- "threshold" : 50,
694
- "hip" : false
695
- } ],
696
- "window" : "ROLLING",
697
- "key" : "url.path+user.zuid"
698
- } ]
699
- },
700
- "extraparams" : {
701
- "disable" : true,
702
- "ignore" : false
703
- },
704
- "authentication" : { }
705
- },
706
- "clan-group" : "helpCenter",
707
- "apihash" : "04c4551119555c62ae08271eb0e14f86",
708
- "module-group" : "community",
709
- "apimethod" : "com.zoho.desk.helpcenter.community.reports.CommunityReportService.getTopicTypeTrend"
710
- }
711
- }
712
- },
713
- "/api/v1/communityUsers/{communityUserId}/stats" : {
714
- "get" : {
715
- "tags" : [ "Community" ],
716
- "summary" : "Get community stats of user",
717
- "description" : "This API fetches the community-related statistics of a particular user.",
718
- "operationId" : "getStatsOfUser",
719
- "parameters" : [ {
720
- "$ref" : "#/components/parameters/startTime"
721
- }, {
722
- "$ref" : "#/components/parameters/endTime"
723
- }, {
724
- "$ref" : "#/components/parameters/categoryId"
725
- }, {
726
- "$ref" : "#/components/parameters/communityUserId"
727
- }, {
728
- "$ref" : "../common/Common.json#/components/parameters/orgId"
729
- } ],
730
- "responses" : {
731
- "422" : {
732
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
733
- },
734
- "200" : {
735
- "$ref" : "#/components/responses/getStatsOfUser"
736
- }
737
- },
738
- "security" : [ {
739
- "org-oauth" : [ "Desk.accessAll.ALL" ]
740
- }, {
741
- "iam-oauth2-schema" : [ "Desk.forums.READ", "Desk.community.READ" ]
742
- } ],
743
- "x-audience" : [ "company-internal" ],
744
- "x-custom-url-attribute" : {
745
- "security" : {
746
- "throttle" : {
747
- "inline" : [ {
748
- "scope" : "APPSERVER",
749
- "rules" : [ {
750
- "duration" : 60000,
751
- "lock-period" : 300000,
752
- "threshold" : 50,
753
- "hip" : false
754
- } ],
755
- "window" : "ROLLING",
756
- "key" : "url.path+user.zuid"
757
- } ]
758
- },
759
- "extraparams" : {
760
- "disable" : true,
761
- "ignore" : false
762
- },
763
- "authentication" : { }
764
- },
765
- "clan-group" : "helpCenter",
766
- "apihash" : "d0128de751078dec90e77bc3e78b8d95",
767
- "module-group" : "community",
768
- "apimethod" : "com.zoho.desk.helpcenter.community.reports.CommunityReportService.getStatsOfUser"
769
- }
770
- }
771
- },
772
- "/api/v1/communityTopics/{topicId}/moveToTrash" : {
773
- "post" : {
774
- "tags" : [ "Community" ],
775
- "summary" : "Trash community topic",
776
- "description" : "This API moves a forum topic to trash of your help desk portal.",
777
- "operationId" : "deleteCommunityTopic",
778
- "parameters" : [ {
779
- "$ref" : "#/components/parameters/topicId"
780
- }, {
781
- "$ref" : "../common/Common.json#/components/parameters/orgId"
782
- } ],
783
- "responses" : {
784
- "204" : {
785
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
786
- }
787
- },
788
- "security" : [ {
789
- "org-oauth" : [ "Desk.accessAll.ALL" ]
790
- }, {
791
- "iam-oauth2-schema" : [ "Desk.forums.UPDATE", "Desk.community.UPDATE" ]
792
- } ],
793
- "x-audience" : [ "external-public" ],
794
- "x-custom-url-attribute" : {
795
- "security" : {
796
- "throttle" : {
797
- "inline" : [ {
798
- "scope" : "APPSERVER",
799
- "rules" : [ {
800
- "duration" : 60000,
801
- "lock-period" : 600000,
802
- "threshold" : 50,
803
- "hip" : false
804
- } ],
805
- "window" : "ROLLING",
806
- "key" : "url.path+user.zuid"
807
- } ]
808
- },
809
- "extraparams" : {
810
- "disable" : true,
811
- "ignore" : false
812
- },
813
- "authentication" : { }
814
- },
815
- "clan-group" : "helpCenter",
816
- "apihash" : "0b733aedac0725089d8aaf1c99bbbff9",
817
- "module-group" : "community",
818
- "apimethod" : "com.zoho.desk.helpcenter.community.posts.TopicRestService.trashTopic"
819
- }
820
- }
821
- },
822
- "/api/v1/community/trashAllSpamTopics" : {
823
- "post" : {
824
- "tags" : [ "Community" ],
825
- "summary" : "Trash all spam topics",
826
- "description" : "This API moves all topics marked as spam to the trash of your help desk portal.",
827
- "operationId" : "scheduleBulkTrashOfSpamTopics",
828
- "parameters" : [ {
829
- "$ref" : "../common/Common.json#/components/parameters/orgId"
830
- } ],
831
- "requestBody" : {
832
- "$ref" : "#/components/requestBodies/scheduleBulkTrashOfSpamTopics_scheduleBulkApprovalOfAwaitingTopicsRequest"
833
- },
834
- "responses" : {
835
- "422" : {
836
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
837
- },
838
- "200" : {
839
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
840
- }
841
- },
842
- "security" : [ {
843
- "org-oauth" : [ "Desk.accessAll.ALL" ]
844
- }, {
845
- "iam-oauth2-schema" : [ "Desk.forums.UPDATE", "Desk.community.UPDATE" ]
846
- } ],
847
- "x-audience" : [ "company-internal" ],
848
- "x-custom-url-attribute" : {
849
- "security" : {
850
- "throttle" : {
851
- "inline" : [ {
852
- "scope" : "APPSERVER",
853
- "rules" : [ {
854
- "duration" : 60000,
855
- "lock-period" : 300000,
856
- "threshold" : 20,
857
- "hip" : false
858
- } ],
859
- "window" : "ROLLING",
860
- "key" : "url.path+user.zuid"
861
- } ]
862
- },
863
- "extraparams" : {
864
- "disable" : true,
865
- "ignore" : false
866
- },
867
- "authentication" : { }
868
- },
869
- "clan-group" : "helpCenter",
870
- "apihash" : "60c542baef6f952794222609c5a9125a",
871
- "module-group" : "community",
872
- "apimethod" : "com.zoho.desk.helpcenter.community.moderation.ModerationService.scheduleBulkTrashOfSpamTopics"
873
- }
874
- }
875
- },
876
- "/api/v1/communityUsers/{communityUserId}/comments/moveToTrash" : {
877
- "post" : {
878
- "tags" : [ "Community" ],
879
- "summary" : "Trash all user comments",
880
- "description" : "This API is to trash all the comments of a user",
881
- "operationId" : "scheduleTrashAllUserComments",
882
- "parameters" : [ {
883
- "$ref" : "#/components/parameters/communityUserId"
884
- }, {
885
- "$ref" : "../common/Common.json#/components/parameters/orgId"
886
- } ],
887
- "requestBody" : {
888
- "$ref" : "#/components/requestBodies/scheduleTrashAllUserCommentsRequest"
889
- },
890
- "responses" : {
891
- "422" : {
892
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
893
- },
894
- "200" : {
895
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
896
- }
897
- },
898
- "security" : [ {
899
- "org-oauth" : [ "Desk.accessAll.ALL" ]
900
- }, {
901
- "iam-oauth2-schema" : [ "Desk.forums.UPDATE" ]
902
- } ],
903
- "x-audience" : [ "company-internal" ],
904
- "x-custom-url-attribute" : {
905
- "security" : {
906
- "throttle" : {
907
- "inline" : [ {
908
- "scope" : "APPSERVER",
909
- "rules" : [ {
910
- "duration" : 60000,
911
- "lock-period" : 300000,
912
- "threshold" : 20,
913
- "hip" : false
914
- } ],
915
- "window" : "ROLLING",
916
- "key" : "url.path+user.zuid"
917
- } ]
918
- },
919
- "extraparams" : {
920
- "disable" : true,
921
- "ignore" : false
922
- },
923
- "authentication" : { }
924
- },
925
- "clan-group" : "helpCenter",
926
- "apihash" : "6c3ec7999e02c10d3542f1cf447807b0",
927
- "module-group" : "community",
928
- "apimethod" : "com.zoho.desk.helpcenter.community.moderation.ModerationService.scheduleTrashUserComments"
929
- }
930
- }
931
- },
932
- "/api/v1/community/trashAllAwaitingTopics" : {
933
- "post" : {
934
- "tags" : [ "Community" ],
935
- "summary" : " Trash all topics pending moderation",
936
- "description" : "This API moves all topics that are pending moderation to the trash of your help desk portal.",
937
- "operationId" : "scheduleBulkTrashOfAwaitingTopics",
938
- "parameters" : [ {
939
- "$ref" : "../common/Common.json#/components/parameters/orgId"
940
- } ],
941
- "requestBody" : {
942
- "$ref" : "#/components/requestBodies/scheduleBulkTrashOfAwaitingTopics_scheduleBulkApprovalOfAwaitingTopicsRequest"
943
- },
944
- "responses" : {
945
- "422" : {
946
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
947
- },
948
- "200" : {
949
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
950
- }
951
- },
952
- "security" : [ {
953
- "org-oauth" : [ "Desk.accessAll.ALL" ]
954
- }, {
955
- "iam-oauth2-schema" : [ "Desk.forums.UPDATE", "Desk.community.UPDATE" ]
956
- } ],
957
- "x-audience" : [ "company-internal" ],
958
- "x-custom-url-attribute" : {
959
- "security" : {
960
- "throttle" : {
961
- "inline" : [ {
962
- "scope" : "APPSERVER",
963
- "rules" : [ {
964
- "duration" : 60000,
965
- "lock-period" : 300000,
966
- "threshold" : 20,
967
- "hip" : false
968
- } ],
969
- "window" : "ROLLING",
970
- "key" : "url.path+user.zuid"
971
- } ]
972
- },
973
- "extraparams" : {
974
- "disable" : true,
975
- "ignore" : false
976
- },
977
- "authentication" : { }
978
- },
979
- "clan-group" : "helpCenter",
980
- "apihash" : "b640b7e797fce63116819681700f077f",
981
- "module-group" : "community",
982
- "apimethod" : "com.zoho.desk.helpcenter.community.moderation.ModerationService.scheduleBulkTrashOfAwaitingTopics"
983
- }
984
- }
985
- },
986
- "/api/v1/community/approveAllSpamTopics" : {
987
- "post" : {
988
- "tags" : [ "Community" ],
989
- "summary" : "Approve all spam topics",
990
- "description" : "This API approves all topics that are marked as spam in the user community.",
991
- "operationId" : "scheduleBulkApprovalOfSpamTopics",
992
- "parameters" : [ {
993
- "$ref" : "../common/Common.json#/components/parameters/orgId"
994
- } ],
995
- "requestBody" : {
996
- "$ref" : "#/components/requestBodies/scheduleBulkApprovalOfSpamTopics_scheduleBulkApprovalOfAwaitingTopicsRequest"
997
- },
998
- "responses" : {
999
- "422" : {
1000
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
1001
- },
1002
- "200" : {
1003
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
1004
- }
1005
- },
1006
- "security" : [ {
1007
- "org-oauth" : [ "Desk.accessAll.ALL" ]
1008
- }, {
1009
- "iam-oauth2-schema" : [ "Desk.forums.UPDATE", "Desk.community.UPDATE" ]
1010
- } ],
1011
- "x-audience" : [ "company-internal" ],
1012
- "x-custom-url-attribute" : {
1013
- "security" : {
1014
- "throttle" : {
1015
- "inline" : [ {
1016
- "scope" : "APPSERVER",
1017
- "rules" : [ {
1018
- "duration" : 60000,
1019
- "lock-period" : 300000,
1020
- "threshold" : 20,
1021
- "hip" : false
1022
- } ],
1023
- "window" : "ROLLING",
1024
- "key" : "url.path+user.zuid"
1025
- } ]
1026
- },
1027
- "extraparams" : {
1028
- "disable" : true,
1029
- "ignore" : false
1030
- },
1031
- "authentication" : { }
1032
- },
1033
- "clan-group" : "helpCenter",
1034
- "apihash" : "b53ab79599bdcc2c1a5c426a09a8df56",
1035
- "module-group" : "community",
1036
- "apimethod" : "com.zoho.desk.helpcenter.community.moderation.ModerationService.scheduleBulkApprovalOfSpamTopics"
1037
- }
1038
- }
1039
- },
1040
- "/api/v1/community/topContributors" : {
1041
- "get" : {
1042
- "tags" : [ "Community" ],
1043
- "summary" : "List top contributors",
1044
- "description" : "This API lists a particular number of users who have participated the most in the user community, based on the limit specified.",
1045
- "operationId" : "getTopContributors",
1046
- "parameters" : [ {
1047
- "name" : "limit",
1048
- "in" : "query",
1049
- "description" : "Number of users to list",
1050
- "required" : false,
1051
- "style" : "form",
1052
- "explode" : true,
1053
- "schema" : {
1054
- "type" : [ "string", "null", "integer" ],
1055
- "format" : "int32",
1056
- "description" : "Number of users to list",
1057
- "maximum" : 25,
1058
- "minimum" : 1,
1059
- "pattern" : "([0-9]+)"
1060
- }
1061
- }, {
1062
- "$ref" : "#/components/parameters/startTime"
1063
- }, {
1064
- "$ref" : "#/components/parameters/endTime"
1065
- }, {
1066
- "name" : "userType",
1067
- "in" : "query",
1068
- "description" : "to filter agent and end user",
1069
- "required" : false,
1070
- "style" : "form",
1071
- "explode" : true,
1072
- "schema" : {
1073
- "type" : [ "string", "null" ],
1074
- "description" : "to filter agent and end user",
1075
- "enum" : [ "AGENT", "END_USER" ],
1076
- "maxLength" : 100,
1077
- "minLength" : 0
1078
- }
1079
- }, {
1080
- "$ref" : "#/components/parameters/categoryId"
1081
- }, {
1082
- "$ref" : "../common/Common.json#/components/parameters/orgId"
1083
- } ],
1084
- "responses" : {
1085
- "422" : {
1086
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
1087
- },
1088
- "200" : {
1089
- "$ref" : "#/components/responses/getTopContributors"
1090
- }
1091
- },
1092
- "security" : [ {
1093
- "org-oauth" : [ "Desk.accessAll.ALL" ]
1094
- }, {
1095
- "iam-oauth2-schema" : [ "Desk.forums.READ" ]
1096
- } ],
1097
- "x-audience" : [ "company-internal" ],
1098
- "x-custom-url-attribute" : {
1099
- "security" : {
1100
- "throttle" : {
1101
- "inline" : [ {
1102
- "scope" : "APPSERVER",
1103
- "rules" : [ {
1104
- "duration" : 60000,
1105
- "lock-period" : 300000,
1106
- "threshold" : 50,
1107
- "hip" : false
1108
- } ],
1109
- "window" : "ROLLING",
1110
- "key" : "url.path+user.zuid"
1111
- } ]
1112
- },
1113
- "extraparams" : {
1114
- "disable" : true,
1115
- "ignore" : false
1116
- },
1117
- "authentication" : { }
1118
- },
1119
- "clan-group" : "helpCenter",
1120
- "apihash" : "3be3a1058c7766278796a7a6769029b7",
1121
- "module-group" : "community",
1122
- "apimethod" : "com.zoho.desk.helpcenter.community.reports.CommunityReportService.getTopContributors"
1123
- }
1124
- }
1125
- },
1126
- "/api/v1/communityTopics/{topicId}/replies/{replyId}/attachments/{attachmentId}/content" : {
1127
- "get" : {
1128
- "tags" : [ "Community" ],
1129
- "summary" : "Get community topic reply attachment",
1130
- "description" : "This API fetches a file attachment from a reply to a topic comment.",
1131
- "operationId" : "getCommunityTopicReplyAttachment",
1132
- "parameters" : [ {
1133
- "$ref" : "#/components/parameters/topicId"
1134
- }, {
1135
- "name" : "replyId",
1136
- "in" : "path",
1137
- "required" : true,
1138
- "style" : "simple",
1139
- "explode" : false,
1140
- "schema" : {
1141
- "type" : [ "string", "null", "integer" ],
1142
- "format" : "int64",
1143
- "pattern" : "([0-9]+)"
1144
- }
1145
- }, {
1146
- "$ref" : "#/components/parameters/attachmentId"
1147
- }, {
1148
- "$ref" : "../common/Common.json#/components/parameters/orgId"
1149
- } ],
1150
- "responses" : {
1151
- "200" : {
1152
- "$ref" : "../common/Common.json#/components/responses/fileResponse"
1153
- }
1154
- },
1155
- "security" : [ {
1156
- "org-oauth" : [ "Desk.accessAll.ALL" ]
1157
- }, {
1158
- "iam-oauth2-schema" : [ "Desk.forums.READ", "Desk.community.READ" ]
1159
- } ],
1160
- "x-audience" : [ "external-public" ],
1161
- "x-custom-url-attribute" : {
1162
- "security" : {
1163
- "throttle" : {
1164
- "inline" : [ {
1165
- "scope" : "APPSERVER",
1166
- "rules" : [ {
1167
- "duration" : 60000,
1168
- "lock-period" : 600000,
1169
- "threshold" : 50,
1170
- "hip" : false
1171
- } ],
1172
- "window" : "ROLLING",
1173
- "key" : "url.path+user.zuid"
1174
- } ]
1175
- },
1176
- "extraparams" : {
1177
- "disable" : true,
1178
- "ignore" : false
1179
- },
1180
- "authentication" : { }
1181
- },
1182
- "clan-group" : "helpCenter",
1183
- "apihash" : "71ba0d7e250f1e9830be6c658985ac86",
1184
- "module-group" : "community",
1185
- "apimethod" : "com.zoho.desk.helpcenter.community.attachments.AttachmentRestService.downloadReplyAttachment"
1186
- }
1187
- }
1188
- },
1189
- "/api/v1/communityTopics/{topicId}/lock" : {
1190
- "post" : {
1191
- "tags" : [ "Community" ],
1192
- "summary" : "Lock community topic",
1193
- "description" : "This API helps lock a forum topic, so that further user actions are restricted.",
1194
- "operationId" : "lockCommunityTopic",
1195
- "parameters" : [ {
1196
- "$ref" : "#/components/parameters/topicId"
1197
- }, {
1198
- "$ref" : "../common/Common.json#/components/parameters/orgId"
1199
- } ],
1200
- "responses" : {
1201
- "204" : {
1202
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
1203
- }
1204
- },
1205
- "security" : [ {
1206
- "org-oauth" : [ "Desk.accessAll.ALL" ]
1207
- }, {
1208
- "iam-oauth2-schema" : [ "Desk.forums.UPDATE", "Desk.community.UPDATE" ]
1209
- } ],
1210
- "x-audience" : [ "external-public" ],
1211
- "x-custom-url-attribute" : {
1212
- "security" : {
1213
- "throttle" : {
1214
- "inline" : [ {
1215
- "scope" : "APPSERVER",
1216
- "rules" : [ {
1217
- "duration" : 60000,
1218
- "lock-period" : 600000,
1219
- "threshold" : 50,
1220
- "hip" : false
1221
- } ],
1222
- "window" : "ROLLING",
1223
- "key" : "url.path+user.zuid"
1224
- } ]
1225
- },
1226
- "extraparams" : {
1227
- "disable" : true,
1228
- "ignore" : false
1229
- },
1230
- "authentication" : { }
1231
- },
1232
- "clan-group" : "helpCenter",
1233
- "apihash" : "1d7a2b780de3ad0c1d8b557c2c13e835",
1234
- "module-group" : "community",
1235
- "apimethod" : "com.zoho.desk.helpcenter.community.posts.TopicRestService.lockTopic"
1236
- }
1237
- }
1238
- },
1239
- "/api/v1/communityTopics/{topicId}/comments/{commentId}/attachments/{attachmentId}/content" : {
1240
- "get" : {
1241
- "tags" : [ "Community" ],
1242
- "summary" : "Get community topic comment attachment",
1243
- "description" : "This API fetches a file attachment from a topic comment.",
1244
- "operationId" : "getCommunityTopicCommentAttachment",
1245
- "parameters" : [ {
1246
- "$ref" : "#/components/parameters/topicId"
1247
- }, {
1248
- "name" : "commentId",
1249
- "in" : "path",
1250
- "required" : true,
1251
- "style" : "simple",
1252
- "explode" : false,
1253
- "schema" : {
1254
- "type" : [ "string", "null", "integer" ],
1255
- "format" : "int64",
1256
- "pattern" : "([0-9]+)"
1257
- }
1258
- }, {
1259
- "$ref" : "#/components/parameters/attachmentId"
1260
- }, {
1261
- "$ref" : "../common/Common.json#/components/parameters/orgId"
1262
- } ],
1263
- "responses" : {
1264
- "200" : {
1265
- "$ref" : "../common/Common.json#/components/responses/fileResponse"
1266
- }
1267
- },
1268
- "security" : [ {
1269
- "org-oauth" : [ "Desk.accessAll.ALL" ]
1270
- }, {
1271
- "iam-oauth2-schema" : [ "Desk.forums.READ", "Desk.community.READ" ]
1272
- } ],
1273
- "x-audience" : [ "external-public" ],
1274
- "x-custom-url-attribute" : {
1275
- "security" : {
1276
- "throttle" : {
1277
- "inline" : [ {
1278
- "scope" : "APPSERVER",
1279
- "rules" : [ {
1280
- "duration" : 60000,
1281
- "lock-period" : 600000,
1282
- "threshold" : 50,
1283
- "hip" : false
1284
- } ],
1285
- "window" : "ROLLING",
1286
- "key" : "url.path+user.zuid"
1287
- } ]
1288
- },
1289
- "extraparams" : {
1290
- "disable" : true,
1291
- "ignore" : false
1292
- },
1293
- "authentication" : { }
1294
- },
1295
- "clan-group" : "helpCenter",
1296
- "apihash" : "b79df3394032606734ec9d475d0b12d3",
1297
- "module-group" : "community",
1298
- "apimethod" : "com.zoho.desk.helpcenter.community.attachments.AttachmentRestService.downloadCommentAttachment"
1299
- }
1300
- }
1301
- },
1302
- "/api/v1/communityUsers/{communityUserId}/topicResponseTrend" : {
1303
- "get" : {
1304
- "tags" : [ "Community" ],
1305
- "summary" : "Get responsiveness trend of user",
1306
- "description" : "This API displays the trend related to an user's responsiveness in the user community.",
1307
- "operationId" : "getTopicResponseTrendOfUser",
1308
- "parameters" : [ {
1309
- "$ref" : "#/components/parameters/startTime"
1310
- }, {
1311
- "$ref" : "#/components/parameters/endTime"
1312
- }, {
1313
- "$ref" : "#/components/parameters/categoryId"
1314
- }, {
1315
- "$ref" : "#/components/parameters/topicType"
1316
- }, {
1317
- "$ref" : "#/components/parameters/communityUserId"
1318
- }, {
1319
- "$ref" : "../common/Common.json#/components/parameters/orgId"
1320
- } ],
1321
- "responses" : {
1322
- "422" : {
1323
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
1324
- },
1325
- "200" : {
1326
- "$ref" : "#/components/responses/getTopicResponseTrend"
1327
- }
1328
- },
1329
- "security" : [ {
1330
- "org-oauth" : [ "Desk.accessAll.ALL" ]
1331
- }, {
1332
- "iam-oauth2-schema" : [ "Desk.forums.READ" ]
1333
- } ],
1334
- "x-audience" : [ "company-internal" ],
1335
- "x-custom-url-attribute" : {
1336
- "security" : {
1337
- "throttle" : {
1338
- "inline" : [ {
1339
- "scope" : "APPSERVER",
1340
- "rules" : [ {
1341
- "duration" : 60000,
1342
- "lock-period" : 300000,
1343
- "threshold" : 50,
1344
- "hip" : false
1345
- } ],
1346
- "window" : "ROLLING",
1347
- "key" : "url.path+user.zuid"
1348
- } ]
1349
- },
1350
- "extraparams" : {
1351
- "disable" : true,
1352
- "ignore" : false
1353
- },
1354
- "authentication" : { }
1355
- },
1356
- "clan-group" : "helpCenter",
1357
- "apihash" : "a1dd8984adaa36049d4ca24adbe16c31",
1358
- "module-group" : "community",
1359
- "apimethod" : "com.zoho.desk.helpcenter.community.reports.CommunityReportService.getTopicResponseTrendOfUser"
1360
- }
1361
- }
1362
- },
1363
- "/api/v1/community/approveAllAwaitingComments" : {
1364
- "post" : {
1365
- "tags" : [ "Community" ],
1366
- "summary" : "Approve all comments pending moderation",
1367
- "description" : "This API approves all comments that are pending moderation in the user community.",
1368
- "operationId" : "scheduleBulkApprovalOfAwaitingComments",
1369
- "parameters" : [ {
1370
- "$ref" : "../common/Common.json#/components/parameters/orgId"
1371
- } ],
1372
- "requestBody" : {
1373
- "$ref" : "#/components/requestBodies/scheduleBulkApprovalOfAwaitingComments_scheduleBulkApprovalOfAwaitingTopicsRequest"
1374
- },
1375
- "responses" : {
1376
- "422" : {
1377
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
1378
- },
1379
- "200" : {
1380
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
1381
- }
1382
- },
1383
- "security" : [ {
1384
- "org-oauth" : [ "Desk.accessAll.ALL" ]
1385
- }, {
1386
- "iam-oauth2-schema" : [ "Desk.forums.UPDATE", "Desk.community.UPDATE" ]
1387
- } ],
1388
- "x-audience" : [ "company-internal" ],
1389
- "x-custom-url-attribute" : {
1390
- "security" : {
1391
- "throttle" : {
1392
- "inline" : [ {
1393
- "scope" : "APPSERVER",
1394
- "rules" : [ {
1395
- "duration" : 60000,
1396
- "lock-period" : 300000,
1397
- "threshold" : 20,
1398
- "hip" : false
1399
- } ],
1400
- "window" : "ROLLING",
1401
- "key" : "url.path+user.zuid"
1402
- } ]
1403
- },
1404
- "extraparams" : {
1405
- "disable" : true,
1406
- "ignore" : false
1407
- },
1408
- "authentication" : { }
1409
- },
1410
- "clan-group" : "helpCenter",
1411
- "apihash" : "7e3928f6af2c17c3c537a5bd7d978fb8",
1412
- "module-group" : "community",
1413
- "apimethod" : "com.zoho.desk.helpcenter.community.moderation.ModerationService.scheduleBulkApprovalOfAwaitingComments"
1414
- }
1415
- }
1416
- },
1417
- "/api/v1/community/approveAllAwaitingTopics" : {
1418
- "post" : {
1419
- "tags" : [ "Community" ],
1420
- "summary" : "Approve all topics pending moderation",
1421
- "description" : "This API approves all topics that are pending moderation in the user community.",
1422
- "operationId" : "scheduleBulkApprovalOfAwaitingTopics",
1423
- "parameters" : [ {
1424
- "$ref" : "../common/Common.json#/components/parameters/orgId"
1425
- } ],
1426
- "requestBody" : {
1427
- "$ref" : "#/components/requestBodies/scheduleBulkApprovalOfAwaitingTopics_scheduleBulkApprovalOfAwaitingTopicsRequest"
1428
- },
1429
- "responses" : {
1430
- "422" : {
1431
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
1432
- },
1433
- "200" : {
1434
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
1435
- }
1436
- },
1437
- "security" : [ {
1438
- "org-oauth" : [ "Desk.accessAll.ALL" ]
1439
- }, {
1440
- "iam-oauth2-schema" : [ "Desk.forums.UPDATE", "Desk.community.UPDATE" ]
1441
- } ],
1442
- "x-audience" : [ "company-internal" ],
1443
- "x-custom-url-attribute" : {
1444
- "security" : {
1445
- "throttle" : {
1446
- "inline" : [ {
1447
- "scope" : "APPSERVER",
1448
- "rules" : [ {
1449
- "duration" : 60000,
1450
- "lock-period" : 300000,
1451
- "threshold" : 15,
1452
- "hip" : false
1453
- } ],
1454
- "window" : "ROLLING",
1455
- "key" : "url.path+user.zuid"
1456
- } ]
1457
- },
1458
- "extraparams" : {
1459
- "disable" : true,
1460
- "ignore" : false
1461
- },
1462
- "authentication" : { }
1463
- },
1464
- "clan-group" : "helpCenter",
1465
- "apihash" : "c8822ba67f826aabdfbdec57a60b7fdf",
1466
- "module-group" : "community",
1467
- "apimethod" : "com.zoho.desk.helpcenter.community.moderation.ModerationService.scheduleBulkApprovalOfAwaitingTopics"
1468
- }
1469
- }
1470
- }
1471
- },
1472
- "components" : {
1473
- "schemas" : {
1474
- "topicsCount" : {
1475
- "type" : [ "null", "object" ],
1476
- "additionalProperties" : false,
1477
- "properties" : {
1478
- "ANNOUNCEMENT" : {
1479
- "type" : [ "string", "null", "integer" ],
1480
- "format" : "int32",
1481
- "pattern" : "([0-9]+)"
1482
- },
1483
- "DISCUSSION" : {
1484
- "type" : [ "string", "null", "integer" ],
1485
- "format" : "int32",
1486
- "pattern" : "([0-9]+)"
1487
- },
1488
- "IDEA" : {
1489
- "type" : [ "string", "null", "integer" ],
1490
- "format" : "int32",
1491
- "pattern" : "([0-9]+)"
1492
- },
1493
- "PROBLEM" : {
1494
- "type" : [ "string", "null", "integer" ],
1495
- "format" : "int32",
1496
- "pattern" : "([0-9]+)"
1497
- },
1498
- "QUESTION" : {
1499
- "type" : [ "string", "null", "integer" ],
1500
- "format" : "int32",
1501
- "pattern" : "([0-9]+)"
1502
- }
1503
- },
1504
- "required" : [ "ANNOUNCEMENT", "DISCUSSION", "IDEA", "PROBLEM", "QUESTION" ]
1505
- },
1506
- "trendDetails" : {
1507
- "type" : [ "null", "object" ],
1508
- "additionalProperties" : false,
1509
- "properties" : {
1510
- "date" : {
1511
- "type" : [ "string", "null" ],
1512
- "maxLength" : 100,
1513
- "minLength" : 0
1514
- },
1515
- "count" : {
1516
- "type" : [ "string", "null", "integer" ],
1517
- "format" : "int64",
1518
- "pattern" : "([0-9]+)"
1519
- }
1520
- },
1521
- "required" : [ "count", "date" ]
1522
- },
1523
- "commentsArr" : {
1524
- "type" : [ "null", "array" ],
1525
- "items" : {
1526
- "$ref" : "./Community.json#/components/schemas/trendDetails"
1527
- }
1528
- },
1529
- "labelWiseTopicsCount_question" : {
1530
- "type" : [ "null", "object" ],
1531
- "additionalProperties" : false,
1532
- "properties" : {
1533
- "ANSWERED" : {
1534
- "type" : [ "string", "null", "integer" ],
1535
- "format" : "int32",
1536
- "pattern" : "([0-9]+)"
1537
- },
1538
- "NEEDMOREINFO" : {
1539
- "type" : [ "string", "null", "integer" ],
1540
- "format" : "int32",
1541
- "pattern" : "([0-9]+)"
1542
- },
1543
- "NOSTATUS" : {
1544
- "type" : [ "string", "null", "integer" ],
1545
- "format" : "int32",
1546
- "pattern" : "([0-9]+)"
1547
- },
1548
- "UNANSWERED" : {
1549
- "type" : [ "string", "null", "integer" ],
1550
- "format" : "int32",
1551
- "pattern" : "([0-9]+)"
1552
- },
1553
- "WORKINGONIT" : {
1554
- "type" : [ "string", "null", "integer" ],
1555
- "format" : "int32",
1556
- "pattern" : "([0-9]+)"
1557
- }
1558
- },
1559
- "required" : [ "ANSWERED", "NEEDMOREINFO", "NOSTATUS", "UNANSWERED", "WORKINGONIT" ]
1560
- },
1561
- "labelWiseTopicsCount_idea" : {
1562
- "type" : [ "null", "object" ],
1563
- "additionalProperties" : false,
1564
- "properties" : {
1565
- "MAYBELATER" : {
1566
- "type" : [ "string", "null", "integer" ],
1567
- "format" : "int32",
1568
- "pattern" : "([0-9]+)"
1569
- },
1570
- "NOSTATUS" : {
1571
- "type" : [ "string", "null", "integer" ],
1572
- "format" : "int32",
1573
- "pattern" : "([0-9]+)"
1574
- },
1575
- "IMPLEMENTED" : {
1576
- "type" : [ "string", "null", "integer" ],
1577
- "format" : "int32",
1578
- "pattern" : "([0-9]+)"
1579
- },
1580
- "WILLNOTIMPLEMENT" : {
1581
- "type" : [ "string", "null", "integer" ],
1582
- "format" : "int32",
1583
- "pattern" : "([0-9]+)"
1584
- },
1585
- "WORKINGONIT" : {
1586
- "type" : [ "string", "null", "integer" ],
1587
- "format" : "int32",
1588
- "pattern" : "([0-9]+)"
1589
- },
1590
- "UNDERREVIEW" : {
1591
- "type" : [ "string", "null", "integer" ],
1592
- "format" : "int32",
1593
- "pattern" : "([0-9]+)"
1594
- }
1595
- },
1596
- "required" : [ "IMPLEMENTED", "MAYBELATER", "NOSTATUS", "UNDERREVIEW", "WILLNOTIMPLEMENT", "WORKINGONIT" ]
1597
- },
1598
- "labelWiseTopicsCount_problem" : {
1599
- "type" : [ "null", "object" ],
1600
- "additionalProperties" : false,
1601
- "properties" : {
1602
- "NOTAPROBLEM" : {
1603
- "type" : [ "string", "null", "integer" ],
1604
- "format" : "int32",
1605
- "pattern" : "([0-9]+)"
1606
- },
1607
- "UNSOLVED" : {
1608
- "type" : [ "string", "null", "integer" ],
1609
- "format" : "int32",
1610
- "pattern" : "([0-9]+)"
1611
- },
1612
- "ANALYZING" : {
1613
- "type" : [ "string", "null", "integer" ],
1614
- "format" : "int32",
1615
- "pattern" : "([0-9]+)"
1616
- },
1617
- "TEMPORARYFIX" : {
1618
- "type" : [ "string", "null", "integer" ],
1619
- "format" : "int32",
1620
- "pattern" : "([0-9]+)"
1621
- },
1622
- "NEEDMOREINFO" : {
1623
- "type" : [ "string", "null", "integer" ],
1624
- "format" : "int32",
1625
- "pattern" : "([0-9]+)"
1626
- },
1627
- "SOLVED" : {
1628
- "type" : [ "string", "null", "integer" ],
1629
- "format" : "int32",
1630
- "pattern" : "([0-9]+)"
1631
- },
1632
- "NOSTATUS" : {
1633
- "type" : [ "string", "null", "integer" ],
1634
- "format" : "int32",
1635
- "pattern" : "([0-9]+)"
1636
- },
1637
- "WORKINGONIT" : {
1638
- "type" : [ "string", "null", "integer" ],
1639
- "format" : "int32",
1640
- "pattern" : "([0-9]+)"
1641
- }
1642
- },
1643
- "required" : [ "ANALYZING", "NEEDMOREINFO", "NOSTATUS", "NOTAPROBLEM", "SOLVED", "TEMPORARYFIX", "UNSOLVED", "WORKINGONIT" ]
1644
- },
1645
- "labelWiseTopicsCount_announcementAndDiscussions" : {
1646
- "type" : [ "null", "object" ],
1647
- "additionalProperties" : false,
1648
- "properties" : {
1649
- "NOSTATUS" : {
1650
- "type" : [ "string", "null", "integer" ],
1651
- "format" : "int32",
1652
- "pattern" : "([0-9]+)"
1653
- }
1654
- },
1655
- "required" : [ "NOSTATUS" ]
1656
- },
1657
- "getTopicResponsivenessObj" : {
1658
- "type" : [ "null", "object" ],
1659
- "additionalProperties" : false,
1660
- "properties" : {
1661
- "repliedTopicsCount" : {
1662
- "type" : [ "string", "null", "integer" ],
1663
- "format" : "int32",
1664
- "pattern" : "([0-9]+)"
1665
- },
1666
- "unrepliedTopicsCount" : {
1667
- "type" : [ "string", "null", "integer" ],
1668
- "format" : "int32",
1669
- "pattern" : "([0-9]+)"
1670
- }
1671
- },
1672
- "required" : [ "repliedTopicsCount", "unrepliedTopicsCount" ]
1673
- },
1674
- "getTopContributorsObj" : {
1675
- "type" : [ "null", "object" ],
1676
- "additionalProperties" : false,
1677
- "properties" : {
1678
- "photoUrl" : {
1679
- "type" : [ "string", "null" ],
1680
- "maxLength" : 400,
1681
- "minLength" : 0,
1682
- "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
1683
- },
1684
- "contactId" : {
1685
- "type" : [ "string", "null", "integer" ],
1686
- "format" : "int64",
1687
- "pattern" : "([0-9]+)"
1688
- },
1689
- "name" : {
1690
- "type" : [ "string", "null" ],
1691
- "maxLength" : 200,
1692
- "minLength" : 0,
1693
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1694
- },
1695
- "id" : {
1696
- "type" : [ "string", "null", "integer" ],
1697
- "format" : "int64",
1698
- "pattern" : "([0-9]+)"
1699
- },
1700
- "label" : {
1701
- "$ref" : "./Label.json#/components/schemas/labelMetaResponse"
1702
- },
1703
- "type" : {
1704
- "type" : [ "string", "null" ],
1705
- "enum" : [ "END_USER", "AGENT" ],
1706
- "maxLength" : 100,
1707
- "minLength" : 0
1708
- },
1709
- "email" : {
1710
- "type" : [ "string", "null" ],
1711
- "maxLength" : 100,
1712
- "minLength" : 0,
1713
- "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$"
1714
- }
1715
- },
1716
- "required" : [ "contactId", "email", "id", "label", "name", "photoUrl", "type" ]
1717
- }
1718
- },
1719
- "responses" : {
1720
- "getStats" : {
1721
- "description" : "getStats template definitions",
1722
- "content" : {
1723
- "application/json" : {
1724
- "schema" : {
1725
- "type" : [ "null", "object" ],
1726
- "additionalProperties" : false,
1727
- "properties" : {
1728
- "uniqueUsersCount" : {
1729
- "type" : [ "string", "null", "integer" ],
1730
- "format" : "int32",
1731
- "pattern" : "([0-9]+)"
1732
- },
1733
- "topicsCount" : {
1734
- "$ref" : "./Community.json#/components/schemas/topicsCount"
1735
- },
1736
- "commentsCount" : {
1737
- "type" : [ "string", "null", "integer" ],
1738
- "format" : "int32",
1739
- "pattern" : "([0-9]+)"
1740
- }
1741
- },
1742
- "required" : [ "commentsCount", "topicsCount", "uniqueUsersCount" ]
1743
- },
1744
- "examples" : {
1745
- "Valid responses Definitions" : {
1746
- "value" : {
1747
- "uniqueUsersCount" : "2",
1748
- "topicsCount" : {
1749
- "ANNOUNCEMENT" : "0",
1750
- "DISCUSSION" : "0",
1751
- "IDEA" : "0",
1752
- "PROBLEM" : "1",
1753
- "QUESTION" : "23"
1754
- },
1755
- "commentsCount" : "21"
1756
- }
1757
- }
1758
- }
1759
- }
1760
- },
1761
- "x-custom-response-attributes" : {
1762
- "disable-safe-headers" : "[]"
1763
- }
1764
- },
1765
- "getTopicResponseTrend" : {
1766
- "description" : "getTopicResponseTrend template definitions",
1767
- "content" : {
1768
- "application/json" : {
1769
- "schema" : {
1770
- "type" : [ "null", "object" ],
1771
- "additionalProperties" : false,
1772
- "properties" : {
1773
- "comments" : {
1774
- "$ref" : "./Community.json#/components/schemas/commentsArr"
1775
- },
1776
- "topics" : {
1777
- "$ref" : "./Community.json#/components/schemas/commentsArr"
1778
- }
1779
- },
1780
- "required" : [ "comments", "topics" ]
1781
- },
1782
- "examples" : {
1783
- "Valid responses Definitions" : {
1784
- "value" : {
1785
- "comments" : [ {
1786
- "date" : "2-Feb-2017",
1787
- "count" : "2"
1788
- }, {
1789
- "date" : "3-Feb-2017",
1790
- "count" : "3"
1791
- }, {
1792
- "date" : "4-Feb-2017",
1793
- "count" : "5"
1794
- }, {
1795
- "date" : "5-Feb-2017",
1796
- "count" : "8"
1797
- } ],
1798
- "topics" : [ {
1799
- "date" : "2-Feb-2017",
1800
- "count" : "2"
1801
- }, {
1802
- "date" : "3-Feb-2017",
1803
- "count" : "3"
1804
- }, {
1805
- "date" : "4-Feb-2017",
1806
- "count" : "5"
1807
- }, {
1808
- "date" : "5-Feb-2017",
1809
- "count" : "8"
1810
- } ]
1811
- }
1812
- }
1813
- }
1814
- }
1815
- },
1816
- "x-custom-response-attributes" : {
1817
- "disable-safe-headers" : "[]"
1818
- }
1819
- },
1820
- "getTopicTypeResponsivenessResponse" : {
1821
- "description" : "getTopicTypeResponsivenessResponse template definitions",
1822
- "content" : {
1823
- "application/json" : {
1824
- "schema" : {
1825
- "oneOf" : [ {
1826
- "type" : [ "null", "object" ],
1827
- "additionalProperties" : false,
1828
- "properties" : {
1829
- "labelWiseTopicsCount" : {
1830
- "$ref" : "./Community.json#/components/schemas/labelWiseTopicsCount_question"
1831
- }
1832
- },
1833
- "required" : [ "labelWiseTopicsCount" ]
1834
- }, {
1835
- "type" : [ "null", "object" ],
1836
- "additionalProperties" : false,
1837
- "properties" : {
1838
- "labelWiseTopicsCount" : {
1839
- "$ref" : "./Community.json#/components/schemas/labelWiseTopicsCount_idea"
1840
- }
1841
- },
1842
- "required" : [ "labelWiseTopicsCount" ]
1843
- }, {
1844
- "type" : [ "null", "object" ],
1845
- "additionalProperties" : false,
1846
- "properties" : {
1847
- "labelWiseTopicsCount" : {
1848
- "$ref" : "./Community.json#/components/schemas/labelWiseTopicsCount_problem"
1849
- }
1850
- },
1851
- "required" : [ "labelWiseTopicsCount" ]
1852
- }, {
1853
- "type" : [ "null", "object" ],
1854
- "additionalProperties" : false,
1855
- "properties" : {
1856
- "labelWiseTopicsCount" : {
1857
- "$ref" : "./Community.json#/components/schemas/labelWiseTopicsCount_announcementAndDiscussions"
1858
- }
1859
- },
1860
- "required" : [ "labelWiseTopicsCount" ]
1861
- } ]
1862
- },
1863
- "examples" : {
1864
- "Valid responses Definitions" : {
1865
- "value" : {
1866
- "labelWiseTopicsCount" : {
1867
- "ANSWERED" : "0",
1868
- "NEEDMOREINFO" : "1",
1869
- "NOSTATUS" : "22",
1870
- "WORKINGONIT" : "0"
1871
- }
1872
- }
1873
- }
1874
- }
1875
- }
1876
- },
1877
- "x-custom-response-attributes" : {
1878
- "disable-safe-headers" : "[]"
1879
- }
1880
- },
1881
- "getTopicResponsiveness" : {
1882
- "description" : "getTopicResponsiveness template definitions",
1883
- "content" : {
1884
- "application/json" : {
1885
- "schema" : {
1886
- "type" : [ "null", "object" ],
1887
- "additionalProperties" : false,
1888
- "properties" : {
1889
- "topicResponsiveness" : {
1890
- "$ref" : "./Community.json#/components/schemas/getTopicResponsivenessObj"
1891
- }
1892
- },
1893
- "required" : [ "topicResponsiveness" ]
1894
- },
1895
- "examples" : {
1896
- "Valid responses Definitions" : {
1897
- "value" : {
1898
- "topicResponsiveness" : {
1899
- "repliedTopicsCount" : "3",
1900
- "unrepliedTopicsCount" : "21"
1901
- }
1902
- }
1903
- }
1904
- }
1905
- }
1906
- },
1907
- "x-custom-response-attributes" : {
1908
- "disable-safe-headers" : "[]"
1909
- }
1910
- },
1911
- "getUniqueUserParticipationTrend" : {
1912
- "description" : "getUniqueUserParticipationTrend template definitions",
1913
- "content" : {
1914
- "application/json" : {
1915
- "schema" : {
1916
- "type" : [ "null", "object" ],
1917
- "additionalProperties" : false,
1918
- "properties" : {
1919
- "uniqueUsersParticipation" : {
1920
- "$ref" : "./Community.json#/components/schemas/commentsArr"
1921
- }
1922
- },
1923
- "required" : [ "uniqueUsersParticipation" ]
1924
- },
1925
- "examples" : {
1926
- "Valid responses Definitions" : {
1927
- "value" : {
1928
- "uniqueUsersParticipation" : [ {
1929
- "date" : "2-Feb-2017",
1930
- "count" : "2"
1931
- }, {
1932
- "date" : "3-Feb-2017",
1933
- "count" : "3"
1934
- }, {
1935
- "date" : "4-Feb-2017",
1936
- "count" : "5"
1937
- }, {
1938
- "date" : "5-Feb-2017",
1939
- "count" : "8"
1940
- } ]
1941
- }
1942
- }
1943
- }
1944
- }
1945
- },
1946
- "x-custom-response-attributes" : {
1947
- "disable-safe-headers" : "[]"
1948
- }
1949
- },
1950
- "topicVoterTrendResponse" : {
1951
- "description" : "topicVoterTrendResponse template definitions",
1952
- "content" : {
1953
- "application/json" : {
1954
- "schema" : {
1955
- "type" : [ "null", "object" ],
1956
- "additionalProperties" : false,
1957
- "properties" : {
1958
- "topicVoterTrend" : {
1959
- "$ref" : "./Community.json#/components/schemas/commentsArr"
1960
- }
1961
- },
1962
- "required" : [ "topicVoterTrend" ]
1963
- },
1964
- "examples" : {
1965
- "Valid responses Definitions" : {
1966
- "value" : {
1967
- "topicVoterTrend" : [ {
1968
- "date" : "May-2023",
1969
- "count" : "0"
1970
- }, {
1971
- "date" : "Jun-2023",
1972
- "count" : "0"
1973
- }, {
1974
- "date" : "Jul-2023",
1975
- "count" : "0"
1976
- }, {
1977
- "date" : "Aug-2023",
1978
- "count" : "0"
1979
- }, {
1980
- "date" : "Sep-2023",
1981
- "count" : "1"
1982
- } ]
1983
- }
1984
- }
1985
- }
1986
- }
1987
- },
1988
- "x-custom-response-attributes" : {
1989
- "disable-safe-headers" : "[]"
1990
- }
1991
- },
1992
- "getStatsOfUser" : {
1993
- "description" : "getStatsOfUser template definitions",
1994
- "content" : {
1995
- "application/json" : {
1996
- "schema" : {
1997
- "type" : [ "null", "object" ],
1998
- "additionalProperties" : false,
1999
- "properties" : {
2000
- "postCount" : {
2001
- "type" : [ "string", "null", "integer" ],
2002
- "format" : "int32",
2003
- "pattern" : "([0-9]+)"
2004
- },
2005
- "responseCount" : {
2006
- "type" : [ "string", "null", "integer" ],
2007
- "format" : "int32",
2008
- "pattern" : "([0-9]+)"
2009
- },
2010
- "followersCount" : {
2011
- "type" : [ "string", "null", "integer" ],
2012
- "format" : "int32",
2013
- "pattern" : "([0-9]+)"
2014
- }
2015
- },
2016
- "required" : [ "followersCount", "postCount", "responseCount" ]
2017
- },
2018
- "examples" : {
2019
- "Valid responses Definitions" : {
2020
- "value" : {
2021
- "postCount" : "8",
2022
- "responseCount" : "8",
2023
- "followersCount" : "0"
2024
- }
2025
- }
2026
- }
2027
- }
2028
- },
2029
- "x-custom-response-attributes" : {
2030
- "disable-safe-headers" : "[]"
2031
- }
2032
- },
2033
- "getTopContributors" : {
2034
- "description" : "getTopContributors template definitions",
2035
- "content" : {
2036
- "application/json" : {
2037
- "schema" : {
2038
- "type" : [ "null", "array" ],
2039
- "items" : {
2040
- "$ref" : "./Community.json#/components/schemas/getTopContributorsObj"
2041
- }
2042
- },
2043
- "examples" : {
2044
- "Valid responses Definitions" : {
2045
- "value" : [ {
2046
- "photoUrl" : "https://desk.zoho.com/api/v1/portalUser/1000000022025/photo?orgId=1234567",
2047
- "name" : "User 1",
2048
- "id" : "1000000022025",
2049
- "label" : {
2050
- "preferences" : {
2051
- "shape" : "RECTANGLE",
2052
- "bgColor" : "#23F123",
2053
- "textColor" : "#2CA123"
2054
- },
2055
- "name" : "Admin",
2056
- "id" : "6000000158001",
2057
- "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
2058
- },
2059
- "email" : "user1@zylker.com"
2060
- }, {
2061
- "photoUrl" : "https://desk.zoho.com/api/v1/agents/1000000012792/photo?orgId=1234567",
2062
- "name" : "User 2",
2063
- "id" : "1000000012792",
2064
- "label" : {
2065
- "preferences" : {
2066
- "shape" : "RECTANGLE",
2067
- "bgColor" : "#23F123",
2068
- "textColor" : "#2CA123"
2069
- },
2070
- "name" : "Admin",
2071
- "id" : "6000000158001",
2072
- "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
2073
- },
2074
- "email" : "user2@zylker.com"
2075
- } ]
2076
- }
2077
- }
2078
- }
2079
- },
2080
- "x-custom-response-attributes" : {
2081
- "disable-safe-headers" : "[]"
2082
- }
2083
- },
2084
- "getTopicTypeTrendResponse" : {
2085
- "description" : "getTopicTypeTrendResponse Response definitions",
2086
- "content" : {
2087
- "application/json" : {
2088
- "schema" : {
2089
- "type" : "object",
2090
- "patternProperties" : {
2091
- "DISCUSSION|IDEA|PROBLEM|QUESTION|ANNOUNCEMENT" : {
2092
- "type" : [ "array", "null" ],
2093
- "items" : {
2094
- "$ref" : "./Community.json#/components/schemas/trendDetails"
2095
- }
2096
- }
2097
- }
2098
- }
2099
- }
2100
- }
2101
- }
2102
- },
2103
- "parameters" : {
2104
- "categoryIds" : {
2105
- "name" : "categoryIds",
2106
- "in" : "query",
2107
- "description" : "IDs of the community categories that must be included. This value can also be empty",
2108
- "required" : false,
2109
- "style" : "simple",
2110
- "explode" : true,
2111
- "schema" : {
2112
- "type" : [ "string", "null", "integer" ],
2113
- "format" : "int64",
2114
- "description" : "IDs of the community categories that must be included. This value can also be empty",
2115
- "pattern" : "([0-9]+)",
2116
- "x-custom-parameters-attributes" : {
2117
- "split" : ","
2118
- }
2119
- }
2120
- },
2121
- "topicId" : {
2122
- "name" : "topicId",
2123
- "in" : "path",
2124
- "required" : true,
2125
- "style" : "simple",
2126
- "explode" : false,
2127
- "schema" : {
2128
- "type" : [ "string", "null", "integer" ],
2129
- "format" : "int64",
2130
- "pattern" : "([0-9]+)"
2131
- }
2132
- },
2133
- "startTime" : {
2134
- "name" : "startTime",
2135
- "in" : "query",
2136
- "description" : "Starting time of the time range for which the statistics should be fetched. The value must be expressed according to the GMT time zone.",
2137
- "required" : true,
2138
- "style" : "form",
2139
- "explode" : true,
2140
- "schema" : {
2141
- "type" : [ "string", "null" ],
2142
- "description" : "Starting time of the time range for which the statistics should be fetched. The value must be expressed according to the GMT time zone.",
2143
- "maxLength" : 100,
2144
- "minLength" : 0,
2145
- "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))"
2146
- }
2147
- },
2148
- "endTime" : {
2149
- "name" : "endTime",
2150
- "in" : "query",
2151
- "description" : "Ending time of the time range for which the statistics should be fetched. The value must be expressed according to the GMT time zone.",
2152
- "required" : true,
2153
- "style" : "form",
2154
- "explode" : true,
2155
- "schema" : {
2156
- "type" : [ "string", "null" ],
2157
- "description" : "Ending time of the time range for which the statistics should be fetched. The value must be expressed according to the GMT time zone.",
2158
- "maxLength" : 100,
2159
- "minLength" : 0,
2160
- "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))"
2161
- }
2162
- },
2163
- "attachmentId" : {
2164
- "name" : "attachmentId",
2165
- "in" : "path",
2166
- "required" : true,
2167
- "style" : "simple",
2168
- "explode" : false,
2169
- "schema" : {
2170
- "type" : [ "string", "null", "integer" ],
2171
- "format" : "int64",
2172
- "pattern" : "([0-9]+)"
2173
- }
2174
- },
2175
- "communityUserId" : {
2176
- "name" : "communityUserId",
2177
- "in" : "path",
2178
- "required" : true,
2179
- "style" : "simple",
2180
- "explode" : false,
2181
- "schema" : {
2182
- "type" : [ "string", "null", "integer" ],
2183
- "format" : "int64",
2184
- "pattern" : "([0-9]+)"
2185
- }
2186
- },
2187
- "categoryId" : {
2188
- "name" : "categoryId",
2189
- "in" : "query",
2190
- "description" : "IDs of the community categories that must be included. This value can also be empty.",
2191
- "required" : false,
2192
- "style" : "form",
2193
- "explode" : true,
2194
- "schema" : {
2195
- "type" : [ "string", "null", "integer" ],
2196
- "format" : "int64",
2197
- "description" : "IDs of the community categories that must be included. This value can also be empty.",
2198
- "pattern" : "([0-9]+)"
2199
- }
2200
- },
2201
- "topicType" : {
2202
- "name" : "topicType",
2203
- "in" : "query",
2204
- "description" : "Topic type for which the trend must be generated. Values allowed are: @ANNOUNCEMENT@, @DISCUSSION@, @IDEA@, @PROBLEM@, and @QUESTION@. ",
2205
- "required" : false,
2206
- "style" : "form",
2207
- "explode" : true,
2208
- "schema" : {
2209
- "type" : [ "string", "null" ],
2210
- "description" : "Topic type for which the trend must be generated. Values allowed are: @ANNOUNCEMENT@, @DISCUSSION@, @IDEA@, @PROBLEM@, and @QUESTION@. ",
2211
- "enum" : [ "DISCUSSION", "QUESTION", "IDEA", "ANNOUNCEMENT", "PROBLEM" ],
2212
- "maxLength" : 100,
2213
- "minLength" : 0
2214
- }
2215
- },
2216
- "topicType_getTopicTypeResponsiveness" : {
2217
- "name" : "topicType",
2218
- "in" : "query",
2219
- "description" : "Topic type for which the statistics must be fetched. Values allowed are: @ANNOUNCEMENT@, @DISCUSSION@, @IDEA@, @PROBLEM@, and @QUESTION@.",
2220
- "required" : true,
2221
- "style" : "form",
2222
- "explode" : true,
2223
- "schema" : {
2224
- "type" : [ "string", "null" ],
2225
- "description" : "Topic type for which the statistics must be fetched. Values allowed are: @ANNOUNCEMENT@, @DISCUSSION@, @IDEA@, @PROBLEM@, and @QUESTION@.",
2226
- "enum" : [ "DISCUSSION", "QUESTION", "IDEA", "ANNOUNCEMENT", "PROBLEM" ],
2227
- "maxLength" : 100,
2228
- "minLength" : 0
2229
- }
2230
- }
2231
- },
2232
- "requestBodies" : {
2233
- "scheduleTrashAllUserTopicsRequest" : {
2234
- "content" : {
2235
- "application/json" : {
2236
- "schema" : {
2237
- "type" : [ "null", "object" ],
2238
- "additionalProperties" : false,
2239
- "properties" : {
2240
- "categoryId" : {
2241
- "type" : [ "string", "null", "integer" ],
2242
- "format" : "int64",
2243
- "description" : "ID of the community category",
2244
- "pattern" : "([0-9]+)"
2245
- }
2246
- }
2247
- },
2248
- "examples" : {
2249
- "Valid requestBody Definitions" : {
2250
- "value" : {
2251
- "categoryId" : "1000000012755"
2252
- }
2253
- }
2254
- }
2255
- }
2256
- },
2257
- "x-custom-request-body-attributes" : {
2258
- "non-empty" : false,
2259
- "allow-invalid" : false
2260
- }
2261
- },
2262
- "scheduleBulkApprovalOfAwaitingTopicsRequest" : {
2263
- "content" : {
2264
- "application/json" : {
2265
- "schema" : {
2266
- "type" : [ "null", "object" ],
2267
- "additionalProperties" : false,
2268
- "properties" : {
2269
- "categoryId" : {
2270
- "type" : [ "string", "null", "integer" ],
2271
- "format" : "int64",
2272
- "description" : "ID of the community category",
2273
- "pattern" : "([0-9]+)"
2274
- }
2275
- },
2276
- "required" : [ "categoryId" ]
2277
- },
2278
- "examples" : {
2279
- "Valid requestBody Definitions" : {
2280
- "value" : {
2281
- "categoryId" : "1000000012755"
2282
- }
2283
- }
2284
- }
2285
- }
2286
- },
2287
- "x-custom-request-body-attributes" : {
2288
- "non-empty" : false,
2289
- "allow-invalid" : false
2290
- }
2291
- },
2292
- "scheduleBulkApprovalOfSpamComments_scheduleBulkApprovalOfAwaitingTopicsRequest" : {
2293
- "content" : {
2294
- "application/json" : {
2295
- "schema" : {
2296
- "type" : [ "null", "object" ],
2297
- "additionalProperties" : false,
2298
- "properties" : {
2299
- "categoryId" : {
2300
- "type" : [ "string", "null", "integer" ],
2301
- "format" : "int64",
2302
- "description" : "ID of the community category",
2303
- "pattern" : "([0-9]+)"
2304
- }
2305
- },
2306
- "required" : [ "categoryId" ]
2307
- },
2308
- "examples" : {
2309
- "Valid requestBody Definitions" : {
2310
- "value" : {
2311
- "categoryId" : "1000000012755"
2312
- }
2313
- }
2314
- }
2315
- }
2316
- },
2317
- "x-custom-request-body-attributes" : {
2318
- "non-empty" : false,
2319
- "allow-invalid" : false
2320
- }
2321
- },
2322
- "scheduleBulkTrashOfSpamComments_scheduleBulkApprovalOfAwaitingTopicsRequest" : {
2323
- "content" : {
2324
- "application/json" : {
2325
- "schema" : {
2326
- "type" : [ "null", "object" ],
2327
- "additionalProperties" : false,
2328
- "properties" : {
2329
- "categoryId" : {
2330
- "type" : [ "string", "null", "integer" ],
2331
- "format" : "int64",
2332
- "description" : "ID of the community category",
2333
- "pattern" : "([0-9]+)"
2334
- }
2335
- },
2336
- "required" : [ "categoryId" ]
2337
- },
2338
- "examples" : {
2339
- "Valid requestBody Definitions" : {
2340
- "value" : {
2341
- "categoryId" : "1000000012755"
2342
- }
2343
- }
2344
- }
2345
- }
2346
- },
2347
- "x-custom-request-body-attributes" : {
2348
- "non-empty" : false,
2349
- "allow-invalid" : false
2350
- }
2351
- },
2352
- "scheduleBulkTrashOfSpamTopics_scheduleBulkApprovalOfAwaitingTopicsRequest" : {
2353
- "content" : {
2354
- "application/json" : {
2355
- "schema" : {
2356
- "type" : [ "null", "object" ],
2357
- "additionalProperties" : false,
2358
- "properties" : {
2359
- "categoryId" : {
2360
- "type" : [ "string", "null", "integer" ],
2361
- "format" : "int64",
2362
- "description" : "ID of the community category",
2363
- "pattern" : "([0-9]+)"
2364
- }
2365
- },
2366
- "required" : [ "categoryId" ]
2367
- },
2368
- "examples" : {
2369
- "Valid requestBody Definitions" : {
2370
- "value" : {
2371
- "categoryId" : "1000000012755"
2372
- }
2373
- }
2374
- }
2375
- }
2376
- },
2377
- "x-custom-request-body-attributes" : {
2378
- "non-empty" : false,
2379
- "allow-invalid" : false
2380
- }
2381
- },
2382
- "scheduleTrashAllUserCommentsRequest" : {
2383
- "content" : {
2384
- "application/json" : {
2385
- "schema" : {
2386
- "type" : [ "null", "object" ],
2387
- "additionalProperties" : false,
2388
- "properties" : {
2389
- "categoryId" : {
2390
- "type" : [ "string", "null", "integer" ],
2391
- "format" : "int64",
2392
- "description" : "ID of the community category",
2393
- "pattern" : "([0-9]+)"
2394
- }
2395
- }
2396
- },
2397
- "examples" : {
2398
- "Valid requestBody Definitions" : {
2399
- "value" : {
2400
- "categoryId" : "1000000012755"
2401
- }
2402
- }
2403
- }
2404
- }
2405
- },
2406
- "x-custom-request-body-attributes" : {
2407
- "non-empty" : false,
2408
- "allow-invalid" : false
2409
- }
2410
- },
2411
- "scheduleBulkTrashOfAwaitingTopics_scheduleBulkApprovalOfAwaitingTopicsRequest" : {
2412
- "content" : {
2413
- "application/json" : {
2414
- "schema" : {
2415
- "type" : [ "null", "object" ],
2416
- "additionalProperties" : false,
2417
- "properties" : {
2418
- "categoryId" : {
2419
- "type" : [ "string", "null", "integer" ],
2420
- "format" : "int64",
2421
- "description" : "ID of the community category",
2422
- "pattern" : "([0-9]+)"
2423
- }
2424
- },
2425
- "required" : [ "categoryId" ]
2426
- },
2427
- "examples" : {
2428
- "Valid requestBody Definitions" : {
2429
- "value" : {
2430
- "categoryId" : "1000000012755"
2431
- }
2432
- }
2433
- }
2434
- }
2435
- },
2436
- "x-custom-request-body-attributes" : {
2437
- "non-empty" : false,
2438
- "allow-invalid" : false
2439
- }
2440
- },
2441
- "scheduleBulkApprovalOfSpamTopics_scheduleBulkApprovalOfAwaitingTopicsRequest" : {
2442
- "content" : {
2443
- "application/json" : {
2444
- "schema" : {
2445
- "type" : [ "null", "object" ],
2446
- "additionalProperties" : false,
2447
- "properties" : {
2448
- "categoryId" : {
2449
- "type" : [ "string", "null", "integer" ],
2450
- "format" : "int64",
2451
- "description" : "ID of the community category",
2452
- "pattern" : "([0-9]+)"
2453
- }
2454
- },
2455
- "required" : [ "categoryId" ]
2456
- },
2457
- "examples" : {
2458
- "Valid requestBody Definitions" : {
2459
- "value" : {
2460
- "categoryId" : "1000000012755"
2461
- }
2462
- }
2463
- }
2464
- }
2465
- },
2466
- "x-custom-request-body-attributes" : {
2467
- "non-empty" : false,
2468
- "allow-invalid" : false
2469
- }
2470
- },
2471
- "scheduleBulkApprovalOfAwaitingComments_scheduleBulkApprovalOfAwaitingTopicsRequest" : {
2472
- "content" : {
2473
- "application/json" : {
2474
- "schema" : {
2475
- "type" : [ "null", "object" ],
2476
- "additionalProperties" : false,
2477
- "properties" : {
2478
- "categoryId" : {
2479
- "type" : [ "string", "null", "integer" ],
2480
- "format" : "int64",
2481
- "description" : "ID of the community category",
2482
- "pattern" : "([0-9]+)"
2483
- }
2484
- },
2485
- "required" : [ "categoryId" ]
2486
- },
2487
- "examples" : {
2488
- "Valid requestBody Definitions" : {
2489
- "value" : {
2490
- "categoryId" : "1000000012755"
2491
- }
2492
- }
2493
- }
2494
- }
2495
- },
2496
- "x-custom-request-body-attributes" : {
2497
- "non-empty" : false,
2498
- "allow-invalid" : false
2499
- }
2500
- },
2501
- "scheduleBulkApprovalOfAwaitingTopics_scheduleBulkApprovalOfAwaitingTopicsRequest" : {
2502
- "content" : {
2503
- "application/json" : {
2504
- "schema" : {
2505
- "type" : [ "null", "object" ],
2506
- "additionalProperties" : false,
2507
- "properties" : {
2508
- "categoryId" : {
2509
- "type" : [ "string", "null", "integer" ],
2510
- "format" : "int64",
2511
- "description" : "ID of the community category",
2512
- "pattern" : "([0-9]+)"
2513
- }
2514
- },
2515
- "required" : [ "categoryId" ]
2516
- },
2517
- "examples" : {
2518
- "Valid requestBody Definitions" : {
2519
- "value" : {
2520
- "categoryId" : "1000000012755"
2521
- }
2522
- }
2523
- }
2524
- }
2525
- },
2526
- "x-custom-request-body-attributes" : {
2527
- "non-empty" : false,
2528
- "allow-invalid" : false
2529
- }
2530
- }
2531
- },
2532
- "securitySchemes" : {
2533
- "cookie-auth" : {
2534
- "$ref" : "../common/Common.json#/components/securitySchemes/cookie-auth"
2535
- },
2536
- "org-oauth" : {
2537
- "$ref" : "../common/Common.json#/components/securitySchemes/org-oauth"
2538
- },
2539
- "iam-oauth2-schema" : {
2540
- "$ref" : "../common/Common.json#/components/securitySchemes/iam-oauth2-schema"
2541
- }
2542
- }
2543
- },
2544
- "x-entity" : "Community"
2545
- }