agent-generator-cli 1.0.0 → 1.0.2

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 (766) hide show
  1. package/README.md +2 -22
  2. package/install-extension.js +89 -0
  3. package/main.js +45 -7
  4. package/package.json +21 -8
  5. package/source/api-data-generators/.idea/api-data-generators.iml +9 -0
  6. package/source/api-data-generators/.idea/misc.xml +6 -0
  7. package/source/api-data-generators/.idea/modules.xml +8 -0
  8. package/source/api-data-generators/.idea/vcs.xml +6 -0
  9. package/source/api-data-generators/portal/ArticleComment/test_data_generation_configurations.json +318 -0
  10. package/source/api-data-generators/portal/ArticleFeedback/test_data_generation_configurations.json +32 -0
  11. package/source/api-data-generators/portal/AsapMobile/test_data_generation_configurations.json +21 -0
  12. package/source/api-data-generators/portal/AsapWeb/test_data_generation_configurations.json +18 -0
  13. package/source/api-data-generators/portal/Category/test_data_generation_configurations.json +39 -0
  14. package/source/api-data-generators/portal/Comment/test_data_generation_configurations.json +157 -0
  15. package/source/api-data-generators/portal/Community/test_data_generation_configurations.json +46 -0
  16. package/source/api-data-generators/portal/CommunityUser/test_data_generation_configurations.json +16 -0
  17. package/source/api-data-generators/portal/Contact/test_data_generation_configurations.json +33 -0
  18. package/source/api-data-generators/portal/Department/test_data_generation_configurations.json +13 -0
  19. package/source/api-data-generators/portal/Extension/test_data_generation_configurations.json +91 -0
  20. package/source/api-data-generators/portal/FeedbackWidget/test_data_generation_configurations.json +18 -0
  21. package/source/api-data-generators/portal/FileExport/test_data_generation_configurations.json +42 -0
  22. package/source/api-data-generators/portal/Followers/test_data_generation_configurations.json +92 -0
  23. package/source/api-data-generators/portal/Gamification/test_data_generation_configurations.json +51 -0
  24. package/source/api-data-generators/portal/HelpCenters/test_data_generation_configurations.json +11 -0
  25. package/source/api-data-generators/portal/Helpcenter/test_data_generation_configurations.json +41 -0
  26. package/source/api-data-generators/portal/HelpcenterGroups/test_data_generation_configurations.json +18 -0
  27. package/source/api-data-generators/portal/KBRootCategory/test_data_generation_configurations.json +76 -0
  28. package/source/api-data-generators/portal/KbCategory/test_data_generation_configurations.json +51 -0
  29. package/source/api-data-generators/portal/KbSection/test_data_generation_configurations.json +25 -0
  30. package/source/api-data-generators/portal/KnowledgeBase/test_data_generation_configurations.json +26 -0
  31. package/source/api-data-generators/portal/Label/test_data_generation_configurations.json +18 -0
  32. package/source/api-data-generators/portal/Layout/test_data_generation_configurations.json +17 -0
  33. package/source/api-data-generators/portal/LayoutRules/test_data_generation_configurations.json +17 -0
  34. package/source/api-data-generators/portal/NewAsapMobile/test_data_generation_configurations.json +21 -0
  35. package/source/api-data-generators/portal/Permalink/test_data_generation_configurations.json +32 -0
  36. package/source/api-data-generators/portal/Product/test_data_generation_configurations.json +43 -0
  37. package/source/api-data-generators/portal/Solution/test_data_generation_configurations.json +631 -0
  38. package/source/api-data-generators/portal/Thread/test_data_generation_configurations.json +70 -0
  39. package/source/api-data-generators/portal/Ticket/test_data_generation_configurations.json +294 -0
  40. package/source/api-data-generators/portal/TicketComment/test_data_generation_configurations.json +58 -0
  41. package/source/api-data-generators/portal/TicketCount/test_data_generation_configurations.json +74 -0
  42. package/source/api-data-generators/portal/TicketStatusMapping/test_data_generation_configurations.json +11 -0
  43. package/source/api-data-generators/portal/TicketTemplate/test_data_generation_configurations.json +24 -0
  44. package/source/api-data-generators/portal/Topic/test_data_generation_configurations.json +259 -0
  45. package/source/api-data-generators/portal/Translation/test_data_generation_configurations.json +6 -0
  46. package/source/api-data-generators/portal/ValidationRules/test_data_generation_configurations.json +14 -0
  47. package/source/api-data-generators/portal/View/test_data_generation_configurations.json +19 -0
  48. package/source/api-data-generators/support/Account/test_data_generation_configurations.json +265 -0
  49. package/source/api-data-generators/support/AccountAttachment/test_data_generation_configurations.json +48 -0
  50. package/source/api-data-generators/support/AccountComments/test_data_generation_configurations.json +47 -0
  51. package/source/api-data-generators/support/AccountContactMappingInfo/test_data_generation_configurations.json +14 -0
  52. package/source/api-data-generators/support/AccountFollowers/test_data_generation_configurations.json +52 -0
  53. package/source/api-data-generators/support/AccountSla/test_data_generation_configurations.json +33 -0
  54. package/source/api-data-generators/support/AccountTimeEntry/test_data_generation_configurations.json +45 -0
  55. package/source/api-data-generators/support/ActiveCalls/test_data_generation_configurations.json +38 -0
  56. package/source/api-data-generators/support/Activity/test_data_generation_configurations.json +50 -0
  57. package/source/api-data-generators/support/ActorsAPI/test_data_generation_configurations.json +22 -0
  58. package/source/api-data-generators/support/Agent/test_data_generation_configurations.json +217 -0
  59. package/source/api-data-generators/support/AgentPresence/test_data_generation_configurations.json +30 -0
  60. package/source/api-data-generators/support/AgentSignatures/test_data_generation_configurations.json +31 -0
  61. package/source/api-data-generators/support/AgentTimeEntry/test_data_generation_configurations.json +36 -0
  62. package/source/api-data-generators/support/AntiSpamInfo/test_data_generation_configurations.json +32 -0
  63. package/source/api-data-generators/support/ApiCreditNotificationRule/test_data_generation_configurations.json +49 -0
  64. package/source/api-data-generators/support/ArchivedView/test_data_generation_configurations.json +66 -0
  65. package/source/api-data-generators/support/Article/test_data_generation_configurations.json +294 -0
  66. package/source/api-data-generators/support/ArticleAttachment/test_data_generation_configurations.json +150 -0
  67. package/source/api-data-generators/support/ArticleComment/test_data_generation_configurations.json +238 -0
  68. package/source/api-data-generators/support/ArticleFeedback/test_data_generation_configurations.json +147 -0
  69. package/source/api-data-generators/support/ArticleFeedbackResolution/test_data_generation_configurations.json +56 -0
  70. package/source/api-data-generators/support/ArticleStatistics/test_data_generation_configurations.json +397 -0
  71. package/source/api-data-generators/support/ArticleTranslation/test_data_generation_configurations.json +1123 -0
  72. package/source/api-data-generators/support/ArticleVersion/test_data_generation_configurations.json +26 -0
  73. package/source/api-data-generators/support/ArticleViews/test_data_generation_configurations.json +26 -0
  74. package/source/api-data-generators/support/Asap/test_data_generation_configurations.json +49 -0
  75. package/source/api-data-generators/support/AuditLog/test_data_generation_configurations.json +58 -0
  76. package/source/api-data-generators/support/AutomationAlerts/test_data_generation_configurations.json +27 -0
  77. package/source/api-data-generators/support/AutomationEngine/test_data_generation_configurations.json +20 -0
  78. package/source/api-data-generators/support/AutomationFeatureCount/test_data_generation_configurations.json +13 -0
  79. package/source/api-data-generators/support/AutomationFieldUpdates/test_data_generation_configurations.json +24 -0
  80. package/source/api-data-generators/support/AutomationTask/test_data_generation_configurations.json +29 -0
  81. package/source/api-data-generators/support/Backup/test_data_generation_configurations.json +115 -0
  82. package/source/api-data-generators/support/Badge/test_data_generation_configurations.json +64 -0
  83. package/source/api-data-generators/support/Bot/test_data_generation_configurations.json +288 -0
  84. package/source/api-data-generators/support/BotInference/test_data_generation_configurations.json +119 -0
  85. package/source/api-data-generators/support/BugInteg/test_data_generation_configurations.json +37 -0
  86. package/source/api-data-generators/support/BulkAction/test_data_generation_configurations.json +26 -0
  87. package/source/api-data-generators/support/BulkImport/test_data_generation_configurations.json +211 -0
  88. package/source/api-data-generators/support/BulkUpdate/test_data_generation_configurations.json +40 -0
  89. package/source/api-data-generators/support/BulkWrite/test_data_generation_configurations.json +32 -0
  90. package/source/api-data-generators/support/BusinessHour/test_data_generation_configurations.json +72 -0
  91. package/source/api-data-generators/support/Call/test_data_generation_configurations.json +247 -0
  92. package/source/api-data-generators/support/CallComments/test_data_generation_configurations.json +51 -0
  93. package/source/api-data-generators/support/CallHistory/test_data_generation_configurations.json +65 -0
  94. package/source/api-data-generators/support/CallTimeEntry/test_data_generation_configurations.json +77 -0
  95. package/source/api-data-generators/support/CallTimer/test_data_generation_configurations.json +14 -0
  96. package/source/api-data-generators/support/Channel/test_data_generation_configurations.json +44 -0
  97. package/source/api-data-generators/support/Chart/test_data_generation_configurations.json +35 -0
  98. package/source/api-data-generators/support/ChatTicket/test_data_generation_configurations.json +185 -0
  99. package/source/api-data-generators/support/Common/test_data_generation_configurations.json +43 -0
  100. package/source/api-data-generators/support/Community/test_data_generation_configurations.json +313 -0
  101. package/source/api-data-generators/support/CommunityAttachment/test_data_generation_configurations.json +16 -0
  102. package/source/api-data-generators/support/CommunityCategory/test_data_generation_configurations.json +121 -0
  103. package/source/api-data-generators/support/CommunityComment/test_data_generation_configurations.json +350 -0
  104. package/source/api-data-generators/support/CommunityInitPermissions/test_data_generation_configurations.json +16 -0
  105. package/source/api-data-generators/support/CommunityPreferences/test_data_generation_configurations.json +19 -0
  106. package/source/api-data-generators/support/CommunityTopic/test_data_generation_configurations.json +509 -0
  107. package/source/api-data-generators/support/CommunityTopicInsights/test_data_generation_configurations.json +32 -0
  108. package/source/api-data-generators/support/CommunityUser/test_data_generation_configurations.json +63 -0
  109. package/source/api-data-generators/support/Contact/test_data_generation_configurations.json +370 -0
  110. package/source/api-data-generators/support/ContactAttachment/test_data_generation_configurations.json +44 -0
  111. package/source/api-data-generators/support/ContactComments/test_data_generation_configurations.json +47 -0
  112. package/source/api-data-generators/support/ContactFollowers/test_data_generation_configurations.json +52 -0
  113. package/source/api-data-generators/support/ContactProfile/test_data_generation_configurations.json +11 -0
  114. package/source/api-data-generators/support/ContactTimeEntry/test_data_generation_configurations.json +45 -0
  115. package/source/api-data-generators/support/Contract/test_data_generation_configurations.json +184 -0
  116. package/source/api-data-generators/support/ContractAttachment/test_data_generation_configurations.json +30 -0
  117. package/source/api-data-generators/support/CreateTicket/test_data_generation_configurations.json +93 -0
  118. package/source/api-data-generators/support/Criteria/test_data_generation_configurations.json +19 -0
  119. package/source/api-data-generators/support/CrmInteg/test_data_generation_configurations.json +202 -0
  120. package/source/api-data-generators/support/CustomAction/test_data_generation_configurations.json +56 -0
  121. package/source/api-data-generators/support/CustomActionRuleMapping/test_data_generation_configurations.json +334 -0
  122. package/source/api-data-generators/support/CustomButton/test_data_generation_configurations.json +113 -0
  123. package/source/api-data-generators/support/CustomFunctionExecutionLogs/test_data_generation_configurations.json +68 -0
  124. package/source/api-data-generators/support/CustomFunctionGallery/test_data_generation_configurations.json +16 -0
  125. package/source/api-data-generators/support/CustomFunctions/test_data_generation_configurations.json +270 -0
  126. package/source/api-data-generators/support/CustomTheme/test_data_generation_configurations.json +70 -0
  127. package/source/api-data-generators/support/CustomView/test_data_generation_configurations.json +486 -0
  128. package/source/api-data-generators/support/CustomerHappiness/test_data_generation_configurations.json +77 -0
  129. package/source/api-data-generators/support/DashboardComponent/test_data_generation_configurations.json +305 -0
  130. package/source/api-data-generators/support/DashboardFolder/test_data_generation_configurations.json +126 -0
  131. package/source/api-data-generators/support/DashboardMetrics/test_data_generation_configurations.json +205 -0
  132. package/source/api-data-generators/support/Dashboards/test_data_generation_configurations.json +90 -0
  133. package/source/api-data-generators/support/DataChips/test_data_generation_configurations.json +33 -0
  134. package/source/api-data-generators/support/DataSync/test_data_generation_configurations.json +228 -0
  135. package/source/api-data-generators/support/DeleteTicket/test_data_generation_configurations.json +44 -0
  136. package/source/api-data-generators/support/Department/test_data_generation_configurations.json +156 -0
  137. package/source/api-data-generators/support/DependencyMappings/test_data_generation_configurations.json +50 -0
  138. package/source/api-data-generators/support/DirectAssignRuleTarget/test_data_generation_configurations.json +17 -0
  139. package/source/api-data-generators/support/DirectAssignmentRules/test_data_generation_configurations.json +37 -0
  140. package/source/api-data-generators/support/DisplayEntity/test_data_generation_configurations.json +45 -0
  141. package/source/api-data-generators/support/DomainMapping/test_data_generation_configurations.json +6 -0
  142. package/source/api-data-generators/support/EmailFailureAlert/test_data_generation_configurations.json +21 -0
  143. package/source/api-data-generators/support/EmailTemplates/test_data_generation_configurations.json +106 -0
  144. package/source/api-data-generators/support/EntityBlueprints/test_data_generation_configurations.json +205 -0
  145. package/source/api-data-generators/support/Event/test_data_generation_configurations.json +196 -0
  146. package/source/api-data-generators/support/EventComments/test_data_generation_configurations.json +45 -0
  147. package/source/api-data-generators/support/EventTimeEntry/test_data_generation_configurations.json +77 -0
  148. package/source/api-data-generators/support/EventTimer/test_data_generation_configurations.json +14 -0
  149. package/source/api-data-generators/support/Extension/test_data_generation_configurations.json +689 -0
  150. package/source/api-data-generators/support/FbManager/test_data_generation_configurations.json +64 -0
  151. package/source/api-data-generators/support/Feature/test_data_generation_configurations.json +61 -0
  152. package/source/api-data-generators/support/FeatureFile/test_data_generation_configurations.json +49 -0
  153. package/source/api-data-generators/support/FeatureFolder/test_data_generation_configurations.json +44 -0
  154. package/source/api-data-generators/support/FeaturePermission/test_data_generation_configurations.json +108 -0
  155. package/source/api-data-generators/support/FederatedLogin/test_data_generation_configurations.json +39 -0
  156. package/source/api-data-generators/support/FeedsAPIs/test_data_generation_configurations.json +54 -0
  157. package/source/api-data-generators/support/Field/test_data_generation_configurations.json +1031 -0
  158. package/source/api-data-generators/support/FieldPrediction/test_data_generation_configurations.json +564 -0
  159. package/source/api-data-generators/support/FileExport/test_data_generation_configurations.json +36 -0
  160. package/source/api-data-generators/support/Finance/test_data_generation_configurations.json +180 -0
  161. package/source/api-data-generators/support/Followers/test_data_generation_configurations.json +60 -0
  162. package/source/api-data-generators/support/GC_Bots/test_data_generation_configurations.json +26 -0
  163. package/source/api-data-generators/support/GC_Guide/test_data_generation_configurations.json +240 -0
  164. package/source/api-data-generators/support/GenericAction/test_data_generation_configurations.json +16 -0
  165. package/source/api-data-generators/support/GenericActionMapping/test_data_generation_configurations.json +216 -0
  166. package/source/api-data-generators/support/GoogleAnalytics/test_data_generation_configurations.json +168 -0
  167. package/source/api-data-generators/support/GoogleChat/test_data_generation_configurations.json +29 -0
  168. package/source/api-data-generators/support/Helpcenter/test_data_generation_configurations.json +98 -0
  169. package/source/api-data-generators/support/HelpcenterAutoTranslateSetting/test_data_generation_configurations.json +11 -0
  170. package/source/api-data-generators/support/HelpcenterGroups/test_data_generation_configurations.json +93 -0
  171. package/source/api-data-generators/support/HelpcenterPages/test_data_generation_configurations.json +34 -0
  172. package/source/api-data-generators/support/HelpcenterPreference/test_data_generation_configurations.json +18 -0
  173. package/source/api-data-generators/support/HelpcenterUpload/test_data_generation_configurations.json +25 -0
  174. package/source/api-data-generators/support/HolidayList/test_data_generation_configurations.json +65 -0
  175. package/source/api-data-generators/support/IMCannedMessage/test_data_generation_configurations.json +155 -0
  176. package/source/api-data-generators/support/IMCannedMessageTranslation/test_data_generation_configurations.json +92 -0
  177. package/source/api-data-generators/support/IMTemplateMessage/test_data_generation_configurations.json +22 -0
  178. package/source/api-data-generators/support/IM_AddOn/test_data_generation_configurations.json +19 -0
  179. package/source/api-data-generators/support/IM_Bot/test_data_generation_configurations.json +143 -0
  180. package/source/api-data-generators/support/IM_Broadcast/test_data_generation_configurations.json +39 -0
  181. package/source/api-data-generators/support/IM_Channel/test_data_generation_configurations.json +312 -0
  182. package/source/api-data-generators/support/IM_ChannelPreference/test_data_generation_configurations.json +35 -0
  183. package/source/api-data-generators/support/IM_Contact/test_data_generation_configurations.json +16 -0
  184. package/source/api-data-generators/support/IM_Integration/test_data_generation_configurations.json +32 -0
  185. package/source/api-data-generators/support/IM_Message/test_data_generation_configurations.json +297 -0
  186. package/source/api-data-generators/support/IM_Metrics/test_data_generation_configurations.json +38 -0
  187. package/source/api-data-generators/support/IM_Search/test_data_generation_configurations.json +56 -0
  188. package/source/api-data-generators/support/IM_Session/test_data_generation_configurations.json +149 -0
  189. package/source/api-data-generators/support/IM_TimeSeriesMetrics/test_data_generation_configurations.json +77 -0
  190. package/source/api-data-generators/support/IM_ZiaGpt/test_data_generation_configurations.json +52 -0
  191. package/source/api-data-generators/support/Import/test_data_generation_configurations.json +229 -0
  192. package/source/api-data-generators/support/InlineImage/test_data_generation_configurations.json +16 -0
  193. package/source/api-data-generators/support/IntegModule/test_data_generation_configurations.json +90 -0
  194. package/source/api-data-generators/support/Integrations/test_data_generation_configurations.json +25 -0
  195. package/source/api-data-generators/support/InteractiveTours/test_data_generation_configurations.json +66 -0
  196. package/source/api-data-generators/support/JWT/test_data_generation_configurations.json +49 -0
  197. package/source/api-data-generators/support/KBCategoryUser/test_data_generation_configurations.json +23 -0
  198. package/source/api-data-generators/support/KBRecycleBin/test_data_generation_configurations.json +131 -0
  199. package/source/api-data-generators/support/KBRootCategory/test_data_generation_configurations.json +214 -0
  200. package/source/api-data-generators/support/KBRootCategoryTranslation/test_data_generation_configurations.json +30 -0
  201. package/source/api-data-generators/support/KBSection/test_data_generation_configurations.json +173 -0
  202. package/source/api-data-generators/support/KPIWidget/test_data_generation_configurations.json +21 -0
  203. package/source/api-data-generators/support/KbCategory/test_data_generation_configurations.json +93 -0
  204. package/source/api-data-generators/support/Label/test_data_generation_configurations.json +103 -0
  205. package/source/api-data-generators/support/Layout/test_data_generation_configurations.json +503 -0
  206. package/source/api-data-generators/support/LayoutRuleCriteria/test_data_generation_configurations.json +19 -0
  207. package/source/api-data-generators/support/LayoutRules/test_data_generation_configurations.json +334 -0
  208. package/source/api-data-generators/support/License/test_data_generation_configurations.json +60 -0
  209. package/source/api-data-generators/support/Livecall/test_data_generation_configurations.json +72 -0
  210. package/source/api-data-generators/support/LookupRecord/test_data_generation_configurations.json +34 -0
  211. package/source/api-data-generators/support/Macros/test_data_generation_configurations.json +184 -0
  212. package/source/api-data-generators/support/MailReplyAddress/test_data_generation_configurations.json +32 -0
  213. package/source/api-data-generators/support/MassAction/test_data_generation_configurations.json +38 -0
  214. package/source/api-data-generators/support/Message/test_data_generation_configurations.json +38 -0
  215. package/source/api-data-generators/support/MicrosoftTeams/test_data_generation_configurations.json +50 -0
  216. package/source/api-data-generators/support/Misc/test_data_generation_configurations.json +16 -0
  217. package/source/api-data-generators/support/Module/test_data_generation_configurations.json +96 -0
  218. package/source/api-data-generators/support/NewCriteria/test_data_generation_configurations.json +26 -0
  219. package/source/api-data-generators/support/NewFeatureFields/test_data_generation_configurations.json +19 -0
  220. package/source/api-data-generators/support/NewTicketHistory/test_data_generation_configurations.json +20 -0
  221. package/source/api-data-generators/support/NotificationRules/test_data_generation_configurations.json +27 -0
  222. package/source/api-data-generators/support/OEmbedData/test_data_generation_configurations.json +19 -0
  223. package/source/api-data-generators/support/Onboarding/test_data_generation_configurations.json +29 -0
  224. package/source/api-data-generators/support/Organization/test_data_generation_configurations.json +79 -0
  225. package/source/api-data-generators/support/PBGroup/test_data_generation_configurations.json +109 -0
  226. package/source/api-data-generators/support/PBGroupAgents/test_data_generation_configurations.json +66 -0
  227. package/source/api-data-generators/support/PBPlatform/test_data_generation_configurations.json +113 -0
  228. package/source/api-data-generators/support/PBX/test_data_generation_configurations.json +28 -0
  229. package/source/api-data-generators/support/PBXConfig/test_data_generation_configurations.json +17 -0
  230. package/source/api-data-generators/support/PBXPhoneNumbers/test_data_generation_configurations.json +54 -0
  231. package/source/api-data-generators/support/PBXPreference/test_data_generation_configurations.json +54 -0
  232. package/source/api-data-generators/support/PageSense/test_data_generation_configurations.json +77 -0
  233. package/source/api-data-generators/support/PendingApproval/test_data_generation_configurations.json +14 -0
  234. package/source/api-data-generators/support/Permalink/test_data_generation_configurations.json +32 -0
  235. package/source/api-data-generators/support/PhoneAgents/test_data_generation_configurations.json +66 -0
  236. package/source/api-data-generators/support/PinnedConversation/test_data_generation_configurations.json +64 -0
  237. package/source/api-data-generators/support/Pipeline_Service/test_data_generation_configurations.json +32 -0
  238. package/source/api-data-generators/support/Product/test_data_generation_configurations.json +196 -0
  239. package/source/api-data-generators/support/ProductAttachment/test_data_generation_configurations.json +48 -0
  240. package/source/api-data-generators/support/Profile/test_data_generation_configurations.json +59 -0
  241. package/source/api-data-generators/support/QueueView/test_data_generation_configurations.json +37 -0
  242. package/source/api-data-generators/support/Records/test_data_generation_configurations.json +239 -0
  243. package/source/api-data-generators/support/Recyclebin/test_data_generation_configurations.json +52 -0
  244. package/source/api-data-generators/support/RemoteAuth/test_data_generation_configurations.json +52 -0
  245. package/source/api-data-generators/support/Report/test_data_generation_configurations.json +538 -0
  246. package/source/api-data-generators/support/ReportChart/test_data_generation_configurations.json +28 -0
  247. package/source/api-data-generators/support/ReportFolder/test_data_generation_configurations.json +100 -0
  248. package/source/api-data-generators/support/Resources/test_data_generation_configurations.json +29 -0
  249. package/source/api-data-generators/support/Role/test_data_generation_configurations.json +84 -0
  250. package/source/api-data-generators/support/RoundRobin/test_data_generation_configurations.json +58 -0
  251. package/source/api-data-generators/support/RoundRobinTarget/test_data_generation_configurations.json +50 -0
  252. package/source/api-data-generators/support/RoutingPreference/test_data_generation_configurations.json +29 -0
  253. package/source/api-data-generators/support/SLAMetaInfo/test_data_generation_configurations.json +22 -0
  254. package/source/api-data-generators/support/Saml/test_data_generation_configurations.json +42 -0
  255. package/source/api-data-generators/support/Sandbox/test_data_generation_configurations.json +92 -0
  256. package/source/api-data-generators/support/SandboxChangeset/test_data_generation_configurations.json +46 -0
  257. package/source/api-data-generators/support/SandboxDeployment/test_data_generation_configurations.json +50 -0
  258. package/source/api-data-generators/support/SandboxDeploymentLogs/test_data_generation_configurations.json +22 -0
  259. package/source/api-data-generators/support/SavedFilters/test_data_generation_configurations.json +203 -0
  260. package/source/api-data-generators/support/Schedule/test_data_generation_configurations.json +172 -0
  261. package/source/api-data-generators/support/ScheduleReplyInfo/test_data_generation_configurations.json +182 -0
  262. package/source/api-data-generators/support/Search/test_data_generation_configurations.json +636 -0
  263. package/source/api-data-generators/support/SearchInteg/test_data_generation_configurations.json +32 -0
  264. package/source/api-data-generators/support/Setup/test_data_generation_configurations.json +32 -0
  265. package/source/api-data-generators/support/SharedSnippet/test_data_generation_configurations.json +62 -0
  266. package/source/api-data-generators/support/Signature/test_data_generation_configurations.json +24 -0
  267. package/source/api-data-generators/support/Skill/test_data_generation_configurations.json +164 -0
  268. package/source/api-data-generators/support/SkillConfiguration/test_data_generation_configurations.json +21 -0
  269. package/source/api-data-generators/support/SkillType/test_data_generation_configurations.json +60 -0
  270. package/source/api-data-generators/support/Slack/test_data_generation_configurations.json +51 -0
  271. package/source/api-data-generators/support/SmsTemplates/test_data_generation_configurations.json +40 -0
  272. package/source/api-data-generators/support/Snippets/test_data_generation_configurations.json +47 -0
  273. package/source/api-data-generators/support/SocialInteg/test_data_generation_configurations.json +22 -0
  274. package/source/api-data-generators/support/SocialPosts/test_data_generation_configurations.json +223 -0
  275. package/source/api-data-generators/support/SocialTwitterConversations/test_data_generation_configurations.json +22 -0
  276. package/source/api-data-generators/support/StarredTemplates/test_data_generation_configurations.json +76 -0
  277. package/source/api-data-generators/support/SubjectAccessRequest/test_data_generation_configurations.json +104 -0
  278. package/source/api-data-generators/support/Supervise/test_data_generation_configurations.json +43 -0
  279. package/source/api-data-generators/support/SupportPlan/test_data_generation_configurations.json +65 -0
  280. package/source/api-data-generators/support/Tab/test_data_generation_configurations.json +29 -0
  281. package/source/api-data-generators/support/Target/test_data_generation_configurations.json +97 -0
  282. package/source/api-data-generators/support/Task/test_data_generation_configurations.json +219 -0
  283. package/source/api-data-generators/support/TaskAttachment/test_data_generation_configurations.json +42 -0
  284. package/source/api-data-generators/support/TaskComments/test_data_generation_configurations.json +45 -0
  285. package/source/api-data-generators/support/TaskTimeEntry/test_data_generation_configurations.json +87 -0
  286. package/source/api-data-generators/support/TaskTimer/test_data_generation_configurations.json +27 -0
  287. package/source/api-data-generators/support/Team/test_data_generation_configurations.json +115 -0
  288. package/source/api-data-generators/support/TemplateFolders/test_data_generation_configurations.json +72 -0
  289. package/source/api-data-generators/support/Thread/test_data_generation_configurations.json +383 -0
  290. package/source/api-data-generators/support/Ticket/test_data_generation_configurations.json +694 -0
  291. package/source/api-data-generators/support/TicketApprovals/test_data_generation_configurations.json +66 -0
  292. package/source/api-data-generators/support/TicketAttachment/test_data_generation_configurations.json +58 -0
  293. package/source/api-data-generators/support/TicketComment/test_data_generation_configurations.json +82 -0
  294. package/source/api-data-generators/support/TicketCount/test_data_generation_configurations.json +43 -0
  295. package/source/api-data-generators/support/TicketFollowers/test_data_generation_configurations.json +65 -0
  296. package/source/api-data-generators/support/TicketMetrics/test_data_generation_configurations.json +16 -0
  297. package/source/api-data-generators/support/TicketTag/test_data_generation_configurations.json +99 -0
  298. package/source/api-data-generators/support/TicketTemplate/test_data_generation_configurations.json +475 -0
  299. package/source/api-data-generators/support/TicketTimeEntry/test_data_generation_configurations.json +110 -0
  300. package/source/api-data-generators/support/TicketTimer/test_data_generation_configurations.json +48 -0
  301. package/source/api-data-generators/support/TicketWithChildren/test_data_generation_configurations.json +91 -0
  302. package/source/api-data-generators/support/TimeTracking/test_data_generation_configurations.json +46 -0
  303. package/source/api-data-generators/support/TranslationLanguages/test_data_generation_configurations.json +68 -0
  304. package/source/api-data-generators/support/Upload/test_data_generation_configurations.json +54 -0
  305. package/source/api-data-generators/support/User/test_data_generation_configurations.json +100 -0
  306. package/source/api-data-generators/support/UserAuthentication/test_data_generation_configurations.json +49 -0
  307. package/source/api-data-generators/support/UserPresence/test_data_generation_configurations.json +19 -0
  308. package/source/api-data-generators/support/ValidationRuleCriteria/test_data_generation_configurations.json +19 -0
  309. package/source/api-data-generators/support/ValidationRules/test_data_generation_configurations.json +321 -0
  310. package/source/api-data-generators/support/Webhook/test_data_generation_configurations.json +501 -0
  311. package/source/api-data-generators/support/Widget/test_data_generation_configurations.json +166 -0
  312. package/source/api-data-generators/support/ZIAAnswerbotInference/test_data_generation_configurations.json +26 -0
  313. package/source/api-data-generators/support/ZIADocumentData/test_data_generation_configurations.json +38 -0
  314. package/source/api-data-generators/support/ZIAVectorSearch/test_data_generation_configurations.json +22 -0
  315. package/source/api-data-generators/support/ZiaGPT/test_data_generation_configurations.json +19 -0
  316. package/source/api-data-generators/support/ZiaScheduler/test_data_generation_configurations.json +22 -0
  317. package/source/api-data-generators/support/ZiapoweredbyGPT/test_data_generation_configurations.json +33 -0
  318. package/source/api-data-generators/support/Zwitch/test_data_generation_configurations.json +71 -0
  319. package/source/api-data-generators/support/blueprintDrafts/test_data_generation_configurations.json +859 -0
  320. package/source/api-data-generators/support/blueprintTransitions/test_data_generation_configurations.json +26 -0
  321. package/source/api-data-generators/support/blueprints/test_data_generation_configurations.json +652 -0
  322. package/source/api-data-generators/support/borrow_book/test_data_generation_configurations.json +21 -0
  323. package/source/api-data-generators/support/zlabsnlp/test_data_generation_configurations.json +50 -0
  324. package/source/openapi-specifications/v1.0/common/Common.json +587 -0
  325. package/source/openapi-specifications/v1.0/portal/Account.json +183 -0
  326. package/source/openapi-specifications/v1.0/portal/ArticleComment.json +1103 -0
  327. package/source/openapi-specifications/v1.0/portal/ArticleFeedback.json +133 -0
  328. package/source/openapi-specifications/v1.0/portal/AsapMobile.json +712 -0
  329. package/source/openapi-specifications/v1.0/portal/AsapWeb.json +91 -0
  330. package/source/openapi-specifications/v1.0/portal/Attachment.json +122 -0
  331. package/source/openapi-specifications/v1.0/portal/Captcha.json +334 -0
  332. package/source/openapi-specifications/v1.0/portal/Category.json +1061 -0
  333. package/source/openapi-specifications/v1.0/portal/Comment.json +1546 -0
  334. package/source/openapi-specifications/v1.0/portal/Community.json +235 -0
  335. package/source/openapi-specifications/v1.0/portal/CommunityUser.json +296 -0
  336. package/source/openapi-specifications/v1.0/portal/Contact.json +536 -0
  337. package/source/openapi-specifications/v1.0/portal/CustomerHappiness.json +163 -0
  338. package/source/openapi-specifications/v1.0/portal/Department.json +246 -0
  339. package/source/openapi-specifications/v1.0/portal/Extension.json +1122 -0
  340. package/source/openapi-specifications/v1.0/portal/FeedbackWidget.json +96 -0
  341. package/source/openapi-specifications/v1.0/portal/Field.json +1239 -0
  342. package/source/openapi-specifications/v1.0/portal/FileExport.json +313 -0
  343. package/source/openapi-specifications/v1.0/portal/Followers.json +802 -0
  344. package/source/openapi-specifications/v1.0/portal/Gamification.json +819 -0
  345. package/source/openapi-specifications/v1.0/portal/HashTags.json +61 -0
  346. package/source/openapi-specifications/v1.0/portal/HelpCenterUser.json +605 -0
  347. package/source/openapi-specifications/v1.0/portal/HelpCenterUserPreference.json +148 -0
  348. package/source/openapi-specifications/v1.0/portal/Helpcenter.json +920 -0
  349. package/source/openapi-specifications/v1.0/portal/HelpcenterGroups.json +118 -0
  350. package/source/openapi-specifications/v1.0/portal/HelpcenterPages.json +184 -0
  351. package/source/openapi-specifications/v1.0/portal/KBCategoryTranslation.json +70 -0
  352. package/source/openapi-specifications/v1.0/portal/KBRootCategory.json +1310 -0
  353. package/source/openapi-specifications/v1.0/portal/KbCategory.json +1525 -0
  354. package/source/openapi-specifications/v1.0/portal/KbSection.json +515 -0
  355. package/source/openapi-specifications/v1.0/portal/Label.json +172 -0
  356. package/source/openapi-specifications/v1.0/portal/Layout.json +303 -0
  357. package/source/openapi-specifications/v1.0/portal/LayoutRules.json +375 -0
  358. package/source/openapi-specifications/v1.0/portal/Mentions.json +580 -0
  359. package/source/openapi-specifications/v1.0/portal/NewAsapMobile.json +699 -0
  360. package/source/openapi-specifications/v1.0/portal/Permalink.json +265 -0
  361. package/source/openapi-specifications/v1.0/portal/Placeholders.json +57 -0
  362. package/source/openapi-specifications/v1.0/portal/Product.json +401 -0
  363. package/source/openapi-specifications/v1.0/portal/Solution.json +3766 -0
  364. package/source/openapi-specifications/v1.0/portal/Thread.json +821 -0
  365. package/source/openapi-specifications/v1.0/portal/Ticket.json +2636 -0
  366. package/source/openapi-specifications/v1.0/portal/TicketComment.json +822 -0
  367. package/source/openapi-specifications/v1.0/portal/TicketCount.json +336 -0
  368. package/source/openapi-specifications/v1.0/portal/TicketExport.json +609 -0
  369. package/source/openapi-specifications/v1.0/portal/TicketField.json +358 -0
  370. package/source/openapi-specifications/v1.0/portal/TicketForm.json +517 -0
  371. package/source/openapi-specifications/v1.0/portal/TicketStatusMapping.json +155 -0
  372. package/source/openapi-specifications/v1.0/portal/TicketTemplate.json +409 -0
  373. package/source/openapi-specifications/v1.0/portal/TicketsViewCount.json +175 -0
  374. package/source/openapi-specifications/v1.0/portal/Topic.json +4079 -0
  375. package/source/openapi-specifications/v1.0/portal/Translation.json +174 -0
  376. package/source/openapi-specifications/v1.0/portal/Upload.json +156 -0
  377. package/source/openapi-specifications/v1.0/portal/ValidationRules.json +309 -0
  378. package/source/openapi-specifications/v1.0/portal/View.json +353 -0
  379. package/source/openapi-specifications/v1.0/portal/Widget.json +218 -0
  380. package/source/openapi-specifications/v1.0/support/AEAdminTool.json +354 -0
  381. package/source/openapi-specifications/v1.0/support/Account.json +3206 -0
  382. package/source/openapi-specifications/v1.0/support/AccountAttachment.json +484 -0
  383. package/source/openapi-specifications/v1.0/support/AccountComments.json +794 -0
  384. package/source/openapi-specifications/v1.0/support/AccountContactMappingInfo.json +227 -0
  385. package/source/openapi-specifications/v1.0/support/AccountDeduplication.json +578 -0
  386. package/source/openapi-specifications/v1.0/support/AccountFollowers.json +350 -0
  387. package/source/openapi-specifications/v1.0/support/AccountSla.json +341 -0
  388. package/source/openapi-specifications/v1.0/support/AccountTimeEntry.json +1152 -0
  389. package/source/openapi-specifications/v1.0/support/ActiveCalls.json +573 -0
  390. package/source/openapi-specifications/v1.0/support/Activity.json +1400 -0
  391. package/source/openapi-specifications/v1.0/support/Actor.json +88 -0
  392. package/source/openapi-specifications/v1.0/support/ActorsAPI.json +304 -0
  393. package/source/openapi-specifications/v1.0/support/AdminTool.json +489 -0
  394. package/source/openapi-specifications/v1.0/support/Agent.json +6685 -0
  395. package/source/openapi-specifications/v1.0/support/AgentPresence.json +567 -0
  396. package/source/openapi-specifications/v1.0/support/AgentRoom.json +1997 -0
  397. package/source/openapi-specifications/v1.0/support/AgentSignatures.json +359 -0
  398. package/source/openapi-specifications/v1.0/support/AgentTimeEntry.json +1402 -0
  399. package/source/openapi-specifications/v1.0/support/AntiSpamInfo.json +510 -0
  400. package/source/openapi-specifications/v1.0/support/ApiCreditNotificationRule.json +1189 -0
  401. package/source/openapi-specifications/v1.0/support/ApiDashboard.json +543 -0
  402. package/source/openapi-specifications/v1.0/support/ApplicationFlags.json +155 -0
  403. package/source/openapi-specifications/v1.0/support/ArchivedView.json +469 -0
  404. package/source/openapi-specifications/v1.0/support/Article.json +5060 -0
  405. package/source/openapi-specifications/v1.0/support/ArticleAttachment.json +544 -0
  406. package/source/openapi-specifications/v1.0/support/ArticleComment.json +1929 -0
  407. package/source/openapi-specifications/v1.0/support/ArticleExternalImageUrlResponse.json +56 -0
  408. package/source/openapi-specifications/v1.0/support/ArticleFeedback.json +1314 -0
  409. package/source/openapi-specifications/v1.0/support/ArticleFeedbackResolution.json +513 -0
  410. package/source/openapi-specifications/v1.0/support/ArticleHistory.json +2510 -0
  411. package/source/openapi-specifications/v1.0/support/ArticleStatistics.json +3053 -0
  412. package/source/openapi-specifications/v1.0/support/ArticleTranslation.json +7530 -0
  413. package/source/openapi-specifications/v1.0/support/ArticleVersion.json +184 -0
  414. package/source/openapi-specifications/v1.0/support/ArticleViews.json +564 -0
  415. package/source/openapi-specifications/v1.0/support/Asap.json +1525 -0
  416. package/source/openapi-specifications/v1.0/support/AsapModule.json +246 -0
  417. package/source/openapi-specifications/v1.0/support/AsapStatus.json +199 -0
  418. package/source/openapi-specifications/v1.0/support/AssistInteg.json +613 -0
  419. package/source/openapi-specifications/v1.0/support/AttachmentRestriction.json +786 -0
  420. package/source/openapi-specifications/v1.0/support/AuditLog.json +1122 -0
  421. package/source/openapi-specifications/v1.0/support/AutomatedSummaryForChats.json +702 -0
  422. package/source/openapi-specifications/v1.0/support/AutomationAlerts.json +868 -0
  423. package/source/openapi-specifications/v1.0/support/AutomationEngine.json +1181 -0
  424. package/source/openapi-specifications/v1.0/support/AutomationFeatureCount.json +207 -0
  425. package/source/openapi-specifications/v1.0/support/AutomationFieldUpdates.json +809 -0
  426. package/source/openapi-specifications/v1.0/support/AutomationTask.json +1054 -0
  427. package/source/openapi-specifications/v1.0/support/Backup.json +2845 -0
  428. package/source/openapi-specifications/v1.0/support/Badge.json +544 -0
  429. package/source/openapi-specifications/v1.0/support/Bot.json +2103 -0
  430. package/source/openapi-specifications/v1.0/support/BotInference.json +1071 -0
  431. package/source/openapi-specifications/v1.0/support/BotResources.json +175 -0
  432. package/source/openapi-specifications/v1.0/support/BotStaticResources.json +541 -0
  433. package/source/openapi-specifications/v1.0/support/Bot_UserInfo.json +63 -0
  434. package/source/openapi-specifications/v1.0/support/Bots.json +58 -0
  435. package/source/openapi-specifications/v1.0/support/BugInteg.json +481 -0
  436. package/source/openapi-specifications/v1.0/support/BulkAction.json +150 -0
  437. package/source/openapi-specifications/v1.0/support/BulkImport.json +2845 -0
  438. package/source/openapi-specifications/v1.0/support/BulkUpdate.json +743 -0
  439. package/source/openapi-specifications/v1.0/support/BulkWrite.json +678 -0
  440. package/source/openapi-specifications/v1.0/support/BusinessHour.json +1344 -0
  441. package/source/openapi-specifications/v1.0/support/Call.json +3839 -0
  442. package/source/openapi-specifications/v1.0/support/CallComments.json +721 -0
  443. package/source/openapi-specifications/v1.0/support/CallHistory.json +936 -0
  444. package/source/openapi-specifications/v1.0/support/CallTimeEntry.json +1745 -0
  445. package/source/openapi-specifications/v1.0/support/CallTimer.json +285 -0
  446. package/source/openapi-specifications/v1.0/support/Channel.json +730 -0
  447. package/source/openapi-specifications/v1.0/support/Chart.json +422 -0
  448. package/source/openapi-specifications/v1.0/support/ChatTicket.json +553 -0
  449. package/source/openapi-specifications/v1.0/support/ClientAction.json +1834 -0
  450. package/source/openapi-specifications/v1.0/support/ClientEvent.json +780 -0
  451. package/source/openapi-specifications/v1.0/support/CliqIntegJsonMapping.json +1123 -0
  452. package/source/openapi-specifications/v1.0/support/CloudAttachment.json +528 -0
  453. package/source/openapi-specifications/v1.0/support/CommonMassActionError.json +44 -0
  454. package/source/openapi-specifications/v1.0/support/CommonMassActionResponse.json +94 -0
  455. package/source/openapi-specifications/v1.0/support/Community.json +2545 -0
  456. package/source/openapi-specifications/v1.0/support/CommunityAttachment.json +249 -0
  457. package/source/openapi-specifications/v1.0/support/CommunityCategory.json +1896 -0
  458. package/source/openapi-specifications/v1.0/support/CommunityCategoryLogo.json +145 -0
  459. package/source/openapi-specifications/v1.0/support/CommunityComment.json +2492 -0
  460. package/source/openapi-specifications/v1.0/support/CommunityInitPermissions.json +129 -0
  461. package/source/openapi-specifications/v1.0/support/CommunityPreferences.json +343 -0
  462. package/source/openapi-specifications/v1.0/support/CommunitySearch.json +78 -0
  463. package/source/openapi-specifications/v1.0/support/CommunityTopic.json +6005 -0
  464. package/source/openapi-specifications/v1.0/support/CommunityTopicInsights.json +310 -0
  465. package/source/openapi-specifications/v1.0/support/CommunityUser.json +822 -0
  466. package/source/openapi-specifications/v1.0/support/Composite.json +414 -0
  467. package/source/openapi-specifications/v1.0/support/Contact.json +4691 -0
  468. package/source/openapi-specifications/v1.0/support/ContactAttachment.json +484 -0
  469. package/source/openapi-specifications/v1.0/support/ContactComments.json +769 -0
  470. package/source/openapi-specifications/v1.0/support/ContactDeduplication.json +683 -0
  471. package/source/openapi-specifications/v1.0/support/ContactFollowers.json +350 -0
  472. package/source/openapi-specifications/v1.0/support/ContactProfile.json +195 -0
  473. package/source/openapi-specifications/v1.0/support/ContactTimeEntry.json +1157 -0
  474. package/source/openapi-specifications/v1.0/support/Contract.json +2877 -0
  475. package/source/openapi-specifications/v1.0/support/ContractAttachment.json +307 -0
  476. package/source/openapi-specifications/v1.0/support/Conversation.json +570 -0
  477. package/source/openapi-specifications/v1.0/support/CountriesAndLanguages.json +5279 -0
  478. package/source/openapi-specifications/v1.0/support/CreditCycle.json +124 -0
  479. package/source/openapi-specifications/v1.0/support/Criteria.json +1014 -0
  480. package/source/openapi-specifications/v1.0/support/CriteriaValue.json +50 -0
  481. package/source/openapi-specifications/v1.0/support/CrmInteg.json +5938 -0
  482. package/source/openapi-specifications/v1.0/support/CustomAction.json +2106 -0
  483. package/source/openapi-specifications/v1.0/support/CustomActionRuleMapping.json +1327 -0
  484. package/source/openapi-specifications/v1.0/support/CustomButton.json +1898 -0
  485. package/source/openapi-specifications/v1.0/support/CustomFunctionExecutionLogs.json +883 -0
  486. package/source/openapi-specifications/v1.0/support/CustomFunctionGallery.json +329 -0
  487. package/source/openapi-specifications/v1.0/support/CustomFunctionReRun.json +317 -0
  488. package/source/openapi-specifications/v1.0/support/CustomFunctionZiaCopilot.json +379 -0
  489. package/source/openapi-specifications/v1.0/support/CustomFunctions.json +3457 -0
  490. package/source/openapi-specifications/v1.0/support/CustomModuleAdminTool.json +81 -0
  491. package/source/openapi-specifications/v1.0/support/CustomTheme.json +7391 -0
  492. package/source/openapi-specifications/v1.0/support/CustomView.json +3478 -0
  493. package/source/openapi-specifications/v1.0/support/CustomerHappiness.json +464 -0
  494. package/source/openapi-specifications/v1.0/support/DBThrottle.json +334 -0
  495. package/source/openapi-specifications/v1.0/support/DashboardComponent.json +1163 -0
  496. package/source/openapi-specifications/v1.0/support/DashboardFolder.json +1258 -0
  497. package/source/openapi-specifications/v1.0/support/DashboardMetrics.json +2310 -0
  498. package/source/openapi-specifications/v1.0/support/Dashboards.json +1219 -0
  499. package/source/openapi-specifications/v1.0/support/DataChips.json +477 -0
  500. package/source/openapi-specifications/v1.0/support/DataImport.json +1099 -0
  501. package/source/openapi-specifications/v1.0/support/DataSync.json +1246 -0
  502. package/source/openapi-specifications/v1.0/support/DatasetEntry.json +153 -0
  503. package/source/openapi-specifications/v1.0/support/Department.json +1971 -0
  504. package/source/openapi-specifications/v1.0/support/DependencyMappings.json +656 -0
  505. package/source/openapi-specifications/v1.0/support/DirectAssignRuleTarget.json +232 -0
  506. package/source/openapi-specifications/v1.0/support/DirectAssignmentRules.json +722 -0
  507. package/source/openapi-specifications/v1.0/support/DisplayEntity.json +91 -0
  508. package/source/openapi-specifications/v1.0/support/DomainMapping.json +1143 -0
  509. package/source/openapi-specifications/v1.0/support/EmailFailureAlert.json +306 -0
  510. package/source/openapi-specifications/v1.0/support/EmailTemplates.json +1491 -0
  511. package/source/openapi-specifications/v1.0/support/EntityBlueprints.json +572 -0
  512. package/source/openapi-specifications/v1.0/support/Event.json +3607 -0
  513. package/source/openapi-specifications/v1.0/support/EventComments.json +737 -0
  514. package/source/openapi-specifications/v1.0/support/EventTimeEntry.json +1520 -0
  515. package/source/openapi-specifications/v1.0/support/EventTimer.json +285 -0
  516. package/source/openapi-specifications/v1.0/support/Expression.json +43 -0
  517. package/source/openapi-specifications/v1.0/support/Extension.json +7152 -0
  518. package/source/openapi-specifications/v1.0/support/ExtensionOrg.json +129 -0
  519. package/source/openapi-specifications/v1.0/support/FAQ.json +142 -0
  520. package/source/openapi-specifications/v1.0/support/FAQTranslation.json +178 -0
  521. package/source/openapi-specifications/v1.0/support/FbManager.json +1147 -0
  522. package/source/openapi-specifications/v1.0/support/Feature.json +691 -0
  523. package/source/openapi-specifications/v1.0/support/FeatureFile.json +435 -0
  524. package/source/openapi-specifications/v1.0/support/FeatureFolder.json +576 -0
  525. package/source/openapi-specifications/v1.0/support/FeaturePermission.json +492 -0
  526. package/source/openapi-specifications/v1.0/support/FederatedLogin.json +318 -0
  527. package/source/openapi-specifications/v1.0/support/FeedsAPIs.json +198 -0
  528. package/source/openapi-specifications/v1.0/support/Field.json +7493 -0
  529. package/source/openapi-specifications/v1.0/support/FieldDetails.json +139 -0
  530. package/source/openapi-specifications/v1.0/support/FieldPermissions.json +113 -0
  531. package/source/openapi-specifications/v1.0/support/FieldPrediction.json +3831 -0
  532. package/source/openapi-specifications/v1.0/support/FileExport.json +324 -0
  533. package/source/openapi-specifications/v1.0/support/Finance.json +4290 -0
  534. package/source/openapi-specifications/v1.0/support/Followers.json +875 -0
  535. package/source/openapi-specifications/v1.0/support/FormulaFunctions.json +47 -0
  536. package/source/openapi-specifications/v1.0/support/GC_Bots.json +138 -0
  537. package/source/openapi-specifications/v1.0/support/GC_Guide.json +1536 -0
  538. package/source/openapi-specifications/v1.0/support/GC_GuideHistories.json +58 -0
  539. package/source/openapi-specifications/v1.0/support/GC_GuideHistory.json +79 -0
  540. package/source/openapi-specifications/v1.0/support/GC_Guides.json +89 -0
  541. package/source/openapi-specifications/v1.0/support/GC_Info.json +208 -0
  542. package/source/openapi-specifications/v1.0/support/GC_Status.json +69 -0
  543. package/source/openapi-specifications/v1.0/support/GC_UserInfo.json +79 -0
  544. package/source/openapi-specifications/v1.0/support/GenericAction.json +1888 -0
  545. package/source/openapi-specifications/v1.0/support/GenericActionMapping.json +1050 -0
  546. package/source/openapi-specifications/v1.0/support/GoogleAnalytics.json +1715 -0
  547. package/source/openapi-specifications/v1.0/support/GoogleChat.json +650 -0
  548. package/source/openapi-specifications/v1.0/support/HelpCenterCommon.json +44 -0
  549. package/source/openapi-specifications/v1.0/support/Help_Center_OIDC_Authentication.json +900 -0
  550. package/source/openapi-specifications/v1.0/support/Helpcenter.json +1212 -0
  551. package/source/openapi-specifications/v1.0/support/HelpcenterAutoTranslateSetting.json +331 -0
  552. package/source/openapi-specifications/v1.0/support/HelpcenterGroups.json +1496 -0
  553. package/source/openapi-specifications/v1.0/support/HelpcenterPages.json +504 -0
  554. package/source/openapi-specifications/v1.0/support/HelpcenterPreference.json +208 -0
  555. package/source/openapi-specifications/v1.0/support/HelpcenterTranslationApp.json +64 -0
  556. package/source/openapi-specifications/v1.0/support/HelpcenterUpload.json +211 -0
  557. package/source/openapi-specifications/v1.0/support/HolidayList.json +731 -0
  558. package/source/openapi-specifications/v1.0/support/IMAPAddress.json +1091 -0
  559. package/source/openapi-specifications/v1.0/support/IMCannedMessage.json +1357 -0
  560. package/source/openapi-specifications/v1.0/support/IMCannedMessagePlaceHolders.json +169 -0
  561. package/source/openapi-specifications/v1.0/support/IMCannedMessageTranslation.json +624 -0
  562. package/source/openapi-specifications/v1.0/support/IMTemplateMessage.json +597 -0
  563. package/source/openapi-specifications/v1.0/support/IM_AddOn.json +841 -0
  564. package/source/openapi-specifications/v1.0/support/IM_AttachmentMessage.json +64 -0
  565. package/source/openapi-specifications/v1.0/support/IM_Bot.json +1007 -0
  566. package/source/openapi-specifications/v1.0/support/IM_BotService.json +357 -0
  567. package/source/openapi-specifications/v1.0/support/IM_Broadcast.json +323 -0
  568. package/source/openapi-specifications/v1.0/support/IM_Channel.json +2849 -0
  569. package/source/openapi-specifications/v1.0/support/IM_ChannelPreference.json +502 -0
  570. package/source/openapi-specifications/v1.0/support/IM_Contact.json +165 -0
  571. package/source/openapi-specifications/v1.0/support/IM_Efc.json +188 -0
  572. package/source/openapi-specifications/v1.0/support/IM_Integration.json +1269 -0
  573. package/source/openapi-specifications/v1.0/support/IM_IntegrationService.json +454 -0
  574. package/source/openapi-specifications/v1.0/support/IM_LayoutView.json +625 -0
  575. package/source/openapi-specifications/v1.0/support/IM_License.json +225 -0
  576. package/source/openapi-specifications/v1.0/support/IM_Message.json +1371 -0
  577. package/source/openapi-specifications/v1.0/support/IM_Metrics.json +462 -0
  578. package/source/openapi-specifications/v1.0/support/IM_Search.json +547 -0
  579. package/source/openapi-specifications/v1.0/support/IM_Session.json +1397 -0
  580. package/source/openapi-specifications/v1.0/support/IM_TemplateButton.json +142 -0
  581. package/source/openapi-specifications/v1.0/support/IM_TemplateFooter.json +83 -0
  582. package/source/openapi-specifications/v1.0/support/IM_TemplateHeader.json +86 -0
  583. package/source/openapi-specifications/v1.0/support/IM_TemplateItems.json +73 -0
  584. package/source/openapi-specifications/v1.0/support/IM_TimeSeriesMetrics.json +435 -0
  585. package/source/openapi-specifications/v1.0/support/IM_TwilioPhoneNumber.json +202 -0
  586. package/source/openapi-specifications/v1.0/support/IM_WhatsApp_Integrations.json +193 -0
  587. package/source/openapi-specifications/v1.0/support/IM_ZiaGpt.json +489 -0
  588. package/source/openapi-specifications/v1.0/support/Import.json +1844 -0
  589. package/source/openapi-specifications/v1.0/support/IncrementalDocuments.json +395 -0
  590. package/source/openapi-specifications/v1.0/support/Inference.json +307 -0
  591. package/source/openapi-specifications/v1.0/support/InlineImage.json +97 -0
  592. package/source/openapi-specifications/v1.0/support/IntegModule.json +938 -0
  593. package/source/openapi-specifications/v1.0/support/Integrations.json +1264 -0
  594. package/source/openapi-specifications/v1.0/support/InteractiveTours.json +539 -0
  595. package/source/openapi-specifications/v1.0/support/JWT.json +535 -0
  596. package/source/openapi-specifications/v1.0/support/KBCategoryPermalink.json +208 -0
  597. package/source/openapi-specifications/v1.0/support/KBCategoryUser.json +241 -0
  598. package/source/openapi-specifications/v1.0/support/KBPreference.json +323 -0
  599. package/source/openapi-specifications/v1.0/support/KBRecycleBin.json +2316 -0
  600. package/source/openapi-specifications/v1.0/support/KBRootCategory.json +2839 -0
  601. package/source/openapi-specifications/v1.0/support/KBRootCategoryTranslation.json +570 -0
  602. package/source/openapi-specifications/v1.0/support/KBSection.json +1941 -0
  603. package/source/openapi-specifications/v1.0/support/KBTranslationMassActionResponse.json +169 -0
  604. package/source/openapi-specifications/v1.0/support/KPIWidget.json +206 -0
  605. package/source/openapi-specifications/v1.0/support/KbBot.json +511 -0
  606. package/source/openapi-specifications/v1.0/support/KbCategory.json +1618 -0
  607. package/source/openapi-specifications/v1.0/support/KbCategoryLogo.json +124 -0
  608. package/source/openapi-specifications/v1.0/support/Label.json +1251 -0
  609. package/source/openapi-specifications/v1.0/support/Layout.json +8042 -0
  610. package/source/openapi-specifications/v1.0/support/LayoutRuleCriteria.json +491 -0
  611. package/source/openapi-specifications/v1.0/support/LayoutRules.json +1422 -0
  612. package/source/openapi-specifications/v1.0/support/LensInteg.json +86 -0
  613. package/source/openapi-specifications/v1.0/support/LicenseFeaturePlan.json +548 -0
  614. package/source/openapi-specifications/v1.0/support/LicenseInfo.json +1231 -0
  615. package/source/openapi-specifications/v1.0/support/LicenseTool.json +165 -0
  616. package/source/openapi-specifications/v1.0/support/Livecall.json +954 -0
  617. package/source/openapi-specifications/v1.0/support/LookupRecord.json +174 -0
  618. package/source/openapi-specifications/v1.0/support/Macros.json +1960 -0
  619. package/source/openapi-specifications/v1.0/support/MailReplyAddress.json +1263 -0
  620. package/source/openapi-specifications/v1.0/support/MassAction.json +1151 -0
  621. package/source/openapi-specifications/v1.0/support/MassActionError.json +55 -0
  622. package/source/openapi-specifications/v1.0/support/MassActionResponse.json +89 -0
  623. package/source/openapi-specifications/v1.0/support/Mentions.json +491 -0
  624. package/source/openapi-specifications/v1.0/support/Message.json +685 -0
  625. package/source/openapi-specifications/v1.0/support/Microsoft.json +887 -0
  626. package/source/openapi-specifications/v1.0/support/MicrosoftTeams.json +574 -0
  627. package/source/openapi-specifications/v1.0/support/Microsoft_PowerBI.json +903 -0
  628. package/source/openapi-specifications/v1.0/support/Misc.json +214 -0
  629. package/source/openapi-specifications/v1.0/support/Module.json +1625 -0
  630. package/source/openapi-specifications/v1.0/support/NewCriteria.json +1863 -0
  631. package/source/openapi-specifications/v1.0/support/NewFeatureFields.json +204 -0
  632. package/source/openapi-specifications/v1.0/support/NewTicketHistory.json +150 -0
  633. package/source/openapi-specifications/v1.0/support/NotificationRules.json +441 -0
  634. package/source/openapi-specifications/v1.0/support/OEmbedData.json +233 -0
  635. package/source/openapi-specifications/v1.0/support/Onboarding.json +282 -0
  636. package/source/openapi-specifications/v1.0/support/Organization.json +1391 -0
  637. package/source/openapi-specifications/v1.0/support/PBGroup.json +634 -0
  638. package/source/openapi-specifications/v1.0/support/PBGroupAgents.json +433 -0
  639. package/source/openapi-specifications/v1.0/support/PBPlatform.json +1447 -0
  640. package/source/openapi-specifications/v1.0/support/PBX.json +550 -0
  641. package/source/openapi-specifications/v1.0/support/PBXConfig.json +219 -0
  642. package/source/openapi-specifications/v1.0/support/PBXPhoneNumbers.json +443 -0
  643. package/source/openapi-specifications/v1.0/support/PBXPreference.json +314 -0
  644. package/source/openapi-specifications/v1.0/support/PageSense.json +1505 -0
  645. package/source/openapi-specifications/v1.0/support/PendingApproval.json +279 -0
  646. package/source/openapi-specifications/v1.0/support/Permalink.json +393 -0
  647. package/source/openapi-specifications/v1.0/support/PhoneAgents.json +1014 -0
  648. package/source/openapi-specifications/v1.0/support/PhoneMenu.json +118 -0
  649. package/source/openapi-specifications/v1.0/support/PinnedConversation.json +1115 -0
  650. package/source/openapi-specifications/v1.0/support/Pipeline_Info.json +232 -0
  651. package/source/openapi-specifications/v1.0/support/Pipeline_Service.json +499 -0
  652. package/source/openapi-specifications/v1.0/support/Product.json +1861 -0
  653. package/source/openapi-specifications/v1.0/support/ProductAttachment.json +485 -0
  654. package/source/openapi-specifications/v1.0/support/Profile.json +4236 -0
  655. package/source/openapi-specifications/v1.0/support/ProjectsInteg.json +989 -0
  656. package/source/openapi-specifications/v1.0/support/QueryStore.json +238 -0
  657. package/source/openapi-specifications/v1.0/support/QueueView.json +335 -0
  658. package/source/openapi-specifications/v1.0/support/RatelimitAdminTool.json +1204 -0
  659. package/source/openapi-specifications/v1.0/support/Records.json +1509 -0
  660. package/source/openapi-specifications/v1.0/support/Recyclebin.json +669 -0
  661. package/source/openapi-specifications/v1.0/support/RemoteAuth.json +401 -0
  662. package/source/openapi-specifications/v1.0/support/Report.json +6491 -0
  663. package/source/openapi-specifications/v1.0/support/ReportChart.json +254 -0
  664. package/source/openapi-specifications/v1.0/support/ReportFolder.json +1076 -0
  665. package/source/openapi-specifications/v1.0/support/ReportIntegration.json +202 -0
  666. package/source/openapi-specifications/v1.0/support/RequestFlags.json +358 -0
  667. package/source/openapi-specifications/v1.0/support/Resources.json +335 -0
  668. package/source/openapi-specifications/v1.0/support/ResponseHelpCenterUser.json +128 -0
  669. package/source/openapi-specifications/v1.0/support/Role.json +996 -0
  670. package/source/openapi-specifications/v1.0/support/RoundRobin.json +796 -0
  671. package/source/openapi-specifications/v1.0/support/RoundRobinTarget.json +381 -0
  672. package/source/openapi-specifications/v1.0/support/RoutingPreference.json +615 -0
  673. package/source/openapi-specifications/v1.0/support/RuleGroup.json +1630 -0
  674. package/source/openapi-specifications/v1.0/support/SLAMetaInfo.json +227 -0
  675. package/source/openapi-specifications/v1.0/support/Saml.json +565 -0
  676. package/source/openapi-specifications/v1.0/support/Sandbox.json +1075 -0
  677. package/source/openapi-specifications/v1.0/support/SandboxChangeset.json +501 -0
  678. package/source/openapi-specifications/v1.0/support/SandboxDeployment.json +428 -0
  679. package/source/openapi-specifications/v1.0/support/SandboxDeploymentLogs.json +295 -0
  680. package/source/openapi-specifications/v1.0/support/SandboxSourceOrganization.json +268 -0
  681. package/source/openapi-specifications/v1.0/support/SavedFilters.json +652 -0
  682. package/source/openapi-specifications/v1.0/support/Schedule.json +2077 -0
  683. package/source/openapi-specifications/v1.0/support/ScheduleReplyInfo.json +2271 -0
  684. package/source/openapi-specifications/v1.0/support/Search.json +12600 -0
  685. package/source/openapi-specifications/v1.0/support/SearchInteg.json +2254 -0
  686. package/source/openapi-specifications/v1.0/support/Setup.json +1766 -0
  687. package/source/openapi-specifications/v1.0/support/SharedSnippet.json +1110 -0
  688. package/source/openapi-specifications/v1.0/support/SharingRule.json +287 -0
  689. package/source/openapi-specifications/v1.0/support/Signature.json +354 -0
  690. package/source/openapi-specifications/v1.0/support/Skill.json +2164 -0
  691. package/source/openapi-specifications/v1.0/support/SkillConfiguration.json +269 -0
  692. package/source/openapi-specifications/v1.0/support/SkillType.json +807 -0
  693. package/source/openapi-specifications/v1.0/support/Slack.json +957 -0
  694. package/source/openapi-specifications/v1.0/support/SmsTemplates.json +514 -0
  695. package/source/openapi-specifications/v1.0/support/Snippets.json +918 -0
  696. package/source/openapi-specifications/v1.0/support/SocialBrands.json +427 -0
  697. package/source/openapi-specifications/v1.0/support/SocialInteg.json +336 -0
  698. package/source/openapi-specifications/v1.0/support/SocialPosts.json +2460 -0
  699. package/source/openapi-specifications/v1.0/support/SocialTwitterConversations.json +337 -0
  700. package/source/openapi-specifications/v1.0/support/StarredTemplates.json +690 -0
  701. package/source/openapi-specifications/v1.0/support/Statistics.json +125 -0
  702. package/source/openapi-specifications/v1.0/support/SubjectAccessRequest.json +2419 -0
  703. package/source/openapi-specifications/v1.0/support/Supervise.json +774 -0
  704. package/source/openapi-specifications/v1.0/support/SupportEmailAddress.json +188 -0
  705. package/source/openapi-specifications/v1.0/support/SupportEmailDomain.json +293 -0
  706. package/source/openapi-specifications/v1.0/support/SupportPlan.json +1109 -0
  707. package/source/openapi-specifications/v1.0/support/Tab.json +606 -0
  708. package/source/openapi-specifications/v1.0/support/Target.json +1311 -0
  709. package/source/openapi-specifications/v1.0/support/TargetFunctions.json +130 -0
  710. package/source/openapi-specifications/v1.0/support/Task.json +4006 -0
  711. package/source/openapi-specifications/v1.0/support/TaskAttachment.json +443 -0
  712. package/source/openapi-specifications/v1.0/support/TaskComments.json +706 -0
  713. package/source/openapi-specifications/v1.0/support/TaskTimeEntry.json +1756 -0
  714. package/source/openapi-specifications/v1.0/support/TaskTimer.json +441 -0
  715. package/source/openapi-specifications/v1.0/support/Team.json +1383 -0
  716. package/source/openapi-specifications/v1.0/support/TemplateFolders.json +1069 -0
  717. package/source/openapi-specifications/v1.0/support/Theme.json +152 -0
  718. package/source/openapi-specifications/v1.0/support/Thread.json +3545 -0
  719. package/source/openapi-specifications/v1.0/support/Ticket.json +9495 -0
  720. package/source/openapi-specifications/v1.0/support/TicketApprovals.json +855 -0
  721. package/source/openapi-specifications/v1.0/support/TicketAttachment.json +562 -0
  722. package/source/openapi-specifications/v1.0/support/TicketComment.json +1444 -0
  723. package/source/openapi-specifications/v1.0/support/TicketCount.json +690 -0
  724. package/source/openapi-specifications/v1.0/support/TicketFollowers.json +454 -0
  725. package/source/openapi-specifications/v1.0/support/TicketHistory.json +414 -0
  726. package/source/openapi-specifications/v1.0/support/TicketMetrics.json +369 -0
  727. package/source/openapi-specifications/v1.0/support/TicketRealTime.json +178 -0
  728. package/source/openapi-specifications/v1.0/support/TicketTag.json +1513 -0
  729. package/source/openapi-specifications/v1.0/support/TicketTemplate.json +907 -0
  730. package/source/openapi-specifications/v1.0/support/TicketTimeEntry.json +1681 -0
  731. package/source/openapi-specifications/v1.0/support/TicketTimer.json +1205 -0
  732. package/source/openapi-specifications/v1.0/support/TimeTracking.json +1212 -0
  733. package/source/openapi-specifications/v1.0/support/TrainingCourses.json +614 -0
  734. package/source/openapi-specifications/v1.0/support/TrainingIntegration.json +163 -0
  735. package/source/openapi-specifications/v1.0/support/TranslationLanguages.json +2772 -0
  736. package/source/openapi-specifications/v1.0/support/Upload.json +620 -0
  737. package/source/openapi-specifications/v1.0/support/User.json +1409 -0
  738. package/source/openapi-specifications/v1.0/support/UserAuthentication.json +617 -0
  739. package/source/openapi-specifications/v1.0/support/UserPresence.json +763 -0
  740. package/source/openapi-specifications/v1.0/support/ValidationRuleCriteria.json +107 -0
  741. package/source/openapi-specifications/v1.0/support/ValidationRules.json +1173 -0
  742. package/source/openapi-specifications/v1.0/support/Webhook.json +1330 -0
  743. package/source/openapi-specifications/v1.0/support/WhatsAppDetails.json +132 -0
  744. package/source/openapi-specifications/v1.0/support/WhatsAppMigration.json +143 -0
  745. package/source/openapi-specifications/v1.0/support/WhatsAppTemplateTags.json +132 -0
  746. package/source/openapi-specifications/v1.0/support/Widget.json +3023 -0
  747. package/source/openapi-specifications/v1.0/support/WmsDomain.json +104 -0
  748. package/source/openapi-specifications/v1.0/support/ZIAAnswerbotInference.json +756 -0
  749. package/source/openapi-specifications/v1.0/support/ZIADocumentData.json +989 -0
  750. package/source/openapi-specifications/v1.0/support/ZIASolutionService.json +135 -0
  751. package/source/openapi-specifications/v1.0/support/ZIAVectorSearch.json +376 -0
  752. package/source/openapi-specifications/v1.0/support/ZiaDCMigration.json +159 -0
  753. package/source/openapi-specifications/v1.0/support/ZiaGPT.json +3229 -0
  754. package/source/openapi-specifications/v1.0/support/ZiaScheduler.json +453 -0
  755. package/source/openapi-specifications/v1.0/support/Zwitch.json +1543 -0
  756. package/source/openapi-specifications/v1.0/support/blueprintChartData.json +201 -0
  757. package/source/openapi-specifications/v1.0/support/blueprintConnections.json +75 -0
  758. package/source/openapi-specifications/v1.0/support/blueprintCriteria.json +255 -0
  759. package/source/openapi-specifications/v1.0/support/blueprintDrafts.json +1677 -0
  760. package/source/openapi-specifications/v1.0/support/blueprintStates.json +284 -0
  761. package/source/openapi-specifications/v1.0/support/blueprintStrictModeConfig.json +91 -0
  762. package/source/openapi-specifications/v1.0/support/blueprintTransitions.json +1546 -0
  763. package/source/openapi-specifications/v1.0/support/blueprints.json +2992 -0
  764. package/source/openapi-specifications/v1.0/support/errors.json +80 -0
  765. package/source/openapi-specifications/v1.0/support/zlabsnlp.json +416 -0
  766. package/.github/agents/Generators.agent.md +0 -121
