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,2849 +0,0 @@
1
- {
2
- "openapi" : "3.1.0",
3
- "info" : {
4
- "title" : "IM_Channel",
5
- "version" : "1.0.0",
6
- "x-clan-group" : "microservices",
7
- "x-module-group" : "im"
8
- },
9
- "paths" : {
10
- "/api/v1/im/channels/{id}/preference" : {
11
- "get" : {
12
- "tags" : [ "IM_Channel" ],
13
- "operationId" : "getIMChannelPreference",
14
- "parameters" : [ {
15
- "$ref" : "#/components/parameters/id"
16
- }, {
17
- "$ref" : "../common/Common.json#/components/parameters/orgId"
18
- } ],
19
- "responses" : {
20
- "404" : {
21
- "$ref" : "../common/Common.json#/components/responses/urlNotFoundErrorResponse"
22
- },
23
- "200" : {
24
- "$ref" : "#/components/responses/getIMChannelPreference"
25
- },
26
- "422" : {
27
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
28
- },
29
- "400" : {
30
- "$ref" : "../common/Common.json#/components/responses/badRequestErrorResponse"
31
- },
32
- "204" : {
33
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
34
- }
35
- },
36
- "security" : [ {
37
- "org-oauth" : [ "Desk.accessAll.ALL" ]
38
- }, {
39
- "iam-oauth2-schema" : [ "Desk.basic.READ" ]
40
- } ],
41
- "x-audience" : [ "company-internal" ],
42
- "x-custom-url-attribute" : {
43
- "security" : {
44
- "throttle" : {
45
- "inline" : [ {
46
- "scope" : "APPSERVER",
47
- "rules" : [ {
48
- "duration" : 60000,
49
- "lock-period" : 300000,
50
- "threshold" : 30,
51
- "hip" : false
52
- } ],
53
- "window" : "ROLLING",
54
- "key" : "url.path+user.zuid"
55
- } ]
56
- },
57
- "extraparams" : {
58
- "disable" : true,
59
- "ignore" : false
60
- },
61
- "authentication" : { }
62
- },
63
- "clan-group" : "microservices",
64
- "module-group" : "im",
65
- "apimethod" : "com.zoho.support.restapi.im.IMChannelService.getIMChannelPreference"
66
- }
67
- },
68
- "patch" : {
69
- "tags" : [ "IM_Channel" ],
70
- "operationId" : "saveIMChannelPreference",
71
- "parameters" : [ {
72
- "$ref" : "#/components/parameters/id"
73
- }, {
74
- "$ref" : "../common/Common.json#/components/parameters/orgId"
75
- } ],
76
- "requestBody" : {
77
- "$ref" : "#/components/requestBodies/saveIMChannelPreference"
78
- },
79
- "responses" : {
80
- "404" : {
81
- "$ref" : "../common/Common.json#/components/responses/urlNotFoundErrorResponse"
82
- },
83
- "200" : {
84
- "$ref" : "#/components/responses/getIMChannelPreference"
85
- },
86
- "422" : {
87
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
88
- },
89
- "400" : {
90
- "$ref" : "../common/Common.json#/components/responses/badRequestErrorResponse"
91
- },
92
- "403" : {
93
- "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
94
- }
95
- },
96
- "security" : [ {
97
- "org-oauth" : [ "Desk.accessAll.ALL" ]
98
- }, {
99
- "iam-oauth2-schema" : [ "Desk.basic.UPDATE" ]
100
- } ],
101
- "x-audience" : [ "company-internal" ],
102
- "x-custom-url-attribute" : {
103
- "security" : {
104
- "throttle" : {
105
- "inline" : [ {
106
- "scope" : "APPSERVER",
107
- "rules" : [ {
108
- "duration" : 60000,
109
- "lock-period" : 300000,
110
- "threshold" : 30,
111
- "hip" : false
112
- } ],
113
- "window" : "ROLLING",
114
- "key" : "url.path+user.zuid"
115
- } ]
116
- },
117
- "extraparams" : {
118
- "disable" : true,
119
- "ignore" : false
120
- },
121
- "authentication" : { }
122
- },
123
- "clan-group" : "microservices",
124
- "module-group" : "im",
125
- "apimethod" : "com.zoho.support.restapi.im.IMChannelService.saveIMChannelPreference"
126
- }
127
- }
128
- },
129
- "/api/v1/im/channels/agents" : {
130
- "post" : {
131
- "tags" : [ "IM_Channel" ],
132
- "operationId" : "addIMChannelsHandlingAgents",
133
- "parameters" : [ {
134
- "$ref" : "../common/Common.json#/components/parameters/orgId"
135
- } ],
136
- "requestBody" : {
137
- "$ref" : "#/components/requestBodies/addIMChannelsHandlingAgents_updateIMChannelHandlingAgents"
138
- },
139
- "responses" : {
140
- "404" : {
141
- "$ref" : "../common/Common.json#/components/responses/urlNotFoundErrorResponse"
142
- },
143
- "200" : {
144
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
145
- },
146
- "422" : {
147
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
148
- },
149
- "400" : {
150
- "$ref" : "../common/Common.json#/components/responses/badRequestErrorResponse"
151
- },
152
- "403" : {
153
- "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
154
- }
155
- },
156
- "security" : [ {
157
- "org-oauth" : [ "Desk.accessAll.ALL" ]
158
- }, {
159
- "iam-oauth2-schema" : [ "Desk.basic.CREATE" ]
160
- } ],
161
- "x-audience" : [ "company-internal" ],
162
- "x-custom-url-attribute" : {
163
- "security" : {
164
- "throttle" : {
165
- "inline" : [ {
166
- "scope" : "APPSERVER",
167
- "rules" : [ {
168
- "duration" : 60000,
169
- "lock-period" : 300000,
170
- "threshold" : 30,
171
- "hip" : false
172
- } ],
173
- "window" : "ROLLING",
174
- "key" : "url.path+user.zuid"
175
- } ]
176
- },
177
- "extraparams" : {
178
- "disable" : true,
179
- "ignore" : false
180
- },
181
- "authentication" : { }
182
- },
183
- "clan-group" : "microservices",
184
- "module-group" : "im",
185
- "apimethod" : "com.zoho.support.restapi.im.IMChannelService.addIMChannelsHandlingAgents"
186
- }
187
- },
188
- "delete" : {
189
- "tags" : [ "IM_Channel" ],
190
- "operationId" : "removeIMChannelsHandlingAgents",
191
- "parameters" : [ {
192
- "$ref" : "../common/Common.json#/components/parameters/orgId"
193
- } ],
194
- "requestBody" : {
195
- "$ref" : "#/components/requestBodies/updateIMChannelHandlingAgents"
196
- },
197
- "responses" : {
198
- "404" : {
199
- "$ref" : "../common/Common.json#/components/responses/urlNotFoundErrorResponse"
200
- },
201
- "200" : {
202
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
203
- },
204
- "422" : {
205
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
206
- },
207
- "400" : {
208
- "$ref" : "../common/Common.json#/components/responses/badRequestErrorResponse"
209
- },
210
- "403" : {
211
- "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
212
- }
213
- },
214
- "security" : [ {
215
- "org-oauth" : [ "Desk.accessAll.ALL" ]
216
- }, {
217
- "iam-oauth2-schema" : [ "Desk.basic.DELETE" ]
218
- } ],
219
- "x-audience" : [ "company-internal" ],
220
- "x-custom-url-attribute" : {
221
- "security" : {
222
- "throttle" : {
223
- "inline" : [ {
224
- "scope" : "APPSERVER",
225
- "rules" : [ {
226
- "duration" : 60000,
227
- "lock-period" : 300000,
228
- "threshold" : 30,
229
- "hip" : false
230
- } ],
231
- "window" : "ROLLING",
232
- "key" : "url.path+user.zuid"
233
- } ]
234
- },
235
- "extraparams" : {
236
- "disable" : true,
237
- "ignore" : false
238
- },
239
- "authentication" : { }
240
- },
241
- "clan-group" : "microservices",
242
- "module-group" : "im",
243
- "apimethod" : "com.zoho.support.restapi.im.IMChannelService.removeIMChannelsHandlingAgents"
244
- }
245
- }
246
- },
247
- "/api/v1/im/channels/{id}/configParams" : {
248
- "get" : {
249
- "tags" : [ "IM_Channel" ],
250
- "operationId" : "getConfigParams",
251
- "parameters" : [ {
252
- "$ref" : "#/components/parameters/id"
253
- }, {
254
- "$ref" : "../common/Common.json#/components/parameters/orgId"
255
- } ],
256
- "responses" : {
257
- "404" : {
258
- "$ref" : "../common/Common.json#/components/responses/urlNotFoundErrorResponse"
259
- },
260
- "200" : {
261
- "$ref" : "#/components/responses/getConfigParams"
262
- },
263
- "422" : {
264
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
265
- },
266
- "400" : {
267
- "$ref" : "../common/Common.json#/components/responses/badRequestErrorResponse"
268
- },
269
- "403" : {
270
- "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
271
- }
272
- },
273
- "security" : [ {
274
- "org-oauth" : [ "Desk.accessAll.ALL" ]
275
- }, {
276
- "iam-oauth2-schema" : [ "Desk.basic.READ" ]
277
- } ],
278
- "x-audience" : [ "company-internal" ],
279
- "x-custom-url-attribute" : {
280
- "security" : {
281
- "throttle" : {
282
- "inline" : [ {
283
- "scope" : "APPSERVER",
284
- "rules" : [ {
285
- "duration" : 60000,
286
- "lock-period" : 300000,
287
- "threshold" : 30,
288
- "hip" : false
289
- } ],
290
- "window" : "ROLLING",
291
- "key" : "url.path+user.zuid"
292
- } ]
293
- },
294
- "extraparams" : {
295
- "disable" : true,
296
- "ignore" : false
297
- },
298
- "authentication" : { }
299
- },
300
- "clan-group" : "microservices",
301
- "module-group" : "im",
302
- "apimethod" : "com.zoho.support.restapi.im.IMChannelService.getConfigParams"
303
- }
304
- },
305
- "patch" : {
306
- "tags" : [ "IM_Channel" ],
307
- "operationId" : "updateConfigParams",
308
- "parameters" : [ {
309
- "$ref" : "#/components/parameters/id"
310
- }, {
311
- "$ref" : "../common/Common.json#/components/parameters/orgId"
312
- } ],
313
- "requestBody" : {
314
- "$ref" : "#/components/requestBodies/updateConfigParams"
315
- },
316
- "responses" : {
317
- "404" : {
318
- "$ref" : "../common/Common.json#/components/responses/urlNotFoundErrorResponse"
319
- },
320
- "200" : {
321
- "$ref" : "#/components/responses/getConfigParams"
322
- },
323
- "422" : {
324
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
325
- },
326
- "400" : {
327
- "$ref" : "../common/Common.json#/components/responses/badRequestErrorResponse"
328
- },
329
- "403" : {
330
- "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
331
- }
332
- },
333
- "security" : [ {
334
- "org-oauth" : [ "Desk.accessAll.ALL" ]
335
- }, {
336
- "iam-oauth2-schema" : [ "Desk.basic.UPDATE" ]
337
- } ],
338
- "x-audience" : [ "company-internal" ],
339
- "x-custom-url-attribute" : {
340
- "security" : {
341
- "throttle" : {
342
- "inline" : [ {
343
- "scope" : "APPSERVER",
344
- "rules" : [ {
345
- "duration" : 60000,
346
- "lock-period" : 300000,
347
- "threshold" : 30,
348
- "hip" : false
349
- } ],
350
- "window" : "ROLLING",
351
- "key" : "url.path+user.zuid"
352
- } ]
353
- },
354
- "extraparams" : {
355
- "disable" : true,
356
- "ignore" : false
357
- },
358
- "authentication" : { }
359
- },
360
- "clan-group" : "microservices",
361
- "module-group" : "im",
362
- "apimethod" : "com.zoho.support.restapi.im.IMChannelService.updateConfigParams"
363
- }
364
- }
365
- },
366
- "/api/v1/im/channels/{id}/agents" : {
367
- "get" : {
368
- "tags" : [ "IM_Channel" ],
369
- "operationId" : "getIMChannelHandlingAgents",
370
- "parameters" : [ {
371
- "$ref" : "#/components/parameters/limit"
372
- }, {
373
- "$ref" : "#/components/parameters/from"
374
- }, {
375
- "$ref" : "#/components/parameters/id"
376
- }, {
377
- "$ref" : "../common/Common.json#/components/parameters/orgId"
378
- } ],
379
- "responses" : {
380
- "404" : {
381
- "$ref" : "../common/Common.json#/components/responses/urlNotFoundErrorResponse"
382
- },
383
- "200" : {
384
- "$ref" : "#/components/responses/getIMChannelHandlingAgents"
385
- },
386
- "422" : {
387
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
388
- },
389
- "400" : {
390
- "$ref" : "../common/Common.json#/components/responses/badRequestErrorResponse"
391
- }
392
- },
393
- "security" : [ {
394
- "org-oauth" : [ "Desk.accessAll.ALL" ]
395
- }, {
396
- "iam-oauth2-schema" : [ "Desk.basic.READ" ]
397
- } ],
398
- "x-audience" : [ "company-internal" ],
399
- "x-custom-url-attribute" : {
400
- "security" : {
401
- "throttle" : {
402
- "inline" : [ {
403
- "scope" : "APPSERVER",
404
- "rules" : [ {
405
- "duration" : 60000,
406
- "lock-period" : 300000,
407
- "threshold" : 45,
408
- "hip" : false
409
- } ],
410
- "window" : "ROLLING",
411
- "key" : "url.path+user.zuid"
412
- } ]
413
- },
414
- "extraparams" : {
415
- "disable" : true,
416
- "ignore" : false
417
- },
418
- "authentication" : { }
419
- },
420
- "clan-group" : "microservices",
421
- "module-group" : "im",
422
- "apimethod" : "com.zoho.support.restapi.im.IMChannelService.getIMChannelHandlingAgents"
423
- }
424
- },
425
- "post" : {
426
- "tags" : [ "IM_Channel" ],
427
- "operationId" : "addIMChannelHandlingAgents",
428
- "parameters" : [ {
429
- "$ref" : "#/components/parameters/id"
430
- }, {
431
- "$ref" : "../common/Common.json#/components/parameters/orgId"
432
- } ],
433
- "requestBody" : {
434
- "$ref" : "#/components/requestBodies/addIMChannelHandlingAgents"
435
- },
436
- "responses" : {
437
- "404" : {
438
- "$ref" : "../common/Common.json#/components/responses/urlNotFoundErrorResponse"
439
- },
440
- "200" : {
441
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
442
- },
443
- "422" : {
444
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
445
- },
446
- "400" : {
447
- "$ref" : "../common/Common.json#/components/responses/badRequestErrorResponse"
448
- },
449
- "403" : {
450
- "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
451
- }
452
- },
453
- "security" : [ {
454
- "org-oauth" : [ "Desk.accessAll.ALL" ]
455
- }, {
456
- "iam-oauth2-schema" : [ "Desk.basic.CREATE" ]
457
- } ],
458
- "x-audience" : [ "company-internal" ],
459
- "x-custom-url-attribute" : {
460
- "security" : {
461
- "throttle" : {
462
- "inline" : [ {
463
- "scope" : "APPSERVER",
464
- "rules" : [ {
465
- "duration" : 60000,
466
- "lock-period" : 300000,
467
- "threshold" : 30,
468
- "hip" : false
469
- } ],
470
- "window" : "ROLLING",
471
- "key" : "url.path+user.zuid"
472
- } ]
473
- },
474
- "extraparams" : {
475
- "disable" : true,
476
- "ignore" : false
477
- },
478
- "authentication" : { }
479
- },
480
- "clan-group" : "microservices",
481
- "module-group" : "im",
482
- "apimethod" : "com.zoho.support.restapi.im.IMChannelService.addIMChannelHandlingAgents"
483
- }
484
- }
485
- },
486
- "/api/v1/im/channels/channelLimitStatus" : {
487
- "get" : {
488
- "tags" : [ "IM_Channel" ],
489
- "operationId" : "getIMChannelCreationAllowed",
490
- "parameters" : [ {
491
- "$ref" : "#/components/parameters/integrationServiceId"
492
- }, {
493
- "$ref" : "../common/Common.json#/components/parameters/orgId"
494
- } ],
495
- "responses" : {
496
- "422" : {
497
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
498
- },
499
- "204" : {
500
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
501
- },
502
- "403" : {
503
- "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
504
- }
505
- },
506
- "security" : [ {
507
- "org-oauth" : [ "Desk.accessAll.ALL" ]
508
- }, {
509
- "iam-oauth2-schema" : [ "Desk.basic.READ" ]
510
- } ],
511
- "x-audience" : [ "company-internal" ],
512
- "x-custom-url-attribute" : {
513
- "security" : {
514
- "throttle" : {
515
- "inline" : [ {
516
- "scope" : "APPSERVER",
517
- "rules" : [ {
518
- "duration" : 60000,
519
- "lock-period" : 300000,
520
- "threshold" : 30,
521
- "hip" : false
522
- } ],
523
- "window" : "ROLLING",
524
- "key" : "url.path+user.zuid"
525
- } ]
526
- },
527
- "extraparams" : {
528
- "disable" : true,
529
- "ignore" : false
530
- },
531
- "authentication" : { }
532
- },
533
- "clan-group" : "microservices",
534
- "module-group" : "im",
535
- "apimethod" : "com.zoho.support.restapi.im.IMChannelService.getIMChannelCreationAllowed"
536
- }
537
- }
538
- },
539
- "/api/v1/im/channels/{id}/activation" : {
540
- "post" : {
541
- "tags" : [ "IM_Channel" ],
542
- "operationId" : "activateChannel",
543
- "parameters" : [ {
544
- "$ref" : "#/components/parameters/id"
545
- }, {
546
- "$ref" : "../common/Common.json#/components/parameters/orgId"
547
- } ],
548
- "responses" : {
549
- "404" : {
550
- "$ref" : "../common/Common.json#/components/responses/urlNotFoundErrorResponse"
551
- },
552
- "200" : {
553
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
554
- },
555
- "422" : {
556
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
557
- },
558
- "400" : {
559
- "$ref" : "../common/Common.json#/components/responses/badRequestErrorResponse"
560
- },
561
- "403" : {
562
- "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
563
- }
564
- },
565
- "security" : [ {
566
- "org-oauth" : [ "Desk.accessAll.ALL" ]
567
- }, {
568
- "iam-oauth2-schema" : [ "Desk.basic.CREATE" ]
569
- } ],
570
- "x-audience" : [ "company-internal" ],
571
- "x-custom-url-attribute" : {
572
- "security" : {
573
- "throttle" : {
574
- "inline" : [ {
575
- "scope" : "APPSERVER",
576
- "rules" : [ {
577
- "duration" : 60000,
578
- "lock-period" : 300000,
579
- "threshold" : 30,
580
- "hip" : false
581
- } ],
582
- "window" : "ROLLING",
583
- "key" : "url.path+user.zuid"
584
- } ]
585
- },
586
- "extraparams" : {
587
- "disable" : true,
588
- "ignore" : false
589
- },
590
- "authentication" : { }
591
- },
592
- "clan-group" : "microservices",
593
- "module-group" : "im",
594
- "apimethod" : "com.zoho.support.restapi.im.IMChannelService.activateChannel"
595
- }
596
- },
597
- "delete" : {
598
- "tags" : [ "IM_Channel" ],
599
- "operationId" : "deActivateChannel",
600
- "parameters" : [ {
601
- "$ref" : "#/components/parameters/id"
602
- }, {
603
- "$ref" : "../common/Common.json#/components/parameters/orgId"
604
- } ],
605
- "responses" : {
606
- "404" : {
607
- "$ref" : "../common/Common.json#/components/responses/urlNotFoundErrorResponse"
608
- },
609
- "200" : {
610
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
611
- },
612
- "422" : {
613
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
614
- },
615
- "400" : {
616
- "$ref" : "../common/Common.json#/components/responses/badRequestErrorResponse"
617
- },
618
- "403" : {
619
- "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
620
- }
621
- },
622
- "security" : [ {
623
- "org-oauth" : [ "Desk.accessAll.ALL" ]
624
- }, {
625
- "iam-oauth2-schema" : [ "Desk.basic.DELETE" ]
626
- } ],
627
- "x-audience" : [ "company-internal" ],
628
- "x-custom-url-attribute" : {
629
- "security" : {
630
- "throttle" : {
631
- "inline" : [ {
632
- "scope" : "APPSERVER",
633
- "rules" : [ {
634
- "duration" : 60000,
635
- "lock-period" : 300000,
636
- "threshold" : 30,
637
- "hip" : false
638
- } ],
639
- "window" : "ROLLING",
640
- "key" : "url.path+user.zuid"
641
- } ]
642
- },
643
- "extraparams" : {
644
- "disable" : true,
645
- "ignore" : false
646
- },
647
- "authentication" : { }
648
- },
649
- "clan-group" : "microservices",
650
- "module-group" : "im",
651
- "apimethod" : "com.zoho.support.restapi.im.IMChannelService.deActivateChannel"
652
- }
653
- }
654
- },
655
- "/api/v1/im/channels/{id}/department" : {
656
- "patch" : {
657
- "tags" : [ "IM_Channel" ],
658
- "operationId" : "associateIMChannel",
659
- "parameters" : [ {
660
- "$ref" : "#/components/parameters/id"
661
- }, {
662
- "$ref" : "../common/Common.json#/components/parameters/orgId"
663
- } ],
664
- "requestBody" : {
665
- "$ref" : "#/components/requestBodies/associateIMChannel"
666
- },
667
- "responses" : {
668
- "404" : {
669
- "$ref" : "../common/Common.json#/components/responses/urlNotFoundErrorResponse"
670
- },
671
- "200" : {
672
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
673
- },
674
- "422" : {
675
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
676
- },
677
- "400" : {
678
- "$ref" : "../common/Common.json#/components/responses/badRequestErrorResponse"
679
- },
680
- "403" : {
681
- "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
682
- }
683
- },
684
- "security" : [ {
685
- "org-oauth" : [ "Desk.accessAll.ALL" ]
686
- }, {
687
- "iam-oauth2-schema" : [ "Desk.basic.UPDATE" ]
688
- } ],
689
- "x-audience" : [ "company-internal" ],
690
- "x-custom-url-attribute" : {
691
- "security" : {
692
- "throttle" : {
693
- "inline" : [ {
694
- "scope" : "APPSERVER",
695
- "rules" : [ {
696
- "duration" : 60000,
697
- "lock-period" : 300000,
698
- "threshold" : 30,
699
- "hip" : false
700
- } ],
701
- "window" : "ROLLING",
702
- "key" : "url.path+user.zuid"
703
- } ]
704
- },
705
- "extraparams" : {
706
- "disable" : true,
707
- "ignore" : false
708
- },
709
- "authentication" : { }
710
- },
711
- "clan-group" : "microservices",
712
- "module-group" : "im",
713
- "apimethod" : "com.zoho.support.restapi.im.IMChannelService.associateIMChannel"
714
- }
715
- }
716
- },
717
- "/api/v1/channels/{deskChannelId}/agents" : {
718
- "get" : {
719
- "tags" : [ "IM_Channel" ],
720
- "operationId" : "getDeskChannelHandlingAgents",
721
- "parameters" : [ {
722
- "$ref" : "#/components/parameters/limit"
723
- }, {
724
- "$ref" : "#/components/parameters/from"
725
- }, {
726
- "name" : "deskChannelId",
727
- "in" : "path",
728
- "description" : "",
729
- "required" : true,
730
- "style" : "simple",
731
- "explode" : false,
732
- "schema" : {
733
- "type" : [ "string", "null" ],
734
- "description" : "",
735
- "maxLength" : 100,
736
- "minLength" : 0,
737
- "pattern" : "([a-zA-Z0-9_\\\\-]+)"
738
- }
739
- }, {
740
- "$ref" : "../common/Common.json#/components/parameters/orgId"
741
- } ],
742
- "responses" : {
743
- "404" : {
744
- "$ref" : "../common/Common.json#/components/responses/urlNotFoundErrorResponse"
745
- },
746
- "200" : {
747
- "$ref" : "#/components/responses/getIMChannelHandlingAgents"
748
- },
749
- "422" : {
750
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
751
- },
752
- "400" : {
753
- "$ref" : "../common/Common.json#/components/responses/badRequestErrorResponse"
754
- }
755
- },
756
- "security" : [ {
757
- "org-oauth" : [ "Desk.accessAll.ALL" ]
758
- }, {
759
- "iam-oauth2-schema" : [ "Desk.basic.READ" ]
760
- } ],
761
- "x-audience" : [ "company-internal" ],
762
- "x-custom-url-attribute" : {
763
- "security" : {
764
- "throttle" : {
765
- "inline" : [ {
766
- "scope" : "APPSERVER",
767
- "rules" : [ {
768
- "duration" : 60000,
769
- "lock-period" : 300000,
770
- "threshold" : 45,
771
- "hip" : false
772
- } ],
773
- "window" : "ROLLING",
774
- "key" : "url.path+user.zuid"
775
- } ]
776
- },
777
- "extraparams" : {
778
- "disable" : true,
779
- "ignore" : false
780
- },
781
- "authentication" : { }
782
- },
783
- "clan-group" : "microservices",
784
- "module-group" : "im",
785
- "apimethod" : "com.zoho.support.restapi.im.IMChannelService.getDeskChannelHandlingAgents"
786
- }
787
- }
788
- },
789
- "/api/v1/im/channels/{id}" : {
790
- "get" : {
791
- "tags" : [ "IM_Channel" ],
792
- "summary" : "Get a Channel",
793
- "description" : "This API fetches details of an channel.",
794
- "operationId" : "getIMChannel",
795
- "parameters" : [ {
796
- "name" : "include",
797
- "in" : "query",
798
- "description" : "Additional information related to the channel. Allowed values are @preference@, @creator@",
799
- "required" : false,
800
- "style" : "simple",
801
- "explode" : true,
802
- "schema" : {
803
- "type" : [ "null", "array" ],
804
- "description" : "Additional information related to the channel. Allowed values are @preference@, @creator@",
805
- "items" : {
806
- "type" : [ "string", "null" ],
807
- "enum" : [ "preference", "creator" ],
808
- "maxLength" : 100,
809
- "minLength" : 0,
810
- "x-custom-parameters-attributes" : [ ]
811
- },
812
- "maxItems" : 2,
813
- "uniqueItems" : true
814
- }
815
- }, {
816
- "$ref" : "#/components/parameters/id"
817
- }, {
818
- "$ref" : "../common/Common.json#/components/parameters/orgId"
819
- } ],
820
- "responses" : {
821
- "404" : {
822
- "$ref" : "../common/Common.json#/components/responses/urlNotFoundErrorResponse"
823
- },
824
- "200" : {
825
- "$ref" : "#/components/responses/getIMChannel"
826
- },
827
- "422" : {
828
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
829
- },
830
- "400" : {
831
- "$ref" : "../common/Common.json#/components/responses/badRequestErrorResponse"
832
- },
833
- "403" : {
834
- "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
835
- }
836
- },
837
- "security" : [ {
838
- "org-oauth" : [ "Desk.accessAll.ALL" ]
839
- }, {
840
- "iam-oauth2-schema" : [ "Desk.basic.READ", "Desk.InstantMessages.READ" ]
841
- } ],
842
- "x-audience" : [ "external-public" ],
843
- "x-custom-url-attribute" : {
844
- "security" : {
845
- "throttle" : {
846
- "inline" : [ {
847
- "scope" : "APPSERVER",
848
- "rules" : [ {
849
- "duration" : 60000,
850
- "lock-period" : 300000,
851
- "threshold" : 30,
852
- "hip" : false
853
- } ],
854
- "window" : "ROLLING",
855
- "key" : "url.path+user.zuid"
856
- } ]
857
- },
858
- "extraparams" : {
859
- "disable" : true,
860
- "ignore" : false
861
- },
862
- "authentication" : { }
863
- },
864
- "clan-group" : "microservices",
865
- "apihash" : "cee1f721cb1b2efc06ae39f825877af1",
866
- "module-group" : "im",
867
- "apimethod" : "com.zoho.support.restapi.im.IMChannelService.getIMChannel"
868
- }
869
- },
870
- "patch" : {
871
- "tags" : [ "IM_Channel" ],
872
- "operationId" : "updateIMChannel",
873
- "parameters" : [ {
874
- "$ref" : "#/components/parameters/id"
875
- }, {
876
- "$ref" : "../common/Common.json#/components/parameters/orgId"
877
- } ],
878
- "requestBody" : {
879
- "$ref" : "#/components/requestBodies/updateIMChannel"
880
- },
881
- "responses" : {
882
- "404" : {
883
- "$ref" : "../common/Common.json#/components/responses/urlNotFoundErrorResponse"
884
- },
885
- "200" : {
886
- "$ref" : "#/components/responses/getIMChannel"
887
- },
888
- "422" : {
889
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
890
- },
891
- "400" : {
892
- "$ref" : "../common/Common.json#/components/responses/badRequestErrorResponse"
893
- },
894
- "403" : {
895
- "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
896
- }
897
- },
898
- "security" : [ {
899
- "org-oauth" : [ "Desk.accessAll.ALL" ]
900
- }, {
901
- "iam-oauth2-schema" : [ "Desk.basic.UPDATE" ]
902
- } ],
903
- "x-audience" : [ "company-internal" ],
904
- "x-custom-url-attribute" : {
905
- "security" : {
906
- "throttle" : {
907
- "inline" : [ {
908
- "scope" : "APPSERVER",
909
- "rules" : [ {
910
- "duration" : 60000,
911
- "lock-period" : 300000,
912
- "threshold" : 30,
913
- "hip" : false
914
- } ],
915
- "window" : "ROLLING",
916
- "key" : "url.path+user.zuid"
917
- } ]
918
- },
919
- "extraparams" : {
920
- "disable" : true,
921
- "ignore" : false
922
- },
923
- "authentication" : { }
924
- },
925
- "clan-group" : "microservices",
926
- "module-group" : "im",
927
- "apimethod" : "com.zoho.support.restapi.im.IMChannelService.updateChannel"
928
- }
929
- }
930
- },
931
- "/api/v1/im/channels/{id}/meta" : {
932
- "patch" : {
933
- "tags" : [ "IM_Channel" ],
934
- "operationId" : "saveChannelMeta",
935
- "parameters" : [ {
936
- "$ref" : "#/components/parameters/id"
937
- }, {
938
- "$ref" : "../common/Common.json#/components/parameters/orgId"
939
- } ],
940
- "requestBody" : {
941
- "$ref" : "#/components/requestBodies/saveChannelMeta"
942
- },
943
- "responses" : {
944
- "404" : {
945
- "$ref" : "../common/Common.json#/components/responses/urlNotFoundErrorResponse"
946
- },
947
- "200" : {
948
- "$ref" : "#/components/responses/saveChannelMetaResponse"
949
- },
950
- "422" : {
951
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
952
- },
953
- "400" : {
954
- "$ref" : "../common/Common.json#/components/responses/badRequestErrorResponse"
955
- },
956
- "403" : {
957
- "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
958
- }
959
- },
960
- "security" : [ {
961
- "org-oauth" : [ "Desk.accessAll.ALL" ]
962
- }, {
963
- "iam-oauth2-schema" : [ "Desk.basic.UPDATE" ]
964
- } ],
965
- "x-audience" : [ "company-internal" ],
966
- "x-custom-url-attribute" : {
967
- "security" : {
968
- "throttle" : {
969
- "inline" : [ {
970
- "scope" : "APPSERVER",
971
- "rules" : [ {
972
- "duration" : 60000,
973
- "lock-period" : 60000,
974
- "threshold" : 30,
975
- "hip" : false
976
- } ],
977
- "window" : "ROLLING",
978
- "key" : "url.path+user.zuid"
979
- } ]
980
- },
981
- "extraparams" : {
982
- "disable" : true,
983
- "ignore" : false
984
- },
985
- "authentication" : { }
986
- },
987
- "clan-group" : "microservices",
988
- "module-group" : "im",
989
- "apimethod" : "com.zoho.support.restapi.im.IMChannelService.saveChannelMeta"
990
- }
991
- }
992
- },
993
- "/api/v1/im/channels/{id}/configParams/{configParamName}/computeOptions" : {
994
- "post" : {
995
- "tags" : [ "IM_Channel" ],
996
- "operationId" : "getConfigParamsComputedOptions",
997
- "parameters" : [ {
998
- "$ref" : "#/components/parameters/id"
999
- }, {
1000
- "name" : "configParamName",
1001
- "in" : "path",
1002
- "required" : true,
1003
- "style" : "simple",
1004
- "explode" : false,
1005
- "schema" : {
1006
- "type" : [ "string", "null" ],
1007
- "enum" : [ "SID", "AUTH_TOKEN", "WHATSAPP_NUMBER", "REMOVE_FROM_EXTSERVER", "CREDIT_REMAINING" ],
1008
- "maxLength" : 100,
1009
- "minLength" : 0,
1010
- "pattern" : "([a-zA-Z0-9_]+)"
1011
- }
1012
- }, {
1013
- "$ref" : "../common/Common.json#/components/parameters/orgId"
1014
- } ],
1015
- "requestBody" : {
1016
- "$ref" : "#/components/requestBodies/getConfigParamsComputedOptions_input"
1017
- },
1018
- "responses" : {
1019
- "404" : {
1020
- "$ref" : "../common/Common.json#/components/responses/urlNotFoundErrorResponse"
1021
- },
1022
- "200" : {
1023
- "$ref" : "#/components/responses/getConfigParamsComputedOptions"
1024
- },
1025
- "422" : {
1026
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
1027
- },
1028
- "400" : {
1029
- "$ref" : "../common/Common.json#/components/responses/badRequestErrorResponse"
1030
- },
1031
- "204" : {
1032
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
1033
- },
1034
- "403" : {
1035
- "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
1036
- }
1037
- },
1038
- "security" : [ {
1039
- "org-oauth" : [ "Desk.accessAll.ALL" ]
1040
- }, {
1041
- "iam-oauth2-schema" : [ "Desk.basic.CREATE" ]
1042
- } ],
1043
- "x-audience" : [ "company-internal" ],
1044
- "x-custom-url-attribute" : {
1045
- "security" : {
1046
- "throttle" : {
1047
- "inline" : [ {
1048
- "scope" : "APPSERVER",
1049
- "rules" : [ {
1050
- "duration" : 3600000,
1051
- "lock-period" : 600000,
1052
- "threshold" : 180,
1053
- "hip" : false
1054
- } ],
1055
- "window" : "ROLLING",
1056
- "key" : "url.path+user.zuid"
1057
- } ]
1058
- },
1059
- "extraparams" : {
1060
- "disable" : true,
1061
- "ignore" : false
1062
- },
1063
- "authentication" : { }
1064
- },
1065
- "clan-group" : "microservices",
1066
- "module-group" : "im",
1067
- "apimethod" : "com.zoho.support.restapi.im.IMChannelService.getComputedConfigParamOptionsExistingChannel"
1068
- }
1069
- }
1070
- },
1071
- "/api/v1/im/channels" : {
1072
- "get" : {
1073
- "tags" : [ "IM_Channel" ],
1074
- "summary" : "List Channels",
1075
- "description" : "This API lists all channels",
1076
- "operationId" : "getIMChannelsList",
1077
- "parameters" : [ {
1078
- "name" : "include",
1079
- "in" : "query",
1080
- "description" : "Additional information related to the channels.If passed in the param, then these values will be appended in the channel response. Allowed values are @preference@,@creator@,@meta@,@configParams@",
1081
- "required" : false,
1082
- "style" : "simple",
1083
- "explode" : true,
1084
- "schema" : {
1085
- "type" : [ "null", "array" ],
1086
- "description" : "Additional information related to the channels.If passed in the param, then these values will be appended in the channel response. Allowed values are @preference@,@creator@,@meta@,@configParams@",
1087
- "items" : {
1088
- "type" : [ "string", "null" ],
1089
- "enum" : [ "preference", "creator" ],
1090
- "maxLength" : 100,
1091
- "minLength" : 0,
1092
- "x-custom-parameters-attributes" : [ ]
1093
- },
1094
- "maxItems" : 2,
1095
- "uniqueItems" : true
1096
- }
1097
- }, {
1098
- "name" : "departmentId",
1099
- "in" : "query",
1100
- "description" : "Department Id for which channels to be fetched",
1101
- "required" : false,
1102
- "style" : "form",
1103
- "explode" : true,
1104
- "schema" : {
1105
- "type" : [ "string", "null", "integer" ],
1106
- "format" : "int64",
1107
- "description" : "Department Id for which channels to be fetched",
1108
- "pattern" : "([0-9]+)"
1109
- }
1110
- }, {
1111
- "$ref" : "#/components/parameters/integrationServiceId"
1112
- }, {
1113
- "$ref" : "../common/Common.json#/components/parameters/orgId"
1114
- } ],
1115
- "responses" : {
1116
- "204" : {
1117
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
1118
- },
1119
- "200" : {
1120
- "$ref" : "#/components/responses/getIMChannelsList"
1121
- }
1122
- },
1123
- "security" : [ {
1124
- "org-oauth" : [ "Desk.accessAll.ALL" ]
1125
- }, {
1126
- "iam-oauth2-schema" : [ "Desk.basic.READ", "Desk.InstantMessages.READ" ]
1127
- } ],
1128
- "x-audience" : [ "external-public" ],
1129
- "x-custom-url-attribute" : {
1130
- "security" : {
1131
- "throttle" : {
1132
- "inline" : [ {
1133
- "scope" : "APPSERVER",
1134
- "rules" : [ {
1135
- "duration" : 60000,
1136
- "lock-period" : 120000,
1137
- "threshold" : 30,
1138
- "hip" : false
1139
- } ],
1140
- "window" : "ROLLING",
1141
- "key" : "url.path+user.zuid"
1142
- } ]
1143
- },
1144
- "extraparams" : {
1145
- "disable" : true,
1146
- "ignore" : false
1147
- },
1148
- "authentication" : { }
1149
- },
1150
- "clan-group" : "microservices",
1151
- "apihash" : "e771aea41f12aef0be1a70145f8003ea",
1152
- "module-group" : "im",
1153
- "apimethod" : "com.zoho.support.restapi.im.IMChannelService.getIMChannelsList"
1154
- }
1155
- }
1156
- },
1157
- "/api/v1/im/channels/{id}/removeAgents" : {
1158
- "post" : {
1159
- "tags" : [ "IM_Channel" ],
1160
- "operationId" : "removeIMChannelHandlingAgents",
1161
- "parameters" : [ {
1162
- "$ref" : "#/components/parameters/id"
1163
- }, {
1164
- "$ref" : "../common/Common.json#/components/parameters/orgId"
1165
- } ],
1166
- "requestBody" : {
1167
- "$ref" : "#/components/requestBodies/removeIMChannelHandlingAgents_addIMChannelHandlingAgents"
1168
- },
1169
- "responses" : {
1170
- "404" : {
1171
- "$ref" : "../common/Common.json#/components/responses/urlNotFoundErrorResponse"
1172
- },
1173
- "200" : {
1174
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
1175
- },
1176
- "422" : {
1177
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
1178
- },
1179
- "400" : {
1180
- "$ref" : "../common/Common.json#/components/responses/badRequestErrorResponse"
1181
- },
1182
- "403" : {
1183
- "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
1184
- }
1185
- },
1186
- "security" : [ {
1187
- "org-oauth" : [ "Desk.accessAll.ALL" ]
1188
- }, {
1189
- "iam-oauth2-schema" : [ "Desk.basic.CREATE" ]
1190
- } ],
1191
- "x-audience" : [ "company-internal" ],
1192
- "x-custom-url-attribute" : {
1193
- "security" : {
1194
- "throttle" : {
1195
- "inline" : [ {
1196
- "scope" : "APPSERVER",
1197
- "rules" : [ {
1198
- "duration" : 60000,
1199
- "lock-period" : 300000,
1200
- "threshold" : 30,
1201
- "hip" : false
1202
- } ],
1203
- "window" : "ROLLING",
1204
- "key" : "url.path+user.zuid"
1205
- } ]
1206
- },
1207
- "extraparams" : {
1208
- "disable" : true,
1209
- "ignore" : false
1210
- },
1211
- "authentication" : { }
1212
- },
1213
- "clan-group" : "microservices",
1214
- "module-group" : "im",
1215
- "apimethod" : "com.zoho.support.restapi.im.IMChannelService.removeIMChannelHandlingAgents"
1216
- }
1217
- }
1218
- }
1219
- },
1220
- "components" : {
1221
- "schemas" : {
1222
- "updater" : {
1223
- "type" : [ "null", "object" ],
1224
- "additionalProperties" : false,
1225
- "properties" : {
1226
- "lastName" : {
1227
- "type" : [ "string", "null" ],
1228
- "maxLength" : 50,
1229
- "minLength" : 0
1230
- },
1231
- "agent" : {
1232
- "type" : [ "boolean", "null" ]
1233
- },
1234
- "displayName" : {
1235
- "type" : [ "string", "null" ],
1236
- "maxLength" : 200,
1237
- "minLength" : 0,
1238
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1239
- },
1240
- "externalId" : {
1241
- "type" : [ "string", "null" ],
1242
- "maxLength" : 100,
1243
- "minLength" : 0
1244
- },
1245
- "emailId" : {
1246
- "type" : [ "string", "null" ],
1247
- "maxLength" : 100,
1248
- "minLength" : 0,
1249
- "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$"
1250
- },
1251
- "type" : {
1252
- "type" : [ "string", "null" ],
1253
- "enum" : [ "END_USER", "AGENT", "TEAM", "TICKET", "ACTIVITY" ],
1254
- "maxLength" : 100,
1255
- "minLength" : 0
1256
- },
1257
- "zuid" : {
1258
- "type" : [ "string", "null", "integer" ],
1259
- "format" : "int32",
1260
- "pattern" : "([0-9]+)"
1261
- },
1262
- "photoURL" : {
1263
- "type" : [ "string", "null" ],
1264
- "maxLength" : 200,
1265
- "minLength" : 0,
1266
- "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
1267
- },
1268
- "firstName" : {
1269
- "type" : [ "string", "null" ],
1270
- "maxLength" : 50,
1271
- "minLength" : 0
1272
- },
1273
- "name" : {
1274
- "type" : [ "string", "null" ],
1275
- "maxLength" : 100,
1276
- "minLength" : 0
1277
- },
1278
- "roleName" : {
1279
- "type" : [ "string", "null" ],
1280
- "maxLength" : 100,
1281
- "minLength" : 0
1282
- },
1283
- "id" : {
1284
- "type" : [ "string", "null", "integer" ],
1285
- "format" : "int64",
1286
- "pattern" : "([0-9]+)"
1287
- },
1288
- "email" : {
1289
- "type" : [ "string", "null" ],
1290
- "maxLength" : 100,
1291
- "minLength" : 0,
1292
- "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$"
1293
- }
1294
- },
1295
- "required" : [ "agent", "displayName", "email", "emailId", "externalId", "firstName", "id", "lastName", "name", "photoURL", "roleName", "type", "zuid" ]
1296
- },
1297
- "listOfAgentIds" : {
1298
- "type" : [ "null", "array" ],
1299
- "items" : {
1300
- "type" : [ "string", "null", "integer" ],
1301
- "format" : "int64",
1302
- "pattern" : "([0-9]+)"
1303
- }
1304
- },
1305
- "listOfIMChannelIds" : {
1306
- "type" : [ "null", "array" ],
1307
- "items" : {
1308
- "type" : [ "null", "array" ],
1309
- "items" : {
1310
- "type" : [ "string", "null", "integer" ],
1311
- "format" : "int64",
1312
- "pattern" : "([0-9]+)",
1313
- "x-custom-parameters-attributes" : [ { } ]
1314
- },
1315
- "uniqueItems" : false
1316
- }
1317
- },
1318
- "getComputedOption" : {
1319
- "type" : [ "null", "object" ],
1320
- "additionalProperties" : false,
1321
- "properties" : {
1322
- "label" : {
1323
- "type" : [ "string", "null" ],
1324
- "maxLength" : 500,
1325
- "minLength" : 0,
1326
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1327
- },
1328
- "value" : {
1329
- "type" : [ "string", "null" ],
1330
- "maxLength" : 100,
1331
- "minLength" : 0
1332
- }
1333
- },
1334
- "required" : [ "label", "value" ]
1335
- },
1336
- "listOfConfigParamsComputedOptions" : {
1337
- "type" : [ "null", "array" ],
1338
- "items" : {
1339
- "$ref" : "./IM_Channel.json#/components/schemas/getComputedOption"
1340
- }
1341
- },
1342
- "getConfigParam" : {
1343
- "type" : [ "null", "object" ],
1344
- "additionalProperties" : false,
1345
- "properties" : {
1346
- "isRequired" : {
1347
- "type" : [ "boolean", "null" ]
1348
- },
1349
- "modifiedTime" : {
1350
- "type" : [ "string", "null" ],
1351
- "maxLength" : 100,
1352
- "minLength" : 0,
1353
- "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))"
1354
- },
1355
- "isDeprecated" : {
1356
- "type" : [ "boolean", "null" ]
1357
- },
1358
- "isSecured" : {
1359
- "type" : [ "boolean", "null" ]
1360
- },
1361
- "defaultValue" : {
1362
- "type" : [ "string", "null" ],
1363
- "maxLength" : 500,
1364
- "minLength" : 0,
1365
- "pattern" : "(null|^$|NULL|[0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+)"
1366
- },
1367
- "parentParams" : {
1368
- "type" : [ "null", "array" ],
1369
- "items" : {
1370
- "type" : [ "string", "null" ],
1371
- "maxLength" : 100,
1372
- "minLength" : 0
1373
- },
1374
- "minItems" : 0,
1375
- "uniqueItems" : false
1376
- },
1377
- "label" : {
1378
- "type" : [ "string", "null" ],
1379
- "maxLength" : 500,
1380
- "minLength" : 0,
1381
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1382
- },
1383
- "type" : {
1384
- "type" : [ "string", "null" ],
1385
- "enum" : [ "STRING", "NUMBER", "URL", "EMAIL", "PHONE", "OPTIONS", "PASSWORD", "DATE", "TIME", "DATETIME", "SYSTEM_DEFINED", "OPTIONS_COMPUTED", "BOOLEAN" ],
1386
- "maxLength" : 100,
1387
- "minLength" : 0
1388
- },
1389
- "uuid" : {
1390
- "type" : [ "string", "null" ],
1391
- "maxLength" : 100,
1392
- "minLength" : 0
1393
- },
1394
- "isInternal" : {
1395
- "type" : [ "boolean", "null" ]
1396
- },
1397
- "name" : {
1398
- "type" : [ "string", "null" ],
1399
- "maxLength" : 500,
1400
- "minLength" : 0,
1401
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1402
- },
1403
- "options" : {
1404
- "$ref" : "./IM_Channel.json#/components/schemas/listOfConfigParamsComputedOptions"
1405
- },
1406
- "id" : {
1407
- "type" : [ "string", "null", "integer" ],
1408
- "format" : "int64",
1409
- "pattern" : "([0-9]+)"
1410
- },
1411
- "value" : {
1412
- "type" : [ "string", "null" ],
1413
- "maxLength" : 100,
1414
- "minLength" : 0
1415
- },
1416
- "maxLen" : {
1417
- "type" : [ "string", "null" ],
1418
- "maxLength" : 100,
1419
- "minLength" : 0,
1420
- "pattern" : "[0-9]+"
1421
- }
1422
- },
1423
- "required" : [ "defaultValue", "id", "isDeprecated", "isInternal", "isRequired", "isSecured", "label", "maxLen", "modifiedTime", "name", "options", "parentParams", "type", "uuid", "value" ]
1424
- },
1425
- "listOfConfigParams" : {
1426
- "type" : [ "null", "array" ],
1427
- "items" : {
1428
- "$ref" : "./IM_Channel.json#/components/schemas/getConfigParam"
1429
- }
1430
- },
1431
- "configParam_input_update" : {
1432
- "type" : [ "null", "object" ],
1433
- "additionalProperties" : false,
1434
- "properties" : {
1435
- "id" : {
1436
- "type" : [ "string", "null", "integer" ],
1437
- "format" : "int64",
1438
- "pattern" : "([0-9]+)"
1439
- },
1440
- "value" : {
1441
- "type" : [ "string", "null" ],
1442
- "maxLength" : 100,
1443
- "minLength" : 0
1444
- }
1445
- },
1446
- "required" : [ "id", "value" ]
1447
- },
1448
- "listofConfigParams_input_update" : {
1449
- "type" : [ "null", "array" ],
1450
- "items" : {
1451
- "$ref" : "./IM_Channel.json#/components/schemas/configParam_input_update"
1452
- }
1453
- },
1454
- "agent" : {
1455
- "type" : [ "null", "object" ],
1456
- "additionalProperties" : false,
1457
- "properties" : {
1458
- "photoURL" : {
1459
- "type" : [ "string", "null" ],
1460
- "maxLength" : 100,
1461
- "minLength" : 0,
1462
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1463
- },
1464
- "name" : {
1465
- "type" : [ "string", "null" ],
1466
- "maxLength" : 100,
1467
- "minLength" : 0
1468
- },
1469
- "id" : {
1470
- "type" : [ "string", "null", "integer" ],
1471
- "format" : "int64",
1472
- "pattern" : "([0-9]+)"
1473
- },
1474
- "type" : {
1475
- "type" : [ "string", "null" ],
1476
- "enum" : [ "END_USER", "AGENT", "BOT" ],
1477
- "maxLength" : 100,
1478
- "minLength" : 0
1479
- },
1480
- "email" : {
1481
- "type" : [ "string", "null" ],
1482
- "maxLength" : 100,
1483
- "minLength" : 0,
1484
- "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$"
1485
- },
1486
- "zuid" : {
1487
- "type" : [ "string", "null", "integer" ],
1488
- "format" : "int32",
1489
- "pattern" : "([0-9]+)"
1490
- }
1491
- },
1492
- "required" : [ "email", "id", "name", "photoURL", "type", "zuid" ]
1493
- },
1494
- "listOfAgents" : {
1495
- "type" : [ "null", "array" ],
1496
- "items" : {
1497
- "$ref" : "./IM_Channel.json#/components/schemas/agent"
1498
- }
1499
- },
1500
- "IMChannelMeta" : {
1501
- "type" : [ "null", "object" ],
1502
- "additionalProperties" : false,
1503
- "properties" : {
1504
- "name" : {
1505
- "type" : [ "string", "null" ],
1506
- "maxLength" : 100,
1507
- "minLength" : 0,
1508
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1509
- },
1510
- "value" : {
1511
- "type" : [ "string", "null" ],
1512
- "maxLength" : 100,
1513
- "minLength" : 0
1514
- }
1515
- },
1516
- "required" : [ "name", "value" ]
1517
- },
1518
- "listOfChannelMeta" : {
1519
- "type" : [ "null", "array" ],
1520
- "items" : {
1521
- "$ref" : "./IM_Channel.json#/components/schemas/IMChannelMeta"
1522
- }
1523
- },
1524
- "metaVariableJSON" : {
1525
- "type" : [ "null", "object" ],
1526
- "additionalProperties" : false,
1527
- "properties" : {
1528
- "name" : {
1529
- "type" : [ "string", "null" ],
1530
- "maxLength" : 100,
1531
- "minLength" : 0,
1532
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1533
- },
1534
- "id" : {
1535
- "type" : [ "string", "null", "integer" ],
1536
- "format" : "int64",
1537
- "pattern" : "([0-9]+)"
1538
- },
1539
- "value" : {
1540
- "type" : [ "string", "null" ],
1541
- "maxLength" : 100,
1542
- "minLength" : 0
1543
- }
1544
- },
1545
- "required" : [ "id", "name", "value" ]
1546
- },
1547
- "listOfIMChanneMeta" : {
1548
- "type" : [ "null", "array" ],
1549
- "items" : {
1550
- "$ref" : "./IM_Channel.json#/components/schemas/metaVariableJSON"
1551
- }
1552
- },
1553
- "configParam_input_add" : {
1554
- "type" : [ "null", "object" ],
1555
- "additionalProperties" : false,
1556
- "description" : "",
1557
- "properties" : {
1558
- "name" : {
1559
- "type" : [ "string", "null" ],
1560
- "description" : "",
1561
- "enum" : [ "SID", "AUTH_TOKEN", "WHATSAPP_NUMBER", "REMOVE_FROM_EXTSERVER", "CREDIT_REMAINING" ],
1562
- "maxLength" : 100,
1563
- "minLength" : 0,
1564
- "pattern" : "([a-zA-Z0-9_]+)"
1565
- },
1566
- "value" : {
1567
- "type" : [ "string", "null" ],
1568
- "description" : "",
1569
- "maxLength" : 100,
1570
- "minLength" : 0
1571
- }
1572
- },
1573
- "required" : [ "name", "value" ]
1574
- },
1575
- "getConfigParamsComputedOptions_input_list" : {
1576
- "type" : [ "null", "array" ],
1577
- "description" : "",
1578
- "items" : {
1579
- "$ref" : "./IM_Channel.json#/components/schemas/configParam_input_add"
1580
- }
1581
- },
1582
- "listofConfigParams_input_add" : {
1583
- "type" : [ "null", "array" ],
1584
- "items" : {
1585
- "$ref" : "./IM_Channel.json#/components/schemas/configParam_input_add"
1586
- }
1587
- },
1588
- "getIMChannel_list" : {
1589
- "type" : [ "null", "object" ],
1590
- "additionalProperties" : false,
1591
- "properties" : {
1592
- "defaultBotId" : {
1593
- "type" : [ "string", "null", "integer" ],
1594
- "format" : "int64",
1595
- "pattern" : "([0-9]+)"
1596
- },
1597
- "code" : {
1598
- "type" : [ "string", "null" ],
1599
- "maxLength" : 100,
1600
- "minLength" : 0
1601
- },
1602
- "accountName" : {
1603
- "type" : [ "string", "null" ],
1604
- "maxLength" : 500,
1605
- "minLength" : 0,
1606
- "pattern" : "[0-9a-zA-Z_\\-\\&\\.\\$\\@\\^\\(\\)\\{\\}\\~\\=\\-\\|\\*\\+\\?\\[\\]\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+"
1607
- },
1608
- "integrationServiceType" : {
1609
- "type" : [ "string", "null" ],
1610
- "enum" : [ "TELEGRAM", "TWILIO", "IM_TALK", "LINE", "WECHAT", "WHATSAPP", "FACEBOOKMESSENGER" ],
1611
- "maxLength" : 100,
1612
- "minLength" : 0
1613
- },
1614
- "appName" : {
1615
- "type" : [ "string", "null" ],
1616
- "maxLength" : 100,
1617
- "minLength" : 0
1618
- },
1619
- "departmentId" : {
1620
- "type" : [ "string", "null", "integer" ],
1621
- "format" : "int64",
1622
- "pattern" : "([0-9]+)",
1623
- "x-custom-parameters-attributes" : {
1624
- "removeExif" : false,
1625
- "filterMatchedContent" : false,
1626
- "antivirus" : false,
1627
- "replacementString" : "",
1628
- "allowInvalid" : false,
1629
- "descrption" : "Department Id for which channels to be fetched",
1630
- "secret" : false,
1631
- "preserveCharsLimit" : 10,
1632
- "trim" : false,
1633
- "internalParam" : false,
1634
- "preserveChars" : "0,5",
1635
- "importUrl" : false,
1636
- "decrypt" : false
1637
- }
1638
- },
1639
- "universalLink" : {
1640
- "type" : [ "string", "null" ],
1641
- "maxLength" : 65535,
1642
- "minLength" : 0,
1643
- "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
1644
- },
1645
- "isActive" : {
1646
- "type" : [ "boolean", "null" ],
1647
- "x-custom-parameters-attributes" : {
1648
- "removeExif" : false,
1649
- "filterMatchedContent" : false,
1650
- "antivirus" : false,
1651
- "replacementString" : "",
1652
- "allowInvalid" : false,
1653
- "descrption" : "Set this to fetch only the active channels",
1654
- "secret" : false,
1655
- "preserveCharsLimit" : 10,
1656
- "trim" : false,
1657
- "internalParam" : false,
1658
- "preserveChars" : "0,5",
1659
- "importUrl" : false,
1660
- "decrypt" : false
1661
- }
1662
- },
1663
- "isAuthorizationPending" : {
1664
- "type" : [ "boolean", "null" ]
1665
- },
1666
- "photoURL" : {
1667
- "type" : [ "string", "null" ],
1668
- "maxLength" : 65535,
1669
- "minLength" : 0,
1670
- "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
1671
- },
1672
- "isSubscribed" : {
1673
- "type" : [ "boolean", "null" ]
1674
- },
1675
- "isDeleted" : {
1676
- "type" : [ "boolean", "null" ]
1677
- },
1678
- "createdBy" : {
1679
- "type" : [ "string", "null" ],
1680
- "maxLength" : 100,
1681
- "minLength" : 0,
1682
- "pattern" : "[0-9]+"
1683
- },
1684
- "isOwner" : {
1685
- "type" : [ "boolean", "null" ]
1686
- },
1687
- "isStorageEnabled" : {
1688
- "type" : [ "boolean", "null" ]
1689
- },
1690
- "name" : {
1691
- "type" : [ "string", "null" ],
1692
- "maxLength" : 100,
1693
- "minLength" : 0,
1694
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1695
- },
1696
- "createdTime" : {
1697
- "type" : [ "string", "null" ],
1698
- "maxLength" : 100,
1699
- "minLength" : 0,
1700
- "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))"
1701
- },
1702
- "authenticationURL" : {
1703
- "type" : [ "string", "null" ],
1704
- "maxLength" : 100,
1705
- "minLength" : 0,
1706
- "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
1707
- },
1708
- "id" : {
1709
- "type" : [ "string", "null", "integer" ],
1710
- "format" : "int64",
1711
- "pattern" : "([0-9]+)"
1712
- },
1713
- "isSandBox" : {
1714
- "type" : [ "boolean", "null" ],
1715
- "x-custom-parameters-attributes" : {
1716
- "removeExif" : false,
1717
- "filterMatchedContent" : false,
1718
- "antivirus" : false,
1719
- "replacementString" : "",
1720
- "allowInvalid" : false,
1721
- "descrption" : "Set this to fetch sandbox channels only.",
1722
- "secret" : false,
1723
- "preserveCharsLimit" : 10,
1724
- "trim" : false,
1725
- "internalParam" : false,
1726
- "preserveChars" : "0,5",
1727
- "importUrl" : false,
1728
- "decrypt" : false
1729
- }
1730
- }
1731
- },
1732
- "required" : [ "accountName", "appName", "authenticationURL", "code", "createdBy", "createdTime", "defaultBotId", "departmentId", "id", "integrationServiceType", "isActive", "isAuthorizationPending", "isDeleted", "isOwner", "isSandBox", "isStorageEnabled", "isSubscribed", "name", "photoURL", "universalLink" ]
1733
- },
1734
- "listOfIMChannels" : {
1735
- "type" : [ "null", "array" ],
1736
- "items" : {
1737
- "$ref" : "./IM_Channel.json#/components/schemas/getIMChannel_list"
1738
- }
1739
- }
1740
- },
1741
- "responses" : {
1742
- "getIMChannelPreference" : {
1743
- "description" : "getIMChannelPreference template definitions",
1744
- "content" : {
1745
- "application/json" : {
1746
- "schema" : {
1747
- "type" : [ "null", "object" ],
1748
- "additionalProperties" : false,
1749
- "properties" : {
1750
- "updatedBy" : {
1751
- "type" : [ "string", "null", "integer" ],
1752
- "format" : "int64",
1753
- "pattern" : "([0-9]+)"
1754
- },
1755
- "businessHourEnabled" : {
1756
- "type" : [ "boolean", "null" ],
1757
- "x-custom-parameters-attributes" : {
1758
- "removeExif" : false,
1759
- "filterMatchedContent" : false,
1760
- "antivirus" : false,
1761
- "replacementString" : "",
1762
- "allowInvalid" : false,
1763
- "descrption" : "Enable and disable Business Hour.",
1764
- "secret" : false,
1765
- "preserveCharsLimit" : 10,
1766
- "trim" : false,
1767
- "internalParam" : false,
1768
- "preserveChars" : "0,5",
1769
- "importUrl" : false,
1770
- "decrypt" : false
1771
- }
1772
- },
1773
- "businessHourId" : {
1774
- "type" : [ "string", "null", "integer" ],
1775
- "format" : "int64",
1776
- "pattern" : "([0-9]+)",
1777
- "x-custom-parameters-attributes" : {
1778
- "removeExif" : false,
1779
- "filterMatchedContent" : false,
1780
- "antivirus" : false,
1781
- "replacementString" : "",
1782
- "allowInvalid" : false,
1783
- "descrption" : "Business Hour Id to be Configured.",
1784
- "secret" : false,
1785
- "preserveCharsLimit" : 10,
1786
- "trim" : false,
1787
- "internalParam" : false,
1788
- "preserveChars" : "0,5",
1789
- "importUrl" : false,
1790
- "decrypt" : false
1791
- }
1792
- },
1793
- "allHandlingAgents" : {
1794
- "type" : [ "null", "array" ],
1795
- "items" : {
1796
- "type" : [ "string", "null", "integer" ],
1797
- "format" : "int64",
1798
- "pattern" : "([0-9]+)"
1799
- },
1800
- "uniqueItems" : false
1801
- },
1802
- "autoTicketConvertInterval" : {
1803
- "type" : [ "string", "null" ],
1804
- "maxLength" : 100,
1805
- "minLength" : 0,
1806
- "pattern" : "[0-9]+",
1807
- "x-custom-parameters-attributes" : {
1808
- "removeExif" : false,
1809
- "filterMatchedContent" : false,
1810
- "antivirus" : false,
1811
- "replacementString" : "",
1812
- "allowInvalid" : false,
1813
- "descrption" : "Time in seconds for idle time of the session",
1814
- "secret" : false,
1815
- "preserveCharsLimit" : 10,
1816
- "trim" : false,
1817
- "internalParam" : false,
1818
- "preserveChars" : "0,5",
1819
- "importUrl" : false,
1820
- "decrypt" : false
1821
- }
1822
- },
1823
- "autoTicketConvert" : {
1824
- "type" : [ "boolean", "null" ],
1825
- "x-custom-parameters-attributes" : {
1826
- "removeExif" : false,
1827
- "filterMatchedContent" : false,
1828
- "antivirus" : false,
1829
- "replacementString" : "",
1830
- "allowInvalid" : false,
1831
- "descrption" : "Specify whether ticket has to be converted automatically after idle time",
1832
- "secret" : false,
1833
- "preserveCharsLimit" : 10,
1834
- "trim" : false,
1835
- "internalParam" : false,
1836
- "preserveChars" : "0,5",
1837
- "importUrl" : false,
1838
- "decrypt" : false
1839
- }
1840
- },
1841
- "assignmentRuleEnabled" : {
1842
- "type" : [ "boolean", "null" ],
1843
- "x-custom-parameters-attributes" : {
1844
- "removeExif" : false,
1845
- "filterMatchedContent" : false,
1846
- "antivirus" : false,
1847
- "replacementString" : "",
1848
- "allowInvalid" : false,
1849
- "descrption" : "Enable and disable Assignment Rule.",
1850
- "secret" : false,
1851
- "preserveCharsLimit" : 10,
1852
- "trim" : false,
1853
- "internalParam" : false,
1854
- "preserveChars" : "0,5",
1855
- "importUrl" : false,
1856
- "decrypt" : false
1857
- }
1858
- },
1859
- "updater" : {
1860
- "$ref" : "./IM_Channel.json#/components/schemas/updater"
1861
- }
1862
- },
1863
- "required" : [ "allHandlingAgents", "assignmentRuleEnabled", "autoTicketConvert", "autoTicketConvertInterval", "businessHourEnabled", "businessHourId", "updatedBy", "updater" ]
1864
- },
1865
- "examples" : {
1866
- "Valid responses Definitions" : {
1867
- "value" : null
1868
- }
1869
- }
1870
- }
1871
- },
1872
- "x-custom-response-attributes" : {
1873
- "disable-safe-headers" : "[]"
1874
- }
1875
- },
1876
- "getConfigParams" : {
1877
- "description" : "getConfigParams template definitions",
1878
- "content" : {
1879
- "application/json" : {
1880
- "schema" : {
1881
- "type" : [ "null", "object" ],
1882
- "additionalProperties" : false,
1883
- "properties" : {
1884
- "data" : {
1885
- "$ref" : "./IM_Channel.json#/components/schemas/listOfConfigParams"
1886
- },
1887
- "kind" : {
1888
- "type" : [ "string", "null" ],
1889
- "enum" : [ "single.channel.configParam", "list.channel.configParam" ],
1890
- "maxLength" : 100,
1891
- "minLength" : 0
1892
- },
1893
- "hasMore" : {
1894
- "type" : [ "boolean", "null" ]
1895
- }
1896
- },
1897
- "required" : [ "data", "hasMore", "kind" ]
1898
- },
1899
- "examples" : {
1900
- "Valid responses Definitions" : {
1901
- "value" : null
1902
- }
1903
- }
1904
- }
1905
- },
1906
- "x-custom-response-attributes" : {
1907
- "disable-safe-headers" : "[]"
1908
- }
1909
- },
1910
- "getIMChannelHandlingAgents" : {
1911
- "description" : "getIMChannelHandlingAgents template definitions",
1912
- "content" : {
1913
- "application/json" : {
1914
- "schema" : {
1915
- "type" : [ "null", "object" ],
1916
- "additionalProperties" : false,
1917
- "properties" : {
1918
- "data" : {
1919
- "$ref" : "./IM_Channel.json#/components/schemas/listOfAgents"
1920
- }
1921
- },
1922
- "required" : [ "data" ]
1923
- },
1924
- "examples" : {
1925
- "Valid responses Definitions" : {
1926
- "value" : null
1927
- }
1928
- }
1929
- }
1930
- },
1931
- "x-custom-response-attributes" : {
1932
- "disable-safe-headers" : "[]"
1933
- }
1934
- },
1935
- "getIMChannel" : {
1936
- "description" : "getIMChannel template definitions",
1937
- "content" : {
1938
- "application/json" : {
1939
- "schema" : {
1940
- "type" : [ "null", "object" ],
1941
- "additionalProperties" : false,
1942
- "properties" : {
1943
- "defaultBotId" : {
1944
- "type" : [ "string", "null", "integer" ],
1945
- "format" : "int64",
1946
- "pattern" : "([0-9]+)",
1947
- "x-custom-parameters-attributes" : {
1948
- "removeExif" : false,
1949
- "filterMatchedContent" : false,
1950
- "antivirus" : false,
1951
- "replacementString" : "",
1952
- "allowInvalid" : false,
1953
- "descrption" : "Default bot id of the channel",
1954
- "secret" : false,
1955
- "preserveCharsLimit" : 10,
1956
- "trim" : false,
1957
- "internalParam" : false,
1958
- "preserveChars" : "0,5",
1959
- "importUrl" : false,
1960
- "decrypt" : false
1961
- }
1962
- },
1963
- "code" : {
1964
- "type" : [ "string", "null" ],
1965
- "maxLength" : 100,
1966
- "minLength" : 0
1967
- },
1968
- "accountName" : {
1969
- "type" : [ "string", "null" ],
1970
- "maxLength" : 500,
1971
- "minLength" : 0,
1972
- "pattern" : "[0-9a-zA-Z_\\-\\&\\.\\$\\@\\^\\(\\)\\{\\}\\~\\=\\-\\|\\*\\+\\?\\[\\]\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+"
1973
- },
1974
- "integrationServiceType" : {
1975
- "type" : [ "string", "null" ],
1976
- "enum" : [ "TELEGRAM", "TWILIO", "IM_TALK", "LINE", "WECHAT", "WHATSAPP", "FACEBOOKMESSENGER" ],
1977
- "maxLength" : 100,
1978
- "minLength" : 0
1979
- },
1980
- "appName" : {
1981
- "type" : [ "string", "null" ],
1982
- "maxLength" : 100,
1983
- "minLength" : 0
1984
- },
1985
- "departmentId" : {
1986
- "type" : [ "string", "null", "integer" ],
1987
- "format" : "int64",
1988
- "pattern" : "([0-9]+)"
1989
- },
1990
- "universalLink" : {
1991
- "type" : [ "string", "null" ],
1992
- "maxLength" : 65535,
1993
- "minLength" : 0,
1994
- "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
1995
- },
1996
- "isActive" : {
1997
- "type" : [ "boolean", "null" ]
1998
- },
1999
- "isAuthorizationPending" : {
2000
- "type" : [ "boolean", "null" ]
2001
- },
2002
- "photoURL" : {
2003
- "type" : [ "string", "null" ],
2004
- "maxLength" : 65535,
2005
- "minLength" : 0,
2006
- "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
2007
- },
2008
- "isSubscribed" : {
2009
- "type" : [ "boolean", "null" ]
2010
- },
2011
- "configParams" : {
2012
- "$ref" : "./IM_Channel.json#/components/schemas/listOfConfigParams"
2013
- },
2014
- "isDeleted" : {
2015
- "type" : [ "boolean", "null" ]
2016
- },
2017
- "createdBy" : {
2018
- "type" : [ "string", "null" ],
2019
- "maxLength" : 100,
2020
- "minLength" : 0,
2021
- "pattern" : "[0-9]+"
2022
- },
2023
- "isOwner" : {
2024
- "type" : [ "boolean", "null" ]
2025
- },
2026
- "isStorageEnabled" : {
2027
- "type" : [ "boolean", "null" ]
2028
- },
2029
- "conversationCount" : {
2030
- "type" : [ "string", "null" ],
2031
- "maxLength" : 100,
2032
- "minLength" : 0,
2033
- "pattern" : "[0-9]+"
2034
- },
2035
- "meta" : {
2036
- "$ref" : "./IM_Channel.json#/components/schemas/listOfChannelMeta"
2037
- },
2038
- "name" : {
2039
- "type" : [ "string", "null" ],
2040
- "maxLength" : 100,
2041
- "minLength" : 0,
2042
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+",
2043
- "x-custom-parameters-attributes" : {
2044
- "removeExif" : false,
2045
- "filterMatchedContent" : false,
2046
- "antivirus" : false,
2047
- "replacementString" : "",
2048
- "allowInvalid" : false,
2049
- "descrption" : "channel name be updated",
2050
- "secret" : false,
2051
- "preserveCharsLimit" : 10,
2052
- "trim" : false,
2053
- "internalParam" : false,
2054
- "preserveChars" : "0,5",
2055
- "importUrl" : false,
2056
- "decrypt" : false
2057
- }
2058
- },
2059
- "createdTime" : {
2060
- "type" : [ "string", "null" ],
2061
- "maxLength" : 100,
2062
- "minLength" : 0,
2063
- "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))"
2064
- },
2065
- "authenticationURL" : {
2066
- "type" : [ "string", "null" ],
2067
- "maxLength" : 100,
2068
- "minLength" : 0,
2069
- "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
2070
- },
2071
- "id" : {
2072
- "type" : [ "string", "null", "integer" ],
2073
- "format" : "int64",
2074
- "pattern" : "([0-9]+)"
2075
- },
2076
- "isSandBox" : {
2077
- "type" : [ "boolean", "null" ]
2078
- }
2079
- },
2080
- "required" : [ "accountName", "appName", "authenticationURL", "code", "configParams", "conversationCount", "createdBy", "createdTime", "defaultBotId", "departmentId", "id", "integrationServiceType", "isActive", "isAuthorizationPending", "isDeleted", "isOwner", "isSandBox", "isStorageEnabled", "isSubscribed", "meta", "name", "photoURL", "universalLink" ]
2081
- },
2082
- "examples" : {
2083
- "Valid responses Definitions" : {
2084
- "value" : null
2085
- }
2086
- }
2087
- }
2088
- },
2089
- "x-custom-response-attributes" : {
2090
- "disable-safe-headers" : "[]"
2091
- }
2092
- },
2093
- "saveChannelMetaResponse" : {
2094
- "description" : "saveChannelMetaResponse template definitions",
2095
- "content" : {
2096
- "application/json" : {
2097
- "schema" : {
2098
- "type" : [ "null", "object" ],
2099
- "additionalProperties" : false,
2100
- "properties" : {
2101
- "data" : {
2102
- "$ref" : "./IM_Channel.json#/components/schemas/listOfChannelMeta"
2103
- },
2104
- "kind" : {
2105
- "type" : [ "string", "null" ],
2106
- "enum" : [ "single.channel", "list.channel", "single.json" ],
2107
- "maxLength" : 100,
2108
- "minLength" : 0
2109
- },
2110
- "hasMore" : {
2111
- "type" : [ "boolean", "null" ]
2112
- }
2113
- },
2114
- "required" : [ "data", "hasMore", "kind" ]
2115
- },
2116
- "examples" : {
2117
- "Valid responses Definitions" : {
2118
- "value" : null
2119
- }
2120
- }
2121
- }
2122
- },
2123
- "x-custom-response-attributes" : {
2124
- "disable-safe-headers" : "[]"
2125
- }
2126
- },
2127
- "getConfigParamsComputedOptions" : {
2128
- "description" : "getConfigParamsComputedOptions template definitions",
2129
- "content" : {
2130
- "application/json" : {
2131
- "schema" : {
2132
- "type" : [ "null", "object" ],
2133
- "additionalProperties" : false,
2134
- "properties" : {
2135
- "data" : {
2136
- "$ref" : "./IM_Channel.json#/components/schemas/listOfConfigParamsComputedOptions"
2137
- },
2138
- "kind" : {
2139
- "type" : [ "string", "null" ],
2140
- "description" : "",
2141
- "enum" : [ "single.license", "single.efc", "list.addOn", "single.addOn", "single.json" ],
2142
- "maxLength" : 100,
2143
- "minLength" : 0,
2144
- "x-custom-parameters-attributes" : { }
2145
- },
2146
- "hasMore" : {
2147
- "type" : [ "boolean", "null" ],
2148
- "description" : "",
2149
- "x-custom-parameters-attributes" : { }
2150
- }
2151
- },
2152
- "required" : [ "data", "hasMore", "kind" ]
2153
- },
2154
- "examples" : {
2155
- "Valid responses Definitions" : {
2156
- "value" : { }
2157
- }
2158
- }
2159
- }
2160
- },
2161
- "x-custom-response-attributes" : { }
2162
- },
2163
- "getIMChannelsList" : {
2164
- "description" : "getIMChannelsList template definitions",
2165
- "content" : {
2166
- "application/json" : {
2167
- "schema" : {
2168
- "allOf" : [ {
2169
- "type" : "object",
2170
- "properties" : {
2171
- "data" : {
2172
- "type" : "array",
2173
- "items" : {
2174
- "type" : "object",
2175
- "properties" : {
2176
- "creator" : {
2177
- "type" : [ "null", "object" ],
2178
- "additionalProperties" : false,
2179
- "maxProperties" : 13,
2180
- "minProperties" : 13,
2181
- "properties" : {
2182
- "lastName" : {
2183
- "type" : [ "string", "null" ],
2184
- "maxLength" : 50,
2185
- "minLength" : 0
2186
- },
2187
- "agent" : {
2188
- "type" : [ "boolean", "null" ]
2189
- },
2190
- "displayName" : {
2191
- "type" : [ "string", "null" ],
2192
- "maxLength" : 200,
2193
- "minLength" : 0,
2194
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
2195
- },
2196
- "externalId" : {
2197
- "type" : [ "string", "null" ],
2198
- "maxLength" : 100,
2199
- "minLength" : 0
2200
- },
2201
- "emailId" : {
2202
- "type" : [ "string", "null" ],
2203
- "maxLength" : 100,
2204
- "minLength" : 0,
2205
- "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$"
2206
- },
2207
- "type" : {
2208
- "type" : [ "string", "null" ],
2209
- "enum" : [ "END_USER", "AGENT", "TEAM", "TICKET", "ACTIVITY" ],
2210
- "maxLength" : 100,
2211
- "minLength" : 0
2212
- },
2213
- "zuid" : {
2214
- "type" : [ "string", "null", "integer" ],
2215
- "format" : "int32",
2216
- "pattern" : "([0-9]+)"
2217
- },
2218
- "photoURL" : {
2219
- "type" : [ "string", "null" ],
2220
- "maxLength" : 200,
2221
- "minLength" : 0,
2222
- "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
2223
- },
2224
- "firstName" : {
2225
- "type" : [ "string", "null" ],
2226
- "maxLength" : 50,
2227
- "minLength" : 0
2228
- },
2229
- "name" : {
2230
- "type" : [ "string", "null" ],
2231
- "maxLength" : 100,
2232
- "minLength" : 0
2233
- },
2234
- "roleName" : {
2235
- "type" : [ "string", "null" ],
2236
- "maxLength" : 100,
2237
- "minLength" : 0
2238
- },
2239
- "id" : {
2240
- "type" : [ "string", "null", "integer" ],
2241
- "format" : "int64",
2242
- "pattern" : "([0-9]+)"
2243
- },
2244
- "email" : {
2245
- "type" : [ "string", "null" ],
2246
- "maxLength" : 100,
2247
- "minLength" : 0,
2248
- "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$"
2249
- }
2250
- },
2251
- "required" : [ "agent", "displayName", "email", "emailId", "externalId", "firstName", "id", "lastName", "name", "photoURL", "roleName", "type", "zuid" ]
2252
- },
2253
- "preference" : {
2254
- "type" : [ "null", "object" ],
2255
- "additionalProperties" : false,
2256
- "maxProperties" : 8,
2257
- "minProperties" : 8,
2258
- "properties" : {
2259
- "updatedBy" : {
2260
- "type" : [ "string", "null", "integer" ],
2261
- "format" : "int64",
2262
- "pattern" : "([0-9]+)"
2263
- },
2264
- "businessHourEnabled" : {
2265
- "type" : [ "boolean", "null" ]
2266
- },
2267
- "businessHourId" : {
2268
- "type" : [ "string", "null", "integer" ],
2269
- "format" : "int64",
2270
- "pattern" : "([0-9]+)"
2271
- },
2272
- "allHandlingAgents" : {
2273
- "type" : [ "null", "array" ],
2274
- "items" : {
2275
- "type" : [ "string", "null", "integer" ],
2276
- "format" : "int64",
2277
- "pattern" : "([0-9]+)"
2278
- },
2279
- "uniqueItems" : false
2280
- },
2281
- "autoTicketConvertInterval" : {
2282
- "type" : [ "string", "null" ],
2283
- "maxLength" : 100,
2284
- "minLength" : 0,
2285
- "pattern" : "[0-9]+"
2286
- },
2287
- "autoTicketConvert" : {
2288
- "type" : [ "boolean", "null" ]
2289
- },
2290
- "assignmentRuleEnabled" : {
2291
- "type" : [ "boolean", "null" ]
2292
- },
2293
- "updater" : {
2294
- "type" : [ "null", "object" ],
2295
- "additionalProperties" : false,
2296
- "maxProperties" : 13,
2297
- "minProperties" : 13,
2298
- "properties" : {
2299
- "lastName" : {
2300
- "type" : [ "string", "null" ],
2301
- "maxLength" : 50,
2302
- "minLength" : 0
2303
- },
2304
- "agent" : {
2305
- "type" : [ "boolean", "null" ]
2306
- },
2307
- "displayName" : {
2308
- "type" : [ "string", "null" ],
2309
- "maxLength" : 200,
2310
- "minLength" : 0,
2311
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
2312
- },
2313
- "externalId" : {
2314
- "type" : [ "string", "null" ],
2315
- "maxLength" : 100,
2316
- "minLength" : 0
2317
- },
2318
- "emailId" : {
2319
- "type" : [ "string", "null" ],
2320
- "maxLength" : 100,
2321
- "minLength" : 0,
2322
- "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$"
2323
- },
2324
- "type" : {
2325
- "type" : [ "string", "null" ],
2326
- "enum" : [ "END_USER", "AGENT", "TEAM", "TICKET", "ACTIVITY" ],
2327
- "maxLength" : 100,
2328
- "minLength" : 0
2329
- },
2330
- "zuid" : {
2331
- "type" : [ "string", "null", "integer" ],
2332
- "format" : "int32",
2333
- "pattern" : "([0-9]+)"
2334
- },
2335
- "photoURL" : {
2336
- "type" : [ "string", "null" ],
2337
- "maxLength" : 200,
2338
- "minLength" : 0,
2339
- "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
2340
- },
2341
- "firstName" : {
2342
- "type" : [ "string", "null" ],
2343
- "maxLength" : 50,
2344
- "minLength" : 0
2345
- },
2346
- "name" : {
2347
- "type" : [ "string", "null" ],
2348
- "maxLength" : 100,
2349
- "minLength" : 0
2350
- },
2351
- "roleName" : {
2352
- "type" : [ "string", "null" ],
2353
- "maxLength" : 100,
2354
- "minLength" : 0
2355
- },
2356
- "id" : {
2357
- "type" : [ "string", "null", "integer" ],
2358
- "format" : "int64",
2359
- "pattern" : "([0-9]+)"
2360
- },
2361
- "email" : {
2362
- "type" : [ "string", "null" ],
2363
- "maxLength" : 100,
2364
- "minLength" : 0,
2365
- "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$"
2366
- }
2367
- },
2368
- "required" : [ "agent", "displayName", "email", "emailId", "externalId", "firstName", "id", "lastName", "name", "photoURL", "roleName", "type", "zuid" ]
2369
- }
2370
- },
2371
- "required" : [ "allHandlingAgents", "assignmentRuleEnabled", "autoTicketConvert", "autoTicketConvertInterval", "businessHourEnabled", "businessHourId", "updatedBy", "updater" ]
2372
- }
2373
- }
2374
- }
2375
- }
2376
- }
2377
- }, {
2378
- "type" : [ "null", "object" ],
2379
- "additionalProperties" : false,
2380
- "properties" : {
2381
- "data" : {
2382
- "$ref" : "./IM_Channel.json#/components/schemas/listOfIMChannels"
2383
- }
2384
- },
2385
- "required" : [ "data" ]
2386
- } ]
2387
- },
2388
- "examples" : {
2389
- "Valid responses Definitions" : {
2390
- "value" : {
2391
- "data" : [ {
2392
- "defaultBotId" : "-1",
2393
- "code" : "SANDBOX",
2394
- "accountName" : "+13312040199",
2395
- "integrationServiceType" : "WHATSAPP",
2396
- "appName" : "Sandbox",
2397
- "departmentId" : "186543000000006907",
2398
- "universalLink" : "https://wa.me/13312040199",
2399
- "isActive" : true,
2400
- "isAuthorizationPending" : false,
2401
- "photoURL" : "https://desk.zoho.com/api/v1/channels/sandbox/photo?orgId=78412359",
2402
- "isSubscribed" : true,
2403
- "isDeleted" : false,
2404
- "isStorageEnabled" : false,
2405
- "createdBy" : "78412824",
2406
- "isOwner" : true,
2407
- "name" : "Sandbox",
2408
- "createdTime" : 1693818836000,
2409
- "id" : "3942000000045001",
2410
- "authenticationURL" : null,
2411
- "isSandBox" : true
2412
- }, {
2413
- "defaultBotId" : "-1",
2414
- "code" : "TEST_SOFTWARE_4_3",
2415
- "accountName" : "Test Software 4",
2416
- "integrationServiceType" : "FACEBOOKMESSENGER",
2417
- "appName" : "Test Software 4",
2418
- "departmentId" : "186543000000393040",
2419
- "universalLink" : "https://m.me/168123406390163",
2420
- "isActive" : true,
2421
- "isAuthorizationPending" : false,
2422
- "photoURL" : "https://desk.zoho.com/api/v1/channels/test_software_4_3/photo?orgId=78412359",
2423
- "isSubscribed" : true,
2424
- "isDeleted" : false,
2425
- "isStorageEnabled" : false,
2426
- "createdBy" : "78412824",
2427
- "isOwner" : true,
2428
- "name" : "Test Software 4",
2429
- "createdTime" : 1707287312000,
2430
- "id" : "3942000000943035",
2431
- "authenticationURL" : null,
2432
- "isSandBox" : false
2433
- }, {
2434
- "defaultBotId" : "-1",
2435
- "code" : "TEST_DEP",
2436
- "accountName" : "ZImAbhiTestBot",
2437
- "integrationServiceType" : "TELEGRAM",
2438
- "appName" : "Test DEP",
2439
- "departmentId" : "186543000000393040",
2440
- "universalLink" : "https://t.me/ZImAbhiTestBot",
2441
- "isActive" : true,
2442
- "isAuthorizationPending" : false,
2443
- "photoURL" : "https://desk.zoho.com/api/v1/channels/test_dep/photo?orgId=78412359",
2444
- "isSubscribed" : true,
2445
- "isDeleted" : false,
2446
- "isStorageEnabled" : false,
2447
- "createdBy" : "76837521",
2448
- "isOwner" : true,
2449
- "name" : "Test DEP",
2450
- "createdTime" : 1705378636000,
2451
- "id" : "3942000000735961",
2452
- "authenticationURL" : null,
2453
- "isSandBox" : false
2454
- } ]
2455
- }
2456
- }
2457
- }
2458
- }
2459
- },
2460
- "x-custom-response-attributes" : {
2461
- "disable-safe-headers" : "[]"
2462
- }
2463
- }
2464
- },
2465
- "parameters" : {
2466
- "limit" : {
2467
- "name" : "limit",
2468
- "in" : "query",
2469
- "description" : "Number of conversations to fetch",
2470
- "required" : false,
2471
- "style" : "form",
2472
- "explode" : true,
2473
- "schema" : {
2474
- "type" : [ "string", "null", "integer" ],
2475
- "format" : "int32",
2476
- "description" : "Number of conversations to fetch",
2477
- "pattern" : "([0-9]+)"
2478
- }
2479
- },
2480
- "from" : {
2481
- "name" : "from",
2482
- "in" : "query",
2483
- "description" : "Index number, starting from which the conversations must be fetched",
2484
- "required" : false,
2485
- "style" : "form",
2486
- "explode" : true,
2487
- "schema" : {
2488
- "type" : [ "string", "null", "integer" ],
2489
- "format" : "int32",
2490
- "description" : "Index number, starting from which the conversations must be fetched",
2491
- "pattern" : "([0-9]+)"
2492
- }
2493
- },
2494
- "id" : {
2495
- "name" : "id",
2496
- "in" : "path",
2497
- "required" : true,
2498
- "style" : "simple",
2499
- "explode" : false,
2500
- "schema" : {
2501
- "type" : [ "string", "null", "integer" ],
2502
- "format" : "int64",
2503
- "pattern" : "([0-9]+)"
2504
- }
2505
- },
2506
- "integrationServiceId" : {
2507
- "name" : "integrationServiceId",
2508
- "in" : "query",
2509
- "description" : "Channel ID to filter",
2510
- "required" : true,
2511
- "style" : "form",
2512
- "explode" : true,
2513
- "schema" : {
2514
- "type" : [ "string", "null" ],
2515
- "description" : "Channel ID to filter",
2516
- "enum" : [ "TELEGRAM", "TWILIO", "IM_TALK", "LINE", "WECHAT", "WHATSAPP", "FACEBOOKMESSENGER" ],
2517
- "maxLength" : 100,
2518
- "minLength" : 0
2519
- }
2520
- }
2521
- },
2522
- "requestBodies" : {
2523
- "updateIMChannelHandlingAgents" : {
2524
- "content" : {
2525
- "application/json" : {
2526
- "schema" : {
2527
- "type" : [ "null", "object" ],
2528
- "additionalProperties" : false,
2529
- "properties" : {
2530
- "agentIds" : {
2531
- "$ref" : "./IM_Channel.json#/components/schemas/listOfAgentIds"
2532
- },
2533
- "channelIds" : {
2534
- "$ref" : "./IM_Channel.json#/components/schemas/listOfIMChannelIds"
2535
- }
2536
- },
2537
- "required" : [ "agentIds", "channelIds" ]
2538
- },
2539
- "examples" : {
2540
- "Valid requestBody Definitions" : {
2541
- "value" : null
2542
- }
2543
- }
2544
- }
2545
- },
2546
- "x-custom-request-body-attributes" : {
2547
- "non-empty" : false,
2548
- "allow-invalid" : false
2549
- }
2550
- },
2551
- "saveIMChannelPreference" : {
2552
- "content" : {
2553
- "application/json" : {
2554
- "schema" : {
2555
- "type" : [ "null", "object" ],
2556
- "additionalProperties" : false,
2557
- "properties" : {
2558
- "businessHourEnabled" : {
2559
- "type" : [ "boolean", "null" ],
2560
- "description" : "Enable and disable Business Hour."
2561
- },
2562
- "departmentId" : {
2563
- "type" : [ "string", "null", "integer" ],
2564
- "format" : "int64",
2565
- "description" : "Default department id for the channel tickets",
2566
- "pattern" : "([0-9]+)"
2567
- },
2568
- "businessHourId" : {
2569
- "type" : [ "string", "null", "integer" ],
2570
- "format" : "int64",
2571
- "description" : "Business Hour Id to be Configured.",
2572
- "pattern" : "([0-9]+)"
2573
- },
2574
- "autoTicketConvertInterval" : {
2575
- "type" : [ "string", "null" ],
2576
- "description" : "Time in seconds for idle time of the session",
2577
- "maxLength" : 100,
2578
- "minLength" : 0,
2579
- "pattern" : "[0-9]+"
2580
- },
2581
- "autoTicketConvert" : {
2582
- "type" : [ "boolean", "null" ],
2583
- "description" : "Specify whether ticket has to be converted automatically after idle time"
2584
- },
2585
- "assignmentRuleEnabled" : {
2586
- "type" : [ "boolean", "null" ],
2587
- "description" : "Enable and disable Assignment Rule."
2588
- }
2589
- }
2590
- },
2591
- "examples" : {
2592
- "Valid requestBody Definitions" : {
2593
- "value" : null
2594
- }
2595
- }
2596
- }
2597
- },
2598
- "x-custom-request-body-attributes" : {
2599
- "non-empty" : false,
2600
- "allow-invalid" : false
2601
- }
2602
- },
2603
- "updateConfigParams" : {
2604
- "content" : {
2605
- "application/json" : {
2606
- "schema" : {
2607
- "type" : [ "null", "object" ],
2608
- "additionalProperties" : false,
2609
- "properties" : {
2610
- "configParams" : {
2611
- "$ref" : "./IM_Channel.json#/components/schemas/listofConfigParams_input_update"
2612
- }
2613
- },
2614
- "required" : [ "configParams" ]
2615
- },
2616
- "examples" : {
2617
- "Valid requestBody Definitions" : {
2618
- "value" : null
2619
- }
2620
- }
2621
- }
2622
- },
2623
- "x-custom-request-body-attributes" : {
2624
- "non-empty" : false,
2625
- "allow-invalid" : false
2626
- }
2627
- },
2628
- "addIMChannelHandlingAgents" : {
2629
- "content" : {
2630
- "application/json" : {
2631
- "schema" : {
2632
- "type" : [ "null", "object" ],
2633
- "additionalProperties" : false,
2634
- "properties" : {
2635
- "agentIds" : {
2636
- "$ref" : "./IM_Channel.json#/components/schemas/listOfAgentIds"
2637
- }
2638
- },
2639
- "required" : [ "agentIds" ]
2640
- },
2641
- "examples" : {
2642
- "Valid requestBody Definitions" : {
2643
- "value" : null
2644
- }
2645
- }
2646
- }
2647
- },
2648
- "x-custom-request-body-attributes" : {
2649
- "non-empty" : false,
2650
- "allow-invalid" : false
2651
- }
2652
- },
2653
- "associateIMChannel" : {
2654
- "content" : {
2655
- "application/json" : {
2656
- "schema" : {
2657
- "type" : [ "null", "object" ],
2658
- "additionalProperties" : false,
2659
- "properties" : {
2660
- "departmentId" : {
2661
- "type" : [ "string", "null", "integer" ],
2662
- "format" : "int64",
2663
- "description" : "Department ID to which the channel is associated",
2664
- "pattern" : "([0-9]+)"
2665
- }
2666
- },
2667
- "required" : [ "departmentId" ]
2668
- },
2669
- "examples" : {
2670
- "Valid requestBody Definitions" : {
2671
- "value" : null
2672
- }
2673
- }
2674
- }
2675
- },
2676
- "x-custom-request-body-attributes" : {
2677
- "non-empty" : false,
2678
- "allow-invalid" : false
2679
- }
2680
- },
2681
- "addIMChannelsHandlingAgents_updateIMChannelHandlingAgents" : {
2682
- "content" : {
2683
- "application/json" : {
2684
- "schema" : {
2685
- "type" : [ "null", "object" ],
2686
- "additionalProperties" : false,
2687
- "properties" : {
2688
- "agentIds" : {
2689
- "$ref" : "./IM_Channel.json#/components/schemas/listOfAgentIds"
2690
- },
2691
- "channelIds" : {
2692
- "$ref" : "./IM_Channel.json#/components/schemas/listOfIMChannelIds"
2693
- }
2694
- },
2695
- "required" : [ "agentIds", "channelIds" ]
2696
- },
2697
- "examples" : {
2698
- "Valid requestBody Definitions" : {
2699
- "value" : null
2700
- }
2701
- }
2702
- }
2703
- },
2704
- "x-custom-request-body-attributes" : {
2705
- "non-empty" : false,
2706
- "allow-invalid" : false
2707
- }
2708
- },
2709
- "saveChannelMeta" : {
2710
- "content" : {
2711
- "application/json" : {
2712
- "schema" : {
2713
- "type" : [ "null", "object" ],
2714
- "additionalProperties" : false,
2715
- "properties" : {
2716
- "data" : {
2717
- "$ref" : "./IM_Channel.json#/components/schemas/listOfIMChanneMeta"
2718
- }
2719
- }
2720
- },
2721
- "examples" : {
2722
- "Valid requestBody Definitions" : {
2723
- "value" : null
2724
- }
2725
- }
2726
- }
2727
- },
2728
- "x-custom-request-body-attributes" : {
2729
- "non-empty" : false,
2730
- "allow-invalid" : false
2731
- }
2732
- },
2733
- "getConfigParamsComputedOptions_input" : {
2734
- "content" : {
2735
- "application/json" : {
2736
- "schema" : {
2737
- "type" : [ "null", "object" ],
2738
- "additionalProperties" : false,
2739
- "properties" : {
2740
- "configParams" : {
2741
- "$ref" : "./IM_Channel.json#/components/schemas/getConfigParamsComputedOptions_input_list"
2742
- }
2743
- }
2744
- },
2745
- "examples" : {
2746
- "Valid requestBody Definitions" : {
2747
- "value" : null
2748
- }
2749
- }
2750
- }
2751
- },
2752
- "x-custom-request-body-attributes" : {
2753
- "non-empty" : false,
2754
- "allow-invalid" : false
2755
- }
2756
- },
2757
- "updateIMChannel" : {
2758
- "content" : {
2759
- "application/json" : {
2760
- "schema" : {
2761
- "type" : [ "null", "object" ],
2762
- "additionalProperties" : false,
2763
- "properties" : {
2764
- "configParams" : {
2765
- "$ref" : "./IM_Channel.json#/components/schemas/listofConfigParams_input_add"
2766
- },
2767
- "name" : {
2768
- "type" : [ "string", "null" ],
2769
- "description" : "channel name be updated",
2770
- "maxLength" : 100,
2771
- "minLength" : 0,
2772
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
2773
- }
2774
- },
2775
- "required" : [ "configParams" ]
2776
- },
2777
- "examples" : {
2778
- "Valid requestBody Definitions" : {
2779
- "value" : null
2780
- }
2781
- }
2782
- }
2783
- },
2784
- "x-custom-request-body-attributes" : {
2785
- "non-empty" : false,
2786
- "allow-invalid" : false
2787
- }
2788
- },
2789
- "removeIMChannelHandlingAgents_addIMChannelHandlingAgents" : {
2790
- "content" : {
2791
- "application/json" : {
2792
- "schema" : {
2793
- "type" : [ "null", "object" ],
2794
- "additionalProperties" : false,
2795
- "properties" : {
2796
- "agentIds" : {
2797
- "$ref" : "./IM_Channel.json#/components/schemas/listOfAgentIds"
2798
- }
2799
- },
2800
- "required" : [ "agentIds" ]
2801
- },
2802
- "examples" : {
2803
- "Valid requestBody Definitions" : {
2804
- "value" : null
2805
- }
2806
- }
2807
- }
2808
- },
2809
- "x-custom-request-body-attributes" : {
2810
- "non-empty" : false,
2811
- "allow-invalid" : false
2812
- }
2813
- },
2814
- "getIntegrationConfigParamsComputedOptions_getConfigParamsComputedOptions_input" : {
2815
- "content" : {
2816
- "application/json" : {
2817
- "schema" : {
2818
- "type" : [ "null", "object" ],
2819
- "additionalProperties" : false,
2820
- "properties" : {
2821
- "configParams" : {
2822
- "$ref" : "./IM_Channel.json#/components/schemas/getConfigParamsComputedOptions_input_list"
2823
- }
2824
- }
2825
- },
2826
- "examples" : {
2827
- "Valid requestBody Definitions" : {
2828
- "value" : { }
2829
- }
2830
- }
2831
- }
2832
- },
2833
- "x-custom-request-body-attributes" : { }
2834
- }
2835
- },
2836
- "securitySchemes" : {
2837
- "cookie-auth" : {
2838
- "$ref" : "../common/Common.json#/components/securitySchemes/cookie-auth"
2839
- },
2840
- "org-oauth" : {
2841
- "$ref" : "../common/Common.json#/components/securitySchemes/org-oauth"
2842
- },
2843
- "iam-oauth2-schema" : {
2844
- "$ref" : "../common/Common.json#/components/securitySchemes/iam-oauth2-schema"
2845
- }
2846
- }
2847
- },
2848
- "x-entity" : "IM_Channel"
2849
- }