agent-generator 1.0.3 → 1.0.4

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 (769) hide show
  1. package/package.json +2 -4
  2. package/Generator_Patterns/Conditional.md +0 -84
  3. package/Generator_Patterns/Dynamic.md +0 -129
  4. package/Generator_Patterns/PathConfig.properties +0 -4
  5. package/Generator_Patterns/README.md +0 -118
  6. package/Generator_Patterns/Reference.md +0 -98
  7. package/Generator_Patterns/Remote.md +0 -259
  8. package/Generator_Patterns/Static.md +0 -99
  9. package/source/api-data-generators/.idea/api-data-generators.iml +0 -9
  10. package/source/api-data-generators/.idea/misc.xml +0 -6
  11. package/source/api-data-generators/.idea/modules.xml +0 -8
  12. package/source/api-data-generators/.idea/vcs.xml +0 -6
  13. package/source/api-data-generators/portal/ArticleComment/test_data_generation_configurations.json +0 -318
  14. package/source/api-data-generators/portal/ArticleFeedback/test_data_generation_configurations.json +0 -32
  15. package/source/api-data-generators/portal/AsapMobile/test_data_generation_configurations.json +0 -21
  16. package/source/api-data-generators/portal/AsapWeb/test_data_generation_configurations.json +0 -18
  17. package/source/api-data-generators/portal/Category/test_data_generation_configurations.json +0 -39
  18. package/source/api-data-generators/portal/Comment/test_data_generation_configurations.json +0 -157
  19. package/source/api-data-generators/portal/Community/test_data_generation_configurations.json +0 -46
  20. package/source/api-data-generators/portal/CommunityUser/test_data_generation_configurations.json +0 -16
  21. package/source/api-data-generators/portal/Contact/test_data_generation_configurations.json +0 -33
  22. package/source/api-data-generators/portal/Department/test_data_generation_configurations.json +0 -13
  23. package/source/api-data-generators/portal/Extension/test_data_generation_configurations.json +0 -91
  24. package/source/api-data-generators/portal/FeedbackWidget/test_data_generation_configurations.json +0 -18
  25. package/source/api-data-generators/portal/FileExport/test_data_generation_configurations.json +0 -42
  26. package/source/api-data-generators/portal/Followers/test_data_generation_configurations.json +0 -92
  27. package/source/api-data-generators/portal/Gamification/test_data_generation_configurations.json +0 -51
  28. package/source/api-data-generators/portal/HelpCenters/test_data_generation_configurations.json +0 -11
  29. package/source/api-data-generators/portal/Helpcenter/test_data_generation_configurations.json +0 -41
  30. package/source/api-data-generators/portal/HelpcenterGroups/test_data_generation_configurations.json +0 -18
  31. package/source/api-data-generators/portal/KBRootCategory/test_data_generation_configurations.json +0 -76
  32. package/source/api-data-generators/portal/KbCategory/test_data_generation_configurations.json +0 -51
  33. package/source/api-data-generators/portal/KbSection/test_data_generation_configurations.json +0 -25
  34. package/source/api-data-generators/portal/KnowledgeBase/test_data_generation_configurations.json +0 -26
  35. package/source/api-data-generators/portal/Label/test_data_generation_configurations.json +0 -18
  36. package/source/api-data-generators/portal/Layout/test_data_generation_configurations.json +0 -17
  37. package/source/api-data-generators/portal/LayoutRules/test_data_generation_configurations.json +0 -17
  38. package/source/api-data-generators/portal/NewAsapMobile/test_data_generation_configurations.json +0 -21
  39. package/source/api-data-generators/portal/Permalink/test_data_generation_configurations.json +0 -32
  40. package/source/api-data-generators/portal/Product/test_data_generation_configurations.json +0 -43
  41. package/source/api-data-generators/portal/Solution/test_data_generation_configurations.json +0 -631
  42. package/source/api-data-generators/portal/Thread/test_data_generation_configurations.json +0 -70
  43. package/source/api-data-generators/portal/Ticket/test_data_generation_configurations.json +0 -294
  44. package/source/api-data-generators/portal/TicketComment/test_data_generation_configurations.json +0 -58
  45. package/source/api-data-generators/portal/TicketCount/test_data_generation_configurations.json +0 -74
  46. package/source/api-data-generators/portal/TicketStatusMapping/test_data_generation_configurations.json +0 -11
  47. package/source/api-data-generators/portal/TicketTemplate/test_data_generation_configurations.json +0 -24
  48. package/source/api-data-generators/portal/Topic/test_data_generation_configurations.json +0 -259
  49. package/source/api-data-generators/portal/Translation/test_data_generation_configurations.json +0 -6
  50. package/source/api-data-generators/portal/ValidationRules/test_data_generation_configurations.json +0 -14
  51. package/source/api-data-generators/portal/View/test_data_generation_configurations.json +0 -19
  52. package/source/api-data-generators/support/Account/test_data_generation_configurations.json +0 -265
  53. package/source/api-data-generators/support/AccountAttachment/test_data_generation_configurations.json +0 -48
  54. package/source/api-data-generators/support/AccountComments/test_data_generation_configurations.json +0 -47
  55. package/source/api-data-generators/support/AccountContactMappingInfo/test_data_generation_configurations.json +0 -14
  56. package/source/api-data-generators/support/AccountFollowers/test_data_generation_configurations.json +0 -52
  57. package/source/api-data-generators/support/AccountSla/test_data_generation_configurations.json +0 -33
  58. package/source/api-data-generators/support/AccountTimeEntry/test_data_generation_configurations.json +0 -45
  59. package/source/api-data-generators/support/ActiveCalls/test_data_generation_configurations.json +0 -38
  60. package/source/api-data-generators/support/Activity/test_data_generation_configurations.json +0 -50
  61. package/source/api-data-generators/support/ActorsAPI/test_data_generation_configurations.json +0 -22
  62. package/source/api-data-generators/support/Agent/test_data_generation_configurations.json +0 -217
  63. package/source/api-data-generators/support/AgentPresence/test_data_generation_configurations.json +0 -30
  64. package/source/api-data-generators/support/AgentSignatures/test_data_generation_configurations.json +0 -31
  65. package/source/api-data-generators/support/AgentTimeEntry/test_data_generation_configurations.json +0 -36
  66. package/source/api-data-generators/support/AntiSpamInfo/test_data_generation_configurations.json +0 -32
  67. package/source/api-data-generators/support/ApiCreditNotificationRule/test_data_generation_configurations.json +0 -49
  68. package/source/api-data-generators/support/ArchivedView/test_data_generation_configurations.json +0 -66
  69. package/source/api-data-generators/support/Article/test_data_generation_configurations.json +0 -294
  70. package/source/api-data-generators/support/ArticleAttachment/test_data_generation_configurations.json +0 -150
  71. package/source/api-data-generators/support/ArticleComment/test_data_generation_configurations.json +0 -238
  72. package/source/api-data-generators/support/ArticleFeedback/test_data_generation_configurations.json +0 -147
  73. package/source/api-data-generators/support/ArticleFeedbackResolution/test_data_generation_configurations.json +0 -56
  74. package/source/api-data-generators/support/ArticleStatistics/test_data_generation_configurations.json +0 -397
  75. package/source/api-data-generators/support/ArticleTranslation/test_data_generation_configurations.json +0 -1123
  76. package/source/api-data-generators/support/ArticleVersion/test_data_generation_configurations.json +0 -26
  77. package/source/api-data-generators/support/ArticleViews/test_data_generation_configurations.json +0 -26
  78. package/source/api-data-generators/support/Asap/test_data_generation_configurations.json +0 -49
  79. package/source/api-data-generators/support/AuditLog/test_data_generation_configurations.json +0 -58
  80. package/source/api-data-generators/support/AutomationAlerts/test_data_generation_configurations.json +0 -27
  81. package/source/api-data-generators/support/AutomationEngine/test_data_generation_configurations.json +0 -20
  82. package/source/api-data-generators/support/AutomationFeatureCount/test_data_generation_configurations.json +0 -13
  83. package/source/api-data-generators/support/AutomationFieldUpdates/test_data_generation_configurations.json +0 -24
  84. package/source/api-data-generators/support/AutomationTask/test_data_generation_configurations.json +0 -29
  85. package/source/api-data-generators/support/Backup/test_data_generation_configurations.json +0 -115
  86. package/source/api-data-generators/support/Badge/test_data_generation_configurations.json +0 -64
  87. package/source/api-data-generators/support/Bot/test_data_generation_configurations.json +0 -288
  88. package/source/api-data-generators/support/BotInference/test_data_generation_configurations.json +0 -119
  89. package/source/api-data-generators/support/BugInteg/test_data_generation_configurations.json +0 -37
  90. package/source/api-data-generators/support/BulkAction/test_data_generation_configurations.json +0 -26
  91. package/source/api-data-generators/support/BulkImport/test_data_generation_configurations.json +0 -211
  92. package/source/api-data-generators/support/BulkUpdate/test_data_generation_configurations.json +0 -40
  93. package/source/api-data-generators/support/BulkWrite/test_data_generation_configurations.json +0 -32
  94. package/source/api-data-generators/support/BusinessHour/test_data_generation_configurations.json +0 -72
  95. package/source/api-data-generators/support/Call/test_data_generation_configurations.json +0 -247
  96. package/source/api-data-generators/support/CallComments/test_data_generation_configurations.json +0 -51
  97. package/source/api-data-generators/support/CallHistory/test_data_generation_configurations.json +0 -65
  98. package/source/api-data-generators/support/CallTimeEntry/test_data_generation_configurations.json +0 -77
  99. package/source/api-data-generators/support/CallTimer/test_data_generation_configurations.json +0 -14
  100. package/source/api-data-generators/support/Channel/test_data_generation_configurations.json +0 -44
  101. package/source/api-data-generators/support/Chart/test_data_generation_configurations.json +0 -35
  102. package/source/api-data-generators/support/ChatTicket/test_data_generation_configurations.json +0 -185
  103. package/source/api-data-generators/support/Common/test_data_generation_configurations.json +0 -43
  104. package/source/api-data-generators/support/Community/test_data_generation_configurations.json +0 -313
  105. package/source/api-data-generators/support/CommunityAttachment/test_data_generation_configurations.json +0 -16
  106. package/source/api-data-generators/support/CommunityCategory/test_data_generation_configurations.json +0 -121
  107. package/source/api-data-generators/support/CommunityComment/test_data_generation_configurations.json +0 -350
  108. package/source/api-data-generators/support/CommunityInitPermissions/test_data_generation_configurations.json +0 -16
  109. package/source/api-data-generators/support/CommunityPreferences/test_data_generation_configurations.json +0 -19
  110. package/source/api-data-generators/support/CommunityTopic/test_data_generation_configurations.json +0 -509
  111. package/source/api-data-generators/support/CommunityTopicInsights/test_data_generation_configurations.json +0 -32
  112. package/source/api-data-generators/support/CommunityUser/test_data_generation_configurations.json +0 -63
  113. package/source/api-data-generators/support/Contact/test_data_generation_configurations.json +0 -370
  114. package/source/api-data-generators/support/ContactAttachment/test_data_generation_configurations.json +0 -44
  115. package/source/api-data-generators/support/ContactComments/test_data_generation_configurations.json +0 -47
  116. package/source/api-data-generators/support/ContactFollowers/test_data_generation_configurations.json +0 -52
  117. package/source/api-data-generators/support/ContactProfile/test_data_generation_configurations.json +0 -11
  118. package/source/api-data-generators/support/ContactTimeEntry/test_data_generation_configurations.json +0 -45
  119. package/source/api-data-generators/support/Contract/test_data_generation_configurations.json +0 -184
  120. package/source/api-data-generators/support/ContractAttachment/test_data_generation_configurations.json +0 -30
  121. package/source/api-data-generators/support/CreateTicket/test_data_generation_configurations.json +0 -93
  122. package/source/api-data-generators/support/Criteria/test_data_generation_configurations.json +0 -19
  123. package/source/api-data-generators/support/CrmInteg/test_data_generation_configurations.json +0 -202
  124. package/source/api-data-generators/support/CustomAction/test_data_generation_configurations.json +0 -56
  125. package/source/api-data-generators/support/CustomActionRuleMapping/test_data_generation_configurations.json +0 -334
  126. package/source/api-data-generators/support/CustomButton/test_data_generation_configurations.json +0 -113
  127. package/source/api-data-generators/support/CustomFunctionExecutionLogs/test_data_generation_configurations.json +0 -68
  128. package/source/api-data-generators/support/CustomFunctionGallery/test_data_generation_configurations.json +0 -16
  129. package/source/api-data-generators/support/CustomFunctions/test_data_generation_configurations.json +0 -270
  130. package/source/api-data-generators/support/CustomTheme/test_data_generation_configurations.json +0 -70
  131. package/source/api-data-generators/support/CustomView/test_data_generation_configurations.json +0 -486
  132. package/source/api-data-generators/support/CustomerHappiness/test_data_generation_configurations.json +0 -77
  133. package/source/api-data-generators/support/DashboardComponent/test_data_generation_configurations.json +0 -305
  134. package/source/api-data-generators/support/DashboardFolder/test_data_generation_configurations.json +0 -126
  135. package/source/api-data-generators/support/DashboardMetrics/test_data_generation_configurations.json +0 -205
  136. package/source/api-data-generators/support/Dashboards/test_data_generation_configurations.json +0 -90
  137. package/source/api-data-generators/support/DataChips/test_data_generation_configurations.json +0 -33
  138. package/source/api-data-generators/support/DataSync/test_data_generation_configurations.json +0 -228
  139. package/source/api-data-generators/support/DeleteTicket/test_data_generation_configurations.json +0 -44
  140. package/source/api-data-generators/support/Department/test_data_generation_configurations.json +0 -156
  141. package/source/api-data-generators/support/DependencyMappings/test_data_generation_configurations.json +0 -50
  142. package/source/api-data-generators/support/DirectAssignRuleTarget/test_data_generation_configurations.json +0 -17
  143. package/source/api-data-generators/support/DirectAssignmentRules/test_data_generation_configurations.json +0 -37
  144. package/source/api-data-generators/support/DisplayEntity/test_data_generation_configurations.json +0 -45
  145. package/source/api-data-generators/support/DomainMapping/test_data_generation_configurations.json +0 -6
  146. package/source/api-data-generators/support/EmailFailureAlert/test_data_generation_configurations.json +0 -21
  147. package/source/api-data-generators/support/EmailTemplates/test_data_generation_configurations.json +0 -106
  148. package/source/api-data-generators/support/EntityBlueprints/test_data_generation_configurations.json +0 -205
  149. package/source/api-data-generators/support/Event/test_data_generation_configurations.json +0 -196
  150. package/source/api-data-generators/support/EventComments/test_data_generation_configurations.json +0 -45
  151. package/source/api-data-generators/support/EventTimeEntry/test_data_generation_configurations.json +0 -77
  152. package/source/api-data-generators/support/EventTimer/test_data_generation_configurations.json +0 -14
  153. package/source/api-data-generators/support/Extension/test_data_generation_configurations.json +0 -689
  154. package/source/api-data-generators/support/FbManager/test_data_generation_configurations.json +0 -64
  155. package/source/api-data-generators/support/Feature/test_data_generation_configurations.json +0 -61
  156. package/source/api-data-generators/support/FeatureFile/test_data_generation_configurations.json +0 -49
  157. package/source/api-data-generators/support/FeatureFolder/test_data_generation_configurations.json +0 -44
  158. package/source/api-data-generators/support/FeaturePermission/test_data_generation_configurations.json +0 -108
  159. package/source/api-data-generators/support/FederatedLogin/test_data_generation_configurations.json +0 -39
  160. package/source/api-data-generators/support/FeedsAPIs/test_data_generation_configurations.json +0 -54
  161. package/source/api-data-generators/support/Field/test_data_generation_configurations.json +0 -1031
  162. package/source/api-data-generators/support/FieldPrediction/test_data_generation_configurations.json +0 -564
  163. package/source/api-data-generators/support/FileExport/test_data_generation_configurations.json +0 -36
  164. package/source/api-data-generators/support/Finance/test_data_generation_configurations.json +0 -180
  165. package/source/api-data-generators/support/Followers/test_data_generation_configurations.json +0 -60
  166. package/source/api-data-generators/support/GC_Bots/test_data_generation_configurations.json +0 -26
  167. package/source/api-data-generators/support/GC_Guide/test_data_generation_configurations.json +0 -240
  168. package/source/api-data-generators/support/GenericAction/test_data_generation_configurations.json +0 -16
  169. package/source/api-data-generators/support/GenericActionMapping/test_data_generation_configurations.json +0 -216
  170. package/source/api-data-generators/support/GoogleAnalytics/test_data_generation_configurations.json +0 -168
  171. package/source/api-data-generators/support/GoogleChat/test_data_generation_configurations.json +0 -29
  172. package/source/api-data-generators/support/Helpcenter/test_data_generation_configurations.json +0 -98
  173. package/source/api-data-generators/support/HelpcenterAutoTranslateSetting/test_data_generation_configurations.json +0 -11
  174. package/source/api-data-generators/support/HelpcenterGroups/test_data_generation_configurations.json +0 -93
  175. package/source/api-data-generators/support/HelpcenterPages/test_data_generation_configurations.json +0 -34
  176. package/source/api-data-generators/support/HelpcenterPreference/test_data_generation_configurations.json +0 -18
  177. package/source/api-data-generators/support/HelpcenterUpload/test_data_generation_configurations.json +0 -25
  178. package/source/api-data-generators/support/HolidayList/test_data_generation_configurations.json +0 -65
  179. package/source/api-data-generators/support/IMCannedMessage/test_data_generation_configurations.json +0 -155
  180. package/source/api-data-generators/support/IMCannedMessageTranslation/test_data_generation_configurations.json +0 -92
  181. package/source/api-data-generators/support/IMTemplateMessage/test_data_generation_configurations.json +0 -22
  182. package/source/api-data-generators/support/IM_AddOn/test_data_generation_configurations.json +0 -19
  183. package/source/api-data-generators/support/IM_Bot/test_data_generation_configurations.json +0 -143
  184. package/source/api-data-generators/support/IM_Broadcast/test_data_generation_configurations.json +0 -39
  185. package/source/api-data-generators/support/IM_Channel/test_data_generation_configurations.json +0 -312
  186. package/source/api-data-generators/support/IM_ChannelPreference/test_data_generation_configurations.json +0 -35
  187. package/source/api-data-generators/support/IM_Contact/test_data_generation_configurations.json +0 -16
  188. package/source/api-data-generators/support/IM_Integration/test_data_generation_configurations.json +0 -32
  189. package/source/api-data-generators/support/IM_Message/test_data_generation_configurations.json +0 -297
  190. package/source/api-data-generators/support/IM_Metrics/test_data_generation_configurations.json +0 -38
  191. package/source/api-data-generators/support/IM_Search/test_data_generation_configurations.json +0 -56
  192. package/source/api-data-generators/support/IM_Session/test_data_generation_configurations.json +0 -149
  193. package/source/api-data-generators/support/IM_TimeSeriesMetrics/test_data_generation_configurations.json +0 -77
  194. package/source/api-data-generators/support/IM_ZiaGpt/test_data_generation_configurations.json +0 -52
  195. package/source/api-data-generators/support/Import/test_data_generation_configurations.json +0 -229
  196. package/source/api-data-generators/support/InlineImage/test_data_generation_configurations.json +0 -16
  197. package/source/api-data-generators/support/IntegModule/test_data_generation_configurations.json +0 -90
  198. package/source/api-data-generators/support/Integrations/test_data_generation_configurations.json +0 -25
  199. package/source/api-data-generators/support/InteractiveTours/test_data_generation_configurations.json +0 -66
  200. package/source/api-data-generators/support/JWT/test_data_generation_configurations.json +0 -49
  201. package/source/api-data-generators/support/KBCategoryUser/test_data_generation_configurations.json +0 -23
  202. package/source/api-data-generators/support/KBRecycleBin/test_data_generation_configurations.json +0 -131
  203. package/source/api-data-generators/support/KBRootCategory/test_data_generation_configurations.json +0 -214
  204. package/source/api-data-generators/support/KBRootCategoryTranslation/test_data_generation_configurations.json +0 -30
  205. package/source/api-data-generators/support/KBSection/test_data_generation_configurations.json +0 -173
  206. package/source/api-data-generators/support/KPIWidget/test_data_generation_configurations.json +0 -21
  207. package/source/api-data-generators/support/KbCategory/test_data_generation_configurations.json +0 -93
  208. package/source/api-data-generators/support/Label/test_data_generation_configurations.json +0 -103
  209. package/source/api-data-generators/support/Layout/test_data_generation_configurations.json +0 -503
  210. package/source/api-data-generators/support/LayoutRuleCriteria/test_data_generation_configurations.json +0 -19
  211. package/source/api-data-generators/support/LayoutRules/test_data_generation_configurations.json +0 -334
  212. package/source/api-data-generators/support/License/test_data_generation_configurations.json +0 -60
  213. package/source/api-data-generators/support/Livecall/test_data_generation_configurations.json +0 -72
  214. package/source/api-data-generators/support/LookupRecord/test_data_generation_configurations.json +0 -34
  215. package/source/api-data-generators/support/Macros/test_data_generation_configurations.json +0 -184
  216. package/source/api-data-generators/support/MailReplyAddress/test_data_generation_configurations.json +0 -32
  217. package/source/api-data-generators/support/MassAction/test_data_generation_configurations.json +0 -38
  218. package/source/api-data-generators/support/Message/test_data_generation_configurations.json +0 -38
  219. package/source/api-data-generators/support/MicrosoftTeams/test_data_generation_configurations.json +0 -50
  220. package/source/api-data-generators/support/Misc/test_data_generation_configurations.json +0 -16
  221. package/source/api-data-generators/support/Module/test_data_generation_configurations.json +0 -96
  222. package/source/api-data-generators/support/NewCriteria/test_data_generation_configurations.json +0 -26
  223. package/source/api-data-generators/support/NewFeatureFields/test_data_generation_configurations.json +0 -19
  224. package/source/api-data-generators/support/NewTicketHistory/test_data_generation_configurations.json +0 -20
  225. package/source/api-data-generators/support/NotificationRules/test_data_generation_configurations.json +0 -27
  226. package/source/api-data-generators/support/OEmbedData/test_data_generation_configurations.json +0 -19
  227. package/source/api-data-generators/support/Onboarding/test_data_generation_configurations.json +0 -29
  228. package/source/api-data-generators/support/Organization/test_data_generation_configurations.json +0 -79
  229. package/source/api-data-generators/support/PBGroup/test_data_generation_configurations.json +0 -109
  230. package/source/api-data-generators/support/PBGroupAgents/test_data_generation_configurations.json +0 -66
  231. package/source/api-data-generators/support/PBPlatform/test_data_generation_configurations.json +0 -113
  232. package/source/api-data-generators/support/PBX/test_data_generation_configurations.json +0 -28
  233. package/source/api-data-generators/support/PBXConfig/test_data_generation_configurations.json +0 -17
  234. package/source/api-data-generators/support/PBXPhoneNumbers/test_data_generation_configurations.json +0 -54
  235. package/source/api-data-generators/support/PBXPreference/test_data_generation_configurations.json +0 -54
  236. package/source/api-data-generators/support/PageSense/test_data_generation_configurations.json +0 -77
  237. package/source/api-data-generators/support/PendingApproval/test_data_generation_configurations.json +0 -14
  238. package/source/api-data-generators/support/Permalink/test_data_generation_configurations.json +0 -32
  239. package/source/api-data-generators/support/PhoneAgents/test_data_generation_configurations.json +0 -66
  240. package/source/api-data-generators/support/PinnedConversation/test_data_generation_configurations.json +0 -64
  241. package/source/api-data-generators/support/Pipeline_Service/test_data_generation_configurations.json +0 -32
  242. package/source/api-data-generators/support/Product/test_data_generation_configurations.json +0 -196
  243. package/source/api-data-generators/support/ProductAttachment/test_data_generation_configurations.json +0 -48
  244. package/source/api-data-generators/support/Profile/test_data_generation_configurations.json +0 -59
  245. package/source/api-data-generators/support/QueueView/test_data_generation_configurations.json +0 -37
  246. package/source/api-data-generators/support/Records/test_data_generation_configurations.json +0 -239
  247. package/source/api-data-generators/support/Recyclebin/test_data_generation_configurations.json +0 -52
  248. package/source/api-data-generators/support/RemoteAuth/test_data_generation_configurations.json +0 -52
  249. package/source/api-data-generators/support/Report/test_data_generation_configurations.json +0 -538
  250. package/source/api-data-generators/support/ReportChart/test_data_generation_configurations.json +0 -28
  251. package/source/api-data-generators/support/ReportFolder/test_data_generation_configurations.json +0 -100
  252. package/source/api-data-generators/support/Resources/test_data_generation_configurations.json +0 -29
  253. package/source/api-data-generators/support/Role/test_data_generation_configurations.json +0 -84
  254. package/source/api-data-generators/support/RoundRobin/test_data_generation_configurations.json +0 -58
  255. package/source/api-data-generators/support/RoundRobinTarget/test_data_generation_configurations.json +0 -50
  256. package/source/api-data-generators/support/RoutingPreference/test_data_generation_configurations.json +0 -29
  257. package/source/api-data-generators/support/SLAMetaInfo/test_data_generation_configurations.json +0 -22
  258. package/source/api-data-generators/support/Saml/test_data_generation_configurations.json +0 -42
  259. package/source/api-data-generators/support/Sandbox/test_data_generation_configurations.json +0 -92
  260. package/source/api-data-generators/support/SandboxChangeset/test_data_generation_configurations.json +0 -46
  261. package/source/api-data-generators/support/SandboxDeployment/test_data_generation_configurations.json +0 -50
  262. package/source/api-data-generators/support/SandboxDeploymentLogs/test_data_generation_configurations.json +0 -22
  263. package/source/api-data-generators/support/SavedFilters/test_data_generation_configurations.json +0 -203
  264. package/source/api-data-generators/support/Schedule/test_data_generation_configurations.json +0 -172
  265. package/source/api-data-generators/support/ScheduleReplyInfo/test_data_generation_configurations.json +0 -182
  266. package/source/api-data-generators/support/Search/test_data_generation_configurations.json +0 -636
  267. package/source/api-data-generators/support/SearchInteg/test_data_generation_configurations.json +0 -32
  268. package/source/api-data-generators/support/Setup/test_data_generation_configurations.json +0 -32
  269. package/source/api-data-generators/support/SharedSnippet/test_data_generation_configurations.json +0 -62
  270. package/source/api-data-generators/support/Signature/test_data_generation_configurations.json +0 -24
  271. package/source/api-data-generators/support/Skill/test_data_generation_configurations.json +0 -164
  272. package/source/api-data-generators/support/SkillConfiguration/test_data_generation_configurations.json +0 -21
  273. package/source/api-data-generators/support/SkillType/test_data_generation_configurations.json +0 -60
  274. package/source/api-data-generators/support/Slack/test_data_generation_configurations.json +0 -51
  275. package/source/api-data-generators/support/SmsTemplates/test_data_generation_configurations.json +0 -40
  276. package/source/api-data-generators/support/Snippets/test_data_generation_configurations.json +0 -47
  277. package/source/api-data-generators/support/SocialInteg/test_data_generation_configurations.json +0 -22
  278. package/source/api-data-generators/support/SocialPosts/test_data_generation_configurations.json +0 -223
  279. package/source/api-data-generators/support/SocialTwitterConversations/test_data_generation_configurations.json +0 -22
  280. package/source/api-data-generators/support/StarredTemplates/test_data_generation_configurations.json +0 -76
  281. package/source/api-data-generators/support/SubjectAccessRequest/test_data_generation_configurations.json +0 -104
  282. package/source/api-data-generators/support/Supervise/test_data_generation_configurations.json +0 -43
  283. package/source/api-data-generators/support/SupportPlan/test_data_generation_configurations.json +0 -65
  284. package/source/api-data-generators/support/Tab/test_data_generation_configurations.json +0 -29
  285. package/source/api-data-generators/support/Target/test_data_generation_configurations.json +0 -97
  286. package/source/api-data-generators/support/Task/test_data_generation_configurations.json +0 -219
  287. package/source/api-data-generators/support/TaskAttachment/test_data_generation_configurations.json +0 -42
  288. package/source/api-data-generators/support/TaskComments/test_data_generation_configurations.json +0 -45
  289. package/source/api-data-generators/support/TaskTimeEntry/test_data_generation_configurations.json +0 -87
  290. package/source/api-data-generators/support/TaskTimer/test_data_generation_configurations.json +0 -27
  291. package/source/api-data-generators/support/Team/test_data_generation_configurations.json +0 -115
  292. package/source/api-data-generators/support/TemplateFolders/test_data_generation_configurations.json +0 -72
  293. package/source/api-data-generators/support/Thread/test_data_generation_configurations.json +0 -383
  294. package/source/api-data-generators/support/Ticket/test_data_generation_configurations.json +0 -694
  295. package/source/api-data-generators/support/TicketApprovals/test_data_generation_configurations.json +0 -66
  296. package/source/api-data-generators/support/TicketAttachment/test_data_generation_configurations.json +0 -58
  297. package/source/api-data-generators/support/TicketComment/test_data_generation_configurations.json +0 -82
  298. package/source/api-data-generators/support/TicketCount/test_data_generation_configurations.json +0 -43
  299. package/source/api-data-generators/support/TicketFollowers/test_data_generation_configurations.json +0 -65
  300. package/source/api-data-generators/support/TicketMetrics/test_data_generation_configurations.json +0 -16
  301. package/source/api-data-generators/support/TicketTag/test_data_generation_configurations.json +0 -99
  302. package/source/api-data-generators/support/TicketTemplate/test_data_generation_configurations.json +0 -475
  303. package/source/api-data-generators/support/TicketTimeEntry/test_data_generation_configurations.json +0 -110
  304. package/source/api-data-generators/support/TicketTimer/test_data_generation_configurations.json +0 -48
  305. package/source/api-data-generators/support/TicketWithChildren/test_data_generation_configurations.json +0 -91
  306. package/source/api-data-generators/support/TimeTracking/test_data_generation_configurations.json +0 -46
  307. package/source/api-data-generators/support/TranslationLanguages/test_data_generation_configurations.json +0 -68
  308. package/source/api-data-generators/support/Upload/test_data_generation_configurations.json +0 -54
  309. package/source/api-data-generators/support/User/test_data_generation_configurations.json +0 -100
  310. package/source/api-data-generators/support/UserAuthentication/test_data_generation_configurations.json +0 -49
  311. package/source/api-data-generators/support/UserPresence/test_data_generation_configurations.json +0 -19
  312. package/source/api-data-generators/support/ValidationRuleCriteria/test_data_generation_configurations.json +0 -19
  313. package/source/api-data-generators/support/ValidationRules/test_data_generation_configurations.json +0 -321
  314. package/source/api-data-generators/support/Webhook/test_data_generation_configurations.json +0 -501
  315. package/source/api-data-generators/support/Widget/test_data_generation_configurations.json +0 -166
  316. package/source/api-data-generators/support/ZIAAnswerbotInference/test_data_generation_configurations.json +0 -26
  317. package/source/api-data-generators/support/ZIADocumentData/test_data_generation_configurations.json +0 -38
  318. package/source/api-data-generators/support/ZIAVectorSearch/test_data_generation_configurations.json +0 -22
  319. package/source/api-data-generators/support/ZiaGPT/test_data_generation_configurations.json +0 -19
  320. package/source/api-data-generators/support/ZiaScheduler/test_data_generation_configurations.json +0 -22
  321. package/source/api-data-generators/support/ZiapoweredbyGPT/test_data_generation_configurations.json +0 -33
  322. package/source/api-data-generators/support/Zwitch/test_data_generation_configurations.json +0 -71
  323. package/source/api-data-generators/support/blueprintDrafts/test_data_generation_configurations.json +0 -859
  324. package/source/api-data-generators/support/blueprintTransitions/test_data_generation_configurations.json +0 -26
  325. package/source/api-data-generators/support/blueprints/test_data_generation_configurations.json +0 -652
  326. package/source/api-data-generators/support/borrow_book/test_data_generation_configurations.json +0 -21
  327. package/source/api-data-generators/support/zlabsnlp/test_data_generation_configurations.json +0 -50
  328. package/source/openapi-specifications/v1.0/common/Common.json +0 -587
  329. package/source/openapi-specifications/v1.0/portal/Account.json +0 -183
  330. package/source/openapi-specifications/v1.0/portal/ArticleComment.json +0 -1103
  331. package/source/openapi-specifications/v1.0/portal/ArticleFeedback.json +0 -133
  332. package/source/openapi-specifications/v1.0/portal/AsapMobile.json +0 -712
  333. package/source/openapi-specifications/v1.0/portal/AsapWeb.json +0 -91
  334. package/source/openapi-specifications/v1.0/portal/Attachment.json +0 -122
  335. package/source/openapi-specifications/v1.0/portal/Captcha.json +0 -334
  336. package/source/openapi-specifications/v1.0/portal/Category.json +0 -1061
  337. package/source/openapi-specifications/v1.0/portal/Comment.json +0 -1546
  338. package/source/openapi-specifications/v1.0/portal/Community.json +0 -235
  339. package/source/openapi-specifications/v1.0/portal/CommunityUser.json +0 -296
  340. package/source/openapi-specifications/v1.0/portal/Contact.json +0 -536
  341. package/source/openapi-specifications/v1.0/portal/CustomerHappiness.json +0 -163
  342. package/source/openapi-specifications/v1.0/portal/Department.json +0 -246
  343. package/source/openapi-specifications/v1.0/portal/Extension.json +0 -1122
  344. package/source/openapi-specifications/v1.0/portal/FeedbackWidget.json +0 -96
  345. package/source/openapi-specifications/v1.0/portal/Field.json +0 -1239
  346. package/source/openapi-specifications/v1.0/portal/FileExport.json +0 -313
  347. package/source/openapi-specifications/v1.0/portal/Followers.json +0 -802
  348. package/source/openapi-specifications/v1.0/portal/Gamification.json +0 -819
  349. package/source/openapi-specifications/v1.0/portal/HashTags.json +0 -61
  350. package/source/openapi-specifications/v1.0/portal/HelpCenterUser.json +0 -605
  351. package/source/openapi-specifications/v1.0/portal/HelpCenterUserPreference.json +0 -148
  352. package/source/openapi-specifications/v1.0/portal/Helpcenter.json +0 -920
  353. package/source/openapi-specifications/v1.0/portal/HelpcenterGroups.json +0 -118
  354. package/source/openapi-specifications/v1.0/portal/HelpcenterPages.json +0 -184
  355. package/source/openapi-specifications/v1.0/portal/KBCategoryTranslation.json +0 -70
  356. package/source/openapi-specifications/v1.0/portal/KBRootCategory.json +0 -1310
  357. package/source/openapi-specifications/v1.0/portal/KbCategory.json +0 -1525
  358. package/source/openapi-specifications/v1.0/portal/KbSection.json +0 -515
  359. package/source/openapi-specifications/v1.0/portal/Label.json +0 -172
  360. package/source/openapi-specifications/v1.0/portal/Layout.json +0 -303
  361. package/source/openapi-specifications/v1.0/portal/LayoutRules.json +0 -375
  362. package/source/openapi-specifications/v1.0/portal/Mentions.json +0 -580
  363. package/source/openapi-specifications/v1.0/portal/NewAsapMobile.json +0 -699
  364. package/source/openapi-specifications/v1.0/portal/Permalink.json +0 -265
  365. package/source/openapi-specifications/v1.0/portal/Placeholders.json +0 -57
  366. package/source/openapi-specifications/v1.0/portal/Product.json +0 -401
  367. package/source/openapi-specifications/v1.0/portal/Solution.json +0 -3766
  368. package/source/openapi-specifications/v1.0/portal/Thread.json +0 -821
  369. package/source/openapi-specifications/v1.0/portal/Ticket.json +0 -2636
  370. package/source/openapi-specifications/v1.0/portal/TicketComment.json +0 -822
  371. package/source/openapi-specifications/v1.0/portal/TicketCount.json +0 -336
  372. package/source/openapi-specifications/v1.0/portal/TicketExport.json +0 -609
  373. package/source/openapi-specifications/v1.0/portal/TicketField.json +0 -358
  374. package/source/openapi-specifications/v1.0/portal/TicketForm.json +0 -517
  375. package/source/openapi-specifications/v1.0/portal/TicketStatusMapping.json +0 -155
  376. package/source/openapi-specifications/v1.0/portal/TicketTemplate.json +0 -409
  377. package/source/openapi-specifications/v1.0/portal/TicketsViewCount.json +0 -175
  378. package/source/openapi-specifications/v1.0/portal/Topic.json +0 -4079
  379. package/source/openapi-specifications/v1.0/portal/Translation.json +0 -174
  380. package/source/openapi-specifications/v1.0/portal/Upload.json +0 -156
  381. package/source/openapi-specifications/v1.0/portal/ValidationRules.json +0 -309
  382. package/source/openapi-specifications/v1.0/portal/View.json +0 -353
  383. package/source/openapi-specifications/v1.0/portal/Widget.json +0 -218
  384. package/source/openapi-specifications/v1.0/support/AEAdminTool.json +0 -354
  385. package/source/openapi-specifications/v1.0/support/Account.json +0 -3206
  386. package/source/openapi-specifications/v1.0/support/AccountAttachment.json +0 -484
  387. package/source/openapi-specifications/v1.0/support/AccountComments.json +0 -794
  388. package/source/openapi-specifications/v1.0/support/AccountContactMappingInfo.json +0 -227
  389. package/source/openapi-specifications/v1.0/support/AccountDeduplication.json +0 -578
  390. package/source/openapi-specifications/v1.0/support/AccountFollowers.json +0 -350
  391. package/source/openapi-specifications/v1.0/support/AccountSla.json +0 -341
  392. package/source/openapi-specifications/v1.0/support/AccountTimeEntry.json +0 -1152
  393. package/source/openapi-specifications/v1.0/support/ActiveCalls.json +0 -573
  394. package/source/openapi-specifications/v1.0/support/Activity.json +0 -1400
  395. package/source/openapi-specifications/v1.0/support/Actor.json +0 -88
  396. package/source/openapi-specifications/v1.0/support/ActorsAPI.json +0 -304
  397. package/source/openapi-specifications/v1.0/support/AdminTool.json +0 -489
  398. package/source/openapi-specifications/v1.0/support/Agent.json +0 -6685
  399. package/source/openapi-specifications/v1.0/support/AgentPresence.json +0 -567
  400. package/source/openapi-specifications/v1.0/support/AgentRoom.json +0 -1997
  401. package/source/openapi-specifications/v1.0/support/AgentSignatures.json +0 -359
  402. package/source/openapi-specifications/v1.0/support/AgentTimeEntry.json +0 -1402
  403. package/source/openapi-specifications/v1.0/support/AntiSpamInfo.json +0 -510
  404. package/source/openapi-specifications/v1.0/support/ApiCreditNotificationRule.json +0 -1189
  405. package/source/openapi-specifications/v1.0/support/ApiDashboard.json +0 -543
  406. package/source/openapi-specifications/v1.0/support/ApplicationFlags.json +0 -155
  407. package/source/openapi-specifications/v1.0/support/ArchivedView.json +0 -469
  408. package/source/openapi-specifications/v1.0/support/Article.json +0 -5060
  409. package/source/openapi-specifications/v1.0/support/ArticleAttachment.json +0 -544
  410. package/source/openapi-specifications/v1.0/support/ArticleComment.json +0 -1929
  411. package/source/openapi-specifications/v1.0/support/ArticleExternalImageUrlResponse.json +0 -56
  412. package/source/openapi-specifications/v1.0/support/ArticleFeedback.json +0 -1314
  413. package/source/openapi-specifications/v1.0/support/ArticleFeedbackResolution.json +0 -513
  414. package/source/openapi-specifications/v1.0/support/ArticleHistory.json +0 -2510
  415. package/source/openapi-specifications/v1.0/support/ArticleStatistics.json +0 -3053
  416. package/source/openapi-specifications/v1.0/support/ArticleTranslation.json +0 -7530
  417. package/source/openapi-specifications/v1.0/support/ArticleVersion.json +0 -184
  418. package/source/openapi-specifications/v1.0/support/ArticleViews.json +0 -564
  419. package/source/openapi-specifications/v1.0/support/Asap.json +0 -1525
  420. package/source/openapi-specifications/v1.0/support/AsapModule.json +0 -246
  421. package/source/openapi-specifications/v1.0/support/AsapStatus.json +0 -199
  422. package/source/openapi-specifications/v1.0/support/AssistInteg.json +0 -613
  423. package/source/openapi-specifications/v1.0/support/AttachmentRestriction.json +0 -786
  424. package/source/openapi-specifications/v1.0/support/AuditLog.json +0 -1122
  425. package/source/openapi-specifications/v1.0/support/AutomatedSummaryForChats.json +0 -702
  426. package/source/openapi-specifications/v1.0/support/AutomationAlerts.json +0 -868
  427. package/source/openapi-specifications/v1.0/support/AutomationEngine.json +0 -1181
  428. package/source/openapi-specifications/v1.0/support/AutomationFeatureCount.json +0 -207
  429. package/source/openapi-specifications/v1.0/support/AutomationFieldUpdates.json +0 -809
  430. package/source/openapi-specifications/v1.0/support/AutomationTask.json +0 -1054
  431. package/source/openapi-specifications/v1.0/support/Backup.json +0 -2845
  432. package/source/openapi-specifications/v1.0/support/Badge.json +0 -544
  433. package/source/openapi-specifications/v1.0/support/Bot.json +0 -2103
  434. package/source/openapi-specifications/v1.0/support/BotInference.json +0 -1071
  435. package/source/openapi-specifications/v1.0/support/BotResources.json +0 -175
  436. package/source/openapi-specifications/v1.0/support/BotStaticResources.json +0 -541
  437. package/source/openapi-specifications/v1.0/support/Bot_UserInfo.json +0 -63
  438. package/source/openapi-specifications/v1.0/support/Bots.json +0 -58
  439. package/source/openapi-specifications/v1.0/support/BugInteg.json +0 -481
  440. package/source/openapi-specifications/v1.0/support/BulkAction.json +0 -150
  441. package/source/openapi-specifications/v1.0/support/BulkImport.json +0 -2845
  442. package/source/openapi-specifications/v1.0/support/BulkUpdate.json +0 -743
  443. package/source/openapi-specifications/v1.0/support/BulkWrite.json +0 -678
  444. package/source/openapi-specifications/v1.0/support/BusinessHour.json +0 -1344
  445. package/source/openapi-specifications/v1.0/support/Call.json +0 -3839
  446. package/source/openapi-specifications/v1.0/support/CallComments.json +0 -721
  447. package/source/openapi-specifications/v1.0/support/CallHistory.json +0 -936
  448. package/source/openapi-specifications/v1.0/support/CallTimeEntry.json +0 -1745
  449. package/source/openapi-specifications/v1.0/support/CallTimer.json +0 -285
  450. package/source/openapi-specifications/v1.0/support/Channel.json +0 -730
  451. package/source/openapi-specifications/v1.0/support/Chart.json +0 -422
  452. package/source/openapi-specifications/v1.0/support/ChatTicket.json +0 -553
  453. package/source/openapi-specifications/v1.0/support/ClientAction.json +0 -1834
  454. package/source/openapi-specifications/v1.0/support/ClientEvent.json +0 -780
  455. package/source/openapi-specifications/v1.0/support/CliqIntegJsonMapping.json +0 -1123
  456. package/source/openapi-specifications/v1.0/support/CloudAttachment.json +0 -528
  457. package/source/openapi-specifications/v1.0/support/CommonMassActionError.json +0 -44
  458. package/source/openapi-specifications/v1.0/support/CommonMassActionResponse.json +0 -94
  459. package/source/openapi-specifications/v1.0/support/Community.json +0 -2545
  460. package/source/openapi-specifications/v1.0/support/CommunityAttachment.json +0 -249
  461. package/source/openapi-specifications/v1.0/support/CommunityCategory.json +0 -1896
  462. package/source/openapi-specifications/v1.0/support/CommunityCategoryLogo.json +0 -145
  463. package/source/openapi-specifications/v1.0/support/CommunityComment.json +0 -2492
  464. package/source/openapi-specifications/v1.0/support/CommunityInitPermissions.json +0 -129
  465. package/source/openapi-specifications/v1.0/support/CommunityPreferences.json +0 -343
  466. package/source/openapi-specifications/v1.0/support/CommunitySearch.json +0 -78
  467. package/source/openapi-specifications/v1.0/support/CommunityTopic.json +0 -6005
  468. package/source/openapi-specifications/v1.0/support/CommunityTopicInsights.json +0 -310
  469. package/source/openapi-specifications/v1.0/support/CommunityUser.json +0 -822
  470. package/source/openapi-specifications/v1.0/support/Composite.json +0 -414
  471. package/source/openapi-specifications/v1.0/support/Contact.json +0 -4691
  472. package/source/openapi-specifications/v1.0/support/ContactAttachment.json +0 -484
  473. package/source/openapi-specifications/v1.0/support/ContactComments.json +0 -769
  474. package/source/openapi-specifications/v1.0/support/ContactDeduplication.json +0 -683
  475. package/source/openapi-specifications/v1.0/support/ContactFollowers.json +0 -350
  476. package/source/openapi-specifications/v1.0/support/ContactProfile.json +0 -195
  477. package/source/openapi-specifications/v1.0/support/ContactTimeEntry.json +0 -1157
  478. package/source/openapi-specifications/v1.0/support/Contract.json +0 -2877
  479. package/source/openapi-specifications/v1.0/support/ContractAttachment.json +0 -307
  480. package/source/openapi-specifications/v1.0/support/Conversation.json +0 -570
  481. package/source/openapi-specifications/v1.0/support/CountriesAndLanguages.json +0 -5279
  482. package/source/openapi-specifications/v1.0/support/CreditCycle.json +0 -124
  483. package/source/openapi-specifications/v1.0/support/Criteria.json +0 -1014
  484. package/source/openapi-specifications/v1.0/support/CriteriaValue.json +0 -50
  485. package/source/openapi-specifications/v1.0/support/CrmInteg.json +0 -5938
  486. package/source/openapi-specifications/v1.0/support/CustomAction.json +0 -2106
  487. package/source/openapi-specifications/v1.0/support/CustomActionRuleMapping.json +0 -1327
  488. package/source/openapi-specifications/v1.0/support/CustomButton.json +0 -1898
  489. package/source/openapi-specifications/v1.0/support/CustomFunctionExecutionLogs.json +0 -883
  490. package/source/openapi-specifications/v1.0/support/CustomFunctionGallery.json +0 -329
  491. package/source/openapi-specifications/v1.0/support/CustomFunctionReRun.json +0 -317
  492. package/source/openapi-specifications/v1.0/support/CustomFunctionZiaCopilot.json +0 -379
  493. package/source/openapi-specifications/v1.0/support/CustomFunctions.json +0 -3457
  494. package/source/openapi-specifications/v1.0/support/CustomModuleAdminTool.json +0 -81
  495. package/source/openapi-specifications/v1.0/support/CustomTheme.json +0 -7391
  496. package/source/openapi-specifications/v1.0/support/CustomView.json +0 -3478
  497. package/source/openapi-specifications/v1.0/support/CustomerHappiness.json +0 -464
  498. package/source/openapi-specifications/v1.0/support/DBThrottle.json +0 -334
  499. package/source/openapi-specifications/v1.0/support/DashboardComponent.json +0 -1163
  500. package/source/openapi-specifications/v1.0/support/DashboardFolder.json +0 -1258
  501. package/source/openapi-specifications/v1.0/support/DashboardMetrics.json +0 -2310
  502. package/source/openapi-specifications/v1.0/support/Dashboards.json +0 -1219
  503. package/source/openapi-specifications/v1.0/support/DataChips.json +0 -477
  504. package/source/openapi-specifications/v1.0/support/DataImport.json +0 -1099
  505. package/source/openapi-specifications/v1.0/support/DataSync.json +0 -1246
  506. package/source/openapi-specifications/v1.0/support/DatasetEntry.json +0 -153
  507. package/source/openapi-specifications/v1.0/support/Department.json +0 -1971
  508. package/source/openapi-specifications/v1.0/support/DependencyMappings.json +0 -656
  509. package/source/openapi-specifications/v1.0/support/DirectAssignRuleTarget.json +0 -232
  510. package/source/openapi-specifications/v1.0/support/DirectAssignmentRules.json +0 -722
  511. package/source/openapi-specifications/v1.0/support/DisplayEntity.json +0 -91
  512. package/source/openapi-specifications/v1.0/support/DomainMapping.json +0 -1143
  513. package/source/openapi-specifications/v1.0/support/EmailFailureAlert.json +0 -306
  514. package/source/openapi-specifications/v1.0/support/EmailTemplates.json +0 -1491
  515. package/source/openapi-specifications/v1.0/support/EntityBlueprints.json +0 -572
  516. package/source/openapi-specifications/v1.0/support/Event.json +0 -3607
  517. package/source/openapi-specifications/v1.0/support/EventComments.json +0 -737
  518. package/source/openapi-specifications/v1.0/support/EventTimeEntry.json +0 -1520
  519. package/source/openapi-specifications/v1.0/support/EventTimer.json +0 -285
  520. package/source/openapi-specifications/v1.0/support/Expression.json +0 -43
  521. package/source/openapi-specifications/v1.0/support/Extension.json +0 -7152
  522. package/source/openapi-specifications/v1.0/support/ExtensionOrg.json +0 -129
  523. package/source/openapi-specifications/v1.0/support/FAQ.json +0 -142
  524. package/source/openapi-specifications/v1.0/support/FAQTranslation.json +0 -178
  525. package/source/openapi-specifications/v1.0/support/FbManager.json +0 -1147
  526. package/source/openapi-specifications/v1.0/support/Feature.json +0 -691
  527. package/source/openapi-specifications/v1.0/support/FeatureFile.json +0 -435
  528. package/source/openapi-specifications/v1.0/support/FeatureFolder.json +0 -576
  529. package/source/openapi-specifications/v1.0/support/FeaturePermission.json +0 -492
  530. package/source/openapi-specifications/v1.0/support/FederatedLogin.json +0 -318
  531. package/source/openapi-specifications/v1.0/support/FeedsAPIs.json +0 -198
  532. package/source/openapi-specifications/v1.0/support/Field.json +0 -7493
  533. package/source/openapi-specifications/v1.0/support/FieldDetails.json +0 -139
  534. package/source/openapi-specifications/v1.0/support/FieldPermissions.json +0 -113
  535. package/source/openapi-specifications/v1.0/support/FieldPrediction.json +0 -3831
  536. package/source/openapi-specifications/v1.0/support/FileExport.json +0 -324
  537. package/source/openapi-specifications/v1.0/support/Finance.json +0 -4290
  538. package/source/openapi-specifications/v1.0/support/Followers.json +0 -875
  539. package/source/openapi-specifications/v1.0/support/FormulaFunctions.json +0 -47
  540. package/source/openapi-specifications/v1.0/support/GC_Bots.json +0 -138
  541. package/source/openapi-specifications/v1.0/support/GC_Guide.json +0 -1536
  542. package/source/openapi-specifications/v1.0/support/GC_GuideHistories.json +0 -58
  543. package/source/openapi-specifications/v1.0/support/GC_GuideHistory.json +0 -79
  544. package/source/openapi-specifications/v1.0/support/GC_Guides.json +0 -89
  545. package/source/openapi-specifications/v1.0/support/GC_Info.json +0 -208
  546. package/source/openapi-specifications/v1.0/support/GC_Status.json +0 -69
  547. package/source/openapi-specifications/v1.0/support/GC_UserInfo.json +0 -79
  548. package/source/openapi-specifications/v1.0/support/GenericAction.json +0 -1888
  549. package/source/openapi-specifications/v1.0/support/GenericActionMapping.json +0 -1050
  550. package/source/openapi-specifications/v1.0/support/GoogleAnalytics.json +0 -1715
  551. package/source/openapi-specifications/v1.0/support/GoogleChat.json +0 -650
  552. package/source/openapi-specifications/v1.0/support/HelpCenterCommon.json +0 -44
  553. package/source/openapi-specifications/v1.0/support/Help_Center_OIDC_Authentication.json +0 -900
  554. package/source/openapi-specifications/v1.0/support/Helpcenter.json +0 -1212
  555. package/source/openapi-specifications/v1.0/support/HelpcenterAutoTranslateSetting.json +0 -331
  556. package/source/openapi-specifications/v1.0/support/HelpcenterGroups.json +0 -1496
  557. package/source/openapi-specifications/v1.0/support/HelpcenterPages.json +0 -504
  558. package/source/openapi-specifications/v1.0/support/HelpcenterPreference.json +0 -208
  559. package/source/openapi-specifications/v1.0/support/HelpcenterTranslationApp.json +0 -64
  560. package/source/openapi-specifications/v1.0/support/HelpcenterUpload.json +0 -211
  561. package/source/openapi-specifications/v1.0/support/HolidayList.json +0 -731
  562. package/source/openapi-specifications/v1.0/support/IMAPAddress.json +0 -1091
  563. package/source/openapi-specifications/v1.0/support/IMCannedMessage.json +0 -1357
  564. package/source/openapi-specifications/v1.0/support/IMCannedMessagePlaceHolders.json +0 -169
  565. package/source/openapi-specifications/v1.0/support/IMCannedMessageTranslation.json +0 -624
  566. package/source/openapi-specifications/v1.0/support/IMTemplateMessage.json +0 -597
  567. package/source/openapi-specifications/v1.0/support/IM_AddOn.json +0 -841
  568. package/source/openapi-specifications/v1.0/support/IM_AttachmentMessage.json +0 -64
  569. package/source/openapi-specifications/v1.0/support/IM_Bot.json +0 -1007
  570. package/source/openapi-specifications/v1.0/support/IM_BotService.json +0 -357
  571. package/source/openapi-specifications/v1.0/support/IM_Broadcast.json +0 -323
  572. package/source/openapi-specifications/v1.0/support/IM_Channel.json +0 -2849
  573. package/source/openapi-specifications/v1.0/support/IM_ChannelPreference.json +0 -502
  574. package/source/openapi-specifications/v1.0/support/IM_Contact.json +0 -165
  575. package/source/openapi-specifications/v1.0/support/IM_Efc.json +0 -188
  576. package/source/openapi-specifications/v1.0/support/IM_Integration.json +0 -1269
  577. package/source/openapi-specifications/v1.0/support/IM_IntegrationService.json +0 -454
  578. package/source/openapi-specifications/v1.0/support/IM_LayoutView.json +0 -625
  579. package/source/openapi-specifications/v1.0/support/IM_License.json +0 -225
  580. package/source/openapi-specifications/v1.0/support/IM_Message.json +0 -1371
  581. package/source/openapi-specifications/v1.0/support/IM_Metrics.json +0 -462
  582. package/source/openapi-specifications/v1.0/support/IM_Search.json +0 -547
  583. package/source/openapi-specifications/v1.0/support/IM_Session.json +0 -1397
  584. package/source/openapi-specifications/v1.0/support/IM_TemplateButton.json +0 -142
  585. package/source/openapi-specifications/v1.0/support/IM_TemplateFooter.json +0 -83
  586. package/source/openapi-specifications/v1.0/support/IM_TemplateHeader.json +0 -86
  587. package/source/openapi-specifications/v1.0/support/IM_TemplateItems.json +0 -73
  588. package/source/openapi-specifications/v1.0/support/IM_TimeSeriesMetrics.json +0 -435
  589. package/source/openapi-specifications/v1.0/support/IM_TwilioPhoneNumber.json +0 -202
  590. package/source/openapi-specifications/v1.0/support/IM_WhatsApp_Integrations.json +0 -193
  591. package/source/openapi-specifications/v1.0/support/IM_ZiaGpt.json +0 -489
  592. package/source/openapi-specifications/v1.0/support/Import.json +0 -1844
  593. package/source/openapi-specifications/v1.0/support/IncrementalDocuments.json +0 -395
  594. package/source/openapi-specifications/v1.0/support/Inference.json +0 -307
  595. package/source/openapi-specifications/v1.0/support/InlineImage.json +0 -97
  596. package/source/openapi-specifications/v1.0/support/IntegModule.json +0 -938
  597. package/source/openapi-specifications/v1.0/support/Integrations.json +0 -1264
  598. package/source/openapi-specifications/v1.0/support/InteractiveTours.json +0 -539
  599. package/source/openapi-specifications/v1.0/support/JWT.json +0 -535
  600. package/source/openapi-specifications/v1.0/support/KBCategoryPermalink.json +0 -208
  601. package/source/openapi-specifications/v1.0/support/KBCategoryUser.json +0 -241
  602. package/source/openapi-specifications/v1.0/support/KBPreference.json +0 -323
  603. package/source/openapi-specifications/v1.0/support/KBRecycleBin.json +0 -2316
  604. package/source/openapi-specifications/v1.0/support/KBRootCategory.json +0 -2839
  605. package/source/openapi-specifications/v1.0/support/KBRootCategoryTranslation.json +0 -570
  606. package/source/openapi-specifications/v1.0/support/KBSection.json +0 -1941
  607. package/source/openapi-specifications/v1.0/support/KBTranslationMassActionResponse.json +0 -169
  608. package/source/openapi-specifications/v1.0/support/KPIWidget.json +0 -206
  609. package/source/openapi-specifications/v1.0/support/KbBot.json +0 -511
  610. package/source/openapi-specifications/v1.0/support/KbCategory.json +0 -1618
  611. package/source/openapi-specifications/v1.0/support/KbCategoryLogo.json +0 -124
  612. package/source/openapi-specifications/v1.0/support/Label.json +0 -1251
  613. package/source/openapi-specifications/v1.0/support/Layout.json +0 -8042
  614. package/source/openapi-specifications/v1.0/support/LayoutRuleCriteria.json +0 -491
  615. package/source/openapi-specifications/v1.0/support/LayoutRules.json +0 -1422
  616. package/source/openapi-specifications/v1.0/support/LensInteg.json +0 -86
  617. package/source/openapi-specifications/v1.0/support/LicenseFeaturePlan.json +0 -548
  618. package/source/openapi-specifications/v1.0/support/LicenseInfo.json +0 -1231
  619. package/source/openapi-specifications/v1.0/support/LicenseTool.json +0 -165
  620. package/source/openapi-specifications/v1.0/support/Livecall.json +0 -954
  621. package/source/openapi-specifications/v1.0/support/LookupRecord.json +0 -174
  622. package/source/openapi-specifications/v1.0/support/Macros.json +0 -1960
  623. package/source/openapi-specifications/v1.0/support/MailReplyAddress.json +0 -1263
  624. package/source/openapi-specifications/v1.0/support/MassAction.json +0 -1151
  625. package/source/openapi-specifications/v1.0/support/MassActionError.json +0 -55
  626. package/source/openapi-specifications/v1.0/support/MassActionResponse.json +0 -89
  627. package/source/openapi-specifications/v1.0/support/Mentions.json +0 -491
  628. package/source/openapi-specifications/v1.0/support/Message.json +0 -685
  629. package/source/openapi-specifications/v1.0/support/Microsoft.json +0 -887
  630. package/source/openapi-specifications/v1.0/support/MicrosoftTeams.json +0 -574
  631. package/source/openapi-specifications/v1.0/support/Microsoft_PowerBI.json +0 -903
  632. package/source/openapi-specifications/v1.0/support/Misc.json +0 -214
  633. package/source/openapi-specifications/v1.0/support/Module.json +0 -1625
  634. package/source/openapi-specifications/v1.0/support/NewCriteria.json +0 -1863
  635. package/source/openapi-specifications/v1.0/support/NewFeatureFields.json +0 -204
  636. package/source/openapi-specifications/v1.0/support/NewTicketHistory.json +0 -150
  637. package/source/openapi-specifications/v1.0/support/NotificationRules.json +0 -441
  638. package/source/openapi-specifications/v1.0/support/OEmbedData.json +0 -233
  639. package/source/openapi-specifications/v1.0/support/Onboarding.json +0 -282
  640. package/source/openapi-specifications/v1.0/support/Organization.json +0 -1391
  641. package/source/openapi-specifications/v1.0/support/PBGroup.json +0 -634
  642. package/source/openapi-specifications/v1.0/support/PBGroupAgents.json +0 -433
  643. package/source/openapi-specifications/v1.0/support/PBPlatform.json +0 -1447
  644. package/source/openapi-specifications/v1.0/support/PBX.json +0 -550
  645. package/source/openapi-specifications/v1.0/support/PBXConfig.json +0 -219
  646. package/source/openapi-specifications/v1.0/support/PBXPhoneNumbers.json +0 -443
  647. package/source/openapi-specifications/v1.0/support/PBXPreference.json +0 -314
  648. package/source/openapi-specifications/v1.0/support/PageSense.json +0 -1505
  649. package/source/openapi-specifications/v1.0/support/PendingApproval.json +0 -279
  650. package/source/openapi-specifications/v1.0/support/Permalink.json +0 -393
  651. package/source/openapi-specifications/v1.0/support/PhoneAgents.json +0 -1014
  652. package/source/openapi-specifications/v1.0/support/PhoneMenu.json +0 -118
  653. package/source/openapi-specifications/v1.0/support/PinnedConversation.json +0 -1115
  654. package/source/openapi-specifications/v1.0/support/Pipeline_Info.json +0 -232
  655. package/source/openapi-specifications/v1.0/support/Pipeline_Service.json +0 -499
  656. package/source/openapi-specifications/v1.0/support/Product.json +0 -1861
  657. package/source/openapi-specifications/v1.0/support/ProductAttachment.json +0 -485
  658. package/source/openapi-specifications/v1.0/support/Profile.json +0 -4236
  659. package/source/openapi-specifications/v1.0/support/ProjectsInteg.json +0 -989
  660. package/source/openapi-specifications/v1.0/support/QueryStore.json +0 -238
  661. package/source/openapi-specifications/v1.0/support/QueueView.json +0 -335
  662. package/source/openapi-specifications/v1.0/support/RatelimitAdminTool.json +0 -1204
  663. package/source/openapi-specifications/v1.0/support/Records.json +0 -1509
  664. package/source/openapi-specifications/v1.0/support/Recyclebin.json +0 -669
  665. package/source/openapi-specifications/v1.0/support/RemoteAuth.json +0 -401
  666. package/source/openapi-specifications/v1.0/support/Report.json +0 -6491
  667. package/source/openapi-specifications/v1.0/support/ReportChart.json +0 -254
  668. package/source/openapi-specifications/v1.0/support/ReportFolder.json +0 -1076
  669. package/source/openapi-specifications/v1.0/support/ReportIntegration.json +0 -202
  670. package/source/openapi-specifications/v1.0/support/RequestFlags.json +0 -358
  671. package/source/openapi-specifications/v1.0/support/Resources.json +0 -335
  672. package/source/openapi-specifications/v1.0/support/ResponseHelpCenterUser.json +0 -128
  673. package/source/openapi-specifications/v1.0/support/Role.json +0 -996
  674. package/source/openapi-specifications/v1.0/support/RoundRobin.json +0 -796
  675. package/source/openapi-specifications/v1.0/support/RoundRobinTarget.json +0 -381
  676. package/source/openapi-specifications/v1.0/support/RoutingPreference.json +0 -615
  677. package/source/openapi-specifications/v1.0/support/RuleGroup.json +0 -1630
  678. package/source/openapi-specifications/v1.0/support/SLAMetaInfo.json +0 -227
  679. package/source/openapi-specifications/v1.0/support/Saml.json +0 -565
  680. package/source/openapi-specifications/v1.0/support/Sandbox.json +0 -1075
  681. package/source/openapi-specifications/v1.0/support/SandboxChangeset.json +0 -501
  682. package/source/openapi-specifications/v1.0/support/SandboxDeployment.json +0 -428
  683. package/source/openapi-specifications/v1.0/support/SandboxDeploymentLogs.json +0 -295
  684. package/source/openapi-specifications/v1.0/support/SandboxSourceOrganization.json +0 -268
  685. package/source/openapi-specifications/v1.0/support/SavedFilters.json +0 -652
  686. package/source/openapi-specifications/v1.0/support/Schedule.json +0 -2077
  687. package/source/openapi-specifications/v1.0/support/ScheduleReplyInfo.json +0 -2271
  688. package/source/openapi-specifications/v1.0/support/Search.json +0 -12600
  689. package/source/openapi-specifications/v1.0/support/SearchInteg.json +0 -2254
  690. package/source/openapi-specifications/v1.0/support/Setup.json +0 -1766
  691. package/source/openapi-specifications/v1.0/support/SharedSnippet.json +0 -1110
  692. package/source/openapi-specifications/v1.0/support/SharingRule.json +0 -287
  693. package/source/openapi-specifications/v1.0/support/Signature.json +0 -354
  694. package/source/openapi-specifications/v1.0/support/Skill.json +0 -2164
  695. package/source/openapi-specifications/v1.0/support/SkillConfiguration.json +0 -269
  696. package/source/openapi-specifications/v1.0/support/SkillType.json +0 -807
  697. package/source/openapi-specifications/v1.0/support/Slack.json +0 -957
  698. package/source/openapi-specifications/v1.0/support/SmsTemplates.json +0 -514
  699. package/source/openapi-specifications/v1.0/support/Snippets.json +0 -918
  700. package/source/openapi-specifications/v1.0/support/SocialBrands.json +0 -427
  701. package/source/openapi-specifications/v1.0/support/SocialInteg.json +0 -336
  702. package/source/openapi-specifications/v1.0/support/SocialPosts.json +0 -2460
  703. package/source/openapi-specifications/v1.0/support/SocialTwitterConversations.json +0 -337
  704. package/source/openapi-specifications/v1.0/support/StarredTemplates.json +0 -690
  705. package/source/openapi-specifications/v1.0/support/Statistics.json +0 -125
  706. package/source/openapi-specifications/v1.0/support/SubjectAccessRequest.json +0 -2419
  707. package/source/openapi-specifications/v1.0/support/Supervise.json +0 -774
  708. package/source/openapi-specifications/v1.0/support/SupportEmailAddress.json +0 -188
  709. package/source/openapi-specifications/v1.0/support/SupportEmailDomain.json +0 -293
  710. package/source/openapi-specifications/v1.0/support/SupportPlan.json +0 -1109
  711. package/source/openapi-specifications/v1.0/support/Tab.json +0 -606
  712. package/source/openapi-specifications/v1.0/support/Target.json +0 -1311
  713. package/source/openapi-specifications/v1.0/support/TargetFunctions.json +0 -130
  714. package/source/openapi-specifications/v1.0/support/Task.json +0 -4006
  715. package/source/openapi-specifications/v1.0/support/TaskAttachment.json +0 -443
  716. package/source/openapi-specifications/v1.0/support/TaskComments.json +0 -706
  717. package/source/openapi-specifications/v1.0/support/TaskTimeEntry.json +0 -1756
  718. package/source/openapi-specifications/v1.0/support/TaskTimer.json +0 -441
  719. package/source/openapi-specifications/v1.0/support/Team.json +0 -1383
  720. package/source/openapi-specifications/v1.0/support/TemplateFolders.json +0 -1069
  721. package/source/openapi-specifications/v1.0/support/Theme.json +0 -152
  722. package/source/openapi-specifications/v1.0/support/Thread.json +0 -3545
  723. package/source/openapi-specifications/v1.0/support/Ticket.json +0 -9495
  724. package/source/openapi-specifications/v1.0/support/TicketApprovals.json +0 -855
  725. package/source/openapi-specifications/v1.0/support/TicketAttachment.json +0 -562
  726. package/source/openapi-specifications/v1.0/support/TicketComment.json +0 -1444
  727. package/source/openapi-specifications/v1.0/support/TicketCount.json +0 -690
  728. package/source/openapi-specifications/v1.0/support/TicketFollowers.json +0 -454
  729. package/source/openapi-specifications/v1.0/support/TicketHistory.json +0 -414
  730. package/source/openapi-specifications/v1.0/support/TicketMetrics.json +0 -369
  731. package/source/openapi-specifications/v1.0/support/TicketRealTime.json +0 -178
  732. package/source/openapi-specifications/v1.0/support/TicketTag.json +0 -1513
  733. package/source/openapi-specifications/v1.0/support/TicketTemplate.json +0 -907
  734. package/source/openapi-specifications/v1.0/support/TicketTimeEntry.json +0 -1681
  735. package/source/openapi-specifications/v1.0/support/TicketTimer.json +0 -1205
  736. package/source/openapi-specifications/v1.0/support/TimeTracking.json +0 -1212
  737. package/source/openapi-specifications/v1.0/support/TrainingCourses.json +0 -614
  738. package/source/openapi-specifications/v1.0/support/TrainingIntegration.json +0 -163
  739. package/source/openapi-specifications/v1.0/support/TranslationLanguages.json +0 -2772
  740. package/source/openapi-specifications/v1.0/support/Upload.json +0 -620
  741. package/source/openapi-specifications/v1.0/support/User.json +0 -1409
  742. package/source/openapi-specifications/v1.0/support/UserAuthentication.json +0 -617
  743. package/source/openapi-specifications/v1.0/support/UserPresence.json +0 -763
  744. package/source/openapi-specifications/v1.0/support/ValidationRuleCriteria.json +0 -107
  745. package/source/openapi-specifications/v1.0/support/ValidationRules.json +0 -1173
  746. package/source/openapi-specifications/v1.0/support/Webhook.json +0 -1330
  747. package/source/openapi-specifications/v1.0/support/WhatsAppDetails.json +0 -132
  748. package/source/openapi-specifications/v1.0/support/WhatsAppMigration.json +0 -143
  749. package/source/openapi-specifications/v1.0/support/WhatsAppTemplateTags.json +0 -132
  750. package/source/openapi-specifications/v1.0/support/Widget.json +0 -3023
  751. package/source/openapi-specifications/v1.0/support/WmsDomain.json +0 -104
  752. package/source/openapi-specifications/v1.0/support/ZIAAnswerbotInference.json +0 -756
  753. package/source/openapi-specifications/v1.0/support/ZIADocumentData.json +0 -989
  754. package/source/openapi-specifications/v1.0/support/ZIASolutionService.json +0 -135
  755. package/source/openapi-specifications/v1.0/support/ZIAVectorSearch.json +0 -376
  756. package/source/openapi-specifications/v1.0/support/ZiaDCMigration.json +0 -159
  757. package/source/openapi-specifications/v1.0/support/ZiaGPT.json +0 -3229
  758. package/source/openapi-specifications/v1.0/support/ZiaScheduler.json +0 -453
  759. package/source/openapi-specifications/v1.0/support/Zwitch.json +0 -1543
  760. package/source/openapi-specifications/v1.0/support/blueprintChartData.json +0 -201
  761. package/source/openapi-specifications/v1.0/support/blueprintConnections.json +0 -75
  762. package/source/openapi-specifications/v1.0/support/blueprintCriteria.json +0 -255
  763. package/source/openapi-specifications/v1.0/support/blueprintDrafts.json +0 -1677
  764. package/source/openapi-specifications/v1.0/support/blueprintStates.json +0 -284
  765. package/source/openapi-specifications/v1.0/support/blueprintStrictModeConfig.json +0 -91
  766. package/source/openapi-specifications/v1.0/support/blueprintTransitions.json +0 -1546
  767. package/source/openapi-specifications/v1.0/support/blueprints.json +0 -2992
  768. package/source/openapi-specifications/v1.0/support/errors.json +0 -80
  769. package/source/openapi-specifications/v1.0/support/zlabsnlp.json +0 -416
