agent-generator 1.0.3 → 1.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (770) hide show
  1. package/install-extension.js +1 -1
  2. package/package.json +2 -4
  3. package/Generator_Patterns/Conditional.md +0 -84
  4. package/Generator_Patterns/Dynamic.md +0 -129
  5. package/Generator_Patterns/PathConfig.properties +0 -4
  6. package/Generator_Patterns/README.md +0 -118
  7. package/Generator_Patterns/Reference.md +0 -98
  8. package/Generator_Patterns/Remote.md +0 -259
  9. package/Generator_Patterns/Static.md +0 -99
  10. package/source/api-data-generators/.idea/api-data-generators.iml +0 -9
  11. package/source/api-data-generators/.idea/misc.xml +0 -6
  12. package/source/api-data-generators/.idea/modules.xml +0 -8
  13. package/source/api-data-generators/.idea/vcs.xml +0 -6
  14. package/source/api-data-generators/portal/ArticleComment/test_data_generation_configurations.json +0 -318
  15. package/source/api-data-generators/portal/ArticleFeedback/test_data_generation_configurations.json +0 -32
  16. package/source/api-data-generators/portal/AsapMobile/test_data_generation_configurations.json +0 -21
  17. package/source/api-data-generators/portal/AsapWeb/test_data_generation_configurations.json +0 -18
  18. package/source/api-data-generators/portal/Category/test_data_generation_configurations.json +0 -39
  19. package/source/api-data-generators/portal/Comment/test_data_generation_configurations.json +0 -157
  20. package/source/api-data-generators/portal/Community/test_data_generation_configurations.json +0 -46
  21. package/source/api-data-generators/portal/CommunityUser/test_data_generation_configurations.json +0 -16
  22. package/source/api-data-generators/portal/Contact/test_data_generation_configurations.json +0 -33
  23. package/source/api-data-generators/portal/Department/test_data_generation_configurations.json +0 -13
  24. package/source/api-data-generators/portal/Extension/test_data_generation_configurations.json +0 -91
  25. package/source/api-data-generators/portal/FeedbackWidget/test_data_generation_configurations.json +0 -18
  26. package/source/api-data-generators/portal/FileExport/test_data_generation_configurations.json +0 -42
  27. package/source/api-data-generators/portal/Followers/test_data_generation_configurations.json +0 -92
  28. package/source/api-data-generators/portal/Gamification/test_data_generation_configurations.json +0 -51
  29. package/source/api-data-generators/portal/HelpCenters/test_data_generation_configurations.json +0 -11
  30. package/source/api-data-generators/portal/Helpcenter/test_data_generation_configurations.json +0 -41
  31. package/source/api-data-generators/portal/HelpcenterGroups/test_data_generation_configurations.json +0 -18
  32. package/source/api-data-generators/portal/KBRootCategory/test_data_generation_configurations.json +0 -76
  33. package/source/api-data-generators/portal/KbCategory/test_data_generation_configurations.json +0 -51
  34. package/source/api-data-generators/portal/KbSection/test_data_generation_configurations.json +0 -25
  35. package/source/api-data-generators/portal/KnowledgeBase/test_data_generation_configurations.json +0 -26
  36. package/source/api-data-generators/portal/Label/test_data_generation_configurations.json +0 -18
  37. package/source/api-data-generators/portal/Layout/test_data_generation_configurations.json +0 -17
  38. package/source/api-data-generators/portal/LayoutRules/test_data_generation_configurations.json +0 -17
  39. package/source/api-data-generators/portal/NewAsapMobile/test_data_generation_configurations.json +0 -21
  40. package/source/api-data-generators/portal/Permalink/test_data_generation_configurations.json +0 -32
  41. package/source/api-data-generators/portal/Product/test_data_generation_configurations.json +0 -43
  42. package/source/api-data-generators/portal/Solution/test_data_generation_configurations.json +0 -631
  43. package/source/api-data-generators/portal/Thread/test_data_generation_configurations.json +0 -70
  44. package/source/api-data-generators/portal/Ticket/test_data_generation_configurations.json +0 -294
  45. package/source/api-data-generators/portal/TicketComment/test_data_generation_configurations.json +0 -58
  46. package/source/api-data-generators/portal/TicketCount/test_data_generation_configurations.json +0 -74
  47. package/source/api-data-generators/portal/TicketStatusMapping/test_data_generation_configurations.json +0 -11
  48. package/source/api-data-generators/portal/TicketTemplate/test_data_generation_configurations.json +0 -24
  49. package/source/api-data-generators/portal/Topic/test_data_generation_configurations.json +0 -259
  50. package/source/api-data-generators/portal/Translation/test_data_generation_configurations.json +0 -6
  51. package/source/api-data-generators/portal/ValidationRules/test_data_generation_configurations.json +0 -14
  52. package/source/api-data-generators/portal/View/test_data_generation_configurations.json +0 -19
  53. package/source/api-data-generators/support/Account/test_data_generation_configurations.json +0 -265
  54. package/source/api-data-generators/support/AccountAttachment/test_data_generation_configurations.json +0 -48
  55. package/source/api-data-generators/support/AccountComments/test_data_generation_configurations.json +0 -47
  56. package/source/api-data-generators/support/AccountContactMappingInfo/test_data_generation_configurations.json +0 -14
  57. package/source/api-data-generators/support/AccountFollowers/test_data_generation_configurations.json +0 -52
  58. package/source/api-data-generators/support/AccountSla/test_data_generation_configurations.json +0 -33
  59. package/source/api-data-generators/support/AccountTimeEntry/test_data_generation_configurations.json +0 -45
  60. package/source/api-data-generators/support/ActiveCalls/test_data_generation_configurations.json +0 -38
  61. package/source/api-data-generators/support/Activity/test_data_generation_configurations.json +0 -50
  62. package/source/api-data-generators/support/ActorsAPI/test_data_generation_configurations.json +0 -22
  63. package/source/api-data-generators/support/Agent/test_data_generation_configurations.json +0 -217
  64. package/source/api-data-generators/support/AgentPresence/test_data_generation_configurations.json +0 -30
  65. package/source/api-data-generators/support/AgentSignatures/test_data_generation_configurations.json +0 -31
  66. package/source/api-data-generators/support/AgentTimeEntry/test_data_generation_configurations.json +0 -36
  67. package/source/api-data-generators/support/AntiSpamInfo/test_data_generation_configurations.json +0 -32
  68. package/source/api-data-generators/support/ApiCreditNotificationRule/test_data_generation_configurations.json +0 -49
  69. package/source/api-data-generators/support/ArchivedView/test_data_generation_configurations.json +0 -66
  70. package/source/api-data-generators/support/Article/test_data_generation_configurations.json +0 -294
  71. package/source/api-data-generators/support/ArticleAttachment/test_data_generation_configurations.json +0 -150
  72. package/source/api-data-generators/support/ArticleComment/test_data_generation_configurations.json +0 -238
  73. package/source/api-data-generators/support/ArticleFeedback/test_data_generation_configurations.json +0 -147
  74. package/source/api-data-generators/support/ArticleFeedbackResolution/test_data_generation_configurations.json +0 -56
  75. package/source/api-data-generators/support/ArticleStatistics/test_data_generation_configurations.json +0 -397
  76. package/source/api-data-generators/support/ArticleTranslation/test_data_generation_configurations.json +0 -1123
  77. package/source/api-data-generators/support/ArticleVersion/test_data_generation_configurations.json +0 -26
  78. package/source/api-data-generators/support/ArticleViews/test_data_generation_configurations.json +0 -26
  79. package/source/api-data-generators/support/Asap/test_data_generation_configurations.json +0 -49
  80. package/source/api-data-generators/support/AuditLog/test_data_generation_configurations.json +0 -58
  81. package/source/api-data-generators/support/AutomationAlerts/test_data_generation_configurations.json +0 -27
  82. package/source/api-data-generators/support/AutomationEngine/test_data_generation_configurations.json +0 -20
  83. package/source/api-data-generators/support/AutomationFeatureCount/test_data_generation_configurations.json +0 -13
  84. package/source/api-data-generators/support/AutomationFieldUpdates/test_data_generation_configurations.json +0 -24
  85. package/source/api-data-generators/support/AutomationTask/test_data_generation_configurations.json +0 -29
  86. package/source/api-data-generators/support/Backup/test_data_generation_configurations.json +0 -115
  87. package/source/api-data-generators/support/Badge/test_data_generation_configurations.json +0 -64
  88. package/source/api-data-generators/support/Bot/test_data_generation_configurations.json +0 -288
  89. package/source/api-data-generators/support/BotInference/test_data_generation_configurations.json +0 -119
  90. package/source/api-data-generators/support/BugInteg/test_data_generation_configurations.json +0 -37
  91. package/source/api-data-generators/support/BulkAction/test_data_generation_configurations.json +0 -26
  92. package/source/api-data-generators/support/BulkImport/test_data_generation_configurations.json +0 -211
  93. package/source/api-data-generators/support/BulkUpdate/test_data_generation_configurations.json +0 -40
  94. package/source/api-data-generators/support/BulkWrite/test_data_generation_configurations.json +0 -32
  95. package/source/api-data-generators/support/BusinessHour/test_data_generation_configurations.json +0 -72
  96. package/source/api-data-generators/support/Call/test_data_generation_configurations.json +0 -247
  97. package/source/api-data-generators/support/CallComments/test_data_generation_configurations.json +0 -51
  98. package/source/api-data-generators/support/CallHistory/test_data_generation_configurations.json +0 -65
  99. package/source/api-data-generators/support/CallTimeEntry/test_data_generation_configurations.json +0 -77
  100. package/source/api-data-generators/support/CallTimer/test_data_generation_configurations.json +0 -14
  101. package/source/api-data-generators/support/Channel/test_data_generation_configurations.json +0 -44
  102. package/source/api-data-generators/support/Chart/test_data_generation_configurations.json +0 -35
  103. package/source/api-data-generators/support/ChatTicket/test_data_generation_configurations.json +0 -185
  104. package/source/api-data-generators/support/Common/test_data_generation_configurations.json +0 -43
  105. package/source/api-data-generators/support/Community/test_data_generation_configurations.json +0 -313
  106. package/source/api-data-generators/support/CommunityAttachment/test_data_generation_configurations.json +0 -16
  107. package/source/api-data-generators/support/CommunityCategory/test_data_generation_configurations.json +0 -121
  108. package/source/api-data-generators/support/CommunityComment/test_data_generation_configurations.json +0 -350
  109. package/source/api-data-generators/support/CommunityInitPermissions/test_data_generation_configurations.json +0 -16
  110. package/source/api-data-generators/support/CommunityPreferences/test_data_generation_configurations.json +0 -19
  111. package/source/api-data-generators/support/CommunityTopic/test_data_generation_configurations.json +0 -509
  112. package/source/api-data-generators/support/CommunityTopicInsights/test_data_generation_configurations.json +0 -32
  113. package/source/api-data-generators/support/CommunityUser/test_data_generation_configurations.json +0 -63
  114. package/source/api-data-generators/support/Contact/test_data_generation_configurations.json +0 -370
  115. package/source/api-data-generators/support/ContactAttachment/test_data_generation_configurations.json +0 -44
  116. package/source/api-data-generators/support/ContactComments/test_data_generation_configurations.json +0 -47
  117. package/source/api-data-generators/support/ContactFollowers/test_data_generation_configurations.json +0 -52
  118. package/source/api-data-generators/support/ContactProfile/test_data_generation_configurations.json +0 -11
  119. package/source/api-data-generators/support/ContactTimeEntry/test_data_generation_configurations.json +0 -45
  120. package/source/api-data-generators/support/Contract/test_data_generation_configurations.json +0 -184
  121. package/source/api-data-generators/support/ContractAttachment/test_data_generation_configurations.json +0 -30
  122. package/source/api-data-generators/support/CreateTicket/test_data_generation_configurations.json +0 -93
  123. package/source/api-data-generators/support/Criteria/test_data_generation_configurations.json +0 -19
  124. package/source/api-data-generators/support/CrmInteg/test_data_generation_configurations.json +0 -202
  125. package/source/api-data-generators/support/CustomAction/test_data_generation_configurations.json +0 -56
  126. package/source/api-data-generators/support/CustomActionRuleMapping/test_data_generation_configurations.json +0 -334
  127. package/source/api-data-generators/support/CustomButton/test_data_generation_configurations.json +0 -113
  128. package/source/api-data-generators/support/CustomFunctionExecutionLogs/test_data_generation_configurations.json +0 -68
  129. package/source/api-data-generators/support/CustomFunctionGallery/test_data_generation_configurations.json +0 -16
  130. package/source/api-data-generators/support/CustomFunctions/test_data_generation_configurations.json +0 -270
  131. package/source/api-data-generators/support/CustomTheme/test_data_generation_configurations.json +0 -70
  132. package/source/api-data-generators/support/CustomView/test_data_generation_configurations.json +0 -486
  133. package/source/api-data-generators/support/CustomerHappiness/test_data_generation_configurations.json +0 -77
  134. package/source/api-data-generators/support/DashboardComponent/test_data_generation_configurations.json +0 -305
  135. package/source/api-data-generators/support/DashboardFolder/test_data_generation_configurations.json +0 -126
  136. package/source/api-data-generators/support/DashboardMetrics/test_data_generation_configurations.json +0 -205
  137. package/source/api-data-generators/support/Dashboards/test_data_generation_configurations.json +0 -90
  138. package/source/api-data-generators/support/DataChips/test_data_generation_configurations.json +0 -33
  139. package/source/api-data-generators/support/DataSync/test_data_generation_configurations.json +0 -228
  140. package/source/api-data-generators/support/DeleteTicket/test_data_generation_configurations.json +0 -44
  141. package/source/api-data-generators/support/Department/test_data_generation_configurations.json +0 -156
  142. package/source/api-data-generators/support/DependencyMappings/test_data_generation_configurations.json +0 -50
  143. package/source/api-data-generators/support/DirectAssignRuleTarget/test_data_generation_configurations.json +0 -17
  144. package/source/api-data-generators/support/DirectAssignmentRules/test_data_generation_configurations.json +0 -37
  145. package/source/api-data-generators/support/DisplayEntity/test_data_generation_configurations.json +0 -45
  146. package/source/api-data-generators/support/DomainMapping/test_data_generation_configurations.json +0 -6
  147. package/source/api-data-generators/support/EmailFailureAlert/test_data_generation_configurations.json +0 -21
  148. package/source/api-data-generators/support/EmailTemplates/test_data_generation_configurations.json +0 -106
  149. package/source/api-data-generators/support/EntityBlueprints/test_data_generation_configurations.json +0 -205
  150. package/source/api-data-generators/support/Event/test_data_generation_configurations.json +0 -196
  151. package/source/api-data-generators/support/EventComments/test_data_generation_configurations.json +0 -45
  152. package/source/api-data-generators/support/EventTimeEntry/test_data_generation_configurations.json +0 -77
  153. package/source/api-data-generators/support/EventTimer/test_data_generation_configurations.json +0 -14
  154. package/source/api-data-generators/support/Extension/test_data_generation_configurations.json +0 -689
  155. package/source/api-data-generators/support/FbManager/test_data_generation_configurations.json +0 -64
  156. package/source/api-data-generators/support/Feature/test_data_generation_configurations.json +0 -61
  157. package/source/api-data-generators/support/FeatureFile/test_data_generation_configurations.json +0 -49
  158. package/source/api-data-generators/support/FeatureFolder/test_data_generation_configurations.json +0 -44
  159. package/source/api-data-generators/support/FeaturePermission/test_data_generation_configurations.json +0 -108
  160. package/source/api-data-generators/support/FederatedLogin/test_data_generation_configurations.json +0 -39
  161. package/source/api-data-generators/support/FeedsAPIs/test_data_generation_configurations.json +0 -54
  162. package/source/api-data-generators/support/Field/test_data_generation_configurations.json +0 -1031
  163. package/source/api-data-generators/support/FieldPrediction/test_data_generation_configurations.json +0 -564
  164. package/source/api-data-generators/support/FileExport/test_data_generation_configurations.json +0 -36
  165. package/source/api-data-generators/support/Finance/test_data_generation_configurations.json +0 -180
  166. package/source/api-data-generators/support/Followers/test_data_generation_configurations.json +0 -60
  167. package/source/api-data-generators/support/GC_Bots/test_data_generation_configurations.json +0 -26
  168. package/source/api-data-generators/support/GC_Guide/test_data_generation_configurations.json +0 -240
  169. package/source/api-data-generators/support/GenericAction/test_data_generation_configurations.json +0 -16
  170. package/source/api-data-generators/support/GenericActionMapping/test_data_generation_configurations.json +0 -216
  171. package/source/api-data-generators/support/GoogleAnalytics/test_data_generation_configurations.json +0 -168
  172. package/source/api-data-generators/support/GoogleChat/test_data_generation_configurations.json +0 -29
  173. package/source/api-data-generators/support/Helpcenter/test_data_generation_configurations.json +0 -98
  174. package/source/api-data-generators/support/HelpcenterAutoTranslateSetting/test_data_generation_configurations.json +0 -11
  175. package/source/api-data-generators/support/HelpcenterGroups/test_data_generation_configurations.json +0 -93
  176. package/source/api-data-generators/support/HelpcenterPages/test_data_generation_configurations.json +0 -34
  177. package/source/api-data-generators/support/HelpcenterPreference/test_data_generation_configurations.json +0 -18
  178. package/source/api-data-generators/support/HelpcenterUpload/test_data_generation_configurations.json +0 -25
  179. package/source/api-data-generators/support/HolidayList/test_data_generation_configurations.json +0 -65
  180. package/source/api-data-generators/support/IMCannedMessage/test_data_generation_configurations.json +0 -155
  181. package/source/api-data-generators/support/IMCannedMessageTranslation/test_data_generation_configurations.json +0 -92
  182. package/source/api-data-generators/support/IMTemplateMessage/test_data_generation_configurations.json +0 -22
  183. package/source/api-data-generators/support/IM_AddOn/test_data_generation_configurations.json +0 -19
  184. package/source/api-data-generators/support/IM_Bot/test_data_generation_configurations.json +0 -143
  185. package/source/api-data-generators/support/IM_Broadcast/test_data_generation_configurations.json +0 -39
  186. package/source/api-data-generators/support/IM_Channel/test_data_generation_configurations.json +0 -312
  187. package/source/api-data-generators/support/IM_ChannelPreference/test_data_generation_configurations.json +0 -35
  188. package/source/api-data-generators/support/IM_Contact/test_data_generation_configurations.json +0 -16
  189. package/source/api-data-generators/support/IM_Integration/test_data_generation_configurations.json +0 -32
  190. package/source/api-data-generators/support/IM_Message/test_data_generation_configurations.json +0 -297
  191. package/source/api-data-generators/support/IM_Metrics/test_data_generation_configurations.json +0 -38
  192. package/source/api-data-generators/support/IM_Search/test_data_generation_configurations.json +0 -56
  193. package/source/api-data-generators/support/IM_Session/test_data_generation_configurations.json +0 -149
  194. package/source/api-data-generators/support/IM_TimeSeriesMetrics/test_data_generation_configurations.json +0 -77
  195. package/source/api-data-generators/support/IM_ZiaGpt/test_data_generation_configurations.json +0 -52
  196. package/source/api-data-generators/support/Import/test_data_generation_configurations.json +0 -229
  197. package/source/api-data-generators/support/InlineImage/test_data_generation_configurations.json +0 -16
  198. package/source/api-data-generators/support/IntegModule/test_data_generation_configurations.json +0 -90
  199. package/source/api-data-generators/support/Integrations/test_data_generation_configurations.json +0 -25
  200. package/source/api-data-generators/support/InteractiveTours/test_data_generation_configurations.json +0 -66
  201. package/source/api-data-generators/support/JWT/test_data_generation_configurations.json +0 -49
  202. package/source/api-data-generators/support/KBCategoryUser/test_data_generation_configurations.json +0 -23
  203. package/source/api-data-generators/support/KBRecycleBin/test_data_generation_configurations.json +0 -131
  204. package/source/api-data-generators/support/KBRootCategory/test_data_generation_configurations.json +0 -214
  205. package/source/api-data-generators/support/KBRootCategoryTranslation/test_data_generation_configurations.json +0 -30
  206. package/source/api-data-generators/support/KBSection/test_data_generation_configurations.json +0 -173
  207. package/source/api-data-generators/support/KPIWidget/test_data_generation_configurations.json +0 -21
  208. package/source/api-data-generators/support/KbCategory/test_data_generation_configurations.json +0 -93
  209. package/source/api-data-generators/support/Label/test_data_generation_configurations.json +0 -103
  210. package/source/api-data-generators/support/Layout/test_data_generation_configurations.json +0 -503
  211. package/source/api-data-generators/support/LayoutRuleCriteria/test_data_generation_configurations.json +0 -19
  212. package/source/api-data-generators/support/LayoutRules/test_data_generation_configurations.json +0 -334
  213. package/source/api-data-generators/support/License/test_data_generation_configurations.json +0 -60
  214. package/source/api-data-generators/support/Livecall/test_data_generation_configurations.json +0 -72
  215. package/source/api-data-generators/support/LookupRecord/test_data_generation_configurations.json +0 -34
  216. package/source/api-data-generators/support/Macros/test_data_generation_configurations.json +0 -184
  217. package/source/api-data-generators/support/MailReplyAddress/test_data_generation_configurations.json +0 -32
  218. package/source/api-data-generators/support/MassAction/test_data_generation_configurations.json +0 -38
  219. package/source/api-data-generators/support/Message/test_data_generation_configurations.json +0 -38
  220. package/source/api-data-generators/support/MicrosoftTeams/test_data_generation_configurations.json +0 -50
  221. package/source/api-data-generators/support/Misc/test_data_generation_configurations.json +0 -16
  222. package/source/api-data-generators/support/Module/test_data_generation_configurations.json +0 -96
  223. package/source/api-data-generators/support/NewCriteria/test_data_generation_configurations.json +0 -26
  224. package/source/api-data-generators/support/NewFeatureFields/test_data_generation_configurations.json +0 -19
  225. package/source/api-data-generators/support/NewTicketHistory/test_data_generation_configurations.json +0 -20
  226. package/source/api-data-generators/support/NotificationRules/test_data_generation_configurations.json +0 -27
  227. package/source/api-data-generators/support/OEmbedData/test_data_generation_configurations.json +0 -19
  228. package/source/api-data-generators/support/Onboarding/test_data_generation_configurations.json +0 -29
  229. package/source/api-data-generators/support/Organization/test_data_generation_configurations.json +0 -79
  230. package/source/api-data-generators/support/PBGroup/test_data_generation_configurations.json +0 -109
  231. package/source/api-data-generators/support/PBGroupAgents/test_data_generation_configurations.json +0 -66
  232. package/source/api-data-generators/support/PBPlatform/test_data_generation_configurations.json +0 -113
  233. package/source/api-data-generators/support/PBX/test_data_generation_configurations.json +0 -28
  234. package/source/api-data-generators/support/PBXConfig/test_data_generation_configurations.json +0 -17
  235. package/source/api-data-generators/support/PBXPhoneNumbers/test_data_generation_configurations.json +0 -54
  236. package/source/api-data-generators/support/PBXPreference/test_data_generation_configurations.json +0 -54
  237. package/source/api-data-generators/support/PageSense/test_data_generation_configurations.json +0 -77
  238. package/source/api-data-generators/support/PendingApproval/test_data_generation_configurations.json +0 -14
  239. package/source/api-data-generators/support/Permalink/test_data_generation_configurations.json +0 -32
  240. package/source/api-data-generators/support/PhoneAgents/test_data_generation_configurations.json +0 -66
  241. package/source/api-data-generators/support/PinnedConversation/test_data_generation_configurations.json +0 -64
  242. package/source/api-data-generators/support/Pipeline_Service/test_data_generation_configurations.json +0 -32
  243. package/source/api-data-generators/support/Product/test_data_generation_configurations.json +0 -196
  244. package/source/api-data-generators/support/ProductAttachment/test_data_generation_configurations.json +0 -48
  245. package/source/api-data-generators/support/Profile/test_data_generation_configurations.json +0 -59
  246. package/source/api-data-generators/support/QueueView/test_data_generation_configurations.json +0 -37
  247. package/source/api-data-generators/support/Records/test_data_generation_configurations.json +0 -239
  248. package/source/api-data-generators/support/Recyclebin/test_data_generation_configurations.json +0 -52
  249. package/source/api-data-generators/support/RemoteAuth/test_data_generation_configurations.json +0 -52
  250. package/source/api-data-generators/support/Report/test_data_generation_configurations.json +0 -538
  251. package/source/api-data-generators/support/ReportChart/test_data_generation_configurations.json +0 -28
  252. package/source/api-data-generators/support/ReportFolder/test_data_generation_configurations.json +0 -100
  253. package/source/api-data-generators/support/Resources/test_data_generation_configurations.json +0 -29
  254. package/source/api-data-generators/support/Role/test_data_generation_configurations.json +0 -84
  255. package/source/api-data-generators/support/RoundRobin/test_data_generation_configurations.json +0 -58
  256. package/source/api-data-generators/support/RoundRobinTarget/test_data_generation_configurations.json +0 -50
  257. package/source/api-data-generators/support/RoutingPreference/test_data_generation_configurations.json +0 -29
  258. package/source/api-data-generators/support/SLAMetaInfo/test_data_generation_configurations.json +0 -22
  259. package/source/api-data-generators/support/Saml/test_data_generation_configurations.json +0 -42
  260. package/source/api-data-generators/support/Sandbox/test_data_generation_configurations.json +0 -92
  261. package/source/api-data-generators/support/SandboxChangeset/test_data_generation_configurations.json +0 -46
  262. package/source/api-data-generators/support/SandboxDeployment/test_data_generation_configurations.json +0 -50
  263. package/source/api-data-generators/support/SandboxDeploymentLogs/test_data_generation_configurations.json +0 -22
  264. package/source/api-data-generators/support/SavedFilters/test_data_generation_configurations.json +0 -203
  265. package/source/api-data-generators/support/Schedule/test_data_generation_configurations.json +0 -172
  266. package/source/api-data-generators/support/ScheduleReplyInfo/test_data_generation_configurations.json +0 -182
  267. package/source/api-data-generators/support/Search/test_data_generation_configurations.json +0 -636
  268. package/source/api-data-generators/support/SearchInteg/test_data_generation_configurations.json +0 -32
  269. package/source/api-data-generators/support/Setup/test_data_generation_configurations.json +0 -32
  270. package/source/api-data-generators/support/SharedSnippet/test_data_generation_configurations.json +0 -62
  271. package/source/api-data-generators/support/Signature/test_data_generation_configurations.json +0 -24
  272. package/source/api-data-generators/support/Skill/test_data_generation_configurations.json +0 -164
  273. package/source/api-data-generators/support/SkillConfiguration/test_data_generation_configurations.json +0 -21
  274. package/source/api-data-generators/support/SkillType/test_data_generation_configurations.json +0 -60
  275. package/source/api-data-generators/support/Slack/test_data_generation_configurations.json +0 -51
  276. package/source/api-data-generators/support/SmsTemplates/test_data_generation_configurations.json +0 -40
  277. package/source/api-data-generators/support/Snippets/test_data_generation_configurations.json +0 -47
  278. package/source/api-data-generators/support/SocialInteg/test_data_generation_configurations.json +0 -22
  279. package/source/api-data-generators/support/SocialPosts/test_data_generation_configurations.json +0 -223
  280. package/source/api-data-generators/support/SocialTwitterConversations/test_data_generation_configurations.json +0 -22
  281. package/source/api-data-generators/support/StarredTemplates/test_data_generation_configurations.json +0 -76
  282. package/source/api-data-generators/support/SubjectAccessRequest/test_data_generation_configurations.json +0 -104
  283. package/source/api-data-generators/support/Supervise/test_data_generation_configurations.json +0 -43
  284. package/source/api-data-generators/support/SupportPlan/test_data_generation_configurations.json +0 -65
  285. package/source/api-data-generators/support/Tab/test_data_generation_configurations.json +0 -29
  286. package/source/api-data-generators/support/Target/test_data_generation_configurations.json +0 -97
  287. package/source/api-data-generators/support/Task/test_data_generation_configurations.json +0 -219
  288. package/source/api-data-generators/support/TaskAttachment/test_data_generation_configurations.json +0 -42
  289. package/source/api-data-generators/support/TaskComments/test_data_generation_configurations.json +0 -45
  290. package/source/api-data-generators/support/TaskTimeEntry/test_data_generation_configurations.json +0 -87
  291. package/source/api-data-generators/support/TaskTimer/test_data_generation_configurations.json +0 -27
  292. package/source/api-data-generators/support/Team/test_data_generation_configurations.json +0 -115
  293. package/source/api-data-generators/support/TemplateFolders/test_data_generation_configurations.json +0 -72
  294. package/source/api-data-generators/support/Thread/test_data_generation_configurations.json +0 -383
  295. package/source/api-data-generators/support/Ticket/test_data_generation_configurations.json +0 -694
  296. package/source/api-data-generators/support/TicketApprovals/test_data_generation_configurations.json +0 -66
  297. package/source/api-data-generators/support/TicketAttachment/test_data_generation_configurations.json +0 -58
  298. package/source/api-data-generators/support/TicketComment/test_data_generation_configurations.json +0 -82
  299. package/source/api-data-generators/support/TicketCount/test_data_generation_configurations.json +0 -43
  300. package/source/api-data-generators/support/TicketFollowers/test_data_generation_configurations.json +0 -65
  301. package/source/api-data-generators/support/TicketMetrics/test_data_generation_configurations.json +0 -16
  302. package/source/api-data-generators/support/TicketTag/test_data_generation_configurations.json +0 -99
  303. package/source/api-data-generators/support/TicketTemplate/test_data_generation_configurations.json +0 -475
  304. package/source/api-data-generators/support/TicketTimeEntry/test_data_generation_configurations.json +0 -110
  305. package/source/api-data-generators/support/TicketTimer/test_data_generation_configurations.json +0 -48
  306. package/source/api-data-generators/support/TicketWithChildren/test_data_generation_configurations.json +0 -91
  307. package/source/api-data-generators/support/TimeTracking/test_data_generation_configurations.json +0 -46
  308. package/source/api-data-generators/support/TranslationLanguages/test_data_generation_configurations.json +0 -68
  309. package/source/api-data-generators/support/Upload/test_data_generation_configurations.json +0 -54
  310. package/source/api-data-generators/support/User/test_data_generation_configurations.json +0 -100
  311. package/source/api-data-generators/support/UserAuthentication/test_data_generation_configurations.json +0 -49
  312. package/source/api-data-generators/support/UserPresence/test_data_generation_configurations.json +0 -19
  313. package/source/api-data-generators/support/ValidationRuleCriteria/test_data_generation_configurations.json +0 -19
  314. package/source/api-data-generators/support/ValidationRules/test_data_generation_configurations.json +0 -321
  315. package/source/api-data-generators/support/Webhook/test_data_generation_configurations.json +0 -501
  316. package/source/api-data-generators/support/Widget/test_data_generation_configurations.json +0 -166
  317. package/source/api-data-generators/support/ZIAAnswerbotInference/test_data_generation_configurations.json +0 -26
  318. package/source/api-data-generators/support/ZIADocumentData/test_data_generation_configurations.json +0 -38
  319. package/source/api-data-generators/support/ZIAVectorSearch/test_data_generation_configurations.json +0 -22
  320. package/source/api-data-generators/support/ZiaGPT/test_data_generation_configurations.json +0 -19
  321. package/source/api-data-generators/support/ZiaScheduler/test_data_generation_configurations.json +0 -22
  322. package/source/api-data-generators/support/ZiapoweredbyGPT/test_data_generation_configurations.json +0 -33
  323. package/source/api-data-generators/support/Zwitch/test_data_generation_configurations.json +0 -71
  324. package/source/api-data-generators/support/blueprintDrafts/test_data_generation_configurations.json +0 -859
  325. package/source/api-data-generators/support/blueprintTransitions/test_data_generation_configurations.json +0 -26
  326. package/source/api-data-generators/support/blueprints/test_data_generation_configurations.json +0 -652
  327. package/source/api-data-generators/support/borrow_book/test_data_generation_configurations.json +0 -21
  328. package/source/api-data-generators/support/zlabsnlp/test_data_generation_configurations.json +0 -50
  329. package/source/openapi-specifications/v1.0/common/Common.json +0 -587
  330. package/source/openapi-specifications/v1.0/portal/Account.json +0 -183
  331. package/source/openapi-specifications/v1.0/portal/ArticleComment.json +0 -1103
  332. package/source/openapi-specifications/v1.0/portal/ArticleFeedback.json +0 -133
  333. package/source/openapi-specifications/v1.0/portal/AsapMobile.json +0 -712
  334. package/source/openapi-specifications/v1.0/portal/AsapWeb.json +0 -91
  335. package/source/openapi-specifications/v1.0/portal/Attachment.json +0 -122
  336. package/source/openapi-specifications/v1.0/portal/Captcha.json +0 -334
  337. package/source/openapi-specifications/v1.0/portal/Category.json +0 -1061
  338. package/source/openapi-specifications/v1.0/portal/Comment.json +0 -1546
  339. package/source/openapi-specifications/v1.0/portal/Community.json +0 -235
  340. package/source/openapi-specifications/v1.0/portal/CommunityUser.json +0 -296
  341. package/source/openapi-specifications/v1.0/portal/Contact.json +0 -536
  342. package/source/openapi-specifications/v1.0/portal/CustomerHappiness.json +0 -163
  343. package/source/openapi-specifications/v1.0/portal/Department.json +0 -246
  344. package/source/openapi-specifications/v1.0/portal/Extension.json +0 -1122
  345. package/source/openapi-specifications/v1.0/portal/FeedbackWidget.json +0 -96
  346. package/source/openapi-specifications/v1.0/portal/Field.json +0 -1239
  347. package/source/openapi-specifications/v1.0/portal/FileExport.json +0 -313
  348. package/source/openapi-specifications/v1.0/portal/Followers.json +0 -802
  349. package/source/openapi-specifications/v1.0/portal/Gamification.json +0 -819
  350. package/source/openapi-specifications/v1.0/portal/HashTags.json +0 -61
  351. package/source/openapi-specifications/v1.0/portal/HelpCenterUser.json +0 -605
  352. package/source/openapi-specifications/v1.0/portal/HelpCenterUserPreference.json +0 -148
  353. package/source/openapi-specifications/v1.0/portal/Helpcenter.json +0 -920
  354. package/source/openapi-specifications/v1.0/portal/HelpcenterGroups.json +0 -118
  355. package/source/openapi-specifications/v1.0/portal/HelpcenterPages.json +0 -184
  356. package/source/openapi-specifications/v1.0/portal/KBCategoryTranslation.json +0 -70
  357. package/source/openapi-specifications/v1.0/portal/KBRootCategory.json +0 -1310
  358. package/source/openapi-specifications/v1.0/portal/KbCategory.json +0 -1525
  359. package/source/openapi-specifications/v1.0/portal/KbSection.json +0 -515
  360. package/source/openapi-specifications/v1.0/portal/Label.json +0 -172
  361. package/source/openapi-specifications/v1.0/portal/Layout.json +0 -303
  362. package/source/openapi-specifications/v1.0/portal/LayoutRules.json +0 -375
  363. package/source/openapi-specifications/v1.0/portal/Mentions.json +0 -580
  364. package/source/openapi-specifications/v1.0/portal/NewAsapMobile.json +0 -699
  365. package/source/openapi-specifications/v1.0/portal/Permalink.json +0 -265
  366. package/source/openapi-specifications/v1.0/portal/Placeholders.json +0 -57
  367. package/source/openapi-specifications/v1.0/portal/Product.json +0 -401
  368. package/source/openapi-specifications/v1.0/portal/Solution.json +0 -3766
  369. package/source/openapi-specifications/v1.0/portal/Thread.json +0 -821
  370. package/source/openapi-specifications/v1.0/portal/Ticket.json +0 -2636
  371. package/source/openapi-specifications/v1.0/portal/TicketComment.json +0 -822
  372. package/source/openapi-specifications/v1.0/portal/TicketCount.json +0 -336
  373. package/source/openapi-specifications/v1.0/portal/TicketExport.json +0 -609
  374. package/source/openapi-specifications/v1.0/portal/TicketField.json +0 -358
  375. package/source/openapi-specifications/v1.0/portal/TicketForm.json +0 -517
  376. package/source/openapi-specifications/v1.0/portal/TicketStatusMapping.json +0 -155
  377. package/source/openapi-specifications/v1.0/portal/TicketTemplate.json +0 -409
  378. package/source/openapi-specifications/v1.0/portal/TicketsViewCount.json +0 -175
  379. package/source/openapi-specifications/v1.0/portal/Topic.json +0 -4079
  380. package/source/openapi-specifications/v1.0/portal/Translation.json +0 -174
  381. package/source/openapi-specifications/v1.0/portal/Upload.json +0 -156
  382. package/source/openapi-specifications/v1.0/portal/ValidationRules.json +0 -309
  383. package/source/openapi-specifications/v1.0/portal/View.json +0 -353
  384. package/source/openapi-specifications/v1.0/portal/Widget.json +0 -218
  385. package/source/openapi-specifications/v1.0/support/AEAdminTool.json +0 -354
  386. package/source/openapi-specifications/v1.0/support/Account.json +0 -3206
  387. package/source/openapi-specifications/v1.0/support/AccountAttachment.json +0 -484
  388. package/source/openapi-specifications/v1.0/support/AccountComments.json +0 -794
  389. package/source/openapi-specifications/v1.0/support/AccountContactMappingInfo.json +0 -227
  390. package/source/openapi-specifications/v1.0/support/AccountDeduplication.json +0 -578
  391. package/source/openapi-specifications/v1.0/support/AccountFollowers.json +0 -350
  392. package/source/openapi-specifications/v1.0/support/AccountSla.json +0 -341
  393. package/source/openapi-specifications/v1.0/support/AccountTimeEntry.json +0 -1152
  394. package/source/openapi-specifications/v1.0/support/ActiveCalls.json +0 -573
  395. package/source/openapi-specifications/v1.0/support/Activity.json +0 -1400
  396. package/source/openapi-specifications/v1.0/support/Actor.json +0 -88
  397. package/source/openapi-specifications/v1.0/support/ActorsAPI.json +0 -304
  398. package/source/openapi-specifications/v1.0/support/AdminTool.json +0 -489
  399. package/source/openapi-specifications/v1.0/support/Agent.json +0 -6685
  400. package/source/openapi-specifications/v1.0/support/AgentPresence.json +0 -567
  401. package/source/openapi-specifications/v1.0/support/AgentRoom.json +0 -1997
  402. package/source/openapi-specifications/v1.0/support/AgentSignatures.json +0 -359
  403. package/source/openapi-specifications/v1.0/support/AgentTimeEntry.json +0 -1402
  404. package/source/openapi-specifications/v1.0/support/AntiSpamInfo.json +0 -510
  405. package/source/openapi-specifications/v1.0/support/ApiCreditNotificationRule.json +0 -1189
  406. package/source/openapi-specifications/v1.0/support/ApiDashboard.json +0 -543
  407. package/source/openapi-specifications/v1.0/support/ApplicationFlags.json +0 -155
  408. package/source/openapi-specifications/v1.0/support/ArchivedView.json +0 -469
  409. package/source/openapi-specifications/v1.0/support/Article.json +0 -5060
  410. package/source/openapi-specifications/v1.0/support/ArticleAttachment.json +0 -544
  411. package/source/openapi-specifications/v1.0/support/ArticleComment.json +0 -1929
  412. package/source/openapi-specifications/v1.0/support/ArticleExternalImageUrlResponse.json +0 -56
  413. package/source/openapi-specifications/v1.0/support/ArticleFeedback.json +0 -1314
  414. package/source/openapi-specifications/v1.0/support/ArticleFeedbackResolution.json +0 -513
  415. package/source/openapi-specifications/v1.0/support/ArticleHistory.json +0 -2510
  416. package/source/openapi-specifications/v1.0/support/ArticleStatistics.json +0 -3053
  417. package/source/openapi-specifications/v1.0/support/ArticleTranslation.json +0 -7530
  418. package/source/openapi-specifications/v1.0/support/ArticleVersion.json +0 -184
  419. package/source/openapi-specifications/v1.0/support/ArticleViews.json +0 -564
  420. package/source/openapi-specifications/v1.0/support/Asap.json +0 -1525
  421. package/source/openapi-specifications/v1.0/support/AsapModule.json +0 -246
  422. package/source/openapi-specifications/v1.0/support/AsapStatus.json +0 -199
  423. package/source/openapi-specifications/v1.0/support/AssistInteg.json +0 -613
  424. package/source/openapi-specifications/v1.0/support/AttachmentRestriction.json +0 -786
  425. package/source/openapi-specifications/v1.0/support/AuditLog.json +0 -1122
  426. package/source/openapi-specifications/v1.0/support/AutomatedSummaryForChats.json +0 -702
  427. package/source/openapi-specifications/v1.0/support/AutomationAlerts.json +0 -868
  428. package/source/openapi-specifications/v1.0/support/AutomationEngine.json +0 -1181
  429. package/source/openapi-specifications/v1.0/support/AutomationFeatureCount.json +0 -207
  430. package/source/openapi-specifications/v1.0/support/AutomationFieldUpdates.json +0 -809
  431. package/source/openapi-specifications/v1.0/support/AutomationTask.json +0 -1054
  432. package/source/openapi-specifications/v1.0/support/Backup.json +0 -2845
  433. package/source/openapi-specifications/v1.0/support/Badge.json +0 -544
  434. package/source/openapi-specifications/v1.0/support/Bot.json +0 -2103
  435. package/source/openapi-specifications/v1.0/support/BotInference.json +0 -1071
  436. package/source/openapi-specifications/v1.0/support/BotResources.json +0 -175
  437. package/source/openapi-specifications/v1.0/support/BotStaticResources.json +0 -541
  438. package/source/openapi-specifications/v1.0/support/Bot_UserInfo.json +0 -63
  439. package/source/openapi-specifications/v1.0/support/Bots.json +0 -58
  440. package/source/openapi-specifications/v1.0/support/BugInteg.json +0 -481
  441. package/source/openapi-specifications/v1.0/support/BulkAction.json +0 -150
  442. package/source/openapi-specifications/v1.0/support/BulkImport.json +0 -2845
  443. package/source/openapi-specifications/v1.0/support/BulkUpdate.json +0 -743
  444. package/source/openapi-specifications/v1.0/support/BulkWrite.json +0 -678
  445. package/source/openapi-specifications/v1.0/support/BusinessHour.json +0 -1344
  446. package/source/openapi-specifications/v1.0/support/Call.json +0 -3839
  447. package/source/openapi-specifications/v1.0/support/CallComments.json +0 -721
  448. package/source/openapi-specifications/v1.0/support/CallHistory.json +0 -936
  449. package/source/openapi-specifications/v1.0/support/CallTimeEntry.json +0 -1745
  450. package/source/openapi-specifications/v1.0/support/CallTimer.json +0 -285
  451. package/source/openapi-specifications/v1.0/support/Channel.json +0 -730
  452. package/source/openapi-specifications/v1.0/support/Chart.json +0 -422
  453. package/source/openapi-specifications/v1.0/support/ChatTicket.json +0 -553
  454. package/source/openapi-specifications/v1.0/support/ClientAction.json +0 -1834
  455. package/source/openapi-specifications/v1.0/support/ClientEvent.json +0 -780
  456. package/source/openapi-specifications/v1.0/support/CliqIntegJsonMapping.json +0 -1123
  457. package/source/openapi-specifications/v1.0/support/CloudAttachment.json +0 -528
  458. package/source/openapi-specifications/v1.0/support/CommonMassActionError.json +0 -44
  459. package/source/openapi-specifications/v1.0/support/CommonMassActionResponse.json +0 -94
  460. package/source/openapi-specifications/v1.0/support/Community.json +0 -2545
  461. package/source/openapi-specifications/v1.0/support/CommunityAttachment.json +0 -249
  462. package/source/openapi-specifications/v1.0/support/CommunityCategory.json +0 -1896
  463. package/source/openapi-specifications/v1.0/support/CommunityCategoryLogo.json +0 -145
  464. package/source/openapi-specifications/v1.0/support/CommunityComment.json +0 -2492
  465. package/source/openapi-specifications/v1.0/support/CommunityInitPermissions.json +0 -129
  466. package/source/openapi-specifications/v1.0/support/CommunityPreferences.json +0 -343
  467. package/source/openapi-specifications/v1.0/support/CommunitySearch.json +0 -78
  468. package/source/openapi-specifications/v1.0/support/CommunityTopic.json +0 -6005
  469. package/source/openapi-specifications/v1.0/support/CommunityTopicInsights.json +0 -310
  470. package/source/openapi-specifications/v1.0/support/CommunityUser.json +0 -822
  471. package/source/openapi-specifications/v1.0/support/Composite.json +0 -414
  472. package/source/openapi-specifications/v1.0/support/Contact.json +0 -4691
  473. package/source/openapi-specifications/v1.0/support/ContactAttachment.json +0 -484
  474. package/source/openapi-specifications/v1.0/support/ContactComments.json +0 -769
  475. package/source/openapi-specifications/v1.0/support/ContactDeduplication.json +0 -683
  476. package/source/openapi-specifications/v1.0/support/ContactFollowers.json +0 -350
  477. package/source/openapi-specifications/v1.0/support/ContactProfile.json +0 -195
  478. package/source/openapi-specifications/v1.0/support/ContactTimeEntry.json +0 -1157
  479. package/source/openapi-specifications/v1.0/support/Contract.json +0 -2877
  480. package/source/openapi-specifications/v1.0/support/ContractAttachment.json +0 -307
  481. package/source/openapi-specifications/v1.0/support/Conversation.json +0 -570
  482. package/source/openapi-specifications/v1.0/support/CountriesAndLanguages.json +0 -5279
  483. package/source/openapi-specifications/v1.0/support/CreditCycle.json +0 -124
  484. package/source/openapi-specifications/v1.0/support/Criteria.json +0 -1014
  485. package/source/openapi-specifications/v1.0/support/CriteriaValue.json +0 -50
  486. package/source/openapi-specifications/v1.0/support/CrmInteg.json +0 -5938
  487. package/source/openapi-specifications/v1.0/support/CustomAction.json +0 -2106
  488. package/source/openapi-specifications/v1.0/support/CustomActionRuleMapping.json +0 -1327
  489. package/source/openapi-specifications/v1.0/support/CustomButton.json +0 -1898
  490. package/source/openapi-specifications/v1.0/support/CustomFunctionExecutionLogs.json +0 -883
  491. package/source/openapi-specifications/v1.0/support/CustomFunctionGallery.json +0 -329
  492. package/source/openapi-specifications/v1.0/support/CustomFunctionReRun.json +0 -317
  493. package/source/openapi-specifications/v1.0/support/CustomFunctionZiaCopilot.json +0 -379
  494. package/source/openapi-specifications/v1.0/support/CustomFunctions.json +0 -3457
  495. package/source/openapi-specifications/v1.0/support/CustomModuleAdminTool.json +0 -81
  496. package/source/openapi-specifications/v1.0/support/CustomTheme.json +0 -7391
  497. package/source/openapi-specifications/v1.0/support/CustomView.json +0 -3478
  498. package/source/openapi-specifications/v1.0/support/CustomerHappiness.json +0 -464
  499. package/source/openapi-specifications/v1.0/support/DBThrottle.json +0 -334
  500. package/source/openapi-specifications/v1.0/support/DashboardComponent.json +0 -1163
  501. package/source/openapi-specifications/v1.0/support/DashboardFolder.json +0 -1258
  502. package/source/openapi-specifications/v1.0/support/DashboardMetrics.json +0 -2310
  503. package/source/openapi-specifications/v1.0/support/Dashboards.json +0 -1219
  504. package/source/openapi-specifications/v1.0/support/DataChips.json +0 -477
  505. package/source/openapi-specifications/v1.0/support/DataImport.json +0 -1099
  506. package/source/openapi-specifications/v1.0/support/DataSync.json +0 -1246
  507. package/source/openapi-specifications/v1.0/support/DatasetEntry.json +0 -153
  508. package/source/openapi-specifications/v1.0/support/Department.json +0 -1971
  509. package/source/openapi-specifications/v1.0/support/DependencyMappings.json +0 -656
  510. package/source/openapi-specifications/v1.0/support/DirectAssignRuleTarget.json +0 -232
  511. package/source/openapi-specifications/v1.0/support/DirectAssignmentRules.json +0 -722
  512. package/source/openapi-specifications/v1.0/support/DisplayEntity.json +0 -91
  513. package/source/openapi-specifications/v1.0/support/DomainMapping.json +0 -1143
  514. package/source/openapi-specifications/v1.0/support/EmailFailureAlert.json +0 -306
  515. package/source/openapi-specifications/v1.0/support/EmailTemplates.json +0 -1491
  516. package/source/openapi-specifications/v1.0/support/EntityBlueprints.json +0 -572
  517. package/source/openapi-specifications/v1.0/support/Event.json +0 -3607
  518. package/source/openapi-specifications/v1.0/support/EventComments.json +0 -737
  519. package/source/openapi-specifications/v1.0/support/EventTimeEntry.json +0 -1520
  520. package/source/openapi-specifications/v1.0/support/EventTimer.json +0 -285
  521. package/source/openapi-specifications/v1.0/support/Expression.json +0 -43
  522. package/source/openapi-specifications/v1.0/support/Extension.json +0 -7152
  523. package/source/openapi-specifications/v1.0/support/ExtensionOrg.json +0 -129
  524. package/source/openapi-specifications/v1.0/support/FAQ.json +0 -142
  525. package/source/openapi-specifications/v1.0/support/FAQTranslation.json +0 -178
  526. package/source/openapi-specifications/v1.0/support/FbManager.json +0 -1147
  527. package/source/openapi-specifications/v1.0/support/Feature.json +0 -691
  528. package/source/openapi-specifications/v1.0/support/FeatureFile.json +0 -435
  529. package/source/openapi-specifications/v1.0/support/FeatureFolder.json +0 -576
  530. package/source/openapi-specifications/v1.0/support/FeaturePermission.json +0 -492
  531. package/source/openapi-specifications/v1.0/support/FederatedLogin.json +0 -318
  532. package/source/openapi-specifications/v1.0/support/FeedsAPIs.json +0 -198
  533. package/source/openapi-specifications/v1.0/support/Field.json +0 -7493
  534. package/source/openapi-specifications/v1.0/support/FieldDetails.json +0 -139
  535. package/source/openapi-specifications/v1.0/support/FieldPermissions.json +0 -113
  536. package/source/openapi-specifications/v1.0/support/FieldPrediction.json +0 -3831
  537. package/source/openapi-specifications/v1.0/support/FileExport.json +0 -324
  538. package/source/openapi-specifications/v1.0/support/Finance.json +0 -4290
  539. package/source/openapi-specifications/v1.0/support/Followers.json +0 -875
  540. package/source/openapi-specifications/v1.0/support/FormulaFunctions.json +0 -47
  541. package/source/openapi-specifications/v1.0/support/GC_Bots.json +0 -138
  542. package/source/openapi-specifications/v1.0/support/GC_Guide.json +0 -1536
  543. package/source/openapi-specifications/v1.0/support/GC_GuideHistories.json +0 -58
  544. package/source/openapi-specifications/v1.0/support/GC_GuideHistory.json +0 -79
  545. package/source/openapi-specifications/v1.0/support/GC_Guides.json +0 -89
  546. package/source/openapi-specifications/v1.0/support/GC_Info.json +0 -208
  547. package/source/openapi-specifications/v1.0/support/GC_Status.json +0 -69
  548. package/source/openapi-specifications/v1.0/support/GC_UserInfo.json +0 -79
  549. package/source/openapi-specifications/v1.0/support/GenericAction.json +0 -1888
  550. package/source/openapi-specifications/v1.0/support/GenericActionMapping.json +0 -1050
  551. package/source/openapi-specifications/v1.0/support/GoogleAnalytics.json +0 -1715
  552. package/source/openapi-specifications/v1.0/support/GoogleChat.json +0 -650
  553. package/source/openapi-specifications/v1.0/support/HelpCenterCommon.json +0 -44
  554. package/source/openapi-specifications/v1.0/support/Help_Center_OIDC_Authentication.json +0 -900
  555. package/source/openapi-specifications/v1.0/support/Helpcenter.json +0 -1212
  556. package/source/openapi-specifications/v1.0/support/HelpcenterAutoTranslateSetting.json +0 -331
  557. package/source/openapi-specifications/v1.0/support/HelpcenterGroups.json +0 -1496
  558. package/source/openapi-specifications/v1.0/support/HelpcenterPages.json +0 -504
  559. package/source/openapi-specifications/v1.0/support/HelpcenterPreference.json +0 -208
  560. package/source/openapi-specifications/v1.0/support/HelpcenterTranslationApp.json +0 -64
  561. package/source/openapi-specifications/v1.0/support/HelpcenterUpload.json +0 -211
  562. package/source/openapi-specifications/v1.0/support/HolidayList.json +0 -731
  563. package/source/openapi-specifications/v1.0/support/IMAPAddress.json +0 -1091
  564. package/source/openapi-specifications/v1.0/support/IMCannedMessage.json +0 -1357
  565. package/source/openapi-specifications/v1.0/support/IMCannedMessagePlaceHolders.json +0 -169
  566. package/source/openapi-specifications/v1.0/support/IMCannedMessageTranslation.json +0 -624
  567. package/source/openapi-specifications/v1.0/support/IMTemplateMessage.json +0 -597
  568. package/source/openapi-specifications/v1.0/support/IM_AddOn.json +0 -841
  569. package/source/openapi-specifications/v1.0/support/IM_AttachmentMessage.json +0 -64
  570. package/source/openapi-specifications/v1.0/support/IM_Bot.json +0 -1007
  571. package/source/openapi-specifications/v1.0/support/IM_BotService.json +0 -357
  572. package/source/openapi-specifications/v1.0/support/IM_Broadcast.json +0 -323
  573. package/source/openapi-specifications/v1.0/support/IM_Channel.json +0 -2849
  574. package/source/openapi-specifications/v1.0/support/IM_ChannelPreference.json +0 -502
  575. package/source/openapi-specifications/v1.0/support/IM_Contact.json +0 -165
  576. package/source/openapi-specifications/v1.0/support/IM_Efc.json +0 -188
  577. package/source/openapi-specifications/v1.0/support/IM_Integration.json +0 -1269
  578. package/source/openapi-specifications/v1.0/support/IM_IntegrationService.json +0 -454
  579. package/source/openapi-specifications/v1.0/support/IM_LayoutView.json +0 -625
  580. package/source/openapi-specifications/v1.0/support/IM_License.json +0 -225
  581. package/source/openapi-specifications/v1.0/support/IM_Message.json +0 -1371
  582. package/source/openapi-specifications/v1.0/support/IM_Metrics.json +0 -462
  583. package/source/openapi-specifications/v1.0/support/IM_Search.json +0 -547
  584. package/source/openapi-specifications/v1.0/support/IM_Session.json +0 -1397
  585. package/source/openapi-specifications/v1.0/support/IM_TemplateButton.json +0 -142
  586. package/source/openapi-specifications/v1.0/support/IM_TemplateFooter.json +0 -83
  587. package/source/openapi-specifications/v1.0/support/IM_TemplateHeader.json +0 -86
  588. package/source/openapi-specifications/v1.0/support/IM_TemplateItems.json +0 -73
  589. package/source/openapi-specifications/v1.0/support/IM_TimeSeriesMetrics.json +0 -435
  590. package/source/openapi-specifications/v1.0/support/IM_TwilioPhoneNumber.json +0 -202
  591. package/source/openapi-specifications/v1.0/support/IM_WhatsApp_Integrations.json +0 -193
  592. package/source/openapi-specifications/v1.0/support/IM_ZiaGpt.json +0 -489
  593. package/source/openapi-specifications/v1.0/support/Import.json +0 -1844
  594. package/source/openapi-specifications/v1.0/support/IncrementalDocuments.json +0 -395
  595. package/source/openapi-specifications/v1.0/support/Inference.json +0 -307
  596. package/source/openapi-specifications/v1.0/support/InlineImage.json +0 -97
  597. package/source/openapi-specifications/v1.0/support/IntegModule.json +0 -938
  598. package/source/openapi-specifications/v1.0/support/Integrations.json +0 -1264
  599. package/source/openapi-specifications/v1.0/support/InteractiveTours.json +0 -539
  600. package/source/openapi-specifications/v1.0/support/JWT.json +0 -535
  601. package/source/openapi-specifications/v1.0/support/KBCategoryPermalink.json +0 -208
  602. package/source/openapi-specifications/v1.0/support/KBCategoryUser.json +0 -241
  603. package/source/openapi-specifications/v1.0/support/KBPreference.json +0 -323
  604. package/source/openapi-specifications/v1.0/support/KBRecycleBin.json +0 -2316
  605. package/source/openapi-specifications/v1.0/support/KBRootCategory.json +0 -2839
  606. package/source/openapi-specifications/v1.0/support/KBRootCategoryTranslation.json +0 -570
  607. package/source/openapi-specifications/v1.0/support/KBSection.json +0 -1941
  608. package/source/openapi-specifications/v1.0/support/KBTranslationMassActionResponse.json +0 -169
  609. package/source/openapi-specifications/v1.0/support/KPIWidget.json +0 -206
  610. package/source/openapi-specifications/v1.0/support/KbBot.json +0 -511
  611. package/source/openapi-specifications/v1.0/support/KbCategory.json +0 -1618
  612. package/source/openapi-specifications/v1.0/support/KbCategoryLogo.json +0 -124
  613. package/source/openapi-specifications/v1.0/support/Label.json +0 -1251
  614. package/source/openapi-specifications/v1.0/support/Layout.json +0 -8042
  615. package/source/openapi-specifications/v1.0/support/LayoutRuleCriteria.json +0 -491
  616. package/source/openapi-specifications/v1.0/support/LayoutRules.json +0 -1422
  617. package/source/openapi-specifications/v1.0/support/LensInteg.json +0 -86
  618. package/source/openapi-specifications/v1.0/support/LicenseFeaturePlan.json +0 -548
  619. package/source/openapi-specifications/v1.0/support/LicenseInfo.json +0 -1231
  620. package/source/openapi-specifications/v1.0/support/LicenseTool.json +0 -165
  621. package/source/openapi-specifications/v1.0/support/Livecall.json +0 -954
  622. package/source/openapi-specifications/v1.0/support/LookupRecord.json +0 -174
  623. package/source/openapi-specifications/v1.0/support/Macros.json +0 -1960
  624. package/source/openapi-specifications/v1.0/support/MailReplyAddress.json +0 -1263
  625. package/source/openapi-specifications/v1.0/support/MassAction.json +0 -1151
  626. package/source/openapi-specifications/v1.0/support/MassActionError.json +0 -55
  627. package/source/openapi-specifications/v1.0/support/MassActionResponse.json +0 -89
  628. package/source/openapi-specifications/v1.0/support/Mentions.json +0 -491
  629. package/source/openapi-specifications/v1.0/support/Message.json +0 -685
  630. package/source/openapi-specifications/v1.0/support/Microsoft.json +0 -887
  631. package/source/openapi-specifications/v1.0/support/MicrosoftTeams.json +0 -574
  632. package/source/openapi-specifications/v1.0/support/Microsoft_PowerBI.json +0 -903
  633. package/source/openapi-specifications/v1.0/support/Misc.json +0 -214
  634. package/source/openapi-specifications/v1.0/support/Module.json +0 -1625
  635. package/source/openapi-specifications/v1.0/support/NewCriteria.json +0 -1863
  636. package/source/openapi-specifications/v1.0/support/NewFeatureFields.json +0 -204
  637. package/source/openapi-specifications/v1.0/support/NewTicketHistory.json +0 -150
  638. package/source/openapi-specifications/v1.0/support/NotificationRules.json +0 -441
  639. package/source/openapi-specifications/v1.0/support/OEmbedData.json +0 -233
  640. package/source/openapi-specifications/v1.0/support/Onboarding.json +0 -282
  641. package/source/openapi-specifications/v1.0/support/Organization.json +0 -1391
  642. package/source/openapi-specifications/v1.0/support/PBGroup.json +0 -634
  643. package/source/openapi-specifications/v1.0/support/PBGroupAgents.json +0 -433
  644. package/source/openapi-specifications/v1.0/support/PBPlatform.json +0 -1447
  645. package/source/openapi-specifications/v1.0/support/PBX.json +0 -550
  646. package/source/openapi-specifications/v1.0/support/PBXConfig.json +0 -219
  647. package/source/openapi-specifications/v1.0/support/PBXPhoneNumbers.json +0 -443
  648. package/source/openapi-specifications/v1.0/support/PBXPreference.json +0 -314
  649. package/source/openapi-specifications/v1.0/support/PageSense.json +0 -1505
  650. package/source/openapi-specifications/v1.0/support/PendingApproval.json +0 -279
  651. package/source/openapi-specifications/v1.0/support/Permalink.json +0 -393
  652. package/source/openapi-specifications/v1.0/support/PhoneAgents.json +0 -1014
  653. package/source/openapi-specifications/v1.0/support/PhoneMenu.json +0 -118
  654. package/source/openapi-specifications/v1.0/support/PinnedConversation.json +0 -1115
  655. package/source/openapi-specifications/v1.0/support/Pipeline_Info.json +0 -232
  656. package/source/openapi-specifications/v1.0/support/Pipeline_Service.json +0 -499
  657. package/source/openapi-specifications/v1.0/support/Product.json +0 -1861
  658. package/source/openapi-specifications/v1.0/support/ProductAttachment.json +0 -485
  659. package/source/openapi-specifications/v1.0/support/Profile.json +0 -4236
  660. package/source/openapi-specifications/v1.0/support/ProjectsInteg.json +0 -989
  661. package/source/openapi-specifications/v1.0/support/QueryStore.json +0 -238
  662. package/source/openapi-specifications/v1.0/support/QueueView.json +0 -335
  663. package/source/openapi-specifications/v1.0/support/RatelimitAdminTool.json +0 -1204
  664. package/source/openapi-specifications/v1.0/support/Records.json +0 -1509
  665. package/source/openapi-specifications/v1.0/support/Recyclebin.json +0 -669
  666. package/source/openapi-specifications/v1.0/support/RemoteAuth.json +0 -401
  667. package/source/openapi-specifications/v1.0/support/Report.json +0 -6491
  668. package/source/openapi-specifications/v1.0/support/ReportChart.json +0 -254
  669. package/source/openapi-specifications/v1.0/support/ReportFolder.json +0 -1076
  670. package/source/openapi-specifications/v1.0/support/ReportIntegration.json +0 -202
  671. package/source/openapi-specifications/v1.0/support/RequestFlags.json +0 -358
  672. package/source/openapi-specifications/v1.0/support/Resources.json +0 -335
  673. package/source/openapi-specifications/v1.0/support/ResponseHelpCenterUser.json +0 -128
  674. package/source/openapi-specifications/v1.0/support/Role.json +0 -996
  675. package/source/openapi-specifications/v1.0/support/RoundRobin.json +0 -796
  676. package/source/openapi-specifications/v1.0/support/RoundRobinTarget.json +0 -381
  677. package/source/openapi-specifications/v1.0/support/RoutingPreference.json +0 -615
  678. package/source/openapi-specifications/v1.0/support/RuleGroup.json +0 -1630
  679. package/source/openapi-specifications/v1.0/support/SLAMetaInfo.json +0 -227
  680. package/source/openapi-specifications/v1.0/support/Saml.json +0 -565
  681. package/source/openapi-specifications/v1.0/support/Sandbox.json +0 -1075
  682. package/source/openapi-specifications/v1.0/support/SandboxChangeset.json +0 -501
  683. package/source/openapi-specifications/v1.0/support/SandboxDeployment.json +0 -428
  684. package/source/openapi-specifications/v1.0/support/SandboxDeploymentLogs.json +0 -295
  685. package/source/openapi-specifications/v1.0/support/SandboxSourceOrganization.json +0 -268
  686. package/source/openapi-specifications/v1.0/support/SavedFilters.json +0 -652
  687. package/source/openapi-specifications/v1.0/support/Schedule.json +0 -2077
  688. package/source/openapi-specifications/v1.0/support/ScheduleReplyInfo.json +0 -2271
  689. package/source/openapi-specifications/v1.0/support/Search.json +0 -12600
  690. package/source/openapi-specifications/v1.0/support/SearchInteg.json +0 -2254
  691. package/source/openapi-specifications/v1.0/support/Setup.json +0 -1766
  692. package/source/openapi-specifications/v1.0/support/SharedSnippet.json +0 -1110
  693. package/source/openapi-specifications/v1.0/support/SharingRule.json +0 -287
  694. package/source/openapi-specifications/v1.0/support/Signature.json +0 -354
  695. package/source/openapi-specifications/v1.0/support/Skill.json +0 -2164
  696. package/source/openapi-specifications/v1.0/support/SkillConfiguration.json +0 -269
  697. package/source/openapi-specifications/v1.0/support/SkillType.json +0 -807
  698. package/source/openapi-specifications/v1.0/support/Slack.json +0 -957
  699. package/source/openapi-specifications/v1.0/support/SmsTemplates.json +0 -514
  700. package/source/openapi-specifications/v1.0/support/Snippets.json +0 -918
  701. package/source/openapi-specifications/v1.0/support/SocialBrands.json +0 -427
  702. package/source/openapi-specifications/v1.0/support/SocialInteg.json +0 -336
  703. package/source/openapi-specifications/v1.0/support/SocialPosts.json +0 -2460
  704. package/source/openapi-specifications/v1.0/support/SocialTwitterConversations.json +0 -337
  705. package/source/openapi-specifications/v1.0/support/StarredTemplates.json +0 -690
  706. package/source/openapi-specifications/v1.0/support/Statistics.json +0 -125
  707. package/source/openapi-specifications/v1.0/support/SubjectAccessRequest.json +0 -2419
  708. package/source/openapi-specifications/v1.0/support/Supervise.json +0 -774
  709. package/source/openapi-specifications/v1.0/support/SupportEmailAddress.json +0 -188
  710. package/source/openapi-specifications/v1.0/support/SupportEmailDomain.json +0 -293
  711. package/source/openapi-specifications/v1.0/support/SupportPlan.json +0 -1109
  712. package/source/openapi-specifications/v1.0/support/Tab.json +0 -606
  713. package/source/openapi-specifications/v1.0/support/Target.json +0 -1311
  714. package/source/openapi-specifications/v1.0/support/TargetFunctions.json +0 -130
  715. package/source/openapi-specifications/v1.0/support/Task.json +0 -4006
  716. package/source/openapi-specifications/v1.0/support/TaskAttachment.json +0 -443
  717. package/source/openapi-specifications/v1.0/support/TaskComments.json +0 -706
  718. package/source/openapi-specifications/v1.0/support/TaskTimeEntry.json +0 -1756
  719. package/source/openapi-specifications/v1.0/support/TaskTimer.json +0 -441
  720. package/source/openapi-specifications/v1.0/support/Team.json +0 -1383
  721. package/source/openapi-specifications/v1.0/support/TemplateFolders.json +0 -1069
  722. package/source/openapi-specifications/v1.0/support/Theme.json +0 -152
  723. package/source/openapi-specifications/v1.0/support/Thread.json +0 -3545
  724. package/source/openapi-specifications/v1.0/support/Ticket.json +0 -9495
  725. package/source/openapi-specifications/v1.0/support/TicketApprovals.json +0 -855
  726. package/source/openapi-specifications/v1.0/support/TicketAttachment.json +0 -562
  727. package/source/openapi-specifications/v1.0/support/TicketComment.json +0 -1444
  728. package/source/openapi-specifications/v1.0/support/TicketCount.json +0 -690
  729. package/source/openapi-specifications/v1.0/support/TicketFollowers.json +0 -454
  730. package/source/openapi-specifications/v1.0/support/TicketHistory.json +0 -414
  731. package/source/openapi-specifications/v1.0/support/TicketMetrics.json +0 -369
  732. package/source/openapi-specifications/v1.0/support/TicketRealTime.json +0 -178
  733. package/source/openapi-specifications/v1.0/support/TicketTag.json +0 -1513
  734. package/source/openapi-specifications/v1.0/support/TicketTemplate.json +0 -907
  735. package/source/openapi-specifications/v1.0/support/TicketTimeEntry.json +0 -1681
  736. package/source/openapi-specifications/v1.0/support/TicketTimer.json +0 -1205
  737. package/source/openapi-specifications/v1.0/support/TimeTracking.json +0 -1212
  738. package/source/openapi-specifications/v1.0/support/TrainingCourses.json +0 -614
  739. package/source/openapi-specifications/v1.0/support/TrainingIntegration.json +0 -163
  740. package/source/openapi-specifications/v1.0/support/TranslationLanguages.json +0 -2772
  741. package/source/openapi-specifications/v1.0/support/Upload.json +0 -620
  742. package/source/openapi-specifications/v1.0/support/User.json +0 -1409
  743. package/source/openapi-specifications/v1.0/support/UserAuthentication.json +0 -617
  744. package/source/openapi-specifications/v1.0/support/UserPresence.json +0 -763
  745. package/source/openapi-specifications/v1.0/support/ValidationRuleCriteria.json +0 -107
  746. package/source/openapi-specifications/v1.0/support/ValidationRules.json +0 -1173
  747. package/source/openapi-specifications/v1.0/support/Webhook.json +0 -1330
  748. package/source/openapi-specifications/v1.0/support/WhatsAppDetails.json +0 -132
  749. package/source/openapi-specifications/v1.0/support/WhatsAppMigration.json +0 -143
  750. package/source/openapi-specifications/v1.0/support/WhatsAppTemplateTags.json +0 -132
  751. package/source/openapi-specifications/v1.0/support/Widget.json +0 -3023
  752. package/source/openapi-specifications/v1.0/support/WmsDomain.json +0 -104
  753. package/source/openapi-specifications/v1.0/support/ZIAAnswerbotInference.json +0 -756
  754. package/source/openapi-specifications/v1.0/support/ZIADocumentData.json +0 -989
  755. package/source/openapi-specifications/v1.0/support/ZIASolutionService.json +0 -135
  756. package/source/openapi-specifications/v1.0/support/ZIAVectorSearch.json +0 -376
  757. package/source/openapi-specifications/v1.0/support/ZiaDCMigration.json +0 -159
  758. package/source/openapi-specifications/v1.0/support/ZiaGPT.json +0 -3229
  759. package/source/openapi-specifications/v1.0/support/ZiaScheduler.json +0 -453
  760. package/source/openapi-specifications/v1.0/support/Zwitch.json +0 -1543
  761. package/source/openapi-specifications/v1.0/support/blueprintChartData.json +0 -201
  762. package/source/openapi-specifications/v1.0/support/blueprintConnections.json +0 -75
  763. package/source/openapi-specifications/v1.0/support/blueprintCriteria.json +0 -255
  764. package/source/openapi-specifications/v1.0/support/blueprintDrafts.json +0 -1677
  765. package/source/openapi-specifications/v1.0/support/blueprintStates.json +0 -284
  766. package/source/openapi-specifications/v1.0/support/blueprintStrictModeConfig.json +0 -91
  767. package/source/openapi-specifications/v1.0/support/blueprintTransitions.json +0 -1546
  768. package/source/openapi-specifications/v1.0/support/blueprints.json +0 -2992
  769. package/source/openapi-specifications/v1.0/support/errors.json +0 -80
  770. package/source/openapi-specifications/v1.0/support/zlabsnlp.json +0 -416
