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,1834 +0,0 @@
1
- {
2
- "openapi": "3.1.0",
3
- "info": {
4
- "title": "Client Action",
5
- "version": "1.0.0",
6
- "description": "Streamlined OpenAPI specification for Client Action creation API only. This configuration is optimized for automation and reusability.",
7
- "x-clan-group": "clientAction",
8
- "x-module-group": "clientAction"
9
- },
10
- "paths": {
11
- "/api/v1/clientActions": {
12
- "post": {
13
- "tags": [
14
- "ClientAction"
15
- ],
16
- "summary": "Create a client action",
17
- "description": "Creates a new client action in the portal with specified component, UI mapping, conditions, and module associations.",
18
- "operationId": "createClientAction",
19
- "x-audience": [
20
- "company-internal"
21
- ],
22
- "parameters": [
23
- {
24
- "$ref": "../common/Common.json#/components/parameters/orgId"
25
- }
26
- ],
27
- "requestBody": {
28
- "$ref": "#/components/requestBodies/createClientActionPayload"
29
- },
30
- "responses": {
31
- "200": {
32
- "$ref": "#/components/responses/clientActionResponse"
33
- },
34
- "403": {
35
- "$ref": "../common/Common.json#/components/responses/forbiddenErrorResponse"
36
- },
37
- "422": {
38
- "$ref": "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
39
- },
40
- "500": {
41
- "$ref": "../common/Common.json#/components/responses/internalErrorResponse"
42
- }
43
- },
44
- "security": [
45
- {
46
- "org-oauth": [
47
- "Desk.accessAll.ALL"
48
- ]
49
- },
50
- {
51
- "iam-oauth2-schema": [
52
- "Desk.settings.CREATE"
53
- ]
54
- }
55
- ],
56
- "x-custom-url-attribute": {
57
- "security": {
58
- "throttle": {
59
- "policy": "WriteAPI_Standard_UserPolicy"
60
- },
61
- "extraparams": {
62
- "disable": true,
63
- "ignore": false
64
- },
65
- "authentication": {}
66
- },
67
- "clan-group": "clientAction",
68
- "apihash": "bea1b8064f927342df8a90d77c3e35c4",
69
- "module-group": "clientAction",
70
- "apimethod": "com.zoho.desk.framework.clientaction.app.ClientActionService.createClientAction"
71
- }
72
- },
73
- "get": {
74
- "tags": [
75
- "ClientAction"
76
- ],
77
- "summary": "Get all client actions",
78
- "description": "With the help of this API, we can able to call get all client actions in a portal.",
79
- "operationId": "getClientActions",
80
- "x-audience": [
81
- "company-internal"
82
- ],
83
- "parameters": [
84
- {
85
- "$ref": "../common/Common.json#/components/parameters/orgId"
86
- },
87
- {
88
- "name": "components",
89
- "in": "query",
90
- "required": false,
91
- "schema": {
92
- "type": ["string", "null"],
93
- "description": "The actual component names.",
94
- "maxLength": 100,
95
- "minLength": 0
96
- }
97
- },
98
- {
99
- "name": "names",
100
- "in": "query",
101
- "required": false,
102
- "schema": {
103
- "type": ["string", "null"],
104
- "description": "The client action names.",
105
- "maxLength": 100,
106
- "minLength": 0
107
- }
108
- },
109
- {
110
- "name": "limit",
111
- "in": "query",
112
- "required": false,
113
- "schema": {
114
- "type": ["string", "null", "integer"],
115
- "format": "int32",
116
- "description": "The number of custom buttons that need to be fetched.",
117
- "maximum": 100,
118
- "minimum": 1,
119
- "pattern": "([0-9]+)"
120
- }
121
- },
122
- {
123
- "name": "from",
124
- "in": "query",
125
- "required": false,
126
- "schema": {
127
- "type": ["string", "null", "integer"],
128
- "format": "int32",
129
- "description": "The starting index number from which the custom buttons should be fetched.",
130
- "pattern": "([0-9]+)"
131
- }
132
- },
133
- {
134
- "name": "locations",
135
- "in": "query",
136
- "required": false,
137
- "schema": {
138
- "type": ["string", "null"],
139
- "description": "The locations where the components can be rendered or shown.",
140
- "enum": ["row_actions", "field_actions"],
141
- "maxLength": 100,
142
- "minLength": 0
143
- }
144
- },
145
- {
146
- "name": "modules",
147
- "in": "query",
148
- "required": false,
149
- "schema": {
150
- "type": ["string", "null"],
151
- "description": "The modules where the actions can be performed.",
152
- "maxLength": 100,
153
- "minLength": 0
154
- }
155
- }
156
- ],
157
- "responses": {
158
- "200": {
159
- "$ref": "#/components/responses/getClientActionsResponse"
160
- },
161
- "403": {
162
- "$ref": "../common/Common.json#/components/responses/forbiddenErrorResponse"
163
- },
164
- "422": {
165
- "$ref": "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
166
- },
167
- "500": {
168
- "$ref": "../common/Common.json#/components/responses/internalErrorResponse"
169
- }
170
- },
171
- "security": [
172
- {
173
- "org-oauth": [
174
- "Desk.accessAll.ALL"
175
- ]
176
- },
177
- {
178
- "iam-oauth2-schema": [
179
- "Desk.settings.READ"
180
- ]
181
- }
182
- ],
183
- "x-custom-url-attribute": {
184
- "security": {
185
- "throttle": {
186
- "policy": "ReadAPI_Standard_UserPolicy"
187
- },
188
- "extraparams": {
189
- "disable": true,
190
- "ignore": false
191
- },
192
- "authentication": {}
193
- },
194
- "clan-group": "clientAction",
195
- "apihash": "99949e3d71e5f99ea032a1fb87091da3",
196
- "module-group": "clientAction",
197
- "apimethod": "com.zoho.desk.framework.clientaction.app.ClientActionService.getClientActions"
198
- }
199
- }
200
- },
201
- "/api/v1/clientActions/{clientActionId}": {
202
- "get": {
203
- "tags": [
204
- "ClientAction"
205
- ],
206
- "summary": "Get a client action",
207
- "description": "With the help of this API, we can able to get client action by its ID.",
208
- "operationId": "getClientActionById",
209
- "x-audience": [
210
- "company-internal"
211
- ],
212
- "parameters": [
213
- {
214
- "$ref": "#/components/parameters/clientActionId"
215
- },
216
- {
217
- "$ref": "../common/Common.json#/components/parameters/orgId"
218
- }
219
- ],
220
- "responses": {
221
- "200": {
222
- "$ref": "#/components/responses/getClientActionResponse"
223
- },
224
- "403": {
225
- "$ref": "../common/Common.json#/components/responses/forbiddenErrorResponse"
226
- },
227
- "422": {
228
- "$ref": "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
229
- },
230
- "500": {
231
- "$ref": "../common/Common.json#/components/responses/internalErrorResponse"
232
- }
233
- },
234
- "security": [
235
- {
236
- "org-oauth": [
237
- "Desk.accessAll.ALL"
238
- ]
239
- },
240
- {
241
- "iam-oauth2-schema": [
242
- "Desk.settings.READ"
243
- ]
244
- }
245
- ],
246
- "x-custom-url-attribute": {
247
- "security": {
248
- "throttle": {
249
- "policy": "ReadAPI_Standard_UserPolicy"
250
- },
251
- "extraparams": {
252
- "disable": true,
253
- "ignore": false
254
- },
255
- "authentication": {}
256
- },
257
- "clan-group": "clientAction",
258
- "apihash": "dad0431d65e5c80e8d708108096249be",
259
- "module-group": "clientAction",
260
- "apimethod": "com.zoho.desk.framework.clientaction.app.ClientActionService.getClientAction"
261
- }
262
- },
263
- "patch": {
264
- "tags": [
265
- "ClientAction"
266
- ],
267
- "summary": "Update a client action",
268
- "description": "Updates an existing client action in the portal with specified component, UI mapping, conditions, and module associations.",
269
- "operationId": "updateClientAction",
270
- "x-audience": [
271
- "company-internal"
272
- ],
273
- "parameters": [
274
- {
275
- "$ref": "#/components/parameters/clientActionId"
276
- },
277
- {
278
- "$ref": "../common/Common.json#/components/parameters/orgId"
279
- }
280
- ],
281
- "requestBody": {
282
- "$ref": "#/components/requestBodies/updateClientActionRequestBody"
283
- },
284
- "responses": {
285
- "200": {
286
- "$ref": "#/components/responses/updateClientActionResponse"
287
- },
288
- "403": {
289
- "$ref": "../common/Common.json#/components/responses/forbiddenErrorResponse"
290
- },
291
- "422": {
292
- "$ref": "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
293
- },
294
- "500": {
295
- "$ref": "../common/Common.json#/components/responses/internalErrorResponse"
296
- }
297
- },
298
- "security": [
299
- {
300
- "org-oauth": [
301
- "Desk.accessAll.ALL"
302
- ]
303
- },
304
- {
305
- "iam-oauth2-schema": [
306
- "Desk.settings.UPDATE"
307
- ]
308
- }
309
- ],
310
- "x-custom-url-attribute": {
311
- "security": {
312
- "throttle": {
313
- "policy": "WriteAPI_Standard_UserPolicy"
314
- },
315
- "extraparams": {
316
- "disable": true,
317
- "ignore": false
318
- },
319
- "authentication": {}
320
- },
321
- "clan-group": "clientAction",
322
- "apihash": "cd2f6b8e5f0161ed30335c9a6d91a34a",
323
- "module-group": "clientAction",
324
- "apimethod": "com.zoho.desk.framework.clientaction.app.ClientActionService.updateClientAction"
325
- }
326
- },
327
- "delete": {
328
- "tags": [
329
- "ClientAction"
330
- ],
331
- "summary": "Delete a client action",
332
- "description": "With the help of this API, we can delete a client action in a portal.",
333
- "operationId": "deleteClientAction",
334
- "x-audience": [
335
- "company-internal"
336
- ],
337
- "parameters": [
338
- {
339
- "$ref": "#/components/parameters/clientActionId"
340
- },
341
- {
342
- "$ref": "../common/Common.json#/components/parameters/orgId"
343
- }
344
- ],
345
- "responses": {
346
- "204": {
347
- "$ref": "../common/Common.json#/components/responses/emptyResponse"
348
- },
349
- "403": {
350
- "$ref": "../common/Common.json#/components/responses/forbiddenErrorResponse"
351
- },
352
- "422": {
353
- "$ref": "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
354
- },
355
- "500": {
356
- "$ref": "../common/Common.json#/components/responses/internalErrorResponse"
357
- }
358
- },
359
- "security": [
360
- {
361
- "org-oauth": [
362
- "Desk.accessAll.ALL"
363
- ]
364
- },
365
- {
366
- "iam-oauth2-schema": [
367
- "Desk.settings.DELETE"
368
- ]
369
- }
370
- ],
371
- "x-custom-url-attribute": {
372
- "security": {
373
- "throttle": {
374
- "policy": "WriteAPI_Standard_UserPolicy"
375
- },
376
- "extraparams": {
377
- "disable": true,
378
- "ignore": false
379
- },
380
- "authentication": {}
381
- },
382
- "clan-group": "clientAction",
383
- "apihash": "c8af24e6dc5f046d482001b26ff8e2e5",
384
- "module-group": "clientAction",
385
- "apimethod": "com.zoho.desk.framework.clientaction.app.ClientActionService.deleteClientAction"
386
- }
387
- }
388
- },
389
- "/api/v1/componentDefinition": {
390
- "get": {
391
- "tags": [
392
- "ComponentDefinition"
393
- ],
394
- "summary": "Get component definitions",
395
- "description": "With the help of this API, we can get all available component definitions with their properties, events, and locations.",
396
- "operationId": "getComponentDefinitions",
397
- "x-audience": [
398
- "company-internal"
399
- ],
400
- "parameters": [
401
- {
402
- "$ref": "../common/Common.json#/components/parameters/orgId"
403
- }
404
- ],
405
- "responses": {
406
- "200": {
407
- "$ref": "#/components/responses/componentDefinitionsResponse"
408
- },
409
- "403": {
410
- "$ref": "../common/Common.json#/components/responses/forbiddenErrorResponse"
411
- },
412
- "422": {
413
- "$ref": "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
414
- },
415
- "500": {
416
- "$ref": "../common/Common.json#/components/responses/internalErrorResponse"
417
- }
418
- },
419
- "security": [
420
- {
421
- "org-oauth": [
422
- "Desk.accessAll.ALL"
423
- ]
424
- },
425
- {
426
- "iam-oauth2-schema": [
427
- "Desk.settings.READ"
428
- ]
429
- }
430
- ],
431
- "x-custom-url-attribute": {
432
- "security": {
433
- "throttle": {
434
- "policy": "ReadAPI_Standard_UserPolicy"
435
- },
436
- "extraparams": {
437
- "disable": true,
438
- "ignore": false
439
- },
440
- "authentication": {}
441
- },
442
- "clan-group": "clientAction",
443
- "apihash": "dad0431d65e5c80e8d708108096249be",
444
- "module-group": "clientAction",
445
- "apimethod": "com.zoho.desk.framework.clientaction.app.ClientActionService.getComponentDefinitions"
446
- }
447
- }
448
- }
449
- },
450
- "components": {
451
- "schemas": {
452
- "agentData": {
453
- "type": "object",
454
- "description": "Agent information including personal details and metadata",
455
- "additionalProperties": false,
456
- "properties": {
457
- "id": {
458
- "type": "string",
459
- "description": "Unique identifier for the agent",
460
- "pattern": "^[0-9]+$"
461
- },
462
- "firstName": {
463
- "type": "string",
464
- "description": "First name of the agent",
465
- "maxLength": 50
466
- },
467
- "lastName": {
468
- "type": "string",
469
- "description": "Last name of the agent",
470
- "maxLength": 50
471
- },
472
- "photoURL": {
473
- "type": "string",
474
- "description": "Profile photo URL of the agent",
475
- "format": "uri"
476
- }
477
- },
478
- "required": ["id", "firstName", "lastName", "photoURL"]
479
- },
480
- "eventMappingPayload": {
481
- "type": "object",
482
- "description": "Defines event mapping configuration for UI components",
483
- "additionalProperties": false,
484
- "properties": {
485
- "sourceEvent": {
486
- "type": "string",
487
- "description": "The event triggered by the component or user interaction (e.g., ACTION_ICON#CLICKED)",
488
- "maxLength": 100,
489
- "minLength": 1
490
- },
491
- "targetEvent": {
492
- "type": "string",
493
- "description": "The event that should be triggered in response to the source event (e.g., TARGET#EVENT)",
494
- "maxLength": 100,
495
- "minLength": 1
496
- },
497
- "payloadValueMapping": {
498
- "type": "object",
499
- "description": "Data passed to the target event for execution. Must contain at least one key-value pair.",
500
- "additionalProperties": true,
501
- "minProperties": 1
502
- }
503
- },
504
- "required": ["sourceEvent", "targetEvent", "payloadValueMapping"]
505
- },
506
- "eventMappingResponse": {
507
- "type": "object",
508
- "description": "Event mapping response structure with metadata",
509
- "additionalProperties": false,
510
- "properties": {
511
- "id": {
512
- "type": "string",
513
- "description": "Unique identifier for the event mapping",
514
- "pattern": "^[0-9]+$"
515
- },
516
- "sourceEvent": {
517
- "type": "string",
518
- "description": "The event triggered by the component"
519
- },
520
- "targetEvent": {
521
- "type": "string",
522
- "description": "The target event to be triggered"
523
- },
524
- "payloadValueMapping": {
525
- "type": "object",
526
- "description": "Payload data mapping",
527
- "additionalProperties": true
528
- },
529
- "createdBy": {
530
- "$ref": "#/components/schemas/agentData"
531
- },
532
- "modifiedBy": {
533
- "$ref": "#/components/schemas/agentData"
534
- }
535
- },
536
- "required": ["id", "sourceEvent", "targetEvent", "payloadValueMapping", "createdBy", "modifiedBy"]
537
- },
538
- "conditionField": {
539
- "type": "object",
540
- "description": "Field-based condition configuration",
541
- "additionalProperties": false,
542
- "properties": {
543
- "fieldName": {
544
- "type": "string",
545
- "description": "Name of the field for the condition (e.g., record.email)",
546
- "maxLength": 100,
547
- "minLength": 1
548
- },
549
- "condition": {
550
- "type": "string",
551
- "description": "Conditional operator to apply",
552
- "enum": ["is", "is not", "contains", "=", "does", "doesn't"]
553
- },
554
- "value": {
555
- "type": "array",
556
- "description": "Expected values for the condition",
557
- "items": {
558
- "type": "string",
559
- "maxLength": 100
560
- },
561
- "minItems": 1
562
- }
563
- },
564
- "required": ["fieldName", "condition", "value"]
565
- },
566
- "conditionPayload": {
567
- "anyOf": [
568
- {
569
- "type": "object",
570
- "description": "Full condition configuration with fields and pattern",
571
- "additionalProperties": false,
572
- "properties": {
573
- "fields": {
574
- "type": "array",
575
- "description": "Array of field-based conditions",
576
- "items": {
577
- "$ref": "#/components/schemas/conditionField"
578
- },
579
- "minItems": 1
580
- },
581
- "pattern": {
582
- "type": "string",
583
- "description": "Logical pattern combining conditions (e.g., '1 and 2')",
584
- "maxLength": 100,
585
- "minLength": 1
586
- }
587
- },
588
- "required": ["fields", "pattern"]
589
- },
590
- {
591
- "type": "object",
592
- "description": "Empty condition object",
593
- "additionalProperties": false,
594
- "properties": {},
595
- "maxProperties": 0
596
- }
597
- ]
598
- },
599
- "uiComponentMappingPayload": {
600
- "type": "object",
601
- "description": "UI component mapping configuration for client action",
602
- "additionalProperties": false,
603
- "properties": {
604
- "name": {
605
- "type": "string",
606
- "description": "Name of the UI component",
607
- "maxLength": 100,
608
- "minLength": 1
609
- },
610
- "component": {
611
- "type": "string",
612
- "description": "Valid registered component name for UI rendering",
613
- "maxLength": 100,
614
- "minLength": 1
615
- },
616
- "propertiesValueMapping": {
617
- "type": "object",
618
- "description": "UI component properties like labels and icons. Must contain at least one property.",
619
- "additionalProperties": true,
620
- "minProperties": 1
621
- },
622
- "eventMappings": {
623
- "type": "array",
624
- "description": "Optional event mappings for component interactions",
625
- "items": {
626
- "$ref": "#/components/schemas/eventMappingPayload"
627
- },
628
- "minItems": 1
629
- }
630
- },
631
- "required": ["name", "component", "propertiesValueMapping"]
632
- },
633
- "uiComponentMappingResponse": {
634
- "type": "object",
635
- "description": "UI component mapping response with metadata",
636
- "additionalProperties": false,
637
- "properties": {
638
- "id": {
639
- "type": "string",
640
- "description": "Unique identifier for the UI component mapping",
641
- "pattern": "^[0-9]+$"
642
- },
643
- "name": {
644
- "type": "string",
645
- "description": "Name of the UI component"
646
- },
647
- "component": {
648
- "type": "string",
649
- "description": "Component name"
650
- },
651
- "propertiesValueMapping": {
652
- "type": "object",
653
- "description": "UI component properties",
654
- "additionalProperties": true
655
- },
656
- "eventMappings": {
657
- "type": "array",
658
- "description": "Event mappings configuration",
659
- "items": {
660
- "$ref": "#/components/schemas/eventMappingResponse"
661
- }
662
- },
663
- "createdBy": {
664
- "$ref": "#/components/schemas/agentData"
665
- },
666
- "modifiedBy": {
667
- "$ref": "#/components/schemas/agentData"
668
- }
669
- },
670
- "required": ["id", "name", "component", "propertiesValueMapping", "eventMappings", "createdBy", "modifiedBy"]
671
- },
672
- "createClientActionPayload": {
673
- "type": "object",
674
- "description": "Payload structure for creating a new client action",
675
- "additionalProperties": false,
676
- "properties": {
677
- "name": {
678
- "type": "string",
679
- "description": "Name of the client action (mandatory)",
680
- "maxLength": 100,
681
- "minLength": 1
682
- },
683
- "component": {
684
- "type": "string",
685
- "description": "Valid registered component name (mandatory)",
686
- "maxLength": 100,
687
- "minLength": 1
688
- },
689
- "location": {
690
- "type": "string",
691
- "description": "Location where the component can be rendered",
692
- "enum": ["row_actions", "header_actions", "field_actions"]
693
- },
694
- "modules": {
695
- "type": "array",
696
- "description": "Desk modules where this action is applicable",
697
- "items": {
698
- "anyOf": [
699
- {
700
- "type": "string",
701
- "enum": ["accounts", "contacts", "tasks", "tickets", "contracts", "products", "timeEntry", "agents", "events", "calls"]
702
- }
703
- ]
704
- }
705
- },
706
- "uiComponentMapping": {
707
- "$ref": "#/components/schemas/uiComponentMappingPayload"
708
- },
709
- "conditions": {
710
- "anyOf": [
711
- {
712
- "$ref": "#/components/schemas/conditionPayload"
713
- },
714
- {
715
- "type": "null"
716
- }
717
- ]
718
- }
719
- },
720
- "required": ["name", "component", "uiComponentMapping"]
721
- },
722
- "clientActionResponse": {
723
- "type": "object",
724
- "description": "Response structure for client action operations",
725
- "additionalProperties": false,
726
- "properties": {
727
- "id": {
728
- "type": "string",
729
- "description": "Unique identifier for the client action (response only)",
730
- "pattern": "^[0-9]+$"
731
- },
732
- "name": {
733
- "type": "string",
734
- "description": "Name of the client action"
735
- },
736
- "component": {
737
- "type": "string",
738
- "description": "Component name"
739
- },
740
- "location": {
741
- "type": ["string", "null"],
742
- "description": "Location of the component",
743
- "enum": ["row_actions", "header_actions", "field_actions", null]
744
- },
745
- "modules": {
746
- "type": "array",
747
- "description": "Associated modules (can be empty array)",
748
- "items": {
749
- "anyOf": [
750
- {
751
- "type": "string",
752
- "enum": ["accounts", "contacts", "tasks", "tickets", "contracts", "products", "timeEntry", "agents", "events", "calls"]
753
- }
754
- ]
755
- }
756
- },
757
- "uiComponentMapping": {
758
- "$ref": "#/components/schemas/uiComponentMappingResponse"
759
- },
760
- "conditions": {
761
- "type": ["object", "null"],
762
- "description": "Condition configuration (required field, can be null or valid condition object)"
763
- },
764
- "conditionId": {
765
- "type": ["string", "null"],
766
- "description": "Unique identifier for the condition (required field, can be null)"
767
- },
768
- "createdTime": {
769
- "type": "string",
770
- "description": "Creation timestamp (response only)",
771
- "format": "date-time"
772
- },
773
- "modifiedTime": {
774
- "type": "string",
775
- "description": "Last modification timestamp (response only)",
776
- "format": "date-time"
777
- },
778
- "createdBy": {
779
- "$ref": "#/components/schemas/agentData"
780
- },
781
- "modifiedBy": {
782
- "$ref": "#/components/schemas/agentData"
783
- }
784
- },
785
- "required": [
786
- "id",
787
- "name",
788
- "component",
789
- "modules",
790
- "uiComponentMapping",
791
- "conditions",
792
- "conditionId",
793
- "createdTime",
794
- "modifiedTime",
795
- "createdBy",
796
- "modifiedBy"
797
- ]
798
- },
799
- "updateUiComponentMappingPayload": {
800
- "type": "object",
801
- "description": "UI component mapping payload for update operations. The 'id' field is MANDATORY and must be provided to identify the existing UI component mapping to update.",
802
- "additionalProperties": false,
803
- "properties": {
804
- "id": {
805
- "type": "string",
806
- "description": "Unique identifier for the UI component mapping (MANDATORY for updates - cannot be null or empty)",
807
- "pattern": "^[0-9]+$",
808
- "minLength": 1
809
- },
810
- "name": {
811
- "type": "string",
812
- "description": "Name of the UI component",
813
- "maxLength": 100,
814
- "minLength": 1
815
- },
816
- "component": {
817
- "type": "string",
818
- "description": "Valid registered component name for UI rendering",
819
- "maxLength": 100,
820
- "minLength": 1
821
- },
822
- "propertiesValueMapping": {
823
- "type": "object",
824
- "description": "UI component properties like labels and icons. Must contain at least one property.",
825
- "additionalProperties": true,
826
- "minProperties": 1
827
- },
828
- "eventMappings": {
829
- "type": "array",
830
- "description": "Optional event mappings for component interactions",
831
- "items": {
832
- "$ref": "#/components/schemas/eventMappingPayload"
833
- },
834
- "minItems": 1
835
- }
836
- },
837
- "required": ["id", "name", "component", "propertiesValueMapping"]
838
- },
839
- "updateClientActionPayload": {
840
- "type": "object",
841
- "description": "Payload structure for updating an existing client action. The uiComponentMapping.id field is MANDATORY and must match an existing UI component mapping.",
842
- "additionalProperties": false,
843
- "properties": {
844
- "name": {
845
- "type": "string",
846
- "description": "Name of the client action",
847
- "maxLength": 100,
848
- "minLength": 1
849
- },
850
- "component": {
851
- "type": "string",
852
- "description": "Valid registered component name",
853
- "maxLength": 100,
854
- "minLength": 1
855
- },
856
- "location": {
857
- "type": "string",
858
- "description": "Location where the component can be rendered",
859
- "enum": ["row_actions", "header_actions", "field_actions"]
860
- },
861
- "modules": {
862
- "type": "array",
863
- "description": "Desk modules where this action is applicable",
864
- "items": {
865
- "anyOf": [
866
- {
867
- "type": "string",
868
- "enum": ["accounts", "contacts", "tasks", "tickets", "contracts", "products", "timeEntry", "agents", "events", "calls"]
869
- }
870
- ]
871
- }
872
- },
873
- "uiComponentMapping": {
874
- "$ref": "#/components/schemas/updateUiComponentMappingPayload"
875
- },
876
- "conditions": {
877
- "anyOf": [
878
- {
879
- "$ref": "#/components/schemas/conditionPayload"
880
- },
881
- {
882
- "type": "null"
883
- }
884
- ]
885
- }
886
- },
887
- "required": ["name", "component", "uiComponentMapping"]
888
- },
889
- "componentEvent": {
890
- "type": [
891
- "object",
892
- "null"
893
- ],
894
- "additionalProperties": false,
895
- "properties": {
896
- "displayLabel": {
897
- "type": [
898
- "string",
899
- "null"
900
- ],
901
- "description": "Display label for the event",
902
- "maxLength": 255,
903
- "minLength": 0,
904
- "x-custom-parameters-attributes": {}
905
- },
906
- "name": {
907
- "type": [
908
- "string",
909
- "null"
910
- ],
911
- "description": "Name of the event",
912
- "maxLength": 100,
913
- "minLength": 0,
914
- "x-custom-parameters-attributes": {}
915
- },
916
- "payload": {
917
- "type": [
918
- "array",
919
- "null"
920
- ],
921
- "description": "Payload data for the event",
922
- "items": {
923
- "type": [
924
- "object",
925
- "null"
926
- ],
927
- "additionalProperties": true,
928
- "x-custom-parameters-attributes": {}
929
- },
930
- "x-custom-parameters-attributes": {}
931
- }
932
- },
933
- "required": [
934
- "displayLabel",
935
- "name",
936
- "payload"
937
- ]
938
- },
939
- "componentProperty": {
940
- "type": [
941
- "object",
942
- "null"
943
- ],
944
- "additionalProperties": false,
945
- "properties": {
946
- "displayLabel": {
947
- "type": [
948
- "string",
949
- "null"
950
- ],
951
- "description": "Display label for the property",
952
- "maxLength": 255,
953
- "minLength": 0,
954
- "x-custom-parameters-attributes": {}
955
- },
956
- "type": {
957
- "type": [
958
- "string",
959
- "null"
960
- ],
961
- "description": "Type of the property",
962
- "maxLength": 100,
963
- "minLength": 0,
964
- "x-custom-parameters-attributes": {}
965
- },
966
- "name": {
967
- "type": [
968
- "string",
969
- "null"
970
- ],
971
- "description": "Name of the property",
972
- "maxLength": 100,
973
- "minLength": 0,
974
- "x-custom-parameters-attributes": {}
975
- },
976
- "maxLength": {
977
- "type": [
978
- "integer",
979
- "null"
980
- ],
981
- "description": "Maximum length allowed for the property",
982
- "format": "int32",
983
- "x-custom-parameters-attributes": {}
984
- },
985
- "isMandatory": {
986
- "type": [
987
- "boolean",
988
- "null"
989
- ],
990
- "description": "Whether the property is mandatory",
991
- "x-custom-parameters-attributes": {}
992
- },
993
- "defaultValue": {
994
- "type": [
995
- "string",
996
- "null"
997
- ],
998
- "description": "Default value of the property",
999
- "x-custom-parameters-attributes": {}
1000
- }
1001
- },
1002
- "required": [
1003
- "displayLabel",
1004
- "type",
1005
- "name",
1006
- "isMandatory",
1007
- "defaultValue"
1008
- ]
1009
- },
1010
- "componentLocation": {
1011
- "type": [
1012
- "object",
1013
- "null"
1014
- ],
1015
- "additionalProperties": false,
1016
- "properties": {
1017
- "displayLabel": {
1018
- "type": [
1019
- "string",
1020
- "null"
1021
- ],
1022
- "description": "Display label for the location",
1023
- "maxLength": 255,
1024
- "minLength": 0,
1025
- "x-custom-parameters-attributes": {}
1026
- },
1027
- "name": {
1028
- "type": [
1029
- "string",
1030
- "null"
1031
- ],
1032
- "description": "Name of the location",
1033
- "maxLength": 100,
1034
- "minLength": 0,
1035
- "x-custom-parameters-attributes": {}
1036
- },
1037
- "allowedComponents": {
1038
- "type": [
1039
- "array",
1040
- "null"
1041
- ],
1042
- "description": "List of allowed components in this location",
1043
- "items": {
1044
- "type": [
1045
- "string",
1046
- "null"
1047
- ],
1048
- "maxLength": 100,
1049
- "minLength": 0,
1050
- "x-custom-parameters-attributes": {}
1051
- },
1052
- "x-custom-parameters-attributes": {}
1053
- }
1054
- },
1055
- "required": [
1056
- "displayLabel",
1057
- "name",
1058
- "allowedComponents"
1059
- ]
1060
- },
1061
- "componentDefinition": {
1062
- "type": [
1063
- "object",
1064
- "null"
1065
- ],
1066
- "additionalProperties": false,
1067
- "properties": {
1068
- "displayLabel": {
1069
- "type": [
1070
- "string",
1071
- "null"
1072
- ],
1073
- "description": "Display label for the component",
1074
- "maxLength": 255,
1075
- "minLength": 0,
1076
- "x-custom-parameters-attributes": {}
1077
- },
1078
- "name": {
1079
- "type": [
1080
- "string",
1081
- "null"
1082
- ],
1083
- "description": "Name of the component",
1084
- "maxLength": 100,
1085
- "minLength": 0,
1086
- "x-custom-parameters-attributes": {}
1087
- },
1088
- "locations": {
1089
- "type": [
1090
- "array",
1091
- "null"
1092
- ],
1093
- "description": "Available locations for the component",
1094
- "items": {
1095
- "$ref": "#/components/schemas/componentLocation"
1096
- },
1097
- "x-custom-parameters-attributes": {}
1098
- },
1099
- "properties": {
1100
- "type": [
1101
- "array",
1102
- "null"
1103
- ],
1104
- "description": "Properties of the component",
1105
- "items": {
1106
- "$ref": "#/components/schemas/componentProperty"
1107
- },
1108
- "x-custom-parameters-attributes": {}
1109
- },
1110
- "events": {
1111
- "type": [
1112
- "array",
1113
- "null"
1114
- ],
1115
- "description": "Events supported by the component",
1116
- "items": {
1117
- "$ref": "#/components/schemas/componentEvent"
1118
- },
1119
- "x-custom-parameters-attributes": {}
1120
- }
1121
- },
1122
- "required": [
1123
- "displayLabel",
1124
- "name",
1125
- "locations",
1126
- "properties",
1127
- "events"
1128
- ]
1129
- },
1130
- "arrayOfComponentDefinitions": {
1131
- "type": [
1132
- "array",
1133
- "null"
1134
- ],
1135
- "items": {
1136
- "$ref": "#/components/schemas/componentDefinition"
1137
- }
1138
- }
1139
- },
1140
- "parameters": {
1141
- "clientActionId": {
1142
- "name": "clientActionId",
1143
- "in": "path",
1144
- "description": "Unique ID of the client action",
1145
- "required": true,
1146
- "style": "simple",
1147
- "explode": false,
1148
- "schema": {
1149
- "type": ["string", "null", "integer"],
1150
- "format": "int64",
1151
- "description": "Unique identifier for the client action",
1152
- "pattern": "([0-9]+)"
1153
- }
1154
- }
1155
- },
1156
- "requestBodies": {
1157
- "createClientActionPayload": {
1158
- "description": "Request body for creating a new client action",
1159
- "required": true,
1160
- "content": {
1161
- "application/json": {
1162
- "schema": {
1163
- "$ref": "#/components/schemas/createClientActionPayload"
1164
- },
1165
- "examples": {
1166
- "basicClientAction": {
1167
- "summary": "Basic client action with required fields",
1168
- "description": "Example of a minimal client action configuration",
1169
- "value": {
1170
- "name": "Payload_250",
1171
- "component": "TableList",
1172
- "location": "field_actions",
1173
- "modules": ["tickets"],
1174
- "uiComponentMapping": {
1175
- "name": "Action_250",
1176
- "component": "CustomActionIcon",
1177
- "propertiesValueMapping": {
1178
- "icon": "ZD-icon-250",
1179
- "label": "Label_250"
1180
- },
1181
- "eventMappings": [
1182
- {
1183
- "sourceEvent": "ACTION_ICON#CLICKED",
1184
- "targetEvent": "TARGET#EVENT",
1185
- "payloadValueMapping": {
1186
- "recordsIds": "warning"
1187
- }
1188
- }
1189
- ]
1190
- },
1191
- "conditions": {
1192
- "fields": [
1193
- {
1194
- "fieldName": "record.email",
1195
- "condition": "contains",
1196
- "value": ["support-spam@example.com"]
1197
- }
1198
- ],
1199
- "pattern": "1 and 2"
1200
- }
1201
- }
1202
- },
1203
- "minimalClientAction": {
1204
- "summary": "Minimal client action with mandatory fields only",
1205
- "description": "Example with only required fields",
1206
- "value": {
1207
- "name": "Simple_Action",
1208
- "component": "ActionButton",
1209
- "uiComponentMapping": {
1210
- "name": "Simple_UI_Action",
1211
- "component": "SimpleIcon",
1212
- "propertiesValueMapping": {
1213
- "label": "Click Me"
1214
- }
1215
- }
1216
- }
1217
- },
1218
- "clientActionWithEmptyConditions": {
1219
- "summary": "Client action with empty conditions object",
1220
- "description": "Example showing empty conditions object results in conditionId: null and conditions: {}",
1221
- "value": {
1222
- "name": "Action_With_Empty_Conditions",
1223
- "component": "TableList",
1224
- "conditions": {},
1225
- "uiComponentMapping": {
1226
- "name": "Simple_UI_Action",
1227
- "component": "ActionIcon",
1228
- "propertiesValueMapping": {
1229
- "icon": "ZD-icon",
1230
- "label": "Empty Conditions Action"
1231
- }
1232
- }
1233
- }
1234
- },
1235
- "clientActionWithNullConditions": {
1236
- "summary": "Client action with null conditions",
1237
- "description": "Example showing null conditions results in conditionId: null and conditions: null",
1238
- "value": {
1239
- "name": "Action_With_Null_Conditions",
1240
- "component": "TableList",
1241
- "conditions": null,
1242
- "uiComponentMapping": {
1243
- "name": "Simple_UI_Action",
1244
- "component": "ActionIcon",
1245
- "propertiesValueMapping": {
1246
- "icon": "ZD-icon",
1247
- "label": "Null Conditions Action"
1248
- }
1249
- }
1250
- }
1251
- }
1252
- }
1253
- }
1254
- }
1255
- },
1256
- "updateClientActionRequestBody": {
1257
- "description": "Request body for updating an existing client action",
1258
- "required": true,
1259
- "content": {
1260
- "application/json": {
1261
- "schema": {
1262
- "$ref": "#/components/schemas/updateClientActionPayload"
1263
- },
1264
- "examples": {
1265
- "updateClientActionExample": {
1266
- "summary": "Update existing client action with mandatory ID",
1267
- "description": "Example of updating a client action with MANDATORY uiComponentMapping.id field. The ID must reference an existing UI component mapping.",
1268
- "value": {
1269
- "name": "Updated_Action_250",
1270
- "component": "TableList",
1271
- "location": "field_actions",
1272
- "modules": ["tickets"],
1273
- "uiComponentMapping": {
1274
- "id": "1000000092001",
1275
- "name": "Updated_Action_250",
1276
- "component": "CustomActionIcon",
1277
- "propertiesValueMapping": {
1278
- "icon": "ZD-icon-updated",
1279
- "label": "Updated_Label_250"
1280
- },
1281
- "eventMappings": [
1282
- {
1283
- "sourceEvent": "ACTION_ICON#CLICKED",
1284
- "targetEvent": "TARGET#UPDATED_EVENT",
1285
- "payloadValueMapping": {
1286
- "recordsIds": "updated_warning"
1287
- }
1288
- }
1289
- ]
1290
- },
1291
- "conditions": {
1292
- "fields": [
1293
- {
1294
- "fieldName": "record.email",
1295
- "condition": "contains",
1296
- "value": ["updated-support@example.com"]
1297
- }
1298
- ],
1299
- "pattern": "1 and 2"
1300
- }
1301
- }
1302
- },
1303
- "updateCustomModuleExample": {
1304
- "summary": "Update action with custom module",
1305
- "description": "Example showing update. This matches error scenarios but with required ID field.",
1306
- "value": {
1307
- "name": "b2db0cfd-94ed-45c5-a7ca-e2442e982fb2",
1308
- "component": "TableList",
1309
- "location": "row_actions",
1310
- "modules": ["tickets"],
1311
- "uiComponentMapping": {
1312
- "id": "1000000094001",
1313
- "name": "c9c1cb97-5110-45d3-beda-a2ff4c2700c9",
1314
- "component": "ActionIcon",
1315
- "propertiesValueMapping": {
1316
- "icon": "3c95aad0-065f-4f64-a00b-03ad25cb9cda"
1317
- },
1318
- "eventMappings": [
1319
- {
1320
- "sourceEvent": "ACTION_ICON#CLICKED",
1321
- "targetEvent": "TARGET#EVENT",
1322
- "payloadValueMapping": {
1323
- "recordsIds": "edf6fcbc-5145-4e1e-a392-75bdf1c3c640"
1324
- }
1325
- }
1326
- ]
1327
- }
1328
- }
1329
- }
1330
- }
1331
- }
1332
- }
1333
- }
1334
- },
1335
- "responses": {
1336
- "clientActionResponse": {
1337
- "description": "Successful client action creation response",
1338
- "content": {
1339
- "application/json": {
1340
- "schema": {
1341
- "$ref": "#/components/schemas/clientActionResponse"
1342
- },
1343
- "examples": {
1344
- "successfulCreation": {
1345
- "summary": "Successful client action creation",
1346
- "description": "Example response after creating a client action",
1347
- "value": {
1348
- "id": "1000000092007",
1349
- "name": "Action in Row Action",
1350
- "component": "TableList",
1351
- "location": "row_actions",
1352
- "modules": [],
1353
- "conditionId": "1000000089021",
1354
- "createdTime": "2025-09-18T08:40:47.000Z",
1355
- "modifiedTime": "2025-09-18T08:40:47.000Z",
1356
- "uiComponentMapping": {
1357
- "id": "1000000092001",
1358
- "name": "Edit",
1359
- "component": "ActionIcon",
1360
- "propertiesValueMapping": {
1361
- "icon": "ZD-GN-edit",
1362
- "label": "sample"
1363
- },
1364
- "eventMappings": [
1365
- {
1366
- "id": "1000000092003",
1367
- "sourceEvent": "ACTION_ICON#CLICKED",
1368
- "targetEvent": "TARGET#EVENT",
1369
- "payloadValueMapping": {
1370
- "recordsIds": "26"
1371
- },
1372
- "createdBy": {
1373
- "id": "1000000000523",
1374
- "firstName": "{firstName}",
1375
- "lastName": "{lastName}",
1376
- "photoURL": "{photoURL}"
1377
- },
1378
- "modifiedBy": {
1379
- "id": "1000000000523",
1380
- "firstName": "{firstName}",
1381
- "lastName": "{lastName}",
1382
- "photoURL": "{photoURL}"
1383
- }
1384
- }
1385
- ],
1386
- "createdBy": {
1387
- "id": "1000000000523",
1388
- "firstName": "{firstName}",
1389
- "lastName": "{lastName}",
1390
- "photoURL": "{photoURL}"
1391
- },
1392
- "modifiedBy": {
1393
- "id": "1000000000523",
1394
- "firstName": "{firstName}",
1395
- "lastName": "{lastName}",
1396
- "photoURL": "{photoURL}"
1397
- }
1398
- },
1399
- "conditions": {
1400
- "fields": [
1401
- {
1402
- "fieldName": "record.email",
1403
- "condition": "contains",
1404
- "value": ["support-spam@example.com"]
1405
- }
1406
- ],
1407
- "pattern": "1 and 2"
1408
- },
1409
- "createdBy": {
1410
- "id": "1000000000523",
1411
- "firstName": "{firstName}",
1412
- "lastName": "{lastName}",
1413
- "photoURL": "{photoURL}"
1414
- },
1415
- "modifiedBy": {
1416
- "id": "1000000000523",
1417
- "firstName": "{firstName}",
1418
- "lastName": "{lastName}",
1419
- "photoURL": "{photoURL}"
1420
- }
1421
- }
1422
- },
1423
- "emptyConditionsResponse": {
1424
- "summary": "Response with empty conditions",
1425
- "description": "Example response when conditions was sent as empty object {}",
1426
- "value": {
1427
- "id": "1000000094101",
1428
- "name": "Action_With_Empty_Conditions",
1429
- "component": "TableList",
1430
- "location": null,
1431
- "modules": [],
1432
- "conditionId": null,
1433
- "conditions": {},
1434
- "createdTime": "2025-11-06T05:51:50.000Z",
1435
- "modifiedTime": "2025-11-06T05:51:50.000Z",
1436
- "uiComponentMapping": {
1437
- "id": "1000000094095",
1438
- "name": "Simple_UI_Action",
1439
- "component": "ActionIcon",
1440
- "propertiesValueMapping": {
1441
- "icon": "ZD-icon"
1442
- },
1443
- "eventMappings": [],
1444
- "createdBy": {
1445
- "id": "1000000000523",
1446
- "firstName": "TestFirst",
1447
- "lastName": "TestLast",
1448
- "photoURL": "/api/v1/agents/1000000000523/photo?orgId=43269111"
1449
- },
1450
- "modifiedBy": {
1451
- "id": "1000000000523",
1452
- "firstName": "TestFirst",
1453
- "lastName": "TestLast",
1454
- "photoURL": "/api/v1/agents/1000000000523/photo?orgId=43269111"
1455
- }
1456
- },
1457
- "createdBy": {
1458
- "id": "1000000000523",
1459
- "firstName": "TestFirst",
1460
- "lastName": "TestLast",
1461
- "photoURL": "/api/v1/agents/1000000000523/photo?orgId=43269111"
1462
- },
1463
- "modifiedBy": {
1464
- "id": "1000000000523",
1465
- "firstName": "TestFirst",
1466
- "lastName": "TestLast",
1467
- "photoURL": "/api/v1/agents/1000000000523/photo?orgId=43269111"
1468
- }
1469
- }
1470
- },
1471
- "nullConditionsResponse": {
1472
- "summary": "Response with null conditions",
1473
- "description": "Example response when conditions was sent as null",
1474
- "value": {
1475
- "id": "1000000094102",
1476
- "name": "Action_With_Null_Conditions",
1477
- "component": "TableList",
1478
- "location": null,
1479
- "modules": [],
1480
- "conditionId": null,
1481
- "conditions": null,
1482
- "createdTime": "2025-11-06T05:51:50.000Z",
1483
- "modifiedTime": "2025-11-06T05:51:50.000Z",
1484
- "uiComponentMapping": {
1485
- "id": "1000000094096",
1486
- "name": "Simple_UI_Action",
1487
- "component": "ActionIcon",
1488
- "propertiesValueMapping": {
1489
- "icon": "ZD-icon"
1490
- },
1491
- "eventMappings": [],
1492
- "createdBy": {
1493
- "id": "1000000000523",
1494
- "firstName": "TestFirst",
1495
- "lastName": "TestLast",
1496
- "photoURL": "/api/v1/agents/1000000000523/photo?orgId=43269111"
1497
- },
1498
- "modifiedBy": {
1499
- "id": "1000000000523",
1500
- "firstName": "TestFirst",
1501
- "lastName": "TestLast",
1502
- "photoURL": "/api/v1/agents/1000000000523/photo?orgId=43269111"
1503
- }
1504
- },
1505
- "createdBy": {
1506
- "id": "1000000000523",
1507
- "firstName": "TestFirst",
1508
- "lastName": "TestLast",
1509
- "photoURL": "/api/v1/agents/1000000000523/photo?orgId=43269111"
1510
- },
1511
- "modifiedBy": {
1512
- "id": "1000000000523",
1513
- "firstName": "TestFirst",
1514
- "lastName": "TestLast",
1515
- "photoURL": "/api/v1/agents/1000000000523/photo?orgId=43269111"
1516
- }
1517
- }
1518
- }
1519
- }
1520
- }
1521
- }
1522
- },
1523
- "updateClientActionResponse": {
1524
- "description": "Successful client action update response",
1525
- "content": {
1526
- "application/json": {
1527
- "schema": {
1528
- "$ref": "#/components/schemas/clientActionResponse"
1529
- },
1530
- "examples": {
1531
- "successfulUpdate": {
1532
- "summary": "Successful client action update",
1533
- "description": "Example response after updating a client action",
1534
- "value": {
1535
- "id": "1000000092007",
1536
- "name": "Updated Action in Row Action",
1537
- "component": "TableList",
1538
- "location": "row_actions",
1539
- "modules": [],
1540
- "conditionId": "1000000089021",
1541
- "createdTime": "2025-09-18T08:40:47.000Z",
1542
- "modifiedTime": "2025-09-18T09:15:32.000Z",
1543
- "uiComponentMapping": {
1544
- "id": "1000000092001",
1545
- "name": "Updated Edit",
1546
- "component": "ActionIcon",
1547
- "propertiesValueMapping": {
1548
- "icon": "ZD-GN-edit-updated",
1549
- "label": "updated sample"
1550
- },
1551
- "eventMappings": [
1552
- {
1553
- "id": "1000000092003",
1554
- "sourceEvent": "ACTION_ICON#CLICKED",
1555
- "targetEvent": "TARGET#UPDATED_EVENT",
1556
- "payloadValueMapping": {
1557
- "recordsIds": "updated_value"
1558
- },
1559
- "createdBy": {
1560
- "id": "1000000000523",
1561
- "firstName": "{firstName}",
1562
- "lastName": "{lastName}",
1563
- "photoURL": "{photoURL}"
1564
- },
1565
- "modifiedBy": {
1566
- "id": "1000000000523",
1567
- "firstName": "{firstName}",
1568
- "lastName": "{lastName}",
1569
- "photoURL": "{photoURL}"
1570
- }
1571
- }
1572
- ],
1573
- "createdBy": {
1574
- "id": "1000000000523",
1575
- "firstName": "{firstName}",
1576
- "lastName": "{lastName}",
1577
- "photoURL": "{photoURL}"
1578
- },
1579
- "modifiedBy": {
1580
- "id": "1000000000523",
1581
- "firstName": "{firstName}",
1582
- "lastName": "{lastName}",
1583
- "photoURL": "{photoURL}"
1584
- }
1585
- },
1586
- "conditions": {
1587
- "fields": [
1588
- {
1589
- "fieldName": "record.email",
1590
- "condition": "contains",
1591
- "value": ["updated-support@example.com"]
1592
- }
1593
- ],
1594
- "pattern": "1 and 2"
1595
- },
1596
- "createdBy": {
1597
- "id": "1000000000523",
1598
- "firstName": "{firstName}",
1599
- "lastName": "{lastName}",
1600
- "photoURL": "{photoURL}"
1601
- },
1602
- "modifiedBy": {
1603
- "id": "1000000000523",
1604
- "firstName": "{firstName}",
1605
- "lastName": "{lastName}",
1606
- "photoURL": "{photoURL}"
1607
- }
1608
- }
1609
- }
1610
- }
1611
- }
1612
- }
1613
- },
1614
- "getClientActionResponse": {
1615
- "description": "Successful get client action by ID response",
1616
- "content": {
1617
- "application/json": {
1618
- "schema": {
1619
- "$ref": "#/components/schemas/clientActionResponse"
1620
- },
1621
- "examples": {
1622
- "successfulGet": {
1623
- "summary": "Successful client action retrieval",
1624
- "description": "Example response when getting a client action by ID",
1625
- "value": {
1626
- "id": "1000000092007",
1627
- "name": "Action in Row Action",
1628
- "component": "TableList",
1629
- "location": "row_actions",
1630
- "modules": [],
1631
- "conditionId": "1000000089021",
1632
- "createdTime": "2025-09-18T08:40:47.000Z",
1633
- "modifiedTime": "2025-09-18T08:40:47.000Z",
1634
- "uiComponentMapping": {
1635
- "id": "1000000092001",
1636
- "name": "Edit",
1637
- "component": "ActionIcon",
1638
- "propertiesValueMapping": {
1639
- "icon": "ZD-GN-edit",
1640
- "label": "sample"
1641
- },
1642
- "eventMappings": [
1643
- {
1644
- "id": "1000000092003",
1645
- "sourceEvent": "ACTION_ICON#CLICKED",
1646
- "targetEvent": "TARGET#EVENT",
1647
- "payloadValueMapping": {
1648
- "recordsIds": "26"
1649
- },
1650
- "createdBy": {
1651
- "id": "1000000000523",
1652
- "firstName": "{firstName}",
1653
- "lastName": "{lastName}",
1654
- "photoURL": "{photoURL}"
1655
- },
1656
- "modifiedBy": {
1657
- "id": "1000000000523",
1658
- "firstName": "{firstName}",
1659
- "lastName": "{lastName}",
1660
- "photoURL": "{photoURL}"
1661
- }
1662
- }
1663
- ],
1664
- "createdBy": {
1665
- "id": "1000000000523",
1666
- "firstName": "{firstName}",
1667
- "lastName": "{lastName}",
1668
- "photoURL": "{photoURL}"
1669
- },
1670
- "modifiedBy": {
1671
- "id": "1000000000523",
1672
- "firstName": "{firstName}",
1673
- "lastName": "{lastName}",
1674
- "photoURL": "{photoURL}"
1675
- }
1676
- },
1677
- "conditions": {
1678
- "fields": [
1679
- {
1680
- "fieldName": "record.email",
1681
- "condition": "contains",
1682
- "value": ["support-spam@example.com"]
1683
- }
1684
- ],
1685
- "pattern": "1 and 2"
1686
- },
1687
- "createdBy": {
1688
- "id": "1000000000523",
1689
- "firstName": "{firstName}",
1690
- "lastName": "{lastName}",
1691
- "photoURL": "{photoURL}"
1692
- },
1693
- "modifiedBy": {
1694
- "id": "1000000000523",
1695
- "firstName": "{firstName}",
1696
- "lastName": "{lastName}",
1697
- "photoURL": "{photoURL}"
1698
- }
1699
- }
1700
- }
1701
- }
1702
- }
1703
- }
1704
- },
1705
- "getClientActionsResponse": {
1706
- "description": "Successful get all client actions response",
1707
- "content": {
1708
- "application/json": {
1709
- "schema": {
1710
- "type": "array",
1711
- "description": "Array of client actions. Returns empty array if no records match filtering parameters.",
1712
- "items": {
1713
- "$ref": "#/components/schemas/clientActionResponse"
1714
- }
1715
- },
1716
- "examples": {
1717
- "successfulGetAll": {
1718
- "summary": "Multiple client actions found",
1719
- "description": "Example response when multiple client actions are found",
1720
- "value": [
1721
- {
1722
- "id": "1000000092007",
1723
- "name": "Action in Row Action",
1724
- "component": "TableList",
1725
- "location": "row_actions",
1726
- "modules": [],
1727
- "conditionId": "1000000089021",
1728
- "createdTime": "2025-09-18T08:40:47.000Z",
1729
- "modifiedTime": "2025-09-18T08:40:47.000Z",
1730
- "uiComponentMapping": {
1731
- "id": "1000000092001",
1732
- "name": "Edit",
1733
- "component": "ActionIcon",
1734
- "propertiesValueMapping": {
1735
- "icon": "ZD-GN-edit",
1736
- "label": "sample"
1737
- },
1738
- "eventMappings": [
1739
- {
1740
- "id": "1000000092003",
1741
- "sourceEvent": "ACTION_ICON#CLICKED",
1742
- "targetEvent": "TARGET#EVENT",
1743
- "payloadValueMapping": {
1744
- "recordsIds": "26"
1745
- },
1746
- "createdBy": {
1747
- "id": "1000000000523",
1748
- "firstName": "{firstName}",
1749
- "lastName": "{lastName}",
1750
- "photoURL": "{photoURL}"
1751
- },
1752
- "modifiedBy": {
1753
- "id": "1000000000523",
1754
- "firstName": "{firstName}",
1755
- "lastName": "{lastName}",
1756
- "photoURL": "{photoURL}"
1757
- }
1758
- }
1759
- ],
1760
- "createdBy": {
1761
- "id": "1000000000523",
1762
- "firstName": "{firstName}",
1763
- "lastName": "{lastName}",
1764
- "photoURL": "{photoURL}"
1765
- },
1766
- "modifiedBy": {
1767
- "id": "1000000000523",
1768
- "firstName": "{firstName}",
1769
- "lastName": "{lastName}",
1770
- "photoURL": "{photoURL}"
1771
- }
1772
- },
1773
- "conditions": {
1774
- "fields": [
1775
- {
1776
- "fieldName": "record.email",
1777
- "condition": "contains",
1778
- "value": ["support-spam@example.com"]
1779
- }
1780
- ],
1781
- "pattern": "1 and 2"
1782
- },
1783
- "createdBy": {
1784
- "id": "1000000000523",
1785
- "firstName": "{firstName}",
1786
- "lastName": "{lastName}",
1787
- "photoURL": "{photoURL}"
1788
- },
1789
- "modifiedBy": {
1790
- "id": "1000000000523",
1791
- "firstName": "{firstName}",
1792
- "lastName": "{lastName}",
1793
- "photoURL": "{photoURL}"
1794
- }
1795
- }
1796
- ]
1797
- },
1798
- "emptyResponse": {
1799
- "summary": "No client actions found",
1800
- "description": "Example response when no records match the filtering parameters",
1801
- "value": []
1802
- }
1803
- }
1804
- }
1805
- }
1806
- },
1807
- "componentDefinitionsResponse": {
1808
- "description": "Component Definitions Response Template Definition",
1809
- "content": {
1810
- "application/json": {
1811
- "schema": {
1812
- "$ref": "#/components/schemas/arrayOfComponentDefinitions"
1813
- },
1814
- "examples": {
1815
- "Valid responses Definitions": {
1816
- "value": []
1817
- }
1818
- }
1819
- }
1820
- },
1821
- "x-custom-response-attributes": {}
1822
- }
1823
- },
1824
- "securitySchemes": {
1825
- "org-oauth": {
1826
- "$ref": "../common/Common.json#/components/securitySchemes/org-oauth"
1827
- },
1828
- "iam-oauth2-schema": {
1829
- "$ref": "../common/Common.json#/components/securitySchemes/iam-oauth2-schema"
1830
- }
1831
- }
1832
- },
1833
- "x-entity": "ClientAction"
1834
- }