@@ -1,1496 +0,0 @@
1
- {
2
- "openapi" : "3.1.0",
3
- "info" : {
4
- "title" : "HelpcenterGroups",
5
- "version" : "1.0.0",
6
- "x-clan-group" : "helpCenter",
7
- "x-module-group" : "solutions"
8
- },
9
- "paths" : {
10
- "/api/v1/groups/{groupId}/users" : {
11
- "get" : {
12
- "tags" : [ "HelpcenterGroups" ],
13
- "summary" : "List users in a group",
14
- "description" : "This API lists a particular number of users in a group, based on the limit defined.",
15
- "operationId" : "getHelpCenterGroupUsers",
16
- "parameters" : [ {
17
- "$ref" : "#/components/parameters/groupId"
18
- }, {
19
- "$ref" : "../common/Common.json#/components/parameters/orgId"
20
- } ],
21
- "responses" : {
22
- "200" : {
23
- "$ref" : "#/components/responses/userListViewJson"
24
- },
25
- "500" : {
26
- "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
27
- },
28
- "403" : {
29
- "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
30
- }
31
- },
32
- "security" : [ {
33
- "org-oauth" : [ "Desk.accessAll.ALL" ]
34
- }, {
35
- "iam-oauth2-schema" : [ "Desk.contacts.READ", "Desk.settings.READ", "Desk.search.READ" ]
36
- } ],
37
- "x-audience" : [ "external-public" ],
38
- "x-custom-url-attribute" : {
39
- "security" : {
40
- "throttle" : {
41
- "inline" : [ {
42
- "scope" : "APPSERVER",
43
- "rules" : [ {
44
- "duration" : 60000,
45
- "lock-period" : 600000,
46
- "threshold" : 80,
47
- "hip" : false
48
- }, {
49
- "duration" : 3600000,
50
- "lock-period" : 1200000,
51
- "threshold" : 500,
52
- "hip" : false
53
- }, {
54
- "duration" : 86400000,
55
- "lock-period" : 1800000,
56
- "threshold" : 1000,
57
- "hip" : false
58
- } ],
59
- "window" : "ROLLING",
60
- "key" : "url.path+user.zuid"
61
- } ]
62
- },
63
- "extraparams" : {
64
- "disable" : true,
65
- "ignore" : false
66
- },
67
- "authentication" : {
68
- "deprecatedScopes" : [ "settings" ]
69
- }
70
- },
71
- "clan-group" : "helpCenter",
72
- "apihash" : "5c778d9d648702346cd906c9d513d5ed",
73
- "module-group" : "solutions",
74
- "apimethod" : "com.zoho.desk.helpcenter.group.restapi.support.GroupService.getUsers"
75
- }
76
- }
77
- },
78
- "/api/v1/groups/{groupId}" : {
79
- "get" : {
80
- "tags" : [ "HelpcenterGroups" ],
81
- "summary" : "Get details of group",
82
- "description" : "This API fetches the details of a particular user group.",
83
- "operationId" : "getHelpCenterGroup",
84
- "parameters" : [ {
85
- "$ref" : "#/components/parameters/groupId"
86
- }, {
87
- "$ref" : "../common/Common.json#/components/parameters/orgId"
88
- } ],
89
- "responses" : {
90
- "200" : {
91
- "$ref" : "#/components/responses/addGroupResponse"
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.contacts.READ", "Desk.settings.READ" ]
104
- } ],
105
- "x-audience" : [ "external-public" ],
106
- "x-custom-url-attribute" : {
107
- "security" : {
108
- "throttle" : {
109
- "policy" : "ReadAPI_Standard_UserPolicy"
110
- },
111
- "extraparams" : {
112
- "disable" : true,
113
- "ignore" : false
114
- },
115
- "authentication" : {
116
- "deprecatedScopes" : [ "settings" ]
117
- }
118
- },
119
- "clan-group" : "helpCenter",
120
- "apihash" : "b3c26f4bc5df209063925c44f8d3a02c",
121
- "module-group" : "solutions",
122
- "apimethod" : "com.zoho.desk.helpcenter.group.restapi.support.GroupService.getGroup"
123
- }
124
- },
125
- "delete" : {
126
- "tags" : [ "HelpcenterGroups" ],
127
- "summary" : "Delete helpcenter user group",
128
- "description" : "This API deletes a user group from your help center.",
129
- "operationId" : "deleteHelpCenterUserGroup",
130
- "parameters" : [ {
131
- "$ref" : "#/components/parameters/groupId"
132
- }, {
133
- "$ref" : "../common/Common.json#/components/parameters/orgId"
134
- } ],
135
- "responses" : {
136
- "422" : {
137
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
138
- },
139
- "500" : {
140
- "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
141
- },
142
- "204" : {
143
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
144
- },
145
- "403" : {
146
- "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
147
- }
148
- },
149
- "security" : [ {
150
- "org-oauth" : [ "Desk.accessAll.ALL" ]
151
- }, {
152
- "iam-oauth2-schema" : [ "Desk.contacts.DELETE", "Desk.settings.DELETE" ]
153
- } ],
154
- "x-audience" : [ "external-public" ],
155
- "x-custom-url-attribute" : {
156
- "security" : {
157
- "throttle" : {
158
- "inline" : [ {
159
- "scope" : "APPSERVER",
160
- "rules" : [ {
161
- "duration" : 60000,
162
- "lock-period" : 300000,
163
- "threshold" : 20,
164
- "hip" : false
165
- }, {
166
- "duration" : 3600000,
167
- "lock-period" : 900000,
168
- "threshold" : 200,
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
- "deprecatedScopes" : [ "settings" ]
181
- }
182
- },
183
- "clan-group" : "helpCenter",
184
- "apihash" : "d422f5bd60e0c52494d87951af16b277",
185
- "module-group" : "solutions",
186
- "apimethod" : "com.zoho.desk.helpcenter.group.restapi.support.GroupService.deleteGroup"
187
- }
188
- },
189
- "patch" : {
190
- "tags" : [ "HelpcenterGroups" ],
191
- "summary" : "Update group",
192
- "description" : "This API helps update the details of a user group.",
193
- "operationId" : "updateHelpCenterUserGroup",
194
- "parameters" : [ {
195
- "$ref" : "#/components/parameters/groupId"
196
- }, {
197
- "$ref" : "../common/Common.json#/components/parameters/orgId"
198
- } ],
199
- "requestBody" : {
200
- "$ref" : "#/components/requestBodies/updateGroupInput"
201
- },
202
- "responses" : {
203
- "200" : {
204
- "$ref" : "#/components/responses/addGroupResponse"
205
- },
206
- "422" : {
207
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
208
- },
209
- "500" : {
210
- "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
211
- },
212
- "403" : {
213
- "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
214
- }
215
- },
216
- "security" : [ {
217
- "org-oauth" : [ "Desk.accessAll.ALL" ]
218
- }, {
219
- "iam-oauth2-schema" : [ "Desk.contacts.UPDATE", "Desk.settings.UPDATE" ]
220
- } ],
221
- "x-audience" : [ "external-public" ],
222
- "x-custom-url-attribute" : {
223
- "security" : {
224
- "throttle" : {
225
- "inline" : [ {
226
- "scope" : "APPSERVER",
227
- "rules" : [ {
228
- "duration" : 60000,
229
- "lock-period" : 300000,
230
- "threshold" : 20,
231
- "hip" : false
232
- }, {
233
- "duration" : 3600000,
234
- "lock-period" : 900000,
235
- "threshold" : 250,
236
- "hip" : false
237
- } ],
238
- "window" : "ROLLING",
239
- "key" : "url.path+user.zuid"
240
- } ]
241
- },
242
- "extraparams" : {
243
- "disable" : true,
244
- "ignore" : false
245
- },
246
- "authentication" : {
247
- "deprecatedScopes" : [ "settings" ]
248
- }
249
- },
250
- "clan-group" : "helpCenter",
251
- "apihash" : "7280e1d688c29be4c4c722c5b42eb7bb",
252
- "module-group" : "solutions",
253
- "apimethod" : "com.zoho.desk.helpcenter.group.restapi.support.GroupService.updateGroup"
254
- }
255
- }
256
- },
257
- "/api/v1/groups/{groupId}/users/remove" : {
258
- "post" : {
259
- "tags" : [ "HelpcenterGroups" ],
260
- "summary" : "Remove users from group",
261
- "description" : "This API removes particular users from a group. ",
262
- "operationId" : "deleteHCGroupUsers",
263
- "parameters" : [ {
264
- "$ref" : "#/components/parameters/groupId"
265
- }, {
266
- "$ref" : "../common/Common.json#/components/parameters/orgId"
267
- } ],
268
- "requestBody" : {
269
- "$ref" : "#/components/requestBodies/removeUserInput"
270
- },
271
- "responses" : {
272
- "404" : {
273
- "$ref" : "../common/Common.json#/components/responses/urlNotFoundErrorResponse"
274
- },
275
- "422" : {
276
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
277
- },
278
- "500" : {
279
- "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
280
- },
281
- "204" : {
282
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
283
- },
284
- "403" : {
285
- "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
286
- }
287
- },
288
- "security" : [ {
289
- "org-oauth" : [ "Desk.accessAll.ALL" ]
290
- }, {
291
- "iam-oauth2-schema" : [ "Desk.contacts.UPDATE", "Desk.settings.UPDATE" ]
292
- } ],
293
- "x-audience" : [ "external-public" ],
294
- "x-custom-url-attribute" : {
295
- "security" : {
296
- "throttle" : {
297
- "inline" : [ {
298
- "scope" : "APPSERVER",
299
- "rules" : [ {
300
- "duration" : 60000,
301
- "lock-period" : 300000,
302
- "threshold" : 20,
303
- "hip" : false
304
- }, {
305
- "duration" : 3600000,
306
- "lock-period" : 900000,
307
- "threshold" : 200,
308
- "hip" : false
309
- } ],
310
- "window" : "ROLLING",
311
- "key" : "url.path+user.zuid"
312
- } ]
313
- },
314
- "extraparams" : {
315
- "disable" : true,
316
- "ignore" : false
317
- },
318
- "authentication" : {
319
- "deprecatedScopes" : [ "settings" ]
320
- }
321
- },
322
- "clan-group" : "helpCenter",
323
- "apihash" : "5aa4fae05b2aeb944a43a782fa874060",
324
- "module-group" : "solutions",
325
- "apimethod" : "com.zoho.desk.helpcenter.group.restapi.support.GroupService.removeUsers"
326
- }
327
- }
328
- },
329
- "/api/v1/groups" : {
330
- "get" : {
331
- "tags" : [ "HelpcenterGroups" ],
332
- "summary" : "List helpcenter groups",
333
- "description" : "This API lists a particular number of groups, based on the limit defined.",
334
- "operationId" : "getHelpCenterGroupList",
335
- "parameters" : [ {
336
- "name" : "limit",
337
- "in" : "query",
338
- "description" : "Number of groups to list. The default value and the maximum value allowed is 50.",
339
- "required" : false,
340
- "style" : "form",
341
- "explode" : true,
342
- "schema" : {
343
- "type" : [ "string", "null", "integer" ],
344
- "format" : "int32",
345
- "description" : "Number of groups to list. The default value and the maximum value allowed is 50.",
346
- "pattern" : "([0-9]+)"
347
- }
348
- }, {
349
- "name" : "searchBy",
350
- "in" : "query",
351
- "description" : "Search keyword to use for finding a particular group The keyword must contain at least two characters. Three types of search are supported: @keyword*@ (search for values that start with the keyword, @*keyword*@ (search for values that contain the keyword), and @keyword@ (search for values that are exact matches of the keyword).",
352
- "required" : false,
353
- "style" : "form",
354
- "explode" : true,
355
- "schema" : {
356
- "type" : [ "string", "null" ],
357
- "description" : "Search keyword to use for finding a particular group The keyword must contain at least two characters. Three types of search are supported: @keyword*@ (search for values that start with the keyword, @*keyword*@ (search for values that contain the keyword), and @keyword@ (search for values that are exact matches of the keyword).",
358
- "maxLength" : 100,
359
- "minLength" : 0,
360
- "pattern" : "[0-9a-zA-Z_\\-\\&\\.\\$\\@\\^\\(\\)\\{\\}\\~\\=\\-\\|\\*\\+\\?\\[\\]\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+"
361
- }
362
- }, {
363
- "name" : "from",
364
- "in" : "query",
365
- "description" : "Index number, starting from which the groups must be fetched. The default value is 1. ",
366
- "required" : false,
367
- "style" : "form",
368
- "explode" : true,
369
- "schema" : {
370
- "type" : [ "string", "null", "integer" ],
371
- "format" : "int32",
372
- "description" : "Index number, starting from which the groups must be fetched. The default value is 1. ",
373
- "pattern" : "([0-9]+)"
374
- }
375
- }, {
376
- "name" : "sortBy",
377
- "in" : "query",
378
- "description" : "Key that sorts the list of groups by a particular attribute: -(@createdTime@, @modifiedTime@, @name@, or @count@)",
379
- "required" : false,
380
- "style" : "form",
381
- "explode" : true,
382
- "schema" : {
383
- "type" : [ "string", "null" ],
384
- "description" : "Key that sorts the list of groups by a particular attribute: -(@createdTime@, @modifiedTime@, @name@, or @count@)",
385
- "enum" : [ "name", "modifiedTime", "createdTime", "count" ],
386
- "maxLength" : 100,
387
- "minLength" : 0
388
- }
389
- }, {
390
- "name" : "helpCenterId",
391
- "in" : "query",
392
- "description" : "ID of the help center from which the resource must be fetched",
393
- "required" : false,
394
- "style" : "form",
395
- "explode" : true,
396
- "schema" : {
397
- "type" : [ "string", "null", "integer" ],
398
- "format" : "int64",
399
- "description" : "ID of the help center from which the resource must be fetched",
400
- "pattern" : "([0-9]+)"
401
- }
402
- }, {
403
- "name" : "status",
404
- "in" : "query",
405
- "description" : "Activation status of the group. Values supported are @ACTIVE@ and @DISABLED@",
406
- "required" : false,
407
- "style" : "form",
408
- "explode" : true,
409
- "schema" : {
410
- "type" : [ "string", "null" ],
411
- "description" : "Activation status of the group. Values supported are @ACTIVE@ and @DISABLED@",
412
- "enum" : [ "ACTIVE", "DISABLED" ],
413
- "maxLength" : 100,
414
- "minLength" : 0,
415
- "x-audience" : [ "company-internal" ]
416
- }
417
- }, {
418
- "$ref" : "../common/Common.json#/components/parameters/orgId"
419
- } ],
420
- "responses" : {
421
- "200" : {
422
- "$ref" : "#/components/responses/listOfGroupResponse"
423
- },
424
- "500" : {
425
- "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
426
- },
427
- "403" : {
428
- "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
429
- }
430
- },
431
- "security" : [ {
432
- "org-oauth" : [ "Desk.accessAll.ALL" ]
433
- }, {
434
- "iam-oauth2-schema" : [ "Desk.contacts.READ", "Desk.settings.READ" ]
435
- } ],
436
- "x-audience" : [ "external-public" ],
437
- "x-custom-url-attribute" : {
438
- "security" : {
439
- "throttle" : {
440
- "inline" : [ {
441
- "scope" : "APPSERVER",
442
- "rules" : [ {
443
- "duration" : 60000,
444
- "lock-period" : 300000,
445
- "threshold" : 50,
446
- "hip" : false
447
- } ],
448
- "window" : "ROLLING",
449
- "key" : "url.path+user.zuid"
450
- } ]
451
- },
452
- "extraparams" : {
453
- "disable" : true,
454
- "ignore" : false
455
- },
456
- "authentication" : {
457
- "deprecatedScopes" : [ "settings" ]
458
- }
459
- },
460
- "clan-group" : "helpCenter",
461
- "apihash" : "d131078316c66b7a999d8a5bce59a1b3",
462
- "module-group" : "solutions",
463
- "apimethod" : "com.zoho.desk.helpcenter.group.restapi.support.GroupService.getGroups"
464
- }
465
- },
466
- "post" : {
467
- "tags" : [ "HelpcenterGroups" ],
468
- "summary" : "Create user groups",
469
- "description" : "This API creates a user group in your help center.",
470
- "operationId" : "addHelpCenterGroup",
471
- "parameters" : [ {
472
- "$ref" : "../common/Common.json#/components/parameters/orgId"
473
- } ],
474
- "requestBody" : {
475
- "$ref" : "#/components/requestBodies/addGroupInput"
476
- },
477
- "responses" : {
478
- "200" : {
479
- "$ref" : "#/components/responses/addGroupResponse"
480
- },
481
- "422" : {
482
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
483
- },
484
- "500" : {
485
- "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
486
- },
487
- "403" : {
488
- "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
489
- }
490
- },
491
- "security" : [ {
492
- "org-oauth" : [ "Desk.accessAll.ALL" ]
493
- }, {
494
- "iam-oauth2-schema" : [ "Desk.contacts.CREATE", "Desk.settings.CREATE" ]
495
- } ],
496
- "x-audience" : [ "external-public" ],
497
- "x-custom-url-attribute" : {
498
- "security" : {
499
- "throttle" : {
500
- "inline" : [ {
501
- "scope" : "APPSERVER",
502
- "rules" : [ {
503
- "duration" : 60000,
504
- "lock-period" : 300000,
505
- "threshold" : 20,
506
- "hip" : false
507
- }, {
508
- "duration" : 3600000,
509
- "lock-period" : 900000,
510
- "threshold" : 300,
511
- "hip" : false
512
- } ],
513
- "window" : "ROLLING",
514
- "key" : "url.path+user.zuid"
515
- } ]
516
- },
517
- "extraparams" : {
518
- "disable" : true,
519
- "ignore" : false
520
- },
521
- "authentication" : {
522
- "deprecatedScopes" : [ "settings" ]
523
- }
524
- },
525
- "clan-group" : "helpCenter",
526
- "apihash" : "8751395ea1cc4262caed87ee40047355",
527
- "module-group" : "solutions",
528
- "apimethod" : "com.zoho.desk.helpcenter.group.restapi.support.GroupService.addGroup"
529
- }
530
- }
531
- },
532
- "/api/v1/groups/{groupId}/users/add" : {
533
- "post" : {
534
- "tags" : [ "HelpcenterGroups" ],
535
- "summary" : "Add users to group",
536
- "description" : "This API adds users to a particular group.",
537
- "operationId" : "addHelpCenterGroupUsers",
538
- "parameters" : [ {
539
- "$ref" : "#/components/parameters/groupId"
540
- }, {
541
- "$ref" : "../common/Common.json#/components/parameters/orgId"
542
- } ],
543
- "requestBody" : {
544
- "$ref" : "#/components/requestBodies/addUserInput"
545
- },
546
- "responses" : {
547
- "422" : {
548
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
549
- },
550
- "500" : {
551
- "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
552
- },
553
- "204" : {
554
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
555
- },
556
- "403" : {
557
- "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
558
- }
559
- },
560
- "security" : [ {
561
- "org-oauth" : [ "Desk.accessAll.ALL" ]
562
- }, {
563
- "iam-oauth2-schema" : [ "Desk.contacts.UPDATE", "Desk.settings.UPDATE" ]
564
- } ],
565
- "x-audience" : [ "external-public" ],
566
- "x-custom-url-attribute" : {
567
- "security" : {
568
- "throttle" : {
569
- "inline" : [ {
570
- "scope" : "APPSERVER",
571
- "rules" : [ {
572
- "duration" : 60000,
573
- "lock-period" : 300000,
574
- "threshold" : 20,
575
- "hip" : false
576
- }, {
577
- "duration" : 3600000,
578
- "lock-period" : 900000,
579
- "threshold" : 200,
580
- "hip" : false
581
- } ],
582
- "window" : "ROLLING",
583
- "key" : "url.path+user.zuid"
584
- } ]
585
- },
586
- "extraparams" : {
587
- "disable" : true,
588
- "ignore" : false
589
- },
590
- "authentication" : {
591
- "deprecatedScopes" : [ "settings" ]
592
- }
593
- },
594
- "clan-group" : "helpCenter",
595
- "apihash" : "b594dbb75ae8ba0801059a197661ae9c",
596
- "module-group" : "solutions",
597
- "apimethod" : "com.zoho.desk.helpcenter.group.restapi.support.GroupService.addUsers"
598
- }
599
- }
600
- }
601
- },
602
- "components" : {
603
- "schemas" : {
604
- "userDefaultJson" : {
605
- "type" : [ "null", "object" ],
606
- "additionalProperties" : false,
607
- "properties" : {
608
- "photoUrl" : {
609
- "type" : [ "string", "null" ],
610
- "maxLength" : 200,
611
- "minLength" : 0,
612
- "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
613
- },
614
- "name" : {
615
- "type" : [ "string", "null" ],
616
- "maxLength" : 100,
617
- "minLength" : 0
618
- },
619
- "id" : {
620
- "type" : [ "string", "null", "integer" ],
621
- "format" : "int64",
622
- "pattern" : "([0-9]+)"
623
- }
624
- },
625
- "required" : [ "id", "name", "photoUrl" ]
626
- },
627
- "userDetailJson" : {
628
- "additionalProperties" : false,
629
- "allOf" : [ {
630
- "$ref" : "./HelpcenterGroups.json#/components/schemas/userDefaultJson"
631
- }, {
632
- "type" : [ "null", "object" ],
633
- "properties" : {
634
- "emailAddress" : {
635
- "type" : [ "string", "null" ],
636
- "maxLength" : 100,
637
- "minLength" : 0,
638
- "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$"
639
- },
640
- "creator" : {
641
- "type" : [ "null", "object" ],
642
- "additionalProperties" : false,
643
- "maxProperties" : 3,
644
- "minProperties" : 3,
645
- "properties" : {
646
- "photoUrl" : {
647
- "type" : [ "string", "null" ],
648
- "maxLength" : 100,
649
- "minLength" : 0,
650
- "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
651
- },
652
- "name" : {
653
- "type" : [ "string", "null" ],
654
- "maxLength" : 100,
655
- "minLength" : 0
656
- },
657
- "id" : {
658
- "type" : [ "string", "null", "integer" ],
659
- "format" : "int64",
660
- "pattern" : "([0-9]+)"
661
- }
662
- },
663
- "required" : [ "id", "name", "photoUrl" ]
664
- },
665
- "addedTime" : {
666
- "type" : [ "string", "null" ],
667
- "maxLength" : 100,
668
- "minLength" : 0,
669
- "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))"
670
- },
671
- "userType" : {
672
- "type" : [ "string", "null" ],
673
- "enum" : [ "ENDUSER", "SUPPORTREP" ],
674
- "maxLength" : 100,
675
- "minLength" : 0
676
- },
677
- "label" : {
678
- "$ref" : "./Label.json#/components/schemas/labelMetaResponse"
679
- },
680
- "status" : {
681
- "type" : [ "string", "null" ],
682
- "enum" : [ "ACTIVE", "DISABLED", "DELETED" ],
683
- "maxLength" : 100,
684
- "minLength" : 0
685
- }
686
- },
687
- "required" : [ "addedTime", "creator", "emailAddress", "label", "status", "userType" ]
688
- } ]
689
- },
690
- "data" : {
691
- "type" : [ "null", "array" ],
692
- "items" : {
693
- "$ref" : "./HelpcenterGroups.json#/components/schemas/userDetailJson"
694
- }
695
- },
696
- "addGroupResponse" : {
697
- "type" : [ "null", "object" ],
698
- "additionalProperties" : false,
699
- "properties" : {
700
- "modifiedTime" : {
701
- "type" : [ "string", "null" ],
702
- "maxLength" : 100,
703
- "minLength" : 0,
704
- "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))"
705
- },
706
- "creator" : {
707
- "type" : [ "null", "object" ],
708
- "additionalProperties" : false,
709
- "maxProperties" : 3,
710
- "minProperties" : 3,
711
- "properties" : {
712
- "photoUrl" : {
713
- "type" : [ "string", "null" ],
714
- "maxLength" : 100,
715
- "minLength" : 0,
716
- "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
717
- },
718
- "name" : {
719
- "type" : [ "string", "null" ],
720
- "maxLength" : 100,
721
- "minLength" : 0
722
- },
723
- "id" : {
724
- "type" : [ "string", "null", "integer" ],
725
- "format" : "int64",
726
- "pattern" : "([0-9]+)"
727
- }
728
- },
729
- "required" : [ "id", "name", "photoUrl" ]
730
- },
731
- "modifier" : {
732
- "type" : [ "null", "object" ],
733
- "additionalProperties" : false,
734
- "maxProperties" : 3,
735
- "minProperties" : 3,
736
- "properties" : {
737
- "photoUrl" : {
738
- "type" : [ "string", "null" ],
739
- "maxLength" : 100,
740
- "minLength" : 0,
741
- "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
742
- },
743
- "name" : {
744
- "type" : [ "string", "null" ],
745
- "maxLength" : 100,
746
- "minLength" : 0
747
- },
748
- "id" : {
749
- "type" : [ "string", "null", "integer" ],
750
- "format" : "int64",
751
- "pattern" : "([0-9]+)"
752
- }
753
- },
754
- "required" : [ "id", "name", "photoUrl" ]
755
- },
756
- "name" : {
757
- "type" : [ "string", "null" ],
758
- "maxLength" : 100,
759
- "minLength" : 0,
760
- "pattern" : "[0-9a-zA-Z_\\-\\&\\.\\$\\@\\^\\(\\)\\{\\}\\~\\=\\-\\|\\*\\+\\?\\[\\]\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+"
761
- },
762
- "count" : {
763
- "type" : [ "string", "null", "integer" ],
764
- "format" : "int32",
765
- "pattern" : "([0-9]+)"
766
- },
767
- "description" : {
768
- "type" : [ "string", "null" ],
769
- "maxLength" : 100,
770
- "minLength" : 0
771
- },
772
- "createdTime" : {
773
- "type" : [ "string", "null" ],
774
- "maxLength" : 100,
775
- "minLength" : 0,
776
- "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))"
777
- },
778
- "id" : {
779
- "type" : [ "string", "null", "integer" ],
780
- "format" : "int64",
781
- "pattern" : "([0-9]+)"
782
- },
783
- "helpCenterId" : {
784
- "type" : [ "string", "null", "integer" ],
785
- "format" : "int64",
786
- "pattern" : "([0-9]+)",
787
- "x-custom-parameters-attributes" : {
788
- "removeExif" : false,
789
- "filterMatchedContent" : false,
790
- "antivirus" : false,
791
- "replacementString" : "",
792
- "allowInvalid" : false,
793
- "descrption" : "ID of the help center from which the resource must be fetched",
794
- "secret" : false,
795
- "preserveCharsLimit" : 10,
796
- "trim" : false,
797
- "internalParam" : false,
798
- "preserveChars" : "0,5",
799
- "importUrl" : false,
800
- "decrypt" : false
801
- }
802
- },
803
- "isAssociated" : {
804
- "type" : [ "boolean", "null" ]
805
- },
806
- "logoUrl" : {
807
- "type" : [ "string", "null" ],
808
- "maxLength" : 200,
809
- "minLength" : 0,
810
- "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
811
- },
812
- "status" : {
813
- "type" : [ "string", "null" ],
814
- "enum" : [ "ACTIVE", "DISABLED" ],
815
- "maxLength" : 100,
816
- "minLength" : 0,
817
- "x-custom-parameters-attributes" : {
818
- "removeExif" : false,
819
- "filterMatchedContent" : false,
820
- "antivirus" : false,
821
- "replacementString" : "",
822
- "allowInvalid" : false,
823
- "descrption" : "Activation status of the group. Values supported are @ACTIVE@ and @DISABLED@",
824
- "secret" : false,
825
- "preserveCharsLimit" : 10,
826
- "trim" : false,
827
- "internalParam" : true,
828
- "preserveChars" : "0,5",
829
- "importUrl" : false,
830
- "decrypt" : false
831
- }
832
- }
833
- },
834
- "required" : [ "count", "createdTime", "creator", "description", "helpCenterId", "id", "isAssociated", "logoUrl", "modifiedTime", "modifier", "name", "status" ]
835
- },
836
- "groupsArray" : {
837
- "type" : [ "null", "array" ],
838
- "items" : {
839
- "$ref" : "./HelpcenterGroups.json#/components/schemas/addGroupResponse"
840
- }
841
- },
842
- "groupIdsArr" : {
843
- "type" : [ "null", "array" ],
844
- "items" : {
845
- "type" : [ "string", "null", "integer" ],
846
- "format" : "int64",
847
- "pattern" : "([0-9]+)"
848
- }
849
- },
850
- "groupMetaResponse" : {
851
- "type" : [ "null", "object" ],
852
- "additionalProperties" : false,
853
- "properties" : {
854
- "name" : {
855
- "type" : [ "string", "null" ],
856
- "maxLength" : 100,
857
- "minLength" : 0,
858
- "pattern" : "[0-9a-zA-Z_\\-\\&\\.\\$\\@\\^\\(\\)\\{\\}\\~\\=\\-\\|\\*\\+\\?\\[\\]\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+"
859
- },
860
- "addedTime" : {
861
- "type" : [ "string", "null" ],
862
- "maxLength" : 100,
863
- "minLength" : 0,
864
- "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))"
865
- },
866
- "id" : {
867
- "type" : [ "string", "null", "integer" ],
868
- "format" : "int64",
869
- "pattern" : "([0-9]+)"
870
- },
871
- "helpCenterId" : {
872
- "type" : [ "string", "null", "integer" ],
873
- "format" : "int64",
874
- "pattern" : "([0-9]+)",
875
- "x-custom-parameters-attributes" : {
876
- "removeExif" : false,
877
- "filterMatchedContent" : false,
878
- "antivirus" : false,
879
- "replacementString" : "",
880
- "allowInvalid" : false,
881
- "descrption" : "ID of the help center from which the groups must be fetched",
882
- "secret" : false,
883
- "preserveCharsLimit" : 10,
884
- "trim" : false,
885
- "internalParam" : false,
886
- "preserveChars" : "0,5",
887
- "importUrl" : false,
888
- "decrypt" : false
889
- }
890
- },
891
- "logoUrl" : {
892
- "type" : [ "string", "null" ],
893
- "maxLength" : 200,
894
- "minLength" : 0,
895
- "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
896
- },
897
- "status" : {
898
- "type" : [ "string", "null" ],
899
- "enum" : [ "ACTIVE", "DISABLED" ],
900
- "maxLength" : 100,
901
- "minLength" : 0,
902
- "x-custom-parameters-attributes" : {
903
- "removeExif" : false,
904
- "filterMatchedContent" : false,
905
- "antivirus" : false,
906
- "replacementString" : "",
907
- "allowInvalid" : false,
908
- "descrption" : "Activation status of the user group. Values allowed are @ACTIVE@ and @DISABLED@.",
909
- "secret" : false,
910
- "preserveCharsLimit" : 10,
911
- "trim" : false,
912
- "internalParam" : true,
913
- "preserveChars" : "0,5",
914
- "importUrl" : false,
915
- "decrypt" : false
916
- }
917
- }
918
- },
919
- "required" : [ "addedTime", "helpCenterId", "id", "logoUrl", "name", "status" ]
920
- }
921
- },
922
- "responses" : {
923
- "userListViewJson" : {
924
- "description" : "userListViewJson template definitions",
925
- "content" : {
926
- "application/json" : {
927
- "schema" : {
928
- "type" : [ "null", "object" ],
929
- "additionalProperties" : false,
930
- "properties" : {
931
- "data" : {
932
- "$ref" : "./HelpcenterGroups.json#/components/schemas/data"
933
- }
934
- },
935
- "required" : [ "data" ]
936
- },
937
- "examples" : {
938
- "Valid responses Definitions" : {
939
- "value" : {
940
- "data" : [ {
941
- "photoUrl" : null,
942
- "creator" : {
943
- "photoUrl" : "https://desk.zoho.com/portal/api/user/24073000000095005/photo?orgId=143315",
944
- "name" : "ZylCare Admin",
945
- "id" : "24073000000095005"
946
- },
947
- "emailAddress" : "carol@zylker.com",
948
- "name" : "John ",
949
- "addedTime" : 1573225059000,
950
- "userType" : "ENDUSER",
951
- "label" : {
952
- "preferences" : {
953
- "shape" : "RECTANGLE",
954
- "bgColor" : "#6CD4DF",
955
- "textColor" : "#FFFFFF"
956
- },
957
- "name" : "Prime Customer",
958
- "id" : "24073000002132001"
959
- },
960
- "id" : "24073000001997453",
961
- "status" : "ACTIVE"
962
- } ]
963
- }
964
- }
965
- }
966
- }
967
- },
968
- "x-custom-response-attributes" : {
969
- "disable-safe-headers" : "[]"
970
- }
971
- },
972
- "addGroupResponse" : {
973
- "description" : "addGroupResponse template definitions",
974
- "content" : {
975
- "application/json" : {
976
- "schema" : {
977
- "type" : [ "null", "object" ],
978
- "additionalProperties" : false,
979
- "properties" : {
980
- "modifiedTime" : {
981
- "type" : [ "string", "null" ],
982
- "maxLength" : 100,
983
- "minLength" : 0,
984
- "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))"
985
- },
986
- "creator" : {
987
- "type" : [ "null", "object" ],
988
- "additionalProperties" : false,
989
- "maxProperties" : 3,
990
- "minProperties" : 3,
991
- "properties" : {
992
- "photoUrl" : {
993
- "type" : [ "string", "null" ],
994
- "maxLength" : 100,
995
- "minLength" : 0,
996
- "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
997
- },
998
- "name" : {
999
- "type" : [ "string", "null" ],
1000
- "maxLength" : 100,
1001
- "minLength" : 0
1002
- },
1003
- "id" : {
1004
- "type" : [ "string", "null", "integer" ],
1005
- "format" : "int64",
1006
- "pattern" : "([0-9]+)"
1007
- }
1008
- },
1009
- "required" : [ "id", "name", "photoUrl" ]
1010
- },
1011
- "modifier" : {
1012
- "type" : [ "null", "object" ],
1013
- "additionalProperties" : false,
1014
- "maxProperties" : 3,
1015
- "minProperties" : 3,
1016
- "properties" : {
1017
- "photoUrl" : {
1018
- "type" : [ "string", "null" ],
1019
- "maxLength" : 100,
1020
- "minLength" : 0,
1021
- "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
1022
- },
1023
- "name" : {
1024
- "type" : [ "string", "null" ],
1025
- "maxLength" : 100,
1026
- "minLength" : 0
1027
- },
1028
- "id" : {
1029
- "type" : [ "string", "null", "integer" ],
1030
- "format" : "int64",
1031
- "pattern" : "([0-9]+)"
1032
- }
1033
- },
1034
- "required" : [ "id", "name", "photoUrl" ]
1035
- },
1036
- "name" : {
1037
- "type" : [ "string", "null" ],
1038
- "maxLength" : 100,
1039
- "minLength" : 0,
1040
- "pattern" : "[0-9a-zA-Z_\\-\\&\\.\\$\\@\\^\\(\\)\\{\\}\\~\\=\\-\\|\\*\\+\\?\\[\\]\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+",
1041
- "x-custom-parameters-attributes" : {
1042
- "removeExif" : false,
1043
- "filterMatchedContent" : false,
1044
- "antivirus" : false,
1045
- "replacementString" : "",
1046
- "allowInvalid" : false,
1047
- "descrption" : "Name of the group",
1048
- "secret" : false,
1049
- "preserveCharsLimit" : 10,
1050
- "trim" : false,
1051
- "internalParam" : false,
1052
- "preserveChars" : "0,5",
1053
- "importUrl" : false,
1054
- "decrypt" : false
1055
- }
1056
- },
1057
- "count" : {
1058
- "type" : [ "string", "null", "integer" ],
1059
- "format" : "int32",
1060
- "pattern" : "([0-9]+)"
1061
- },
1062
- "description" : {
1063
- "type" : [ "string", "null" ],
1064
- "maxLength" : 100,
1065
- "minLength" : 0,
1066
- "x-custom-parameters-attributes" : {
1067
- "removeExif" : false,
1068
- "filterMatchedContent" : false,
1069
- "antivirus" : false,
1070
- "replacementString" : "",
1071
- "allowInvalid" : false,
1072
- "descrption" : "A brief description of the group",
1073
- "secret" : false,
1074
- "preserveCharsLimit" : 10,
1075
- "trim" : false,
1076
- "internalParam" : false,
1077
- "preserveChars" : "0,5",
1078
- "importUrl" : false,
1079
- "decrypt" : false
1080
- }
1081
- },
1082
- "createdTime" : {
1083
- "type" : [ "string", "null" ],
1084
- "maxLength" : 100,
1085
- "minLength" : 0,
1086
- "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))"
1087
- },
1088
- "id" : {
1089
- "type" : [ "string", "null", "integer" ],
1090
- "format" : "int64",
1091
- "pattern" : "([0-9]+)"
1092
- },
1093
- "helpCenterId" : {
1094
- "type" : [ "string", "null", "integer" ],
1095
- "format" : "int64",
1096
- "pattern" : "([0-9]+)",
1097
- "x-custom-parameters-attributes" : {
1098
- "removeExif" : false,
1099
- "filterMatchedContent" : false,
1100
- "antivirus" : false,
1101
- "replacementString" : "",
1102
- "allowInvalid" : false,
1103
- "descrption" : "ID of the help center in which the group must be created",
1104
- "secret" : false,
1105
- "preserveCharsLimit" : 10,
1106
- "trim" : false,
1107
- "internalParam" : false,
1108
- "preserveChars" : "0,5",
1109
- "importUrl" : false,
1110
- "decrypt" : false
1111
- }
1112
- },
1113
- "isAssociated" : {
1114
- "type" : [ "boolean", "null" ]
1115
- },
1116
- "logoUrl" : {
1117
- "type" : [ "string", "null" ],
1118
- "maxLength" : 200,
1119
- "minLength" : 0,
1120
- "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
1121
- },
1122
- "status" : {
1123
- "type" : [ "string", "null" ],
1124
- "enum" : [ "ACTIVE", "DISABLED" ],
1125
- "maxLength" : 100,
1126
- "minLength" : 0,
1127
- "x-custom-parameters-attributes" : {
1128
- "removeExif" : false,
1129
- "filterMatchedContent" : false,
1130
- "antivirus" : false,
1131
- "replacementString" : "",
1132
- "allowInvalid" : false,
1133
- "descrption" : "Activation status of the group. Values supported are @ACTIVE@ and @DISABLED@",
1134
- "secret" : false,
1135
- "preserveCharsLimit" : 10,
1136
- "trim" : false,
1137
- "internalParam" : true,
1138
- "preserveChars" : "0,5",
1139
- "importUrl" : false,
1140
- "decrypt" : false
1141
- }
1142
- }
1143
- },
1144
- "required" : [ "count", "createdTime", "creator", "description", "helpCenterId", "id", "isAssociated", "logoUrl", "modifiedTime", "modifier", "name", "status" ]
1145
- },
1146
- "examples" : {
1147
- "Valid responses Definitions" : {
1148
- "value" : {
1149
- "modifiedTime" : 1505797130000,
1150
- "creator" : {
1151
- "photoURL" : "https://desk.zoho.com/portal/api/user/6000000015895/photo?orgId=143315",
1152
- "name" : "SupportAdmin",
1153
- "id" : "310975130121"
1154
- },
1155
- "modifier" : {
1156
- "photoURL" : "https://desk.zoho.com/portal/api/user/6000000015895/photo?orgId=143315",
1157
- "name" : "SupportAdmin",
1158
- "id" : "310975130121"
1159
- },
1160
- "name" : "Prime Customer",
1161
- "count" : "0",
1162
- "description" : "Prime customer will have special access to Knowledge base module and Community categories",
1163
- "createdTime" : 1505797130000,
1164
- "id" : "310975134902",
1165
- "helpCenterId" : "31097519102",
1166
- "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/310975130121?portalId=5c9470fcc808cc98932703e28221d6c302e105dc4da8b23fafb6719abeecaa48",
1167
- "status" : "ACTIVE"
1168
- }
1169
- }
1170
- }
1171
- }
1172
- },
1173
- "x-custom-response-attributes" : {
1174
- "disable-safe-headers" : "[]"
1175
- }
1176
- },
1177
- "listOfGroupResponse" : {
1178
- "description" : "listOfGroupResponse template definitions",
1179
- "content" : {
1180
- "application/json" : {
1181
- "schema" : {
1182
- "type" : [ "null", "object" ],
1183
- "additionalProperties" : false,
1184
- "properties" : {
1185
- "data" : {
1186
- "$ref" : "./HelpcenterGroups.json#/components/schemas/groupsArray"
1187
- }
1188
- },
1189
- "required" : [ "data" ]
1190
- },
1191
- "examples" : {
1192
- "Valid responses Definitions" : {
1193
- "value" : {
1194
- "data" : [ {
1195
- "modifiedTime" : 1505797130000,
1196
- "creator" : {
1197
- "photoURL" : "https://desk.zoho.com/portal/api/user/310975130121/photo?orgId=143315",
1198
- "name" : "SupportAdmin",
1199
- "id" : "310975130121"
1200
- },
1201
- "modifier" : {
1202
- "photoURL" : "https://desk.zoho.com/portal/api/user/310975130121/photo?orgId=143315",
1203
- "name" : "SupportAdmin",
1204
- "id" : "310975130121"
1205
- },
1206
- "name" : "Pro Customer",
1207
- "count" : "353",
1208
- "description" : "Pro Customers paid customers of the org will avail 24x7 Support service",
1209
- "createdTime" : 1505797130000,
1210
- "id" : "310975130110",
1211
- "helpCenterId" : "310975130119",
1212
- "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/310975130133?portalId=5c9470fcc808cc98932703e28221d6c302e105dc4da8b23fafb6719abeecaa48",
1213
- "status" : "ACTIVE"
1214
- } ]
1215
- }
1216
- }
1217
- }
1218
- }
1219
- },
1220
- "x-custom-response-attributes" : {
1221
- "disable-safe-headers" : "[]"
1222
- }
1223
- }
1224
- },
1225
- "parameters" : {
1226
- "groupId" : {
1227
- "name" : "groupId",
1228
- "in" : "path",
1229
- "required" : true,
1230
- "style" : "simple",
1231
- "explode" : false,
1232
- "schema" : {
1233
- "type" : [ "string", "null", "integer" ],
1234
- "format" : "int64",
1235
- "pattern" : "([0-9]+)"
1236
- }
1237
- }
1238
- },
1239
- "requestBodies" : {
1240
- "removeUserInput" : {
1241
- "content" : {
1242
- "application/json" : {
1243
- "schema" : {
1244
- "type" : [ "null", "object" ],
1245
- "additionalProperties" : false,
1246
- "properties" : {
1247
- "userIds" : {
1248
- "type" : [ "null", "array" ],
1249
- "items" : {
1250
- "type" : [ "string", "null", "integer" ],
1251
- "format" : "int64",
1252
- "pattern" : "([0-9]+)",
1253
- "x-custom-parameters-attributes" : [ { } ]
1254
- },
1255
- "minItems" : 1,
1256
- "uniqueItems" : false
1257
- }
1258
- },
1259
- "required" : [ "userIds" ]
1260
- },
1261
- "examples" : {
1262
- "Valid requestBody Definitions" : {
1263
- "value" : {
1264
- "userIds" : [ "17883000000013101", "17883000000094023" ]
1265
- }
1266
- }
1267
- }
1268
- }
1269
- },
1270
- "x-custom-request-body-attributes" : {
1271
- "non-empty" : false,
1272
- "allow-invalid" : false
1273
- }
1274
- },
1275
- "updateGroupInput" : {
1276
- "content" : {
1277
- "application/json" : {
1278
- "schema" : {
1279
- "type" : [ "null", "object" ],
1280
- "additionalProperties" : false,
1281
- "properties" : {
1282
- "name" : {
1283
- "type" : [ "string", "null" ],
1284
- "description" : "Name of the group",
1285
- "maxLength" : 100,
1286
- "minLength" : 0,
1287
- "pattern" : "[0-9a-zA-Z_\\-\\&\\.\\$\\@\\^\\(\\)\\{\\}\\~\\=\\-\\|\\*\\+\\?\\[\\]\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+"
1288
- },
1289
- "description" : {
1290
- "type" : [ "string", "null" ],
1291
- "description" : "A brief description of the group",
1292
- "maxLength" : 100,
1293
- "minLength" : 0
1294
- },
1295
- "logoId" : {
1296
- "type" : [ "string", "null", "integer" ],
1297
- "format" : "int64",
1298
- "description" : "ID of the logo to associate with the group",
1299
- "pattern" : "([0-9]+)"
1300
- },
1301
- "status" : {
1302
- "type" : "string",
1303
- "description" : "Activation status of the group. Values supported are @ACTIVE@ and @DISABLED@",
1304
- "enum" : [ "ACTIVE", "DISABLED" ],
1305
- "x-audience" : [ "company-internal" ]
1306
- }
1307
- }
1308
- },
1309
- "examples" : {
1310
- "Valid requestBody Definitions" : {
1311
- "value" : {
1312
- "name" : "MVP Customer",
1313
- "description" : "Prime customer will have special access to Knowledge base module and Community categories",
1314
- "logoId" : "310975130133",
1315
- "status" : "ACTIVE"
1316
- }
1317
- }
1318
- }
1319
- }
1320
- },
1321
- "x-custom-request-body-attributes" : {
1322
- "non-empty" : false,
1323
- "allow-invalid" : false
1324
- }
1325
- },
1326
- "addGroupInput" : {
1327
- "content" : {
1328
- "application/json" : {
1329
- "schema" : {
1330
- "type" : [ "null", "object" ],
1331
- "additionalProperties" : false,
1332
- "properties" : {
1333
- "name" : {
1334
- "type" : [ "string", "null" ],
1335
- "description" : "Name of the group",
1336
- "maxLength" : 100,
1337
- "minLength" : 0,
1338
- "pattern" : "[0-9a-zA-Z_\\-\\&\\.\\$\\@\\^\\(\\)\\{\\}\\~\\=\\-\\|\\*\\+\\?\\[\\]\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+"
1339
- },
1340
- "description" : {
1341
- "type" : [ "string", "null" ],
1342
- "description" : "A brief description of the group",
1343
- "maxLength" : 100,
1344
- "minLength" : 0
1345
- },
1346
- "helpCenterId" : {
1347
- "type" : [ "string", "null", "integer" ],
1348
- "format" : "int64",
1349
- "description" : "ID of the help center in which the group must be created",
1350
- "pattern" : "([0-9]+)"
1351
- },
1352
- "logoId" : {
1353
- "type" : [ "string", "null", "integer" ],
1354
- "format" : "int64",
1355
- "description" : "ID of the logo to associate with the group",
1356
- "pattern" : "([0-9]+)"
1357
- },
1358
- "status" : {
1359
- "type" : [ "string", "null" ],
1360
- "description" : "Activation status of the group. Values supported are @ACTIVE@ and @DISABLED@",
1361
- "enum" : [ "ACTIVE", "DISABLED" ],
1362
- "maxLength" : 100,
1363
- "minLength" : 0,
1364
- "x-audience" : [ "company-internal" ]
1365
- }
1366
- },
1367
- "required" : [ "helpCenterId", "name" ]
1368
- },
1369
- "examples" : {
1370
- "Valid requestBody Definitions" : {
1371
- "value" : {
1372
- "name" : "Prime Customer",
1373
- "description" : "Prime customer will have special access to Knowledge base module and Community categories",
1374
- "helpCenterId" : "31097519102",
1375
- "logoId" : "310975130121"
1376
- }
1377
- }
1378
- }
1379
- }
1380
- },
1381
- "x-custom-request-body-attributes" : {
1382
- "non-empty" : false,
1383
- "allow-invalid" : false
1384
- }
1385
- },
1386
- "addUserInput" : {
1387
- "content" : {
1388
- "application/json" : {
1389
- "schema" : {
1390
- "type" : [ "null", "object" ],
1391
- "additionalProperties" : false,
1392
- "properties" : {
1393
- "labelIds" : {
1394
- "type" : [ "null", "array" ],
1395
- "items" : {
1396
- "type" : [ "string", "null", "integer" ],
1397
- "format" : "int64",
1398
- "pattern" : "([0-9]+)",
1399
- "x-custom-parameters-attributes" : [ { } ]
1400
- },
1401
- "uniqueItems" : false
1402
- },
1403
- "groupIds" : {
1404
- "type" : [ "null", "array" ],
1405
- "items" : {
1406
- "type" : [ "string", "null", "integer" ],
1407
- "format" : "int64",
1408
- "pattern" : "([0-9]+)",
1409
- "x-custom-parameters-attributes" : [ { } ]
1410
- },
1411
- "uniqueItems" : false
1412
- },
1413
- "users" : {
1414
- "type" : [ "null", "array" ],
1415
- "items" : {
1416
- "type" : [ "null", "object" ],
1417
- "additionalProperties" : false,
1418
- "maxProperties" : 1,
1419
- "minProperties" : 1,
1420
- "properties" : {
1421
- "id" : {
1422
- "type" : [ "string", "null", "integer" ],
1423
- "format" : "int64",
1424
- "pattern" : "([0-9]+)",
1425
- "x-custom-parameters-attributes" : [ ]
1426
- }
1427
- },
1428
- "required" : [ "id" ],
1429
- "x-custom-parameters-attributes" : [ ]
1430
- },
1431
- "minItems" : 1,
1432
- "uniqueItems" : true
1433
- }
1434
- },
1435
- "required" : [ "users" ]
1436
- },
1437
- "examples" : {
1438
- "Valid requestBody Definitions" : {
1439
- "value" : {
1440
- "users" : [ {
1441
- "id" : "17883000000094001"
1442
- }, {
1443
- "id" : "17883000000094023"
1444
- } ]
1445
- }
1446
- }
1447
- }
1448
- }
1449
- },
1450
- "x-custom-request-body-attributes" : {
1451
- "non-empty" : false,
1452
- "allow-invalid" : false
1453
- }
1454
- },
1455
- "groupIds" : {
1456
- "content" : {
1457
- "application/json" : {
1458
- "schema" : {
1459
- "type" : [ "null", "object" ],
1460
- "additionalProperties" : false,
1461
- "properties" : {
1462
- "groupIds" : {
1463
- "$ref" : "./HelpcenterGroups.json#/components/schemas/groupIdsArr"
1464
- }
1465
- },
1466
- "required" : [ "groupIds" ]
1467
- },
1468
- "examples" : {
1469
- "Valid requestBody Definitions" : {
1470
- "value" : {
1471
- "groupIds" : [ "24073000002957051", "24073000002932512", "24073000002953232" ]
1472
- }
1473
- }
1474
- }
1475
- }
1476
- },
1477
- "x-custom-request-body-attributes" : {
1478
- "non-empty" : false,
1479
- "allow-invalid" : false
1480
- }
1481
- }
1482
- },
1483
- "securitySchemes" : {
1484
- "cookie-auth" : {
1485
- "$ref" : "../common/Common.json#/components/securitySchemes/cookie-auth"
1486
- },
1487
- "org-oauth" : {
1488
- "$ref" : "../common/Common.json#/components/securitySchemes/org-oauth"
1489
- },
1490
- "iam-oauth2-schema" : {
1491
- "$ref" : "../common/Common.json#/components/securitySchemes/iam-oauth2-schema"
1492
- }
1493
- }
1494
- },
1495
- "x-entity" : "HelpcenterGroups"
1496
- }