@@ -1,1971 +0,0 @@
1
- {
2
- "openapi" : "3.1.0",
3
- "info" : {
4
- "title" : "Department",
5
- "version" : "1.0.0",
6
- "x-clan-group" : "automation",
7
- "x-module-group" : "users"
8
- },
9
- "paths" : {
10
- "/api/v1/departments/{departmentId}/associateAgents" : {
11
- "post" : {
12
- "tags" : [ "Department" ],
13
- "summary" : "Associate agents to department",
14
- "description" : "This API associates agents to a department.",
15
- "operationId" : "associateAgentsToDepartment",
16
- "parameters" : [ {
17
- "$ref" : "#/components/parameters/departmentId"
18
- }, {
19
- "$ref" : "../common/Common.json#/components/parameters/orgId"
20
- } ],
21
- "requestBody" : {
22
- "$ref" : "#/components/requestBodies/associateAgents_agentIdsArray"
23
- },
24
- "responses" : {
25
- "422" : {
26
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
27
- },
28
- "204" : {
29
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
30
- }
31
- },
32
- "security" : [ {
33
- "org-oauth" : [ "Desk.accessAll.ALL" ]
34
- }, {
35
- "iam-oauth2-schema" : [ "Desk.settings.UPDATE", "Desk.basic.UPDATE" ]
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" : 300000,
46
- "threshold" : 25,
47
- "hip" : false
48
- }, {
49
- "duration" : 3600000,
50
- "lock-period" : 900000,
51
- "threshold" : 500,
52
- "hip" : false
53
- } ],
54
- "window" : "ROLLING",
55
- "key" : "url.path+user.zuid"
56
- } ]
57
- },
58
- "extraparams" : {
59
- "disable" : true,
60
- "ignore" : false
61
- },
62
- "authentication" : { }
63
- },
64
- "clan-group" : "automation",
65
- "apihash" : "7d8a5f3bed513ecff04f22b4d4040f67",
66
- "module-group" : "users",
67
- "apimethod" : "com.zoho.support.restapi.DepartmentService.associateAgents"
68
- }
69
- }
70
- },
71
- "/api/v1/departments/{departmentId}" : {
72
- "get" : {
73
- "tags" : [ "Department" ],
74
- "summary" : "Get department",
75
- "description" : "This API fetches the details of a department from your help desk",
76
- "operationId" : "getDepartment",
77
- "parameters" : [ {
78
- "$ref" : "#/components/parameters/departmentId"
79
- }, {
80
- "$ref" : "../common/Common.json#/components/parameters/orgId"
81
- } ],
82
- "responses" : {
83
- "200" : {
84
- "$ref" : "#/components/responses/getDepartmentResponse"
85
- }
86
- },
87
- "security" : [ {
88
- "org-oauth" : [ "Desk.accessAll.ALL" ]
89
- }, {
90
- "iam-oauth2-schema" : [ "Desk.settings.READ", "Desk.basic.READ" ]
91
- } ],
92
- "x-audience" : [ "external-public" ],
93
- "x-custom-url-attribute" : {
94
- "security" : {
95
- "throttle" : {
96
- "policy" : "ReadAPI_Standard_UserPolicy"
97
- },
98
- "extraparams" : {
99
- "disable" : true,
100
- "ignore" : false
101
- },
102
- "authentication" : { }
103
- },
104
- "clan-group" : "automation",
105
- "apihash" : "8ff8f45c432d0e23134b63518927ae8c",
106
- "module-group" : "users",
107
- "apimethod" : "com.zoho.support.restapi.DepartmentService.getDepartment"
108
- }
109
- },
110
- "patch" : {
111
- "tags" : [ "Department" ],
112
- "summary" : "Update department",
113
- "description" : "This API updates the details of an existing department.",
114
- "operationId" : "updateDepartment",
115
- "parameters" : [ {
116
- "$ref" : "#/components/parameters/departmentId"
117
- }, {
118
- "$ref" : "../common/Common.json#/components/parameters/orgId"
119
- } ],
120
- "requestBody" : {
121
- "$ref" : "#/components/requestBodies/updateDepartmentJson"
122
- },
123
- "responses" : {
124
- "200" : {
125
- "$ref" : "#/components/responses/getDepartmentResponse"
126
- },
127
- "422" : {
128
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
129
- }
130
- },
131
- "security" : [ {
132
- "org-oauth" : [ "Desk.accessAll.ALL" ]
133
- }, {
134
- "iam-oauth2-schema" : [ "Desk.settings.UPDATE", "Desk.basic.UPDATE" ]
135
- } ],
136
- "x-audience" : [ "external-public" ],
137
- "x-custom-url-attribute" : {
138
- "security" : {
139
- "throttle" : {
140
- "inline" : [ {
141
- "scope" : "APPSERVER",
142
- "rules" : [ {
143
- "duration" : 60000,
144
- "lock-period" : 300000,
145
- "threshold" : 20,
146
- "hip" : false
147
- }, {
148
- "duration" : 3600000,
149
- "lock-period" : 900000,
150
- "threshold" : 500,
151
- "hip" : false
152
- } ],
153
- "window" : "ROLLING",
154
- "key" : "url.path+user.zuid"
155
- } ]
156
- },
157
- "extraparams" : {
158
- "disable" : true,
159
- "ignore" : false
160
- },
161
- "authentication" : { }
162
- },
163
- "clan-group" : "automation",
164
- "apihash" : "5e3f519e53eb6695f16cd98331d9c754",
165
- "module-group" : "users",
166
- "apimethod" : "com.zoho.support.restapi.DepartmentService.updateDepartment"
167
- }
168
- }
169
- },
170
- "/api/v1/departments/{departmentId}/logo" : {
171
- "get" : {
172
- "tags" : [ "Department" ],
173
- "summary" : "Get department logo",
174
- "description" : "This API fetches the logo set for a department.",
175
- "operationId" : "getDepartmentLogo",
176
- "parameters" : [ {
177
- "name" : "fileSize",
178
- "in" : "query",
179
- "description" : "Size of the image file to download. Values allowed are @THUMBNAIL@ (image with reduced dimensions and size) and @ACTUAL@ (image with actual dimensions and size). The default value is @ACTUAL@.",
180
- "required" : false,
181
- "style" : "form",
182
- "explode" : true,
183
- "schema" : {
184
- "type" : [ "string", "null" ],
185
- "description" : "Size of the image file to download. Values allowed are @THUMBNAIL@ (image with reduced dimensions and size) and @ACTUAL@ (image with actual dimensions and size). The default value is @ACTUAL@.",
186
- "enum" : [ "THUMBNAIL", "ACTUAL" ],
187
- "maxLength" : 100,
188
- "minLength" : 0
189
- }
190
- }, {
191
- "$ref" : "#/components/parameters/departmentId"
192
- }, {
193
- "$ref" : "../common/Common.json#/components/parameters/orgId"
194
- } ],
195
- "responses" : {
196
- "200" : {
197
- "$ref" : "../common/Common.json#/components/responses/fileResponse"
198
- }
199
- },
200
- "security" : [ {
201
- "org-oauth" : [ "Desk.accessAll.ALL" ]
202
- }, {
203
- "iam-oauth2-schema" : [ "Desk.settings.READ", "Desk.basic.READ" ]
204
- } ],
205
- "x-audience" : [ "external-public" ],
206
- "x-custom-url-attribute" : {
207
- "security" : {
208
- "throttle" : {
209
- "inline" : [ {
210
- "scope" : "APPSERVER",
211
- "rules" : [ {
212
- "duration" : 60000,
213
- "lock-period" : 300000,
214
- "threshold" : 100,
215
- "hip" : false
216
- } ],
217
- "window" : "ROLLING",
218
- "key" : "url.path+user.zuid"
219
- } ]
220
- },
221
- "extraparams" : {
222
- "disable" : true,
223
- "ignore" : false
224
- },
225
- "authentication" : { }
226
- },
227
- "clan-group" : "automation",
228
- "apihash" : "10bb761f1c551a5747038dce9fc34772",
229
- "module-group" : "users",
230
- "apimethod" : "com.zoho.support.restapi.DepartmentService.getDepartmentsLogoStream"
231
- }
232
- },
233
- "post" : {
234
- "tags" : [ "Department" ],
235
- "summary" : "Upload department logo",
236
- "description" : "This API updates the logo set for a department.",
237
- "operationId" : "updateDepartmentLogo",
238
- "parameters" : [ {
239
- "$ref" : "#/components/parameters/departmentId"
240
- }, {
241
- "$ref" : "../common/Common.json#/components/parameters/orgId"
242
- } ],
243
- "requestBody" : {
244
- "content" : {
245
- "multipart/form-data" : {
246
- "schema" : {
247
- "type" : "object",
248
- "properties" : {
249
- "departmentLogo" : {
250
- "type" : "string",
251
- "format" : "binary"
252
- }
253
- },
254
- "required" : [ "departmentLogo" ]
255
- }
256
- }
257
- }
258
- },
259
- "responses" : {
260
- "422" : {
261
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
262
- },
263
- "204" : {
264
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
265
- }
266
- },
267
- "security" : [ {
268
- "org-oauth" : [ "Desk.accessAll.ALL" ]
269
- }, {
270
- "iam-oauth2-schema" : [ "Desk.settings.UPDATE", "Desk.basic.UPDATE" ]
271
- } ],
272
- "x-audience" : [ "external-public" ],
273
- "x-custom-url-attribute" : {
274
- "security" : {
275
- "throttle" : {
276
- "inline" : [ {
277
- "scope" : "APPSERVER",
278
- "rules" : [ {
279
- "duration" : 60000,
280
- "lock-period" : 300000,
281
- "threshold" : 15,
282
- "hip" : false
283
- }, {
284
- "duration" : 3600000,
285
- "lock-period" : 900000,
286
- "threshold" : 500,
287
- "hip" : false
288
- } ],
289
- "window" : "ROLLING",
290
- "key" : "url.path+user.zuid"
291
- } ]
292
- },
293
- "extraparams" : {
294
- "disable" : true,
295
- "ignore" : false
296
- },
297
- "authentication" : { }
298
- },
299
- "clan-group" : "automation",
300
- "apihash" : "9bad8032c0917a07252ac2bea63a9845",
301
- "module-group" : "users",
302
- "apimethod" : "com.zoho.support.restapi.DepartmentService.uploadDepartmentLogo"
303
- }
304
- },
305
- "delete" : {
306
- "tags" : [ "Department" ],
307
- "summary" : "Delete department logo",
308
- "description" : "This API removes the logo set for a department.",
309
- "operationId" : "deleteDepartmentLogo",
310
- "parameters" : [ {
311
- "$ref" : "#/components/parameters/departmentId"
312
- }, {
313
- "$ref" : "../common/Common.json#/components/parameters/orgId"
314
- } ],
315
- "responses" : {
316
- "204" : {
317
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
318
- }
319
- },
320
- "security" : [ {
321
- "org-oauth" : [ "Desk.accessAll.ALL" ]
322
- }, {
323
- "iam-oauth2-schema" : [ "Desk.settings.DELETE", "Desk.basic.DELETE" ]
324
- } ],
325
- "x-audience" : [ "external-public" ],
326
- "x-custom-url-attribute" : {
327
- "security" : {
328
- "throttle" : {
329
- "inline" : [ {
330
- "scope" : "APPSERVER",
331
- "rules" : [ {
332
- "duration" : 60000,
333
- "lock-period" : 300000,
334
- "threshold" : 15,
335
- "hip" : false
336
- }, {
337
- "duration" : 3600000,
338
- "lock-period" : 900000,
339
- "threshold" : 500,
340
- "hip" : false
341
- } ],
342
- "window" : "ROLLING",
343
- "key" : "url.path+user.zuid"
344
- } ]
345
- },
346
- "extraparams" : {
347
- "disable" : true,
348
- "ignore" : false
349
- },
350
- "authentication" : { }
351
- },
352
- "clan-group" : "automation",
353
- "apihash" : "2b5f4120e0e3632f54a1ae222ec4ff3f",
354
- "module-group" : "users",
355
- "apimethod" : "com.zoho.support.restapi.DepartmentService.deleteDepartmentLogo"
356
- }
357
- }
358
- },
359
- "/api/v1/departments/{departmentId}/enable" : {
360
- "post" : {
361
- "tags" : [ "Department" ],
362
- "summary" : "Enable department",
363
- "description" : "This API enables a department in your help desk portal.",
364
- "operationId" : "enableDepartment",
365
- "parameters" : [ {
366
- "$ref" : "#/components/parameters/departmentId"
367
- }, {
368
- "$ref" : "../common/Common.json#/components/parameters/orgId"
369
- } ],
370
- "responses" : {
371
- "204" : {
372
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
373
- }
374
- },
375
- "security" : [ {
376
- "org-oauth" : [ "Desk.accessAll.ALL" ]
377
- }, {
378
- "iam-oauth2-schema" : [ "Desk.settings.UPDATE", "Desk.basic.UPDATE" ]
379
- } ],
380
- "x-audience" : [ "external-public" ],
381
- "x-custom-url-attribute" : {
382
- "security" : {
383
- "throttle" : {
384
- "inline" : [ {
385
- "scope" : "APPSERVER",
386
- "rules" : [ {
387
- "duration" : 60000,
388
- "lock-period" : 300000,
389
- "threshold" : 15,
390
- "hip" : false
391
- }, {
392
- "duration" : 3600000,
393
- "lock-period" : 900000,
394
- "threshold" : 500,
395
- "hip" : false
396
- } ],
397
- "window" : "ROLLING",
398
- "key" : "url.path+user.zuid"
399
- } ]
400
- },
401
- "extraparams" : {
402
- "disable" : true,
403
- "ignore" : false
404
- },
405
- "authentication" : { }
406
- },
407
- "clan-group" : "automation",
408
- "apihash" : "a72c42afa5da9baee56292a852324ce1",
409
- "module-group" : "users",
410
- "apimethod" : "com.zoho.support.restapi.DepartmentService.enableDepartment"
411
- }
412
- }
413
- },
414
- "/api/v1/departments/{departmentId}/disable" : {
415
- "post" : {
416
- "tags" : [ "Department" ],
417
- "summary" : "Disable department",
418
- "description" : "This API disables a department in your help desk portal.",
419
- "operationId" : "disableDepartment",
420
- "parameters" : [ {
421
- "$ref" : "#/components/parameters/departmentId"
422
- }, {
423
- "$ref" : "../common/Common.json#/components/parameters/orgId"
424
- } ],
425
- "requestBody" : {
426
- "$ref" : "#/components/requestBodies/disableTransfer"
427
- },
428
- "responses" : {
429
- "422" : {
430
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
431
- },
432
- "204" : {
433
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
434
- }
435
- },
436
- "security" : [ {
437
- "org-oauth" : [ "Desk.accessAll.ALL" ]
438
- }, {
439
- "iam-oauth2-schema" : [ "Desk.settings.UPDATE", "Desk.basic.UPDATE" ]
440
- } ],
441
- "x-audience" : [ "external-public" ],
442
- "x-custom-url-attribute" : {
443
- "security" : {
444
- "throttle" : {
445
- "inline" : [ {
446
- "scope" : "APPSERVER",
447
- "rules" : [ {
448
- "duration" : 60000,
449
- "lock-period" : 300000,
450
- "threshold" : 15,
451
- "hip" : false
452
- }, {
453
- "duration" : 3600000,
454
- "lock-period" : 900000,
455
- "threshold" : 500,
456
- "hip" : false
457
- } ],
458
- "window" : "ROLLING",
459
- "key" : "url.path+user.zuid"
460
- } ]
461
- },
462
- "extraparams" : {
463
- "disable" : true,
464
- "ignore" : false
465
- },
466
- "authentication" : { }
467
- },
468
- "clan-group" : "automation",
469
- "apihash" : "726da229d7b7f6901dfcb6115b606b31",
470
- "module-group" : "users",
471
- "apimethod" : "com.zoho.support.restapi.DepartmentService.disableDepartment"
472
- }
473
- }
474
- },
475
- "/api/v1/departmentsByIds" : {
476
- "get" : {
477
- "tags" : [ "Department" ],
478
- "summary" : "Get department details by department IDs",
479
- "description" : "This API fetches the details of the departments whose IDs are passed in the API request.",
480
- "operationId" : "getDepartmentsByIds",
481
- "parameters" : [ {
482
- "name" : "departmentIds",
483
- "in" : "query",
484
- "description" : "Comma-separated array of department IDs. Maximum number of IDs allowed is 50.",
485
- "required" : true,
486
- "style" : "simple",
487
- "explode" : true,
488
- "schema" : {
489
- "type" : [ "null", "array" ],
490
- "description" : "Comma-separated array of department IDs. Maximum number of IDs allowed is 50.",
491
- "items" : {
492
- "type" : [ "string", "null", "integer" ],
493
- "format" : "int64",
494
- "pattern" : "([0-9]+)",
495
- "x-custom-parameters-attributes" : [ false, false, false, "", false, "Comma-separated array of department IDs. Maximum number of IDs allowed is 50.", false, 10, ",", false, false, "0,5", false, false ]
496
- },
497
- "uniqueItems" : false
498
- }
499
- }, {
500
- "$ref" : "../common/Common.json#/components/parameters/orgId"
501
- } ],
502
- "responses" : {
503
- "422" : {
504
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
505
- },
506
- "204" : {
507
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
508
- },
509
- "200" : {
510
- "$ref" : "#/components/responses/departmentListViewArray"
511
- }
512
- },
513
- "security" : [ {
514
- "org-oauth" : [ "Desk.accessAll.ALL" ]
515
- }, {
516
- "iam-oauth2-schema" : [ "Desk.settings.READ", "Desk.basic.READ" ]
517
- } ],
518
- "x-audience" : [ "external-public" ],
519
- "x-custom-url-attribute" : {
520
- "security" : {
521
- "throttle" : {
522
- "policy" : "ReadAPI_Standard_UserPolicy,IscSignatureCalls_OrgPolicy"
523
- },
524
- "extraparams" : {
525
- "disable" : true,
526
- "ignore" : false
527
- },
528
- "authentication" : {
529
- "system-auth" : "optional",
530
- "scoped-services" : [ "ZohoSupport" ]
531
- }
532
- },
533
- "clan-group" : "automation",
534
- "apihash" : "cde556d0e6a0149ef387c419e403c24e",
535
- "module-group" : "users",
536
- "apimethod" : "com.zoho.support.restapi.DepartmentService.getDepartmentsByIds"
537
- }
538
- }
539
- },
540
- "/api/v1/departments/{departmentId}/agents" : {
541
- "get" : {
542
- "tags" : [ "Department" ],
543
- "summary" : "List agents in department",
544
- "description" : "This API lists the agents in a department.",
545
- "operationId" : "getAgentsInDepartment",
546
- "parameters" : [ {
547
- "name" : "fieldName",
548
- "in" : "query",
549
- "description" : "Name of the field that must be used for searching and listing agents. Values allowed are: @firstName@, @lastName@, @name@, and @emailId@.",
550
- "required" : false,
551
- "style" : "form",
552
- "explode" : true,
553
- "schema" : {
554
- "type" : [ "string", "null" ],
555
- "description" : "Name of the field that must be used for searching and listing agents. Values allowed are: @firstName@, @lastName@, @name@, and @emailId@.",
556
- "enum" : [ "firstName", "lastName", "emailId", "name" ],
557
- "maxLength" : 100,
558
- "minLength" : 0
559
- }
560
- }, {
561
- "$ref" : "#/components/parameters/searchStr"
562
- }, {
563
- "name" : "isLightAgent",
564
- "in" : "query",
565
- "description" : "Key that denotes if the agents must be light or non light.",
566
- "required" : false,
567
- "style" : "form",
568
- "explode" : true,
569
- "schema" : {
570
- "type" : [ "boolean", "null" ],
571
- "description" : "Key that denotes if the agents must be light or non light."
572
- }
573
- }, {
574
- "name" : "sortOrder",
575
- "in" : "query",
576
- "description" : "To sort the available list of agents in either ascending or descending order. Values allowed are: @asc@ or @desc@",
577
- "required" : false,
578
- "style" : "form",
579
- "explode" : true,
580
- "schema" : {
581
- "type" : [ "string", "null" ],
582
- "description" : "To sort the available list of agents in either ascending or descending order. Values allowed are: @asc@ or @desc@",
583
- "enum" : [ "asc", "desc" ],
584
- "maxLength" : 100,
585
- "minLength" : 0
586
- }
587
- }, {
588
- "$ref" : "#/components/parameters/limit"
589
- }, {
590
- "$ref" : "#/components/parameters/from"
591
- }, {
592
- "name" : "isConfirmed",
593
- "in" : "query",
594
- "description" : "Key that denotes if the agents must be confirmed or unconfirmed.",
595
- "required" : false,
596
- "style" : "form",
597
- "explode" : true,
598
- "schema" : {
599
- "type" : [ "boolean", "null" ],
600
- "description" : "Key that denotes if the agents must be confirmed or unconfirmed."
601
- }
602
- }, {
603
- "name" : "status",
604
- "in" : "query",
605
- "description" : "Key that filters agents, based on their activation status: @ACTIVE@ or @DISABLED@",
606
- "required" : false,
607
- "style" : "form",
608
- "explode" : true,
609
- "schema" : {
610
- "type" : [ "string", "null" ],
611
- "description" : "Key that filters agents, based on their activation status: @ACTIVE@ or @DISABLED@",
612
- "enum" : [ "ACTIVE", "DISABLED" ],
613
- "maxLength" : 100,
614
- "minLength" : 0
615
- }
616
- }, {
617
- "$ref" : "#/components/parameters/departmentId"
618
- }, {
619
- "$ref" : "../common/Common.json#/components/parameters/orgId"
620
- } ],
621
- "responses" : {
622
- "204" : {
623
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
624
- },
625
- "200" : {
626
- "$ref" : "./Agent.json#/components/responses/agentListArray"
627
- }
628
- },
629
- "security" : [ {
630
- "org-oauth" : [ "Desk.accessAll.ALL" ]
631
- }, {
632
- "iam-oauth2-schema" : [ "Desk.settings.READ", "Desk.basic.READ" ]
633
- } ],
634
- "x-audience" : [ "external-public" ],
635
- "x-custom-url-attribute" : {
636
- "security" : {
637
- "throttle" : {
638
- "inline" : [ {
639
- "scope" : "APPSERVER",
640
- "rules" : [ {
641
- "duration" : 60000,
642
- "lock-period" : 300000,
643
- "threshold" : 30,
644
- "hip" : false
645
- } ],
646
- "window" : "ROLLING",
647
- "key" : "url.path+user.zuid"
648
- } ]
649
- },
650
- "extraparams" : {
651
- "disable" : true,
652
- "ignore" : false
653
- },
654
- "authentication" : { }
655
- },
656
- "clan-group" : "automation",
657
- "apihash" : "efa77c0515bb75d402f46bc4bfba09e8",
658
- "module-group" : "users",
659
- "apimethod" : "com.zoho.support.restapi.DepartmentService.getAgentsByDepartment"
660
- }
661
- }
662
- },
663
- "/api/v1/departments/count" : {
664
- "get" : {
665
- "tags" : [ "Department" ],
666
- "summary" : "Get department count",
667
- "description" : "This API returns the number of departments configured in your help desk portal.",
668
- "operationId" : "getDepartmentsCount",
669
- "parameters" : [ {
670
- "$ref" : "../common/Common.json#/components/parameters/orgId"
671
- } ],
672
- "responses" : {
673
- "200" : {
674
- "$ref" : "#/components/responses/deptCountResponse"
675
- }
676
- },
677
- "security" : [ {
678
- "org-oauth" : [ "Desk.accessAll.ALL" ]
679
- }, {
680
- "iam-oauth2-schema" : [ "Desk.settings.READ", "Desk.basic.READ" ]
681
- } ],
682
- "x-audience" : [ "external-public" ],
683
- "x-custom-url-attribute" : {
684
- "security" : {
685
- "throttle" : {
686
- "inline" : [ {
687
- "scope" : "APPSERVER",
688
- "rules" : [ {
689
- "duration" : 60000,
690
- "lock-period" : 300000,
691
- "threshold" : 25,
692
- "hip" : false
693
- } ],
694
- "window" : "ROLLING",
695
- "key" : "url.path+user.zuid"
696
- } ]
697
- },
698
- "extraparams" : {
699
- "disable" : true,
700
- "ignore" : false
701
- },
702
- "authentication" : { }
703
- },
704
- "clan-group" : "automation",
705
- "apihash" : "041792329fe117b1f6038294e0f3e71c",
706
- "module-group" : "users",
707
- "apimethod" : "com.zoho.support.restapi.DepartmentService.getDepartmentsCount"
708
- }
709
- }
710
- },
711
- "/api/v1/departments/{departmentId}/dissociateAgents" : {
712
- "post" : {
713
- "tags" : [ "Department" ],
714
- "summary" : "Dissociate agents from department",
715
- "description" : "This API dissociates agents from a department.",
716
- "operationId" : "dissociateAgents",
717
- "parameters" : [ {
718
- "$ref" : "#/components/parameters/departmentId"
719
- }, {
720
- "$ref" : "../common/Common.json#/components/parameters/orgId"
721
- } ],
722
- "requestBody" : {
723
- "$ref" : "#/components/requestBodies/dissociateAgents_agentIdsArray"
724
- },
725
- "responses" : {
726
- "422" : {
727
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
728
- },
729
- "204" : {
730
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
731
- }
732
- },
733
- "security" : [ {
734
- "org-oauth" : [ "Desk.accessAll.ALL" ]
735
- }, {
736
- "iam-oauth2-schema" : [ "Desk.settings.UPDATE", "Desk.basic.UPDATE" ]
737
- } ],
738
- "x-audience" : [ "external-public" ],
739
- "x-custom-url-attribute" : {
740
- "security" : {
741
- "throttle" : {
742
- "inline" : [ {
743
- "scope" : "APPSERVER",
744
- "rules" : [ {
745
- "duration" : 60000,
746
- "lock-period" : 300000,
747
- "threshold" : 25,
748
- "hip" : false
749
- }, {
750
- "duration" : 3600000,
751
- "lock-period" : 900000,
752
- "threshold" : 500,
753
- "hip" : false
754
- } ],
755
- "window" : "ROLLING",
756
- "key" : "url.path+user.zuid"
757
- } ]
758
- },
759
- "extraparams" : {
760
- "disable" : true,
761
- "ignore" : false
762
- },
763
- "authentication" : { }
764
- },
765
- "clan-group" : "automation",
766
- "apihash" : "0f4ef46f55df0ef6721a2cf9d4008c57",
767
- "module-group" : "users",
768
- "apimethod" : "com.zoho.support.restapi.DepartmentService.dissociateAgents"
769
- }
770
- }
771
- },
772
- "/api/v1/departments/{departmentId}/associableAgents" : {
773
- "get" : {
774
- "tags" : [ "Department" ],
775
- "summary" : "Get associable agents in a department",
776
- "description" : "This API lists the associable agents in a department in your helpdesk.",
777
- "operationId" : "getAssociableAgents",
778
- "parameters" : [ {
779
- "$ref" : "#/components/parameters/departmentId"
780
- }, {
781
- "$ref" : "../common/Common.json#/components/parameters/orgId"
782
- } ],
783
- "responses" : {
784
- "422" : {
785
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
786
- },
787
- "204" : {
788
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
789
- },
790
- "200" : {
791
- "$ref" : "#/components/responses/getAssociableAgentsResponse"
792
- }
793
- },
794
- "security" : [ {
795
- "org-oauth" : [ "Desk.accessAll.ALL" ]
796
- }, {
797
- "iam-oauth2-schema" : [ "Desk.settings.READ", "Desk.basic.READ" ]
798
- } ],
799
- "x-audience" : [ "company-internal" ],
800
- "x-custom-url-attribute" : {
801
- "security" : {
802
- "throttle" : {
803
- "inline" : [ {
804
- "scope" : "APPSERVER",
805
- "rules" : [ {
806
- "duration" : 60000,
807
- "lock-period" : 300000,
808
- "threshold" : 25,
809
- "hip" : false
810
- } ],
811
- "window" : "ROLLING",
812
- "key" : "url.path+user.zuid"
813
- } ]
814
- },
815
- "extraparams" : {
816
- "disable" : true,
817
- "ignore" : false
818
- },
819
- "authentication" : { }
820
- },
821
- "clan-group" : "automation",
822
- "apihash" : "4bd1bf2d8ddd5daf334c9b6f966250d1",
823
- "module-group" : "users",
824
- "apimethod" : "com.zoho.support.restapi.DepartmentService.getAssociableAgents"
825
- }
826
- }
827
- },
828
- "/api/v1/departments" : {
829
- "get" : {
830
- "tags" : [ "Department" ],
831
- "summary" : "List departments",
832
- "description" : "This API lists a particular number of departments, based on the limit specified.",
833
- "operationId" : "getDepartments",
834
- "parameters" : [ {
835
- "name" : "chatStatus",
836
- "in" : "query",
837
- "description" : "Key that filters departments based on their chat status. Values allowed are @AVAILABLE@, @DISABLED@, @NOT_CREATED@, and @${UNAVAILABLE}@. @${UNAVAILABLE}@ refers to departments which are not available for chat.",
838
- "required" : false,
839
- "style" : "form",
840
- "explode" : true,
841
- "schema" : {
842
- "type" : [ "string", "null" ],
843
- "description" : "Key that filters departments based on their chat status. Values allowed are @AVAILABLE@, @DISABLED@, @NOT_CREATED@, and @${UNAVAILABLE}@. @${UNAVAILABLE}@ refers to departments which are not available for chat.",
844
- "enum" : [ "AVAILABLE", "DISABLED", "NOT_CREATED", "${UNAVAILABLE}" ],
845
- "maxLength" : 100,
846
- "minLength" : 0
847
- }
848
- }, {
849
- "$ref" : "#/components/parameters/searchStr"
850
- }, {
851
- "name" : "isEnabled",
852
- "in" : "query",
853
- "description" : "Key that filters departments based on their enabled status",
854
- "required" : false,
855
- "style" : "form",
856
- "explode" : true,
857
- "schema" : {
858
- "type" : [ "boolean", "null" ],
859
- "description" : "Key that filters departments based on their enabled status"
860
- }
861
- }, {
862
- "$ref" : "#/components/parameters/limit"
863
- }, {
864
- "$ref" : "#/components/parameters/from"
865
- }, {
866
- "$ref" : "../common/Common.json#/components/parameters/orgId"
867
- } ],
868
- "responses" : {
869
- "204" : {
870
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
871
- },
872
- "200" : {
873
- "$ref" : "#/components/responses/departmentListViewArray"
874
- }
875
- },
876
- "security" : [ {
877
- "org-oauth" : [ "Desk.accessAll.ALL" ]
878
- }, {
879
- "iam-oauth2-schema" : [ "Desk.settings.READ", "Desk.basic.READ" ]
880
- } ],
881
- "x-audience" : [ "external-public" ],
882
- "x-custom-url-attribute" : {
883
- "security" : {
884
- "throttle" : {
885
- "policy" : "ReadAPI_Standard_UserPolicy,IscSignatureCalls_OrgPolicy"
886
- },
887
- "extraparams" : {
888
- "disable" : true,
889
- "ignore" : false
890
- },
891
- "authentication" : {
892
- "iscscope" : [ "SupCrmAPI" ],
893
- "system-auth" : "optional",
894
- "scoped-services" : [ "ZohoSupport" ]
895
- }
896
- },
897
- "clan-group" : "automation",
898
- "apihash" : "374e115e7ddcf792c3dfec9ba7a8c0b7",
899
- "module-group" : "users",
900
- "apimethod" : "com.zoho.support.restapi.DepartmentService.getDepartments"
901
- }
902
- },
903
- "post" : {
904
- "tags" : [ "Department" ],
905
- "summary" : "Add department",
906
- "description" : "This API adds a department to your help desk portal.",
907
- "operationId" : "addDepartment",
908
- "parameters" : [ {
909
- "$ref" : "../common/Common.json#/components/parameters/orgId"
910
- } ],
911
- "requestBody" : {
912
- "$ref" : "#/components/requestBodies/addDepartmentJson"
913
- },
914
- "responses" : {
915
- "422" : {
916
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
917
- },
918
- "200" : {
919
- "$ref" : "#/components/responses/getDepartmentResponse"
920
- }
921
- },
922
- "security" : [ {
923
- "org-oauth" : [ "Desk.accessAll.ALL" ]
924
- }, {
925
- "iam-oauth2-schema" : [ "Desk.settings.CREATE", "Desk.basic.CREATE" ]
926
- } ],
927
- "x-audience" : [ "external-public" ],
928
- "x-custom-url-attribute" : {
929
- "security" : {
930
- "throttle" : {
931
- "inline" : [ {
932
- "scope" : "APPSERVER",
933
- "rules" : [ {
934
- "duration" : 60000,
935
- "lock-period" : 300000,
936
- "threshold" : 20,
937
- "hip" : false
938
- } ],
939
- "window" : "ROLLING",
940
- "key" : "url.path+user.zuid"
941
- } ]
942
- },
943
- "extraparams" : {
944
- "disable" : true,
945
- "ignore" : false
946
- },
947
- "authentication" : { }
948
- },
949
- "clan-group" : "automation",
950
- "apihash" : "81073236b6aa36731498232baaa44032",
951
- "module-group" : "users",
952
- "apimethod" : "com.zoho.support.restapi.DepartmentService.addDepartment"
953
- }
954
- }
955
- },
956
- "/api/v1/departments/checkExists" : {
957
- "get" : {
958
- "tags" : [ "Department" ],
959
- "summary" : "Check for duplicate departments",
960
- "description" : "This API checks if multiple departments have the same name.",
961
- "operationId" : "checkDepartmentNameExist",
962
- "parameters" : [ {
963
- "name" : "departmentName",
964
- "in" : "query",
965
- "description" : "Name of the department for which you want to check duplicate entries",
966
- "required" : true,
967
- "style" : "form",
968
- "explode" : true,
969
- "schema" : {
970
- "type" : [ "string", "null" ],
971
- "description" : "Name of the department for which you want to check duplicate entries",
972
- "maxLength" : 200,
973
- "minLength" : 0,
974
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
975
- }
976
- }, {
977
- "$ref" : "../common/Common.json#/components/parameters/orgId"
978
- } ],
979
- "responses" : {
980
- "422" : {
981
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
982
- },
983
- "200" : {
984
- "$ref" : "#/components/responses/checkNameResponse"
985
- }
986
- },
987
- "security" : [ {
988
- "org-oauth" : [ "Desk.accessAll.ALL" ]
989
- }, {
990
- "iam-oauth2-schema" : [ "Desk.settings.READ", "Desk.basic.READ" ]
991
- } ],
992
- "x-audience" : [ "external-public" ],
993
- "x-custom-url-attribute" : {
994
- "security" : {
995
- "throttle" : {
996
- "inline" : [ {
997
- "scope" : "APPSERVER",
998
- "rules" : [ {
999
- "duration" : 60000,
1000
- "lock-period" : 300000,
1001
- "threshold" : 25,
1002
- "hip" : false
1003
- } ],
1004
- "window" : "ROLLING",
1005
- "key" : "url.path+user.zuid"
1006
- } ]
1007
- },
1008
- "extraparams" : {
1009
- "disable" : true,
1010
- "ignore" : false
1011
- },
1012
- "authentication" : { }
1013
- },
1014
- "clan-group" : "automation",
1015
- "apihash" : "b3331d1b09d1c90a84a6a7e5534b6a12",
1016
- "module-group" : "users",
1017
- "apimethod" : "com.zoho.support.restapi.DepartmentService.checkDepartmentNameExist"
1018
- }
1019
- }
1020
- },
1021
- "/api/v1/departments/sync" : {
1022
- "get" : {
1023
- "tags" : [ "Department" ],
1024
- "summary" : "List sync departments",
1025
- "description" : "This API lists departments, based on the last fetched time specified.",
1026
- "operationId" : "getSyncDepartments",
1027
- "parameters" : [ {
1028
- "$ref" : "#/components/parameters/limit"
1029
- }, {
1030
- "name" : "lastFetchedTime",
1031
- "in" : "query",
1032
- "description" : "Key that filters departments after a specific time. Enter a date in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ.",
1033
- "required" : false,
1034
- "style" : "form",
1035
- "explode" : true,
1036
- "schema" : {
1037
- "type" : [ "string", "null" ],
1038
- "description" : "Key that filters departments after a specific time. Enter a date in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ.",
1039
- "maxLength" : 100,
1040
- "minLength" : 0,
1041
- "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))"
1042
- }
1043
- }, {
1044
- "name" : "bulkUpdateOffset",
1045
- "in" : "query",
1046
- "description" : "Number of bulk record already fetched",
1047
- "required" : false,
1048
- "style" : "form",
1049
- "explode" : true,
1050
- "schema" : {
1051
- "type" : [ "string", "null", "integer" ],
1052
- "format" : "int32",
1053
- "description" : "Number of bulk record already fetched",
1054
- "pattern" : "([0-9]+)"
1055
- }
1056
- }, {
1057
- "$ref" : "../common/Common.json#/components/parameters/orgId"
1058
- } ],
1059
- "responses" : {
1060
- "204" : {
1061
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
1062
- },
1063
- "200" : {
1064
- "$ref" : "#/components/responses/departmentSyncArray"
1065
- }
1066
- },
1067
- "security" : [ {
1068
- "org-oauth" : [ "Desk.accessAll.ALL" ]
1069
- }, {
1070
- "iam-oauth2-schema" : [ "Desk.settings.READ", "Desk.basic.READ" ]
1071
- } ],
1072
- "x-audience" : [ "company-internal" ],
1073
- "x-custom-url-attribute" : {
1074
- "security" : {
1075
- "throttle" : {
1076
- "inline" : [ {
1077
- "scope" : "APPSERVER",
1078
- "rules" : [ {
1079
- "duration" : 60000,
1080
- "lock-period" : 300000,
1081
- "threshold" : 20,
1082
- "hip" : false
1083
- } ],
1084
- "window" : "ROLLING",
1085
- "key" : "url.path+user.zuid"
1086
- } ]
1087
- },
1088
- "extraparams" : {
1089
- "disable" : true,
1090
- "ignore" : false
1091
- },
1092
- "authentication" : { }
1093
- },
1094
- "clan-group" : "automation",
1095
- "apihash" : "0fc282f9e4ced308543421e15370a9a1",
1096
- "module-group" : "users",
1097
- "apimethod" : "com.zoho.support.restapi.DepartmentService.getDepartmentsForSync"
1098
- }
1099
- }
1100
- },
1101
- "/api/v1/myDepartments" : {
1102
- "get" : {
1103
- "tags" : [ "Department" ],
1104
- "summary" : "List my departments",
1105
- "description" : "This API lists departments, that is assocaited with user",
1106
- "operationId" : "getMyDepartments",
1107
- "parameters" : [ {
1108
- "$ref" : "../common/Common.json#/components/parameters/orgId"
1109
- } ],
1110
- "responses" : {
1111
- "204" : {
1112
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
1113
- },
1114
- "200" : {
1115
- "$ref" : "#/components/responses/departmentListViewArray"
1116
- }
1117
- },
1118
- "security" : [ {
1119
- "org-oauth" : [ "Desk.accessAll.ALL" ]
1120
- }, {
1121
- "iam-oauth2-schema" : [ "Desk.settings.READ", "Desk.basic.READ" ]
1122
- } ],
1123
- "x-audience" : [ "company-internal" ],
1124
- "x-custom-url-attribute" : {
1125
- "security" : {
1126
- "throttle" : {
1127
- "inline" : [ {
1128
- "scope" : "APPSERVER",
1129
- "rules" : [ {
1130
- "duration" : 60000,
1131
- "lock-period" : 600000,
1132
- "threshold" : 30,
1133
- "hip" : false
1134
- } ],
1135
- "window" : "ROLLING",
1136
- "key" : "url.path+user.zuid"
1137
- } ]
1138
- },
1139
- "extraparams" : {
1140
- "disable" : true,
1141
- "ignore" : false
1142
- },
1143
- "authentication" : { }
1144
- },
1145
- "clan-group" : "automation",
1146
- "apihash" : "5258f4c84a07e7d186836e32b06e14da",
1147
- "module-group" : "users",
1148
- "apimethod" : "com.zoho.support.restapi.DepartmentService.getMyDepartments"
1149
- }
1150
- }
1151
- }
1152
- },
1153
- "components" : {
1154
- "schemas" : {
1155
- "agentData" : {
1156
- "type" : [ "null", "array" ],
1157
- "items" : {
1158
- "$ref" : "./Agent.json#/components/schemas/agentIdsResponse"
1159
- }
1160
- },
1161
- "deptAgentsResponse" : {
1162
- "type" : [ "null", "object" ],
1163
- "additionalProperties" : false,
1164
- "properties" : {
1165
- "photoURL" : {
1166
- "type" : [ "string", "null" ],
1167
- "maxLength" : 100,
1168
- "minLength" : 0,
1169
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1170
- },
1171
- "firstName" : {
1172
- "type" : [ "string", "null" ],
1173
- "maxLength" : 50,
1174
- "minLength" : 0
1175
- },
1176
- "lastName" : {
1177
- "type" : [ "string", "null" ],
1178
- "maxLength" : 50,
1179
- "minLength" : 0
1180
- },
1181
- "roleId" : {
1182
- "type" : [ "string", "null", "integer" ],
1183
- "format" : "int64",
1184
- "pattern" : "([0-9]+)"
1185
- },
1186
- "profileId" : {
1187
- "type" : [ "string", "null", "integer" ],
1188
- "format" : "int64",
1189
- "pattern" : "([0-9]+)"
1190
- },
1191
- "emailId" : {
1192
- "type" : [ "string", "null" ],
1193
- "maxLength" : 100,
1194
- "minLength" : 0,
1195
- "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$"
1196
- },
1197
- "id" : {
1198
- "type" : [ "string", "null", "integer" ],
1199
- "format" : "int64",
1200
- "pattern" : "([0-9]+)"
1201
- },
1202
- "zuid" : {
1203
- "type" : [ "string", "null", "integer" ],
1204
- "format" : "int32",
1205
- "pattern" : "([0-9]+)"
1206
- }
1207
- },
1208
- "required" : [ "emailId", "firstName", "id", "lastName", "photoURL", "profileId", "roleId", "zuid" ]
1209
- },
1210
- "commonDepartmentResponse" : {
1211
- "type" : [ "null", "object" ],
1212
- "additionalProperties" : false,
1213
- "properties" : {
1214
- "isAssignToTeamEnabled" : {
1215
- "type" : [ "boolean", "null" ]
1216
- },
1217
- "chatStatus" : {
1218
- "type" : [ "string", "null" ],
1219
- "enum" : [ "AVAILABLE", "DISABLED", "NOT_CREATED" ],
1220
- "maxLength" : 100,
1221
- "minLength" : 0
1222
- },
1223
- "hasLogo" : {
1224
- "type" : [ "boolean", "null" ]
1225
- },
1226
- "sanitizedName" : {
1227
- "type" : [ "string", "null" ],
1228
- "maxLength" : 100,
1229
- "minLength" : 0
1230
- },
1231
- "isVisibleInCustomerPortal" : {
1232
- "type" : [ "boolean", "null" ]
1233
- },
1234
- "creatorId" : {
1235
- "type" : [ "string", "null", "integer" ],
1236
- "format" : "int64",
1237
- "pattern" : "([0-9]+)"
1238
- },
1239
- "description" : {
1240
- "type" : [ "string", "null" ],
1241
- "maxLength" : 100,
1242
- "minLength" : 0
1243
- },
1244
- "isDefault" : {
1245
- "type" : [ "boolean", "null" ]
1246
- },
1247
- "isEnabled" : {
1248
- "type" : [ "boolean", "null" ]
1249
- },
1250
- "name" : {
1251
- "type" : [ "string", "null" ],
1252
- "maxLength" : 200,
1253
- "minLength" : 0,
1254
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1255
- },
1256
- "createdTime" : {
1257
- "type" : [ "string", "null" ],
1258
- "maxLength" : 100,
1259
- "minLength" : 0,
1260
- "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))"
1261
- },
1262
- "id" : {
1263
- "type" : [ "string", "null", "integer" ],
1264
- "format" : "int64",
1265
- "pattern" : "([0-9]+)"
1266
- },
1267
- "nameInCustomerPortal" : {
1268
- "type" : [ "string", "null" ],
1269
- "maxLength" : 200,
1270
- "minLength" : 0,
1271
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1272
- }
1273
- },
1274
- "required" : [ "chatStatus", "createdTime", "creatorId", "description", "hasLogo", "id", "isAssignToTeamEnabled", "isDefault", "isEnabled", "isVisibleInCustomerPortal", "name", "nameInCustomerPortal", "sanitizedName" ]
1275
- },
1276
- "data" : {
1277
- "type" : [ "null", "array" ],
1278
- "items" : {
1279
- "$ref" : "#/components/schemas/commonDepartmentResponse"
1280
- }
1281
- },
1282
- "updateDepartmentJson" : {
1283
- "type" : [ "null", "object" ],
1284
- "additionalProperties" : false,
1285
- "properties" : {
1286
- "isAssignToTeamEnabled" : {
1287
- "type" : [ "boolean", "null" ],
1288
- "description" : "Key that denotes if the assign to team functionality is enabled or not"
1289
- },
1290
- "nameInCustomerPortal" : {
1291
- "type" : [ "string", "null" ],
1292
- "description" : "Display name of the department in the help center",
1293
- "maxLength" : 200,
1294
- "minLength" : 0,
1295
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1296
- }
1297
- }
1298
- },
1299
- "departmentObjectWithPrimaryDetails" : {
1300
- "type" : [ "null", "object" ],
1301
- "additionalProperties" : false,
1302
- "properties" : {
1303
- "name" : {
1304
- "type" : [ "string", "null" ],
1305
- "maxLength" : 200,
1306
- "minLength" : 0,
1307
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1308
- },
1309
- "id" : {
1310
- "type" : [ "string", "null", "integer" ],
1311
- "format" : "int64",
1312
- "pattern" : "([0-9]+)"
1313
- }
1314
- },
1315
- "required" : [ "id", "name" ]
1316
- }
1317
- },
1318
- "responses" : {
1319
- "deptCountResponse" : {
1320
- "description" : "deptCountResponse template definitions",
1321
- "content" : {
1322
- "application/json" : {
1323
- "schema" : {
1324
- "type" : [ "null", "object" ],
1325
- "additionalProperties" : false,
1326
- "properties" : {
1327
- "count" : {
1328
- "type" : [ "string", "null", "integer" ],
1329
- "format" : "int64",
1330
- "pattern" : "([0-9]+)"
1331
- }
1332
- },
1333
- "required" : [ "count" ]
1334
- },
1335
- "examples" : {
1336
- "Valid responses Definitions" : {
1337
- "value" : {
1338
- "count" : 5
1339
- }
1340
- }
1341
- }
1342
- }
1343
- },
1344
- "x-custom-response-attributes" : {
1345
- "disable-safe-headers" : "[]"
1346
- }
1347
- },
1348
- "getDepartmentResponse" : {
1349
- "description" : "getDepartmentResponse template definitions",
1350
- "content" : {
1351
- "application/json" : {
1352
- "schema" : {
1353
- "additionalProperties" : false,
1354
- "allOf" : [ {
1355
- "$ref" : "#/components/schemas/commonDepartmentResponse"
1356
- }, {
1357
- "type" : [ "null", "object" ],
1358
- "properties" : {
1359
- "associatedAgentIds" : {
1360
- "type" : [ "null", "array" ],
1361
- "items" : {
1362
- "type" : [ "string", "null", "integer" ],
1363
- "format" : "int64",
1364
- "pattern" : "([0-9]+)",
1365
- "x-custom-parameters-attributes" : [ { } ]
1366
- },
1367
- "uniqueItems" : false
1368
- }
1369
- },
1370
- "required" : [ "associatedAgentIds" ]
1371
- } ]
1372
- },
1373
- "examples" : {
1374
- "Valid responses Definitions" : {
1375
- "value" : {
1376
- "isAssignToTeamEnabled" : false,
1377
- "chatStatus" : "NOT_CREATED",
1378
- "hasLogo" : false,
1379
- "isVisibleInCustomerPortal" : true,
1380
- "creatorId" : "1892000000042001",
1381
- "description" : "With the most advanced technology, the zPhone is the world’s largest selling smartphone.",
1382
- "associatedAgentIds" : [ "1892000000042001", "1892000000056007" ],
1383
- "isDefault" : false,
1384
- "isEnabled" : true,
1385
- "name" : "zPhone",
1386
- "createdTime" : 1564146662000,
1387
- "id" : "1892000000082085",
1388
- "nameInCustomerPortal" : "zPhone"
1389
- }
1390
- }
1391
- }
1392
- }
1393
- },
1394
- "x-custom-response-attributes" : {
1395
- "disable-safe-headers" : "[]"
1396
- }
1397
- },
1398
- "departmentListViewArray" : {
1399
- "description" : "departmentListViewArray template definitions",
1400
- "content" : {
1401
- "application/json" : {
1402
- "schema" : {
1403
- "type" : [ "null", "object" ],
1404
- "additionalProperties" : false,
1405
- "properties" : {
1406
- "data" : {
1407
- "$ref" : "#/components/schemas/data"
1408
- }
1409
- },
1410
- "required" : [ "data" ]
1411
- },
1412
- "examples" : {
1413
- "Valid responses Definitions" : {
1414
- "value" : {
1415
- "data" : [ {
1416
- "isAssignToTeamEnabled" : true,
1417
- "chatStatus" : "AVAILABLE",
1418
- "isDefault" : true,
1419
- "hasLogo" : true,
1420
- "isVisibleInCustomerPortal" : true,
1421
- "isEnabled" : true,
1422
- "name" : "Zylker",
1423
- "creatorId" : "1892000000042001",
1424
- "description" : "Zylker Inc. is a multinational technology company that designs, develops, and sells consumer electronics.",
1425
- "createdTime" : 1564146662000,
1426
- "id" : "1892000000082069",
1427
- "nameInCustomerPortal" : "ZylCares"
1428
- }, {
1429
- "isAssignToTeamEnabled" : true,
1430
- "chatStatus" : "AVAILABLE",
1431
- "isDefault" : false,
1432
- "hasLogo" : true,
1433
- "isVisibleInCustomerPortal" : true,
1434
- "isEnabled" : true,
1435
- "name" : "zPad",
1436
- "creatorId" : "1892000000042001",
1437
- "description" : "zPad is the most advanced tablet that brings you the never-experienced-before processing power.",
1438
- "createdTime" : 1566904321000,
1439
- "id" : "1892000000082085",
1440
- "nameInCustomerPortal" : "zPad"
1441
- } ]
1442
- }
1443
- }
1444
- }
1445
- }
1446
- },
1447
- "x-custom-response-attributes" : {
1448
- "disable-safe-headers" : "[]"
1449
- }
1450
- },
1451
- "getAssociableAgentsResponse" : {
1452
- "description" : "getAssociableAgentsResponse template definitions",
1453
- "content" : {
1454
- "application/json" : {
1455
- "schema" : {
1456
- "type" : [ "null", "object" ],
1457
- "additionalProperties" : false,
1458
- "properties" : {
1459
- "data" : {
1460
- "$ref" : "#/components/schemas/agentData"
1461
- }
1462
- },
1463
- "required" : [ "data" ]
1464
- },
1465
- "examples" : {
1466
- "Valid responses Definitions" : {
1467
- "value" : {
1468
- "data" : [ {
1469
- "firstName" : "",
1470
- "lastName" : "case",
1471
- "photoURL" : null,
1472
- "roleId" : "1892000000056099",
1473
- "profileId" : "1892000000056091",
1474
- "emailId" : "case@zylker.com",
1475
- "id" : "1892000000056007",
1476
- "zuid" : "10687231"
1477
- }, {
1478
- "firstName" : "",
1479
- "lastName" : "jade",
1480
- "photoURL" : "https://contacts.zoho.com/file?t=user&ID=10657727",
1481
- "roleId" : "1892000000056899",
1482
- "profileId" : "1892000000056091",
1483
- "emailId" : "jade@zylker.com",
1484
- "id" : "1892000000042001",
1485
- "zuid" : "10657727"
1486
- }, {
1487
- "firstName" : "Steve",
1488
- "lastName" : "Waugh",
1489
- "photoURL" : "https://contacts.zoho.com/file?t=user&ID=10657828",
1490
- "roleId" : "1892000000056004",
1491
- "profileId" : "18920000000232043",
1492
- "emailId" : "stephen@zylker.com",
1493
- "id" : "1892000000888059",
1494
- "zuid" : null
1495
- } ]
1496
- }
1497
- }
1498
- }
1499
- }
1500
- },
1501
- "x-custom-response-attributes" : {
1502
- "disable-safe-headers" : "[]"
1503
- }
1504
- },
1505
- "checkNameResponse" : {
1506
- "description" : "checkNameResponse template definitions",
1507
- "content" : {
1508
- "application/json" : {
1509
- "schema" : {
1510
- "type" : [ "null", "object" ],
1511
- "additionalProperties" : false,
1512
- "properties" : {
1513
- "isDepartmentNameExist" : {
1514
- "type" : [ "boolean", "null" ]
1515
- }
1516
- },
1517
- "required" : [ "isDepartmentNameExist" ]
1518
- },
1519
- "examples" : {
1520
- "Valid responses Definitions" : {
1521
- "value" : {
1522
- "isDepartmentNameExist" : true
1523
- }
1524
- }
1525
- }
1526
- }
1527
- },
1528
- "x-custom-response-attributes" : {
1529
- "disable-safe-headers" : "[]"
1530
- }
1531
- },
1532
- "departmentSyncArray" : {
1533
- "description" : "departmentSyncArray template definitions",
1534
- "content" : {
1535
- "application/json" : {
1536
- "schema" : {
1537
- "type" : [ "null", "object" ],
1538
- "additionalProperties" : false,
1539
- "properties" : {
1540
- "data" : {
1541
- "$ref" : "#/components/schemas/data"
1542
- },
1543
- "hasMore" : {
1544
- "type" : [ "boolean", "null" ]
1545
- },
1546
- "lastFetchedTime" : {
1547
- "type" : [ "string", "null" ],
1548
- "maxLength" : 100,
1549
- "minLength" : 0,
1550
- "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))",
1551
- "x-custom-parameters-attributes" : {
1552
- "removeExif" : false,
1553
- "filterMatchedContent" : false,
1554
- "antivirus" : false,
1555
- "replacementString" : "",
1556
- "allowInvalid" : false,
1557
- "descrption" : "Key that filters departments after a specific time. Enter a date in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ.",
1558
- "secret" : false,
1559
- "preserveCharsLimit" : 10,
1560
- "trim" : false,
1561
- "internalParam" : false,
1562
- "preserveChars" : "0,5",
1563
- "importUrl" : false,
1564
- "decrypt" : false
1565
- }
1566
- },
1567
- "bulkUpdateOffset" : {
1568
- "type" : [ "string", "null" ],
1569
- "maxLength" : 100,
1570
- "minLength" : 0,
1571
- "pattern" : "[0-9]+",
1572
- "x-custom-parameters-attributes" : {
1573
- "removeExif" : false,
1574
- "filterMatchedContent" : false,
1575
- "antivirus" : false,
1576
- "replacementString" : "",
1577
- "allowInvalid" : false,
1578
- "descrption" : "Number of bulk record already fetched",
1579
- "secret" : false,
1580
- "preserveCharsLimit" : 10,
1581
- "trim" : false,
1582
- "internalParam" : false,
1583
- "preserveChars" : "0,5",
1584
- "importUrl" : false,
1585
- "decrypt" : false
1586
- }
1587
- }
1588
- },
1589
- "required" : [ "bulkUpdateOffset", "data", "hasMore", "lastFetchedTime" ]
1590
- },
1591
- "examples" : {
1592
- "Valid responses Definitions" : {
1593
- "value" : {
1594
- "data" : [ {
1595
- "isAssignToTeamEnabled" : true,
1596
- "chatStatus" : "AVAILABLE",
1597
- "isDefault" : true,
1598
- "hasLogo" : true,
1599
- "isVisibleInCustomerPortal" : true,
1600
- "isEnabled" : true,
1601
- "name" : "Zylker",
1602
- "creatorId" : "1892000000042001",
1603
- "description" : "Zylker Inc. is a multinational technology company that designs, develops, and sells consumer electronics.",
1604
- "createdTime" : 1564146662000,
1605
- "id" : "1892000000082069",
1606
- "nameInCustomerPortal" : "ZylCares"
1607
- }, {
1608
- "isAssignToTeamEnabled" : true,
1609
- "chatStatus" : "DISABLED",
1610
- "isDefault" : false,
1611
- "hasLogo" : true,
1612
- "isVisibleInCustomerPortal" : true,
1613
- "isEnabled" : true,
1614
- "name" : "zPad",
1615
- "creatorId" : "1892000000042001",
1616
- "description" : "zPad is the most advanced tablet that brings you the never-experienced-before processing power.",
1617
- "createdTime" : 1501074662000,
1618
- "id" : "1892000000082085",
1619
- "nameInCustomerPortal" : "zPad"
1620
- } ],
1621
- "lastFetchedTime" : 1538551094000,
1622
- "hasmore" : true
1623
- }
1624
- }
1625
- }
1626
- }
1627
- },
1628
- "x-custom-response-attributes" : {
1629
- "disable-safe-headers" : "[]"
1630
- }
1631
- }
1632
- },
1633
- "parameters" : {
1634
- "searchStr" : {
1635
- "name" : "searchStr",
1636
- "in" : "query",
1637
- "description" : "String to search for agents by first name, last name, or email ID. The string must contain at least one character. Three search methods are supported: 1) string* - Searches for agents whose first name, last name, or email ID start with the string, 2) *string* - Searches for agents whose first name, last name, or email ID contain the string, 3) string - Searches for agents whose first name, last name, or email ID is an exact match for the string",
1638
- "required" : false,
1639
- "style" : "form",
1640
- "explode" : true,
1641
- "schema" : {
1642
- "type" : [ "string", "null" ],
1643
- "description" : "String to search for agents by first name, last name, or email ID. The string must contain at least one character. Three search methods are supported: 1) string* - Searches for agents whose first name, last name, or email ID start with the string, 2) *string* - Searches for agents whose first name, last name, or email ID contain the string, 3) string - Searches for agents whose first name, last name, or email ID is an exact match for the string",
1644
- "maxLength" : 100,
1645
- "minLength" : 0
1646
- }
1647
- },
1648
- "departmentId" : {
1649
- "name" : "departmentId",
1650
- "in" : "path",
1651
- "required" : true,
1652
- "style" : "simple",
1653
- "explode" : false,
1654
- "schema" : {
1655
- "type" : [ "string", "null", "integer" ],
1656
- "format" : "int64",
1657
- "pattern" : "([0-9]+)"
1658
- }
1659
- },
1660
- "limit" : {
1661
- "name" : "limit",
1662
- "in" : "query",
1663
- "description" : "Number of agents to fetch; default value is 10 and maximum value is 200",
1664
- "required" : false,
1665
- "style" : "form",
1666
- "explode" : true,
1667
- "schema" : {
1668
- "type" : [ "string", "null", "integer" ],
1669
- "format" : "int32",
1670
- "description" : "Number of agents to fetch; default value is 10 and maximum value is 200",
1671
- "maximum" : 200,
1672
- "minimum" : 0,
1673
- "pattern" : "([0-9]+)"
1674
- }
1675
- },
1676
- "from" : {
1677
- "name" : "from",
1678
- "in" : "query",
1679
- "description" : "Index number, starting from which the agents must be listed",
1680
- "required" : false,
1681
- "style" : "form",
1682
- "explode" : true,
1683
- "schema" : {
1684
- "type" : [ "string", "null", "integer" ],
1685
- "format" : "int32",
1686
- "description" : "Index number, starting from which the agents must be listed",
1687
- "minimum" : 0,
1688
- "pattern" : "([0-9]+)"
1689
- }
1690
- }
1691
- },
1692
- "requestBodies" : {
1693
- "agentIdsArray" : {
1694
- "content" : {
1695
- "application/json" : {
1696
- "schema" : {
1697
- "type" : [ "null", "object" ],
1698
- "additionalProperties" : false,
1699
- "properties" : {
1700
- "agentIds" : {
1701
- "type" : [ "null", "array" ],
1702
- "items" : {
1703
- "type" : [ "string", "null", "integer" ],
1704
- "format" : "int64",
1705
- "pattern" : "([0-9]+)"
1706
- },
1707
- "uniqueItems" : false
1708
- }
1709
- },
1710
- "required" : [ "agentIds" ]
1711
- },
1712
- "examples" : {
1713
- "Valid requestBody Definitions" : {
1714
- "value" : {
1715
- "agentIds" : [ 1892000000056007, 1892000000056008 ]
1716
- }
1717
- }
1718
- }
1719
- }
1720
- },
1721
- "x-custom-request-body-attributes" : {
1722
- "non-empty" : false,
1723
- "allow-invalid" : false
1724
- }
1725
- },
1726
- "reInviteAgents_agentIdsArray" : {
1727
- "content" : {
1728
- "application/json" : {
1729
- "schema" : {
1730
- "type" : [ "null", "object" ],
1731
- "additionalProperties" : false,
1732
- "properties" : {
1733
- "agentIds" : {
1734
- "type" : [ "null", "array" ],
1735
- "items" : {
1736
- "type" : [ "string", "null", "integer" ],
1737
- "format" : "int64",
1738
- "pattern" : "([0-9]+)"
1739
- },
1740
- "uniqueItems" : false
1741
- }
1742
- },
1743
- "required" : [ "agentIds" ]
1744
- },
1745
- "examples" : {
1746
- "Valid requestBody Definitions" : {
1747
- "value" : {
1748
- "agentIds" : [ 1892000000056007, 1892000000056008 ]
1749
- }
1750
- }
1751
- }
1752
- }
1753
- },
1754
- "x-custom-request-body-attributes" : {
1755
- "non-empty" : false,
1756
- "allow-invalid" : false
1757
- }
1758
- },
1759
- "associateAgents_agentIdsArray" : {
1760
- "content" : {
1761
- "application/json" : {
1762
- "schema" : {
1763
- "type" : [ "null", "object" ],
1764
- "additionalProperties" : false,
1765
- "properties" : {
1766
- "agentIds" : {
1767
- "type" : [ "null", "array" ],
1768
- "items" : {
1769
- "type" : [ "string", "null", "integer" ],
1770
- "format" : "int64",
1771
- "pattern" : "([0-9]+)"
1772
- },
1773
- "uniqueItems" : false
1774
- }
1775
- },
1776
- "required" : [ "agentIds" ]
1777
- },
1778
- "examples" : {
1779
- "Valid requestBody Definitions" : {
1780
- "value" : {
1781
- "agentIds" : [ "1892000000042001", "1892000000056007" ]
1782
- }
1783
- }
1784
- }
1785
- }
1786
- },
1787
- "x-custom-request-body-attributes" : {
1788
- "non-empty" : false,
1789
- "allow-invalid" : false
1790
- }
1791
- },
1792
- "disableTransfer" : {
1793
- "content" : {
1794
- "application/json" : {
1795
- "schema" : {
1796
- "type" : [ "null", "object" ],
1797
- "additionalProperties" : false,
1798
- "properties" : {
1799
- "emailNewDepartment" : {
1800
- "type" : [ "string", "null", "integer" ],
1801
- "format" : "int64",
1802
- "pattern" : "([0-9]+)"
1803
- },
1804
- "agentNewDepartment" : {
1805
- "type" : [ "string", "null", "integer" ],
1806
- "format" : "int64",
1807
- "pattern" : "([0-9]+)"
1808
- }
1809
- },
1810
- "required" : [ "agentNewDepartment" ]
1811
- },
1812
- "examples" : {
1813
- "Valid requestBody Definitions" : {
1814
- "value" : {
1815
- "emailNewDepartment" : "1892000000082069",
1816
- "agentNewDepartment" : "1892000000082069"
1817
- }
1818
- }
1819
- }
1820
- }
1821
- },
1822
- "x-custom-request-body-attributes" : {
1823
- "non-empty" : false,
1824
- "allow-invalid" : false
1825
- }
1826
- },
1827
- "dissociateAgents_agentIdsArray" : {
1828
- "content" : {
1829
- "application/json" : {
1830
- "schema" : {
1831
- "type" : [ "null", "object" ],
1832
- "additionalProperties" : false,
1833
- "properties" : {
1834
- "agentIds" : {
1835
- "type" : [ "null", "array" ],
1836
- "items" : {
1837
- "type" : [ "string", "null", "integer" ],
1838
- "format" : "int64",
1839
- "pattern" : "([0-9]+)"
1840
- },
1841
- "uniqueItems" : false
1842
- }
1843
- },
1844
- "required" : [ "agentIds" ]
1845
- },
1846
- "examples" : {
1847
- "Valid requestBody Definitions" : {
1848
- "value" : {
1849
- "agentIds" : [ "1892000000056007" ]
1850
- }
1851
- }
1852
- }
1853
- }
1854
- },
1855
- "x-custom-request-body-attributes" : {
1856
- "non-empty" : false,
1857
- "allow-invalid" : false
1858
- }
1859
- },
1860
- "updateDepartmentJson" : {
1861
- "content" : {
1862
- "application/json" : {
1863
- "schema" : {
1864
- "type" : [ "null", "object" ],
1865
- "additionalProperties" : false,
1866
- "properties" : {
1867
- "isAssignToTeamEnabled" : {
1868
- "type" : [ "boolean", "null" ],
1869
- "description" : "Key that denotes if the assign to team functionality is enabled or not"
1870
- },
1871
- "nameInCustomerPortal" : {
1872
- "type" : [ "string", "null" ],
1873
- "description" : "Display name of the department in the help center",
1874
- "maxLength" : 200,
1875
- "minLength" : 0,
1876
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1877
- }
1878
- }
1879
- },
1880
- "examples" : {
1881
- "Valid requestBody Definitions" : {
1882
- "value" : {
1883
- "isAssignToTeamEnabled" : true,
1884
- "nameInCustomerPortal" : "zPhone Support"
1885
- }
1886
- }
1887
- }
1888
- }
1889
- },
1890
- "x-custom-request-body-attributes" : {
1891
- "non-empty" : false,
1892
- "allow-invalid" : false
1893
- }
1894
- },
1895
- "addDepartmentJson" : {
1896
- "content" : {
1897
- "application/json" : {
1898
- "schema" : {
1899
- "additionalProperties" : false,
1900
- "allOf" : [ {
1901
- "$ref" : "#/components/schemas/updateDepartmentJson"
1902
- }, {
1903
- "type" : [ "null", "object" ],
1904
- "properties" : {
1905
- "isVisibleInCustomerPortal" : {
1906
- "type" : [ "boolean", "null" ],
1907
- "description" : "Key that denotes if the department is visible in the help center or not"
1908
- },
1909
- "name" : {
1910
- "type" : [ "string", "null" ],
1911
- "description" : "Name of the department",
1912
- "maxLength" : 200,
1913
- "minLength" : 0,
1914
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1915
- },
1916
- "description" : {
1917
- "type" : [ "string", "null" ],
1918
- "description" : "A short description of the department",
1919
- "maxLength" : 100,
1920
- "minLength" : 0
1921
- },
1922
- "associatedAgentIds" : {
1923
- "type" : [ "null", "array" ],
1924
- "items" : {
1925
- "type" : [ "string", "null", "integer" ],
1926
- "format" : "int64",
1927
- "pattern" : "([0-9]+)",
1928
- "x-custom-parameters-attributes" : [ { } ]
1929
- },
1930
- "uniqueItems" : false
1931
- }
1932
- }
1933
- }, {
1934
- "type" : "object",
1935
- "required" : [ "associatedAgentIds", "name" ]
1936
- } ]
1937
- },
1938
- "examples" : {
1939
- "Valid requestBody Definitions" : {
1940
- "value" : {
1941
- "isAssignToTeamEnabled" : false,
1942
- "isVisibleInCustomerPortal" : true,
1943
- "name" : "zPhone",
1944
- "description" : "With the most advanced technology, the zPhone is the world’s largest selling smartphone.",
1945
- "associatedAgentIds" : [ "1892000000042001", "1892000000056007" ],
1946
- "nameInCustomerPortal" : "zPhone"
1947
- }
1948
- }
1949
- }
1950
- }
1951
- },
1952
- "x-custom-request-body-attributes" : {
1953
- "non-empty" : false,
1954
- "allow-invalid" : false
1955
- }
1956
- }
1957
- },
1958
- "securitySchemes" : {
1959
- "cookie-auth" : {
1960
- "$ref" : "../common/Common.json#/components/securitySchemes/cookie-auth"
1961
- },
1962
- "org-oauth" : {
1963
- "$ref" : "../common/Common.json#/components/securitySchemes/org-oauth"
1964
- },
1965
- "iam-oauth2-schema" : {
1966
- "$ref" : "../common/Common.json#/components/securitySchemes/iam-oauth2-schema"
1967
- }
1968
- }
1969
- },
1970
- "x-entity" : "Department"
1971
- }