@@ -0,0 +1,1625 @@
1
+ {
2
+ "openapi" : "3.1.0",
3
+ "info" : {
4
+ "title" : "Module",
5
+ "version" : "1.0.0",
6
+ "x-clan-group" : "layouts",
7
+ "x-module-group" : "customModule"
8
+ },
9
+ "paths" : {
10
+ "/api/v1/organizationModules/{moduleId}" : {
11
+ "get" : {
12
+ "tags" : [ "Module" ],
13
+ "summary" : "Get Module",
14
+ "description" : "This API fetches a single Module",
15
+ "operationId" : "getModule",
16
+ "parameters" : [ {
17
+ "$ref" : "#/components/parameters/moduleId"
18
+ }, {
19
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
20
+ } ],
21
+ "responses" : {
22
+ "200" : {
23
+ "$ref" : "#/components/responses/moduleJsonIncludingCustomModule"
24
+ },
25
+ "422" : {
26
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
27
+ },
28
+ "500" : {
29
+ "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
30
+ },
31
+ "204" : {
32
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
33
+ },
34
+ "403" : {
35
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
36
+ }
37
+ },
38
+ "security" : [ {
39
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
40
+ }, {
41
+ "iam-oauth2-schema" : [ "Desk.settings.READ" ]
42
+ } ],
43
+ "x-audience" : [ "external-public" ],
44
+ "x-custom-url-attribute" : {
45
+ "security" : {
46
+ "throttle" : {
47
+ "inline" : [ {
48
+ "scope" : "APPSERVER",
49
+ "rules" : [ {
50
+ "duration" : 60000,
51
+ "lock-period" : 600000,
52
+ "threshold" : 30,
53
+ "hip" : false
54
+ } ],
55
+ "window" : "ROLLING",
56
+ "key" : "url.path+user.zuid"
57
+ } ]
58
+ },
59
+ "extraparams" : {
60
+ "disable" : true,
61
+ "ignore" : false
62
+ },
63
+ "authentication" : { }
64
+ },
65
+ "clan-group" : "layouts",
66
+ "apihash" : "3eeb223a7e5054901c55f450fb76722a",
67
+ "module-group" : "customModule",
68
+ "apimethod" : "com.zoho.support.restapi.ModuleService.getCustomModule"
69
+ }
70
+ },
71
+ "put" : {
72
+ "tags" : [ "Module" ],
73
+ "summary" : "Update Module",
74
+ "description" : "The API updates a Module.",
75
+ "operationId" : "updateModule",
76
+ "parameters" : [ {
77
+ "$ref" : "#/components/parameters/moduleId"
78
+ }, {
79
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
80
+ } ],
81
+ "requestBody" : {
82
+ "$ref" : "#/components/requestBodies/editRequestJson"
83
+ },
84
+ "responses" : {
85
+ "200" : {
86
+ "$ref" : "#/components/responses/moduleJsonIncludingCustomModule"
87
+ },
88
+ "422" : {
89
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
90
+ },
91
+ "500" : {
92
+ "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
93
+ },
94
+ "204" : {
95
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
96
+ },
97
+ "403" : {
98
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
99
+ }
100
+ },
101
+ "security" : [ {
102
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
103
+ }, {
104
+ "iam-oauth2-schema" : [ "Desk.settings.UPDATE" ]
105
+ } ],
106
+ "x-audience" : [ "external-public" ],
107
+ "x-custom-url-attribute" : {
108
+ "security" : {
109
+ "throttle" : {
110
+ "inline" : [ {
111
+ "scope" : "APPSERVER",
112
+ "rules" : [ {
113
+ "duration" : 60000,
114
+ "lock-period" : 600000,
115
+ "threshold" : 30,
116
+ "hip" : false
117
+ } ],
118
+ "window" : "ROLLING",
119
+ "key" : "url.path+user.zuid"
120
+ } ]
121
+ },
122
+ "extraparams" : {
123
+ "disable" : true,
124
+ "ignore" : false
125
+ },
126
+ "authentication" : { }
127
+ },
128
+ "clan-group" : "layouts",
129
+ "apihash" : "6eff0de6c4719e4e1a19926ca0ae34cc",
130
+ "module-group" : "customModule",
131
+ "apimethod" : "com.zoho.support.restapi.ModuleService.editModule"
132
+ }
133
+ }
134
+ },
135
+ "/api/v1/myAccessibleModules" : {
136
+ "get" : {
137
+ "tags" : [ "Module" ],
138
+ "summary" : "Get Modules Accessible To Current User Profile",
139
+ "description" : "The API fetches a list of modules that are accessible to the current user profile.",
140
+ "operationId" : "getMyModules",
141
+ "parameters" : [ {
142
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
143
+ } ],
144
+ "responses" : {
145
+ "200" : {
146
+ "$ref" : "#/components/responses/modulesResponse"
147
+ }
148
+ },
149
+ "security" : [ {
150
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
151
+ }, {
152
+ "iam-oauth2-schema" : [ "Desk.basic.READ" ]
153
+ } ],
154
+ "x-audience" : [ "external-public" ],
155
+ "x-custom-url-attribute" : {
156
+ "security" : {
157
+ "throttle" : {
158
+ "policy" : "ReadAPI_Standard_UserPolicy,IscSignatureCalls_OrgPolicy"
159
+ },
160
+ "extraparams" : {
161
+ "disable" : true,
162
+ "ignore" : false
163
+ },
164
+ "authentication" : {
165
+ "system-auth" : "optional",
166
+ "scoped-services" : [ "ZohoSupport" ]
167
+ }
168
+ },
169
+ "clan-group" : "layouts",
170
+ "apihash" : "465b89185cef6d26ada5e93b2f6f5637",
171
+ "module-group" : "layouts",
172
+ "apimethod" : "com.zoho.support.restapi.ModuleService.getMyModules"
173
+ }
174
+ }
175
+ },
176
+ "/api/v1/modules" : {
177
+ "get" : {
178
+ "tags" : [ "Module" ],
179
+ "summary" : "Get modules",
180
+ "description" : "The API fetches all the modules available in Zoho Desk. <br></br> <b> This API is <code>deprecated</code>, use <i>api/v1/organizationModules</i> api for fetching modules.</b>",
181
+ "operationId" : "getModulesDeprecated",
182
+ "parameters" : [ {
183
+ "$ref" : "#/components/parameters/featureFlags"
184
+ }, {
185
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
186
+ } ],
187
+ "responses" : {
188
+ "200" : {
189
+ "$ref" : "#/components/responses/getModulesResponse"
190
+ },
191
+ "500" : {
192
+ "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
193
+ }
194
+ },
195
+ "security" : [ {
196
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
197
+ }, {
198
+ "iam-oauth2-schema" : [ "Desk.basic.READ" ]
199
+ } ],
200
+ "x-audience" : [ "external-public" ],
201
+ "x-custom-url-attribute" : {
202
+ "security" : {
203
+ "throttle" : {
204
+ "policy" : "ReadAPI_Standard_UserPolicy,IscSignatureCalls_OrgPolicy"
205
+ },
206
+ "extraparams" : {
207
+ "disable" : true,
208
+ "ignore" : false
209
+ },
210
+ "authentication" : {
211
+ "system-auth" : "optional",
212
+ "scoped-services" : [ "ZohoSupport" ]
213
+ }
214
+ },
215
+ "clan-group" : "layouts",
216
+ "apihash" : "c04031bb62b1ff404826dfba59b64172",
217
+ "module-group" : "layouts",
218
+ "apimethod" : "com.zoho.support.restapi.ModuleService.getModules"
219
+ }
220
+ }
221
+ },
222
+ "/api/v1/organizationModules" : {
223
+ "get" : {
224
+ "tags" : [ "Module" ],
225
+ "summary" : "Get Modules",
226
+ "description" : "The API fetches all the modules.",
227
+ "operationId" : "getModules",
228
+ "parameters" : [ {
229
+ "name" : "moduleAPIname",
230
+ "in" : "query",
231
+ "description" : "Module apiName. You can pass multiple values by separating them with commas in the API request",
232
+ "required" : false,
233
+ "style" : "simple",
234
+ "explode" : true,
235
+ "schema" : {
236
+ "type" : [ "null", "array" ],
237
+ "description" : "Module apiName. You can pass multiple values by separating them with commas in the API request",
238
+ "items" : {
239
+ "type" : [ "string", "null" ],
240
+ "maxLength" : 100,
241
+ "minLength" : 0,
242
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+",
243
+ "x-custom-parameters-attributes" : [ false, false, false, "", false, "Module apiName. You can pass multiple values by separating them with commas in the API request", false, 10, ",", false, true, "0,5", false, false, "moduleAPIname" ]
244
+ },
245
+ "uniqueItems" : true,
246
+ "x-audience" : [ "company-internal" ]
247
+ }
248
+ }, {
249
+ "$ref" : "#/components/parameters/featureFlags"
250
+ }, {
251
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
252
+ } ],
253
+ "responses" : {
254
+ "500" : {
255
+ "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
256
+ },
257
+ "204" : {
258
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
259
+ },
260
+ "200" : {
261
+ "$ref" : "#/components/responses/getOrganizationModulesResponse"
262
+ }
263
+ },
264
+ "security" : [ {
265
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
266
+ }, {
267
+ "iam-oauth2-schema" : [ "Desk.settings.READ" ]
268
+ } ],
269
+ "x-audience" : [ "external-public" ],
270
+ "x-custom-url-attribute" : {
271
+ "security" : {
272
+ "throttle" : {
273
+ "inline" : [ {
274
+ "scope" : "APPSERVER",
275
+ "rules" : [ {
276
+ "duration" : 60000,
277
+ "lock-period" : 600000,
278
+ "threshold" : 30,
279
+ "hip" : false
280
+ } ],
281
+ "window" : "ROLLING",
282
+ "key" : "url.path+user.zuid"
283
+ } ]
284
+ },
285
+ "extraparams" : {
286
+ "disable" : true,
287
+ "ignore" : false
288
+ },
289
+ "authentication" : { }
290
+ },
291
+ "clan-group" : "layouts",
292
+ "apihash" : "1f932d37adecfcd056b261eb1b0ba3f0",
293
+ "module-group" : "customModule",
294
+ "apimethod" : "com.zoho.support.restapi.ModuleService.getOrganizationModules"
295
+ }
296
+ },
297
+ "post" : {
298
+ "tags" : [ "Module" ],
299
+ "summary" : "Create Module",
300
+ "description" : "The API creates a Custom Module. <a href='https://help.zoho.com/portal/en/kb/desk/customization/modules/articles/creating-custom-modules' target='_blank'>Custom Module</a> allows users to organize, store, and manage specific types of data tailored to meet unique business requirements.",
301
+ "operationId" : "createModule",
302
+ "parameters" : [ {
303
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
304
+ } ],
305
+ "requestBody" : {
306
+ "$ref" : "#/components/requestBodies/requestJson"
307
+ },
308
+ "responses" : {
309
+ "200" : {
310
+ "$ref" : "#/components/responses/moduleJsonIncludingCustomModule"
311
+ },
312
+ "422" : {
313
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
314
+ },
315
+ "500" : {
316
+ "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
317
+ },
318
+ "403" : {
319
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
320
+ }
321
+ },
322
+ "security" : [ {
323
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
324
+ }, {
325
+ "iam-oauth2-schema" : [ "Desk.settings.CREATE" ]
326
+ } ],
327
+ "x-audience" : [ "external-public" ],
328
+ "x-custom-url-attribute" : {
329
+ "security" : {
330
+ "throttle" : {
331
+ "inline" : [ {
332
+ "scope" : "APPSERVER",
333
+ "rules" : [ {
334
+ "duration" : 60000,
335
+ "lock-period" : 600000,
336
+ "threshold" : 30,
337
+ "hip" : false
338
+ } ],
339
+ "window" : "ROLLING",
340
+ "key" : "url.path+user.zuid"
341
+ } ]
342
+ },
343
+ "extraparams" : {
344
+ "disable" : true,
345
+ "ignore" : false
346
+ },
347
+ "authentication" : { }
348
+ },
349
+ "clan-group" : "layouts",
350
+ "apihash" : "5625b2d59224774e35d1bf0d3297fc0e",
351
+ "module-group" : "customModule",
352
+ "apimethod" : "com.zoho.support.restapi.ModuleService.createModule"
353
+ }
354
+ }
355
+ },
356
+ "/api/v1/{customModuleApiName}/count" : {
357
+ "get" : {
358
+ "tags" : [ "Module" ],
359
+ "summary" : "Get Custom Module Record Count ",
360
+ "description" : "This API fetches the number of records.",
361
+ "operationId" : "getCustomModuleRecordsCount",
362
+ "parameters" : [ {
363
+ "name" : "viewId",
364
+ "in" : "query",
365
+ "description" : "ID of the view from which the record count needs to be fetched.",
366
+ "required" : true,
367
+ "style" : "form",
368
+ "explode" : true,
369
+ "schema" : {
370
+ "type" : [ "string", "null", "integer" ],
371
+ "format" : "int64",
372
+ "description" : "ID of the view from which the record count needs to be fetched.",
373
+ "pattern" : "([0-9]+)"
374
+ }
375
+ }, {
376
+ "name" : "customModuleApiName",
377
+ "in" : "path",
378
+ "required" : true,
379
+ "style" : "simple",
380
+ "explode" : false,
381
+ "schema" : {
382
+ "type" : [ "string", "null" ],
383
+ "maxLength" : 100,
384
+ "minLength" : 0,
385
+ "pattern" : "(cm_[a-zA-Z0-9_]+)"
386
+ }
387
+ }, {
388
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
389
+ } ],
390
+ "responses" : {
391
+ "200" : {
392
+ "$ref" : "./Ticket.json#/components/responses/getRequestsCount"
393
+ },
394
+ "422" : {
395
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
396
+ },
397
+ "500" : {
398
+ "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
399
+ },
400
+ "403" : {
401
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
402
+ }
403
+ },
404
+ "security" : [ {
405
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
406
+ }, {
407
+ "iam-oauth2-schema" : [ "Desk.custommodule.READ" ]
408
+ } ],
409
+ "x-audience" : [ "external-public" ],
410
+ "x-custom-url-attribute" : {
411
+ "security" : {
412
+ "throttle" : {
413
+ "policy" : "ReadAPI_Lenient_UserPolicy"
414
+ },
415
+ "extraparams" : {
416
+ "disable" : true,
417
+ "ignore" : false
418
+ },
419
+ "authentication" : { }
420
+ },
421
+ "clan-group" : "layouts",
422
+ "apihash" : "f943adfc7b5fab2593e29d0a679cf2ce",
423
+ "module-group" : "customModule",
424
+ "apimethod" : "com.zoho.support.restapi.RecordsCountService.getRecordsCountOld"
425
+ }
426
+ }
427
+ }
428
+ },
429
+ "components" : {
430
+ "schemas" : {
431
+ "modifierJson" : {
432
+ "type" : [ "null", "object" ],
433
+ "additionalProperties" : false,
434
+ "properties" : {
435
+ "photoURL" : {
436
+ "type" : [ "string", "null" ],
437
+ "maxLength" : 200,
438
+ "minLength" : 0,
439
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&amp;%\\$#_@]*)?$)"
440
+ },
441
+ "firstName" : {
442
+ "type" : [ "string", "null" ],
443
+ "maxLength" : 50,
444
+ "minLength" : 0
445
+ },
446
+ "lastName" : {
447
+ "type" : [ "string", "null" ],
448
+ "maxLength" : 50,
449
+ "minLength" : 0
450
+ },
451
+ "id" : {
452
+ "type" : [ "string", "null", "integer" ],
453
+ "format" : "int64",
454
+ "pattern" : "([0-9]+)"
455
+ },
456
+ "email" : {
457
+ "type" : [ "string", "null" ],
458
+ "maxLength" : 100,
459
+ "minLength" : 0,
460
+ "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$"
461
+ }
462
+ },
463
+ "required" : [ "email", "firstName", "id", "lastName", "photoURL" ]
464
+ },
465
+ "moduleJsonIncludingCustomModuleforList" : {
466
+ "type" : [ "null", "object" ],
467
+ "additionalProperties" : false,
468
+ "properties" : {
469
+ "displayLabel" : {
470
+ "type" : [ "string", "null" ],
471
+ "maxLength" : 100,
472
+ "minLength" : 0,
473
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
474
+ },
475
+ "modifiedTime" : {
476
+ "type" : [ "string", "null" ],
477
+ "maxLength" : 100,
478
+ "minLength" : 0,
479
+ "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
480
+ },
481
+ "apiName" : {
482
+ "type" : [ "string", "null" ],
483
+ "maxLength" : 100,
484
+ "minLength" : 0
485
+ },
486
+ "modifier" : {
487
+ "$ref" : "#/components/schemas/modifierJson"
488
+ },
489
+ "description" : {
490
+ "type" : [ "string", "null" ],
491
+ "maxLength" : 100,
492
+ "minLength" : 0
493
+ },
494
+ "nameField" : {
495
+ "type" : [ "string", "null" ],
496
+ "maxLength" : 100,
497
+ "minLength" : 0
498
+ },
499
+ "pluralLabel" : {
500
+ "type" : [ "string", "null" ],
501
+ "maxLength" : 100,
502
+ "minLength" : 0,
503
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
504
+ },
505
+ "singularLabel" : {
506
+ "type" : [ "string", "null" ],
507
+ "maxLength" : 100,
508
+ "minLength" : 0,
509
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
510
+ },
511
+ "hasRecycleBin" : {
512
+ "type" : [ "boolean", "null" ]
513
+ },
514
+ "createdBy" : {
515
+ "type" : [ "string", "null", "integer" ],
516
+ "format" : "int64",
517
+ "pattern" : "([0-9]+)"
518
+ },
519
+ "isCustomModule" : {
520
+ "type" : [ "boolean", "null" ]
521
+ },
522
+ "createdTime" : {
523
+ "type" : [ "string", "null" ],
524
+ "maxLength" : 100,
525
+ "minLength" : 0,
526
+ "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
527
+ },
528
+ "isDeptSpecific" : {
529
+ "type" : [ "boolean", "null" ]
530
+ },
531
+ "modifiedBy" : {
532
+ "type" : [ "string", "null", "integer" ],
533
+ "format" : "int64",
534
+ "pattern" : "([0-9]+)"
535
+ },
536
+ "id" : {
537
+ "type" : [ "string", "null", "integer" ],
538
+ "format" : "int64",
539
+ "pattern" : "([0-9]+)"
540
+ }
541
+ },
542
+ "required" : [ "apiName", "createdBy", "createdTime", "description", "displayLabel", "hasRecycleBin", "id", "isCustomModule", "isDeptSpecific", "modifiedBy", "modifiedTime", "modifier", "nameField", "pluralLabel", "singularLabel" ]
543
+ },
544
+ "moduleJson" : {
545
+ "type" : [ "null", "object" ],
546
+ "additionalProperties" : false,
547
+ "properties" : {
548
+ "displayLabel" : {
549
+ "type" : [ "string", "null" ],
550
+ "maxLength" : 100,
551
+ "minLength" : 0,
552
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
553
+ },
554
+ "apiKey" : {
555
+ "type" : [ "string", "null" ],
556
+ "maxLength" : 100,
557
+ "minLength" : 0,
558
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
559
+ },
560
+ "isEnabled" : {
561
+ "type" : [ "boolean", "null" ]
562
+ },
563
+ "nameField" : {
564
+ "type" : [ "string", "null" ],
565
+ "maxLength" : 100,
566
+ "minLength" : 0
567
+ },
568
+ "pluralLabel" : {
569
+ "type" : [ "string", "null" ],
570
+ "maxLength" : 100,
571
+ "minLength" : 0,
572
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
573
+ },
574
+ "id" : {
575
+ "type" : [ "string", "null", "integer" ],
576
+ "format" : "int64",
577
+ "pattern" : "([0-9]+)"
578
+ },
579
+ "singularLabel" : {
580
+ "type" : [ "string", "null" ],
581
+ "maxLength" : 100,
582
+ "minLength" : 0,
583
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
584
+ }
585
+ },
586
+ "required" : [ "apiKey", "displayLabel", "id", "isEnabled", "nameField", "pluralLabel", "singularLabel" ]
587
+ },
588
+ "listOfModules" : {
589
+ "type" : [ "null", "array" ],
590
+ "items" : {
591
+ "$ref" : "#/components/schemas/moduleJson"
592
+ }
593
+ },
594
+ "modulesWithNameFieldResponse" : {
595
+ "type" : [ "null", "object" ],
596
+ "additionalProperties" : false,
597
+ "properties" : {
598
+ "displayLabel" : {
599
+ "type" : [ "string", "null" ],
600
+ "maxLength" : 100,
601
+ "minLength" : 0,
602
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
603
+ },
604
+ "apiKey" : {
605
+ "type" : [ "string", "null" ],
606
+ "maxLength" : 100,
607
+ "minLength" : 0,
608
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
609
+ },
610
+ "isEnabled" : {
611
+ "type" : [ "boolean", "null" ]
612
+ },
613
+ "nameField" : {
614
+ "type" : [ "string", "null" ],
615
+ "maxLength" : 100,
616
+ "minLength" : 0
617
+ },
618
+ "isMigratedModule" : {
619
+ "type" : [ "boolean", "null" ]
620
+ },
621
+ "pluralLabel" : {
622
+ "type" : [ "string", "null" ],
623
+ "maxLength" : 100,
624
+ "minLength" : 0,
625
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
626
+ },
627
+ "id" : {
628
+ "type" : [ "string", "null", "integer" ],
629
+ "format" : "int64",
630
+ "pattern" : "([0-9]+)"
631
+ },
632
+ "singularLabel" : {
633
+ "type" : [ "string", "null" ],
634
+ "maxLength" : 100,
635
+ "minLength" : 0,
636
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
637
+ }
638
+ },
639
+ "required" : [ "apiKey", "displayLabel", "id", "isEnabled", "isMigratedModule", "nameField", "pluralLabel", "singularLabel" ]
640
+ },
641
+ "modulesWithNameField" : {
642
+ "type" : [ "null", "array" ],
643
+ "items" : {
644
+ "$ref" : "#/components/schemas/modulesWithNameFieldResponse"
645
+ }
646
+ },
647
+ "modulesWithCustomModuleJson" : {
648
+ "additionalProperties" : false,
649
+ "allOf" : [ {
650
+ "$ref" : "#/components/schemas/moduleJson"
651
+ }, {
652
+ "type" : [ "null", "object" ],
653
+ "properties" : {
654
+ "sanitizedName" : {
655
+ "type" : [ "string", "null" ],
656
+ "maxLength" : 100,
657
+ "minLength" : 0,
658
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
659
+ },
660
+ "isCustomModule" : {
661
+ "type" : [ "boolean", "null" ]
662
+ },
663
+ "singularI18NLabel" : {
664
+ "type" : [ "string", "null" ],
665
+ "maxLength" : 100,
666
+ "minLength" : 0,
667
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
668
+ },
669
+ "i18NLabel" : {
670
+ "type" : [ "string", "null" ],
671
+ "maxLength" : 100,
672
+ "minLength" : 0,
673
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
674
+ },
675
+ "isDeptSpecific" : {
676
+ "type" : [ "boolean", "null" ]
677
+ },
678
+ "isMigratedModule" : {
679
+ "type" : [ "boolean", "null" ]
680
+ }
681
+ },
682
+ "required" : [ "i18NLabel", "isCustomModule", "isDeptSpecific", "isMigratedModule", "sanitizedName", "singularI18NLabel" ]
683
+ } ]
684
+ },
685
+ "listOfModulesWithCustomModuleData" : {
686
+ "type" : [ "null", "array" ],
687
+ "items" : {
688
+ "$ref" : "#/components/schemas/modulesWithCustomModuleJson"
689
+ }
690
+ },
691
+ "listOfModulesIncludingCustomModule" : {
692
+ "type" : [ "null", "array" ],
693
+ "items" : {
694
+ "$ref" : "#/components/schemas/moduleJsonIncludingCustomModuleforList"
695
+ }
696
+ },
697
+ "custommoduleResponseWithNameField" : {
698
+ "type" : [ "null", "object" ],
699
+ "additionalProperties" : false,
700
+ "properties" : {
701
+ "displayLabel" : {
702
+ "type" : [ "string", "null" ],
703
+ "maxLength" : 100,
704
+ "minLength" : 0,
705
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
706
+ },
707
+ "modifiedTime" : {
708
+ "type" : [ "string", "null" ],
709
+ "maxLength" : 100,
710
+ "minLength" : 0,
711
+ "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
712
+ },
713
+ "apiName" : {
714
+ "type" : [ "string", "null" ],
715
+ "maxLength" : 100,
716
+ "minLength" : 0
717
+ },
718
+ "modifier" : {
719
+ "$ref" : "#/components/schemas/modifierJson"
720
+ },
721
+ "nameField" : {
722
+ "type" : [ "string", "null" ],
723
+ "maxLength" : 100,
724
+ "minLength" : 0
725
+ },
726
+ "description" : {
727
+ "type" : [ "string", "null" ],
728
+ "maxLength" : 100,
729
+ "minLength" : 0
730
+ },
731
+ "pluralLabel" : {
732
+ "type" : [ "string", "null" ],
733
+ "maxLength" : 100,
734
+ "minLength" : 0,
735
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
736
+ },
737
+ "singularLabel" : {
738
+ "type" : [ "string", "null" ],
739
+ "maxLength" : 100,
740
+ "minLength" : 0,
741
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
742
+ },
743
+ "hasRecycleBin" : {
744
+ "type" : [ "boolean", "null" ]
745
+ },
746
+ "createdBy" : {
747
+ "type" : [ "string", "null", "integer" ],
748
+ "format" : "int64",
749
+ "pattern" : "([0-9]+)"
750
+ },
751
+ "isCustomModule" : {
752
+ "type" : [ "boolean", "null" ]
753
+ },
754
+ "createdTime" : {
755
+ "type" : [ "string", "null" ],
756
+ "maxLength" : 100,
757
+ "minLength" : 0,
758
+ "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
759
+ },
760
+ "isDeptSpecific" : {
761
+ "type" : [ "boolean", "null" ]
762
+ },
763
+ "modifiedBy" : {
764
+ "type" : [ "string", "null", "integer" ],
765
+ "format" : "int64",
766
+ "pattern" : "([0-9]+)"
767
+ },
768
+ "id" : {
769
+ "type" : [ "string", "null", "integer" ],
770
+ "format" : "int64",
771
+ "pattern" : "([0-9]+)"
772
+ }
773
+ },
774
+ "required" : [ "apiName", "createdBy", "createdTime", "description", "displayLabel", "hasRecycleBin", "id", "isCustomModule", "isDeptSpecific", "modifiedBy", "modifiedTime", "modifier", "nameField", "pluralLabel", "singularLabel" ]
775
+ },
776
+ "organizationModuleArrayOfResponses" : {
777
+ "type" : [ "null", "array" ],
778
+ "items" : {
779
+ "$ref" : "#/components/schemas/custommoduleResponseWithNameField"
780
+ }
781
+ }
782
+ },
783
+ "responses" : {
784
+ "moduleJsonIncludingCustomModule" : {
785
+ "description" : "moduleJsonIncludingCustomModule template definitions",
786
+ "content" : {
787
+ "application/json" : {
788
+ "schema" : {
789
+ "additionalProperties" : false,
790
+ "allOf" : [ {
791
+ "$ref" : "#/components/schemas/moduleJsonIncludingCustomModuleforList"
792
+ }, {
793
+ "type" : [ "null", "object" ],
794
+ "properties" : {
795
+ "profileIds" : {
796
+ "type" : [ "null", "array" ],
797
+ "items" : {
798
+ "type" : [ "string", "null", "integer" ],
799
+ "format" : "int64",
800
+ "pattern" : "([0-9]+)",
801
+ "x-custom-parameters-attributes" : [ { } ]
802
+ },
803
+ "uniqueItems" : false
804
+ },
805
+ "departmentIds" : {
806
+ "type" : [ "null", "array" ],
807
+ "items" : {
808
+ "type" : [ "string", "null", "integer" ],
809
+ "format" : "int64",
810
+ "pattern" : "([0-9]+)",
811
+ "x-custom-parameters-attributes" : [ { } ]
812
+ },
813
+ "uniqueItems" : false
814
+ }
815
+ },
816
+ "required" : [ "departmentIds", "profileIds" ]
817
+ } ]
818
+ },
819
+ "examples" : {
820
+ "Valid responses Definitions" : {
821
+ "value" : {
822
+ "displayLabel" : "Doctors",
823
+ "modifiedTime" : 1713519302000,
824
+ "apiName" : "cm_doctors",
825
+ "modifier" : {
826
+ "firstName" : "",
827
+ "lastName" : "Kyle",
828
+ "photoURL" : "https://desk.zoho.com/api/v1/agents/4000000000329/photo?orgId=3981311",
829
+ "id" : "4000000000329",
830
+ "email" : "kyle@zylker.com"
831
+ },
832
+ "nameField" : "name",
833
+ "profileIds" : [ "1000000029530" ],
834
+ "description" : "Doctor informations",
835
+ "departmentIds" : [ "1000000774623", "1000000025632" ],
836
+ "pluralLabel" : "Doctors",
837
+ "singularLabel" : "Doctor",
838
+ "hasRecycleBin" : true,
839
+ "createdBy" : "1000000000375",
840
+ "isCustomModule" : true,
841
+ "createdTime" : 1713517457000,
842
+ "modifiedBy" : "1000000000375",
843
+ "isDeptSpecific" : true,
844
+ "id" : "1000003000001"
845
+ }
846
+ }
847
+ }
848
+ }
849
+ },
850
+ "x-custom-response-attributes" : {
851
+ "disable-safe-headers" : "[]"
852
+ }
853
+ },
854
+ "modulesResponse" : {
855
+ "description" : "modulesResponse template definitions",
856
+ "content" : {
857
+ "application/json" : {
858
+ "schema" : {
859
+ "type" : [ "null", "object" ],
860
+ "additionalProperties" : false,
861
+ "properties" : {
862
+ "modules" : {
863
+ "$ref" : "#/components/schemas/listOfModules"
864
+ }
865
+ },
866
+ "required" : [ "modules" ]
867
+ },
868
+ "examples" : {
869
+ "Valid responses Definitions" : {
870
+ "value" : {
871
+ "modules" : [ {
872
+ "displayLabel" : "Contracts",
873
+ "apiKey" : "contracts",
874
+ "isEnabled" : false,
875
+ "nameField" : null,
876
+ "id" : "1000000000485",
877
+ "pluralLabel" : "Contracts",
878
+ "singularLabel" : "Contract"
879
+ }, {
880
+ "displayLabel" : "Time Entry",
881
+ "apiKey" : "timeEntry",
882
+ "isEnabled" : false,
883
+ "nameField" : null,
884
+ "id" : "1000000000489",
885
+ "pluralLabel" : "Time Entry",
886
+ "singularLabel" : "Time Entry"
887
+ }, {
888
+ "displayLabel" : "Department",
889
+ "apiKey" : "departments",
890
+ "isEnabled" : false,
891
+ "nameField" : null,
892
+ "id" : "1000000000491",
893
+ "pluralLabel" : "Departments",
894
+ "singularLabel" : "Department"
895
+ }, {
896
+ "displayLabel" : "Agents",
897
+ "apiKey" : "agents",
898
+ "isEnabled" : false,
899
+ "nameField" : null,
900
+ "id" : "1000000000493",
901
+ "pluralLabel" : "Agents",
902
+ "singularLabel" : "Agent"
903
+ }, {
904
+ "displayLabel" : "Topics",
905
+ "apiKey" : "category",
906
+ "isEnabled" : false,
907
+ "nameField" : null,
908
+ "id" : "1000000000527",
909
+ "pluralLabel" : "Topics",
910
+ "singularLabel" : "Topic"
911
+ }, {
912
+ "displayLabel" : "Ticketss",
913
+ "apiKey" : "tickets",
914
+ "isEnabled" : true,
915
+ "nameField" : null,
916
+ "id" : "1000000000481",
917
+ "pluralLabel" : "Ticketss",
918
+ "singularLabel" : "Ticket"
919
+ }, {
920
+ "displayLabel" : "Reports",
921
+ "apiKey" : "reports",
922
+ "isEnabled" : true,
923
+ "nameField" : null,
924
+ "id" : "1000000000463",
925
+ "pluralLabel" : "Reports",
926
+ "singularLabel" : "Report"
927
+ }, {
928
+ "displayLabel" : "Dashboards",
929
+ "apiKey" : "dashboards",
930
+ "isEnabled" : true,
931
+ "nameField" : null,
932
+ "id" : "1000000000465",
933
+ "pluralLabel" : "Dashboards",
934
+ "singularLabel" : "Dashboard"
935
+ }, {
936
+ "displayLabel" : "Knowledge Base",
937
+ "apiKey" : "kbCategory",
938
+ "isEnabled" : true,
939
+ "nameField" : null,
940
+ "id" : "1000000000483",
941
+ "pluralLabel" : "Articles",
942
+ "singularLabel" : "Article"
943
+ }, {
944
+ "displayLabel" : "Contacts",
945
+ "apiKey" : "contacts",
946
+ "isEnabled" : true,
947
+ "nameField" : null,
948
+ "id" : "1000000000461",
949
+ "pluralLabel" : "Contacts",
950
+ "singularLabel" : "Contact"
951
+ }, {
952
+ "displayLabel" : "Products",
953
+ "apiKey" : "products",
954
+ "isEnabled" : true,
955
+ "nameField" : null,
956
+ "id" : "1000000000487",
957
+ "pluralLabel" : "Products",
958
+ "singularLabel" : "Product"
959
+ }, {
960
+ "displayLabel" : "Accounts",
961
+ "apiKey" : "accounts",
962
+ "isEnabled" : true,
963
+ "nameField" : null,
964
+ "id" : "1000000000459",
965
+ "pluralLabel" : "Accounts",
966
+ "singularLabel" : "Account"
967
+ }, {
968
+ "displayLabel" : "Community",
969
+ "apiKey" : "community",
970
+ "isEnabled" : true,
971
+ "nameField" : null,
972
+ "id" : "1000000000533",
973
+ "pluralLabel" : "Community",
974
+ "singularLabel" : "Community"
975
+ }, {
976
+ "displayLabel" : "Social",
977
+ "apiKey" : "social",
978
+ "isEnabled" : true,
979
+ "nameField" : null,
980
+ "id" : "1000000000535",
981
+ "pluralLabel" : "Social",
982
+ "singularLabel" : "Social"
983
+ }, {
984
+ "displayLabel" : "Chat",
985
+ "apiKey" : "chat",
986
+ "isEnabled" : true,
987
+ "nameField" : null,
988
+ "id" : "1000000000537",
989
+ "pluralLabel" : "Chat",
990
+ "singularLabel" : "Chat"
991
+ }, {
992
+ "displayLabel" : "Activities",
993
+ "apiKey" : "activities",
994
+ "isEnabled" : true,
995
+ "nameField" : null,
996
+ "id" : "1000000000471",
997
+ "pluralLabel" : "Activities",
998
+ "singularLabel" : "Activity"
999
+ }, {
1000
+ "displayLabel" : "Calls",
1001
+ "apiKey" : "calls",
1002
+ "isEnabled" : true,
1003
+ "nameField" : null,
1004
+ "id" : "1000000000531",
1005
+ "pluralLabel" : "Calls",
1006
+ "singularLabel" : "Call"
1007
+ }, {
1008
+ "displayLabel" : "Tasks",
1009
+ "apiKey" : "tasks",
1010
+ "isEnabled" : true,
1011
+ "nameField" : null,
1012
+ "id" : "1000000000469",
1013
+ "pluralLabel" : "Tasks",
1014
+ "singularLabel" : "Task"
1015
+ }, {
1016
+ "displayLabel" : "Events",
1017
+ "apiKey" : "events",
1018
+ "isEnabled" : true,
1019
+ "nameField" : null,
1020
+ "id" : "1000000000529",
1021
+ "pluralLabel" : "Events",
1022
+ "singularLabel" : "Event"
1023
+ }, {
1024
+ "displayLabel" : "IM",
1025
+ "apiKey" : "im",
1026
+ "isEnabled" : true,
1027
+ "nameField" : null,
1028
+ "id" : "1000000000475",
1029
+ "pluralLabel" : "IM",
1030
+ "singularLabel" : "IM"
1031
+ } ]
1032
+ }
1033
+ }
1034
+ }
1035
+ }
1036
+ },
1037
+ "x-custom-response-attributes" : {
1038
+ "disable-safe-headers" : "[]"
1039
+ }
1040
+ },
1041
+ "getModulesResponse" : {
1042
+ "description" : "getModulesResponse template definitions",
1043
+ "content" : {
1044
+ "application/json" : {
1045
+ "schema" : {
1046
+ "oneOf" : [ {
1047
+ "type" : [ "null", "object" ],
1048
+ "additionalProperties" : false,
1049
+ "properties" : {
1050
+ "modules" : {
1051
+ "$ref" : "#/components/schemas/listOfModules"
1052
+ }
1053
+ },
1054
+ "required" : [ "modules" ]
1055
+ }, {
1056
+ "type" : [ "null", "object" ],
1057
+ "additionalProperties" : false,
1058
+ "properties" : {
1059
+ "data" : {
1060
+ "$ref" : "#/components/schemas/modulesWithNameField"
1061
+ }
1062
+ },
1063
+ "required" : [ "data" ]
1064
+ }, {
1065
+ "type" : [ "null", "object" ],
1066
+ "additionalProperties" : false,
1067
+ "properties" : {
1068
+ "data" : {
1069
+ "$ref" : "#/components/schemas/listOfModulesWithCustomModuleData"
1070
+ }
1071
+ },
1072
+ "required" : [ "data" ]
1073
+ } ]
1074
+ },
1075
+ "examples" : {
1076
+ "Valid responses Definitions" : {
1077
+ "value" : {
1078
+ "modules" : [ {
1079
+ "displayLabel" : "Contracts",
1080
+ "apiKey" : "contracts",
1081
+ "nameField" : null,
1082
+ "id" : "1000000000485",
1083
+ "pluralLabel" : "Contracts",
1084
+ "singularLabel" : "Contract"
1085
+ }, {
1086
+ "displayLabel" : "Time Entry",
1087
+ "apiKey" : "timeEntry",
1088
+ "nameField" : null,
1089
+ "id" : "1000000000489",
1090
+ "pluralLabel" : "Time Entry",
1091
+ "singularLabel" : "Time Entry"
1092
+ }, {
1093
+ "displayLabel" : "Department",
1094
+ "apiKey" : "departments",
1095
+ "nameField" : null,
1096
+ "id" : "1000000000491",
1097
+ "pluralLabel" : "Departments",
1098
+ "singularLabel" : "Department"
1099
+ }, {
1100
+ "displayLabel" : "Agents",
1101
+ "apiKey" : "agents",
1102
+ "nameField" : null,
1103
+ "id" : "1000000000493",
1104
+ "pluralLabel" : "Agents",
1105
+ "singularLabel" : "Agent"
1106
+ }, {
1107
+ "displayLabel" : "Topics",
1108
+ "apiKey" : "category",
1109
+ "nameField" : null,
1110
+ "id" : "1000000000527",
1111
+ "pluralLabel" : "Topics",
1112
+ "singularLabel" : "Topic"
1113
+ }, {
1114
+ "displayLabel" : "Ticketss",
1115
+ "apiKey" : "tickets",
1116
+ "nameField" : null,
1117
+ "id" : "1000000000481",
1118
+ "pluralLabel" : "Ticketss",
1119
+ "singularLabel" : "Ticket"
1120
+ }, {
1121
+ "displayLabel" : "Reports",
1122
+ "apiKey" : "reports",
1123
+ "nameField" : null,
1124
+ "id" : "1000000000463",
1125
+ "pluralLabel" : "Reports",
1126
+ "singularLabel" : "Report"
1127
+ }, {
1128
+ "displayLabel" : "Dashboards",
1129
+ "apiKey" : "dashboards",
1130
+ "nameField" : null,
1131
+ "id" : "1000000000465",
1132
+ "pluralLabel" : "Dashboards",
1133
+ "singularLabel" : "Dashboard"
1134
+ }, {
1135
+ "displayLabel" : "Knowledge Base",
1136
+ "apiKey" : "kbCategory",
1137
+ "nameField" : null,
1138
+ "id" : "1000000000483",
1139
+ "pluralLabel" : "Articles",
1140
+ "singularLabel" : "Article"
1141
+ }, {
1142
+ "displayLabel" : "Contacts",
1143
+ "apiKey" : "contacts",
1144
+ "nameField" : null,
1145
+ "id" : "1000000000461",
1146
+ "pluralLabel" : "Contacts",
1147
+ "singularLabel" : "Contact"
1148
+ }, {
1149
+ "displayLabel" : "Products",
1150
+ "apiKey" : "products",
1151
+ "nameField" : null,
1152
+ "id" : "1000000000487",
1153
+ "pluralLabel" : "Products",
1154
+ "singularLabel" : "Product"
1155
+ }, {
1156
+ "displayLabel" : "Accounts",
1157
+ "apiKey" : "accounts",
1158
+ "nameField" : null,
1159
+ "id" : "1000000000459",
1160
+ "pluralLabel" : "Accounts",
1161
+ "singularLabel" : "Account"
1162
+ }, {
1163
+ "displayLabel" : "Community",
1164
+ "apiKey" : "community",
1165
+ "nameField" : null,
1166
+ "id" : "1000000000533",
1167
+ "pluralLabel" : "Community",
1168
+ "singularLabel" : "Community"
1169
+ }, {
1170
+ "displayLabel" : "Social",
1171
+ "apiKey" : "social",
1172
+ "nameField" : null,
1173
+ "id" : "1000000000535",
1174
+ "pluralLabel" : "Social",
1175
+ "singularLabel" : "Social"
1176
+ }, {
1177
+ "displayLabel" : "Chat",
1178
+ "apiKey" : "chat",
1179
+ "nameField" : null,
1180
+ "id" : "1000000000537",
1181
+ "pluralLabel" : "Chat",
1182
+ "singularLabel" : "Chat"
1183
+ }, {
1184
+ "displayLabel" : "Activities",
1185
+ "apiKey" : "activities",
1186
+ "nameField" : null,
1187
+ "id" : "1000000000471",
1188
+ "pluralLabel" : "Activities",
1189
+ "singularLabel" : "Activity"
1190
+ }, {
1191
+ "displayLabel" : "Calls",
1192
+ "apiKey" : "calls",
1193
+ "nameField" : null,
1194
+ "id" : "1000000000531",
1195
+ "pluralLabel" : "Calls",
1196
+ "singularLabel" : "Call"
1197
+ }, {
1198
+ "displayLabel" : "Tasks",
1199
+ "apiKey" : "tasks",
1200
+ "nameField" : null,
1201
+ "id" : "1000000000469",
1202
+ "pluralLabel" : "Tasks",
1203
+ "singularLabel" : "Task"
1204
+ }, {
1205
+ "displayLabel" : "Events",
1206
+ "apiKey" : "events",
1207
+ "nameField" : null,
1208
+ "id" : "1000000000529",
1209
+ "pluralLabel" : "Events",
1210
+ "singularLabel" : "Event"
1211
+ }, {
1212
+ "displayLabel" : "IM",
1213
+ "apiKey" : "im",
1214
+ "nameField" : null,
1215
+ "id" : "1000000000475",
1216
+ "pluralLabel" : "IM",
1217
+ "singularLabel" : "IM"
1218
+ } ]
1219
+ }
1220
+ }
1221
+ }
1222
+ }
1223
+ },
1224
+ "x-custom-response-attributes" : {
1225
+ "disable-safe-headers" : "[]"
1226
+ }
1227
+ },
1228
+ "getOrganizationModulesResponse" : {
1229
+ "description" : "getOrganizationModulesResponse template definitions",
1230
+ "content" : {
1231
+ "application/json" : {
1232
+ "schema" : {
1233
+ "anyOf" : [ {
1234
+ "type" : [ "null", "object" ],
1235
+ "additionalProperties" : false,
1236
+ "properties" : {
1237
+ "data" : {
1238
+ "$ref" : "#/components/schemas/listOfModulesIncludingCustomModule"
1239
+ }
1240
+ },
1241
+ "required" : [ "data" ]
1242
+ }, {
1243
+ "type" : [ "null", "object" ],
1244
+ "additionalProperties" : false,
1245
+ "properties" : {
1246
+ "data" : {
1247
+ "$ref" : "#/components/schemas/organizationModuleArrayOfResponses"
1248
+ }
1249
+ },
1250
+ "required" : [ "data" ]
1251
+ } ]
1252
+ },
1253
+ "examples" : {
1254
+ "Valid responses Definitions" : {
1255
+ "value" : {
1256
+ "data" : [ {
1257
+ "displayLabel" : "Accounts",
1258
+ "modifiedTime" : 946684800000,
1259
+ "apiName" : "accounts",
1260
+ "modifier" : null,
1261
+ "nameField" : "accountName",
1262
+ "description" : null,
1263
+ "pluralLabel" : "Accounts",
1264
+ "singularLabel" : "Account",
1265
+ "hasRecycleBin" : true,
1266
+ "createdBy" : null,
1267
+ "isCustomModule" : false,
1268
+ "createdTime" : 946684800000,
1269
+ "modifiedBy" : null,
1270
+ "isDeptSpecific" : false,
1271
+ "id" : "1000000000377"
1272
+ }, {
1273
+ "displayLabel" : "Contacts",
1274
+ "modifiedTime" : 946684800000,
1275
+ "apiName" : "contacts",
1276
+ "modifier" : null,
1277
+ "nameField" : "lastName",
1278
+ "description" : null,
1279
+ "pluralLabel" : "Contacts",
1280
+ "singularLabel" : "Contact",
1281
+ "hasRecycleBin" : true,
1282
+ "createdBy" : null,
1283
+ "isCustomModule" : false,
1284
+ "createdTime" : 946684800000,
1285
+ "modifiedBy" : null,
1286
+ "isDeptSpecific" : false,
1287
+ "id" : "1000000000379"
1288
+ }, {
1289
+ "displayLabel" : "Tasks",
1290
+ "modifiedTime" : 946684800000,
1291
+ "apiName" : "tasks",
1292
+ "modifier" : null,
1293
+ "nameField" : "subject",
1294
+ "description" : null,
1295
+ "pluralLabel" : "Tasks",
1296
+ "singularLabel" : "Task",
1297
+ "hasRecycleBin" : true,
1298
+ "createdBy" : null,
1299
+ "isCustomModule" : false,
1300
+ "createdTime" : 946684800000,
1301
+ "modifiedBy" : null,
1302
+ "isDeptSpecific" : true,
1303
+ "id" : "1000000000383"
1304
+ }, {
1305
+ "displayLabel" : "Tickets",
1306
+ "modifiedTime" : 946684800000,
1307
+ "apiName" : "tickets",
1308
+ "modifier" : null,
1309
+ "nameField" : "subject",
1310
+ "description" : null,
1311
+ "pluralLabel" : "Tickets",
1312
+ "singularLabel" : "Ticket",
1313
+ "hasRecycleBin" : true,
1314
+ "createdBy" : null,
1315
+ "isCustomModule" : false,
1316
+ "createdTime" : 946684800000,
1317
+ "modifiedBy" : null,
1318
+ "isDeptSpecific" : true,
1319
+ "id" : "1000000000423"
1320
+ }, {
1321
+ "displayLabel" : "Contracts",
1322
+ "modifiedTime" : 946684800000,
1323
+ "apiName" : "contracts",
1324
+ "modifier" : null,
1325
+ "nameField" : "contractName",
1326
+ "description" : null,
1327
+ "pluralLabel" : "Contracts",
1328
+ "singularLabel" : "Contract",
1329
+ "hasRecycleBin" : true,
1330
+ "createdBy" : null,
1331
+ "isCustomModule" : false,
1332
+ "createdTime" : 946684800000,
1333
+ "modifiedBy" : null,
1334
+ "isDeptSpecific" : true,
1335
+ "id" : "1000000000427"
1336
+ }, {
1337
+ "displayLabel" : "Products",
1338
+ "modifiedTime" : 946684800000,
1339
+ "apiName" : "products",
1340
+ "modifier" : null,
1341
+ "nameField" : "productName",
1342
+ "description" : null,
1343
+ "pluralLabel" : "Products",
1344
+ "singularLabel" : "Product",
1345
+ "hasRecycleBin" : true,
1346
+ "createdBy" : null,
1347
+ "isCustomModule" : false,
1348
+ "createdTime" : 946684800000,
1349
+ "modifiedBy" : null,
1350
+ "isDeptSpecific" : false,
1351
+ "id" : "1000000000429"
1352
+ }, {
1353
+ "displayLabel" : "Time Entry",
1354
+ "modifiedTime" : 946684800000,
1355
+ "apiName" : "timeEntry",
1356
+ "modifier" : null,
1357
+ "nameField" : "requestChargeType",
1358
+ "description" : null,
1359
+ "pluralLabel" : "Time Entry",
1360
+ "singularLabel" : "Time Entry",
1361
+ "hasRecycleBin" : true,
1362
+ "createdBy" : null,
1363
+ "isCustomModule" : false,
1364
+ "createdTime" : 946684800000,
1365
+ "modifiedBy" : null,
1366
+ "isDeptSpecific" : true,
1367
+ "id" : "1000000000431"
1368
+ }, {
1369
+ "displayLabel" : "Agents",
1370
+ "modifiedTime" : 946684800000,
1371
+ "apiName" : "agents",
1372
+ "modifier" : null,
1373
+ "nameField" : "lastName",
1374
+ "description" : null,
1375
+ "pluralLabel" : "Agents",
1376
+ "singularLabel" : "Agent",
1377
+ "hasRecycleBin" : false,
1378
+ "createdBy" : null,
1379
+ "isCustomModule" : false,
1380
+ "createdTime" : 946684800000,
1381
+ "modifiedBy" : null,
1382
+ "isDeptSpecific" : false,
1383
+ "id" : "1000000000435"
1384
+ }, {
1385
+ "displayLabel" : "Events",
1386
+ "modifiedTime" : 946684800000,
1387
+ "apiName" : "events",
1388
+ "modifier" : null,
1389
+ "nameField" : "subject",
1390
+ "description" : null,
1391
+ "pluralLabel" : "Events",
1392
+ "singularLabel" : "Event",
1393
+ "hasRecycleBin" : true,
1394
+ "createdBy" : null,
1395
+ "isCustomModule" : false,
1396
+ "createdTime" : 946684800000,
1397
+ "modifiedBy" : null,
1398
+ "isDeptSpecific" : true,
1399
+ "id" : "1000000000445"
1400
+ }, {
1401
+ "displayLabel" : "Calls",
1402
+ "modifiedTime" : 946684800000,
1403
+ "apiName" : "calls",
1404
+ "modifier" : null,
1405
+ "nameField" : "subject",
1406
+ "description" : null,
1407
+ "pluralLabel" : "Calls",
1408
+ "singularLabel" : "Call",
1409
+ "hasRecycleBin" : true,
1410
+ "createdBy" : null,
1411
+ "isCustomModule" : false,
1412
+ "createdTime" : 946684800000,
1413
+ "modifiedBy" : null,
1414
+ "isDeptSpecific" : true,
1415
+ "id" : "1000000000447"
1416
+ }, {
1417
+ "displayLabel" : "Doctors",
1418
+ "modifiedTime" : 1713519302000,
1419
+ "apiName" : "cm_doctors",
1420
+ "modifier" : {
1421
+ "firstName" : "",
1422
+ "lastName" : "Kyle",
1423
+ "photoURL" : "https://desk.zoho.com/api/v1/agents/4000000000329/photo?orgId=3981311",
1424
+ "id" : "4000000000329",
1425
+ "email" : "kyle@zylker.com"
1426
+ },
1427
+ "nameField" : "name",
1428
+ "description" : "Doctor informations",
1429
+ "pluralLabel" : "Doctors",
1430
+ "singularLabel" : "Doctor",
1431
+ "hasRecycleBin" : true,
1432
+ "createdBy" : "1000000000375",
1433
+ "isCustomModule" : true,
1434
+ "createdTime" : 1713517457000,
1435
+ "modifiedBy" : "1000000000375",
1436
+ "isDeptSpecific" : true,
1437
+ "id" : "1000003000001"
1438
+ } ]
1439
+ }
1440
+ }
1441
+ }
1442
+ }
1443
+ },
1444
+ "x-custom-response-attributes" : {
1445
+ "disable-safe-headers" : "[]"
1446
+ }
1447
+ }
1448
+ },
1449
+ "parameters" : {
1450
+ "moduleId" : {
1451
+ "name" : "moduleId",
1452
+ "in" : "path",
1453
+ "required" : true,
1454
+ "style" : "simple",
1455
+ "explode" : false,
1456
+ "schema" : {
1457
+ "type" : [ "string", "null", "integer" ],
1458
+ "format" : "int64",
1459
+ "pattern" : "([0-9]+)"
1460
+ }
1461
+ },
1462
+ "featureFlags" : {
1463
+ "name" : "featureFlags",
1464
+ "in" : "header",
1465
+ "required" : false,
1466
+ "style" : "simple",
1467
+ "explode" : false,
1468
+ "schema" : {
1469
+ "type" : [ "string", "null" ],
1470
+ "enum" : [ "customModule" ],
1471
+ "maxLength" : 100,
1472
+ "minLength" : 0
1473
+ }
1474
+ }
1475
+ },
1476
+ "requestBodies" : {
1477
+ "editRequestJson" : {
1478
+ "content" : {
1479
+ "application/json" : {
1480
+ "schema" : {
1481
+ "type" : [ "null", "object" ],
1482
+ "additionalProperties" : false,
1483
+ "properties" : {
1484
+ "description" : {
1485
+ "type" : [ "string", "null" ],
1486
+ "maxLength" : 100,
1487
+ "minLength" : 0
1488
+ },
1489
+ "profileIds" : {
1490
+ "type" : [ "null", "array" ],
1491
+ "items" : {
1492
+ "type" : [ "string", "null", "integer" ],
1493
+ "format" : "int64",
1494
+ "pattern" : "([0-9]+)",
1495
+ "x-custom-parameters-attributes" : [ { } ]
1496
+ },
1497
+ "uniqueItems" : false
1498
+ },
1499
+ "pluralLabel" : {
1500
+ "type" : [ "string", "null" ],
1501
+ "maxLength" : 100,
1502
+ "minLength" : 0,
1503
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1504
+ },
1505
+ "departmentIds" : {
1506
+ "type" : [ "null", "array" ],
1507
+ "items" : {
1508
+ "type" : [ "string", "null", "integer" ],
1509
+ "format" : "int64",
1510
+ "pattern" : "([0-9]+)",
1511
+ "x-custom-parameters-attributes" : [ { } ]
1512
+ },
1513
+ "uniqueItems" : false
1514
+ },
1515
+ "singularLabel" : {
1516
+ "type" : [ "string", "null" ],
1517
+ "maxLength" : 100,
1518
+ "minLength" : 0,
1519
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1520
+ }
1521
+ },
1522
+ "required" : [ "departmentIds", "pluralLabel", "profileIds", "singularLabel" ]
1523
+ },
1524
+ "examples" : {
1525
+ "Valid requestBody Definitions" : {
1526
+ "value" : {
1527
+ "description" : "Doctor informations",
1528
+ "profileIds" : [ 1000000029530, 1000000029533 ],
1529
+ "pluralLabel" : "Doctors",
1530
+ "departmentIds" : [ 1000000774623, 1000000025632 ],
1531
+ "singularLabel" : "Doctor"
1532
+ }
1533
+ }
1534
+ }
1535
+ }
1536
+ },
1537
+ "x-custom-request-body-attributes" : {
1538
+ "non-empty" : false,
1539
+ "allow-invalid" : false
1540
+ }
1541
+ },
1542
+ "requestJson" : {
1543
+ "content" : {
1544
+ "application/json" : {
1545
+ "schema" : {
1546
+ "type" : [ "null", "object" ],
1547
+ "additionalProperties" : false,
1548
+ "properties" : {
1549
+ "description" : {
1550
+ "type" : [ "string", "null" ],
1551
+ "maxLength" : 100,
1552
+ "minLength" : 0
1553
+ },
1554
+ "profileIds" : {
1555
+ "type" : [ "null", "array" ],
1556
+ "items" : {
1557
+ "type" : [ "string", "null", "integer" ],
1558
+ "format" : "int64",
1559
+ "pattern" : "([0-9]+)",
1560
+ "x-custom-parameters-attributes" : [ { } ]
1561
+ },
1562
+ "uniqueItems" : false
1563
+ },
1564
+ "isDeptSpecific" : {
1565
+ "type" : [ "boolean", "null" ]
1566
+ },
1567
+ "pluralLabel" : {
1568
+ "type" : [ "string", "null" ],
1569
+ "maxLength" : 100,
1570
+ "minLength" : 0,
1571
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1572
+ },
1573
+ "departmentIds" : {
1574
+ "type" : [ "null", "array" ],
1575
+ "items" : {
1576
+ "type" : [ "string", "null", "integer" ],
1577
+ "format" : "int64",
1578
+ "pattern" : "([0-9]+)",
1579
+ "x-custom-parameters-attributes" : [ { } ]
1580
+ },
1581
+ "uniqueItems" : false
1582
+ },
1583
+ "singularLabel" : {
1584
+ "type" : [ "string", "null" ],
1585
+ "maxLength" : 100,
1586
+ "minLength" : 0,
1587
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1588
+ }
1589
+ },
1590
+ "required" : [ "departmentIds", "isDeptSpecific", "pluralLabel", "profileIds", "singularLabel" ]
1591
+ },
1592
+ "examples" : {
1593
+ "Valid requestBody Definitions" : {
1594
+ "value" : {
1595
+ "description" : "Doctor informations",
1596
+ "profileIds" : [ 1000000029530 ],
1597
+ "isDeptSpecific" : true,
1598
+ "pluralLabel" : "Doctors",
1599
+ "departmentIds" : [ 1000000774623, 1000000025632 ],
1600
+ "singularLabel" : "Doctor"
1601
+ }
1602
+ }
1603
+ }
1604
+ }
1605
+ },
1606
+ "x-custom-request-body-attributes" : {
1607
+ "non-empty" : false,
1608
+ "allow-invalid" : false
1609
+ }
1610
+ }
1611
+ },
1612
+ "securitySchemes" : {
1613
+ "cookie-auth" : {
1614
+ "$ref" : "../common/Common.json#/components/securitySchemes/cookie-auth"
1615
+ },
1616
+ "org-oauth" : {
1617
+ "$ref" : "../common/Common.json#/components/securitySchemes/org-oauth"
1618
+ },
1619
+ "iam-oauth2-schema" : {
1620
+ "$ref" : "../common/Common.json#/components/securitySchemes/iam-oauth2-schema"
1621
+ }
1622
+ }
1623
+ },
1624
+ "x-entity" : "Module"
1625
+ }