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