agent-generator 1.0.3 → 1.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (770) hide show
  1. package/install-extension.js +1 -1
  2. package/package.json +2 -4
  3. package/Generator_Patterns/Conditional.md +0 -84
  4. package/Generator_Patterns/Dynamic.md +0 -129
  5. package/Generator_Patterns/PathConfig.properties +0 -4
  6. package/Generator_Patterns/README.md +0 -118
  7. package/Generator_Patterns/Reference.md +0 -98
  8. package/Generator_Patterns/Remote.md +0 -259
  9. package/Generator_Patterns/Static.md +0 -99
  10. package/source/api-data-generators/.idea/api-data-generators.iml +0 -9
  11. package/source/api-data-generators/.idea/misc.xml +0 -6
  12. package/source/api-data-generators/.idea/modules.xml +0 -8
  13. package/source/api-data-generators/.idea/vcs.xml +0 -6
  14. package/source/api-data-generators/portal/ArticleComment/test_data_generation_configurations.json +0 -318
  15. package/source/api-data-generators/portal/ArticleFeedback/test_data_generation_configurations.json +0 -32
  16. package/source/api-data-generators/portal/AsapMobile/test_data_generation_configurations.json +0 -21
  17. package/source/api-data-generators/portal/AsapWeb/test_data_generation_configurations.json +0 -18
  18. package/source/api-data-generators/portal/Category/test_data_generation_configurations.json +0 -39
  19. package/source/api-data-generators/portal/Comment/test_data_generation_configurations.json +0 -157
  20. package/source/api-data-generators/portal/Community/test_data_generation_configurations.json +0 -46
  21. package/source/api-data-generators/portal/CommunityUser/test_data_generation_configurations.json +0 -16
  22. package/source/api-data-generators/portal/Contact/test_data_generation_configurations.json +0 -33
  23. package/source/api-data-generators/portal/Department/test_data_generation_configurations.json +0 -13
  24. package/source/api-data-generators/portal/Extension/test_data_generation_configurations.json +0 -91
  25. package/source/api-data-generators/portal/FeedbackWidget/test_data_generation_configurations.json +0 -18
  26. package/source/api-data-generators/portal/FileExport/test_data_generation_configurations.json +0 -42
  27. package/source/api-data-generators/portal/Followers/test_data_generation_configurations.json +0 -92
  28. package/source/api-data-generators/portal/Gamification/test_data_generation_configurations.json +0 -51
  29. package/source/api-data-generators/portal/HelpCenters/test_data_generation_configurations.json +0 -11
  30. package/source/api-data-generators/portal/Helpcenter/test_data_generation_configurations.json +0 -41
  31. package/source/api-data-generators/portal/HelpcenterGroups/test_data_generation_configurations.json +0 -18
  32. package/source/api-data-generators/portal/KBRootCategory/test_data_generation_configurations.json +0 -76
  33. package/source/api-data-generators/portal/KbCategory/test_data_generation_configurations.json +0 -51
  34. package/source/api-data-generators/portal/KbSection/test_data_generation_configurations.json +0 -25
  35. package/source/api-data-generators/portal/KnowledgeBase/test_data_generation_configurations.json +0 -26
  36. package/source/api-data-generators/portal/Label/test_data_generation_configurations.json +0 -18
  37. package/source/api-data-generators/portal/Layout/test_data_generation_configurations.json +0 -17
  38. package/source/api-data-generators/portal/LayoutRules/test_data_generation_configurations.json +0 -17
  39. package/source/api-data-generators/portal/NewAsapMobile/test_data_generation_configurations.json +0 -21
  40. package/source/api-data-generators/portal/Permalink/test_data_generation_configurations.json +0 -32
  41. package/source/api-data-generators/portal/Product/test_data_generation_configurations.json +0 -43
  42. package/source/api-data-generators/portal/Solution/test_data_generation_configurations.json +0 -631
  43. package/source/api-data-generators/portal/Thread/test_data_generation_configurations.json +0 -70
  44. package/source/api-data-generators/portal/Ticket/test_data_generation_configurations.json +0 -294
  45. package/source/api-data-generators/portal/TicketComment/test_data_generation_configurations.json +0 -58
  46. package/source/api-data-generators/portal/TicketCount/test_data_generation_configurations.json +0 -74
  47. package/source/api-data-generators/portal/TicketStatusMapping/test_data_generation_configurations.json +0 -11
  48. package/source/api-data-generators/portal/TicketTemplate/test_data_generation_configurations.json +0 -24
  49. package/source/api-data-generators/portal/Topic/test_data_generation_configurations.json +0 -259
  50. package/source/api-data-generators/portal/Translation/test_data_generation_configurations.json +0 -6
  51. package/source/api-data-generators/portal/ValidationRules/test_data_generation_configurations.json +0 -14
  52. package/source/api-data-generators/portal/View/test_data_generation_configurations.json +0 -19
  53. package/source/api-data-generators/support/Account/test_data_generation_configurations.json +0 -265
  54. package/source/api-data-generators/support/AccountAttachment/test_data_generation_configurations.json +0 -48
  55. package/source/api-data-generators/support/AccountComments/test_data_generation_configurations.json +0 -47
  56. package/source/api-data-generators/support/AccountContactMappingInfo/test_data_generation_configurations.json +0 -14
  57. package/source/api-data-generators/support/AccountFollowers/test_data_generation_configurations.json +0 -52
  58. package/source/api-data-generators/support/AccountSla/test_data_generation_configurations.json +0 -33
  59. package/source/api-data-generators/support/AccountTimeEntry/test_data_generation_configurations.json +0 -45
  60. package/source/api-data-generators/support/ActiveCalls/test_data_generation_configurations.json +0 -38
  61. package/source/api-data-generators/support/Activity/test_data_generation_configurations.json +0 -50
  62. package/source/api-data-generators/support/ActorsAPI/test_data_generation_configurations.json +0 -22
  63. package/source/api-data-generators/support/Agent/test_data_generation_configurations.json +0 -217
  64. package/source/api-data-generators/support/AgentPresence/test_data_generation_configurations.json +0 -30
  65. package/source/api-data-generators/support/AgentSignatures/test_data_generation_configurations.json +0 -31
  66. package/source/api-data-generators/support/AgentTimeEntry/test_data_generation_configurations.json +0 -36
  67. package/source/api-data-generators/support/AntiSpamInfo/test_data_generation_configurations.json +0 -32
  68. package/source/api-data-generators/support/ApiCreditNotificationRule/test_data_generation_configurations.json +0 -49
  69. package/source/api-data-generators/support/ArchivedView/test_data_generation_configurations.json +0 -66
  70. package/source/api-data-generators/support/Article/test_data_generation_configurations.json +0 -294
  71. package/source/api-data-generators/support/ArticleAttachment/test_data_generation_configurations.json +0 -150
  72. package/source/api-data-generators/support/ArticleComment/test_data_generation_configurations.json +0 -238
  73. package/source/api-data-generators/support/ArticleFeedback/test_data_generation_configurations.json +0 -147
  74. package/source/api-data-generators/support/ArticleFeedbackResolution/test_data_generation_configurations.json +0 -56
  75. package/source/api-data-generators/support/ArticleStatistics/test_data_generation_configurations.json +0 -397
  76. package/source/api-data-generators/support/ArticleTranslation/test_data_generation_configurations.json +0 -1123
  77. package/source/api-data-generators/support/ArticleVersion/test_data_generation_configurations.json +0 -26
  78. package/source/api-data-generators/support/ArticleViews/test_data_generation_configurations.json +0 -26
  79. package/source/api-data-generators/support/Asap/test_data_generation_configurations.json +0 -49
  80. package/source/api-data-generators/support/AuditLog/test_data_generation_configurations.json +0 -58
  81. package/source/api-data-generators/support/AutomationAlerts/test_data_generation_configurations.json +0 -27
  82. package/source/api-data-generators/support/AutomationEngine/test_data_generation_configurations.json +0 -20
  83. package/source/api-data-generators/support/AutomationFeatureCount/test_data_generation_configurations.json +0 -13
  84. package/source/api-data-generators/support/AutomationFieldUpdates/test_data_generation_configurations.json +0 -24
  85. package/source/api-data-generators/support/AutomationTask/test_data_generation_configurations.json +0 -29
  86. package/source/api-data-generators/support/Backup/test_data_generation_configurations.json +0 -115
  87. package/source/api-data-generators/support/Badge/test_data_generation_configurations.json +0 -64
  88. package/source/api-data-generators/support/Bot/test_data_generation_configurations.json +0 -288
  89. package/source/api-data-generators/support/BotInference/test_data_generation_configurations.json +0 -119
  90. package/source/api-data-generators/support/BugInteg/test_data_generation_configurations.json +0 -37
  91. package/source/api-data-generators/support/BulkAction/test_data_generation_configurations.json +0 -26
  92. package/source/api-data-generators/support/BulkImport/test_data_generation_configurations.json +0 -211
  93. package/source/api-data-generators/support/BulkUpdate/test_data_generation_configurations.json +0 -40
  94. package/source/api-data-generators/support/BulkWrite/test_data_generation_configurations.json +0 -32
  95. package/source/api-data-generators/support/BusinessHour/test_data_generation_configurations.json +0 -72
  96. package/source/api-data-generators/support/Call/test_data_generation_configurations.json +0 -247
  97. package/source/api-data-generators/support/CallComments/test_data_generation_configurations.json +0 -51
  98. package/source/api-data-generators/support/CallHistory/test_data_generation_configurations.json +0 -65
  99. package/source/api-data-generators/support/CallTimeEntry/test_data_generation_configurations.json +0 -77
  100. package/source/api-data-generators/support/CallTimer/test_data_generation_configurations.json +0 -14
  101. package/source/api-data-generators/support/Channel/test_data_generation_configurations.json +0 -44
  102. package/source/api-data-generators/support/Chart/test_data_generation_configurations.json +0 -35
  103. package/source/api-data-generators/support/ChatTicket/test_data_generation_configurations.json +0 -185
  104. package/source/api-data-generators/support/Common/test_data_generation_configurations.json +0 -43
  105. package/source/api-data-generators/support/Community/test_data_generation_configurations.json +0 -313
  106. package/source/api-data-generators/support/CommunityAttachment/test_data_generation_configurations.json +0 -16
  107. package/source/api-data-generators/support/CommunityCategory/test_data_generation_configurations.json +0 -121
  108. package/source/api-data-generators/support/CommunityComment/test_data_generation_configurations.json +0 -350
  109. package/source/api-data-generators/support/CommunityInitPermissions/test_data_generation_configurations.json +0 -16
  110. package/source/api-data-generators/support/CommunityPreferences/test_data_generation_configurations.json +0 -19
  111. package/source/api-data-generators/support/CommunityTopic/test_data_generation_configurations.json +0 -509
  112. package/source/api-data-generators/support/CommunityTopicInsights/test_data_generation_configurations.json +0 -32
  113. package/source/api-data-generators/support/CommunityUser/test_data_generation_configurations.json +0 -63
  114. package/source/api-data-generators/support/Contact/test_data_generation_configurations.json +0 -370
  115. package/source/api-data-generators/support/ContactAttachment/test_data_generation_configurations.json +0 -44
  116. package/source/api-data-generators/support/ContactComments/test_data_generation_configurations.json +0 -47
  117. package/source/api-data-generators/support/ContactFollowers/test_data_generation_configurations.json +0 -52
  118. package/source/api-data-generators/support/ContactProfile/test_data_generation_configurations.json +0 -11
  119. package/source/api-data-generators/support/ContactTimeEntry/test_data_generation_configurations.json +0 -45
  120. package/source/api-data-generators/support/Contract/test_data_generation_configurations.json +0 -184
  121. package/source/api-data-generators/support/ContractAttachment/test_data_generation_configurations.json +0 -30
  122. package/source/api-data-generators/support/CreateTicket/test_data_generation_configurations.json +0 -93
  123. package/source/api-data-generators/support/Criteria/test_data_generation_configurations.json +0 -19
  124. package/source/api-data-generators/support/CrmInteg/test_data_generation_configurations.json +0 -202
  125. package/source/api-data-generators/support/CustomAction/test_data_generation_configurations.json +0 -56
  126. package/source/api-data-generators/support/CustomActionRuleMapping/test_data_generation_configurations.json +0 -334
  127. package/source/api-data-generators/support/CustomButton/test_data_generation_configurations.json +0 -113
  128. package/source/api-data-generators/support/CustomFunctionExecutionLogs/test_data_generation_configurations.json +0 -68
  129. package/source/api-data-generators/support/CustomFunctionGallery/test_data_generation_configurations.json +0 -16
  130. package/source/api-data-generators/support/CustomFunctions/test_data_generation_configurations.json +0 -270
  131. package/source/api-data-generators/support/CustomTheme/test_data_generation_configurations.json +0 -70
  132. package/source/api-data-generators/support/CustomView/test_data_generation_configurations.json +0 -486
  133. package/source/api-data-generators/support/CustomerHappiness/test_data_generation_configurations.json +0 -77
  134. package/source/api-data-generators/support/DashboardComponent/test_data_generation_configurations.json +0 -305
  135. package/source/api-data-generators/support/DashboardFolder/test_data_generation_configurations.json +0 -126
  136. package/source/api-data-generators/support/DashboardMetrics/test_data_generation_configurations.json +0 -205
  137. package/source/api-data-generators/support/Dashboards/test_data_generation_configurations.json +0 -90
  138. package/source/api-data-generators/support/DataChips/test_data_generation_configurations.json +0 -33
  139. package/source/api-data-generators/support/DataSync/test_data_generation_configurations.json +0 -228
  140. package/source/api-data-generators/support/DeleteTicket/test_data_generation_configurations.json +0 -44
  141. package/source/api-data-generators/support/Department/test_data_generation_configurations.json +0 -156
  142. package/source/api-data-generators/support/DependencyMappings/test_data_generation_configurations.json +0 -50
  143. package/source/api-data-generators/support/DirectAssignRuleTarget/test_data_generation_configurations.json +0 -17
  144. package/source/api-data-generators/support/DirectAssignmentRules/test_data_generation_configurations.json +0 -37
  145. package/source/api-data-generators/support/DisplayEntity/test_data_generation_configurations.json +0 -45
  146. package/source/api-data-generators/support/DomainMapping/test_data_generation_configurations.json +0 -6
  147. package/source/api-data-generators/support/EmailFailureAlert/test_data_generation_configurations.json +0 -21
  148. package/source/api-data-generators/support/EmailTemplates/test_data_generation_configurations.json +0 -106
  149. package/source/api-data-generators/support/EntityBlueprints/test_data_generation_configurations.json +0 -205
  150. package/source/api-data-generators/support/Event/test_data_generation_configurations.json +0 -196
  151. package/source/api-data-generators/support/EventComments/test_data_generation_configurations.json +0 -45
  152. package/source/api-data-generators/support/EventTimeEntry/test_data_generation_configurations.json +0 -77
  153. package/source/api-data-generators/support/EventTimer/test_data_generation_configurations.json +0 -14
  154. package/source/api-data-generators/support/Extension/test_data_generation_configurations.json +0 -689
  155. package/source/api-data-generators/support/FbManager/test_data_generation_configurations.json +0 -64
  156. package/source/api-data-generators/support/Feature/test_data_generation_configurations.json +0 -61
  157. package/source/api-data-generators/support/FeatureFile/test_data_generation_configurations.json +0 -49
  158. package/source/api-data-generators/support/FeatureFolder/test_data_generation_configurations.json +0 -44
  159. package/source/api-data-generators/support/FeaturePermission/test_data_generation_configurations.json +0 -108
  160. package/source/api-data-generators/support/FederatedLogin/test_data_generation_configurations.json +0 -39
  161. package/source/api-data-generators/support/FeedsAPIs/test_data_generation_configurations.json +0 -54
  162. package/source/api-data-generators/support/Field/test_data_generation_configurations.json +0 -1031
  163. package/source/api-data-generators/support/FieldPrediction/test_data_generation_configurations.json +0 -564
  164. package/source/api-data-generators/support/FileExport/test_data_generation_configurations.json +0 -36
  165. package/source/api-data-generators/support/Finance/test_data_generation_configurations.json +0 -180
  166. package/source/api-data-generators/support/Followers/test_data_generation_configurations.json +0 -60
  167. package/source/api-data-generators/support/GC_Bots/test_data_generation_configurations.json +0 -26
  168. package/source/api-data-generators/support/GC_Guide/test_data_generation_configurations.json +0 -240
  169. package/source/api-data-generators/support/GenericAction/test_data_generation_configurations.json +0 -16
  170. package/source/api-data-generators/support/GenericActionMapping/test_data_generation_configurations.json +0 -216
  171. package/source/api-data-generators/support/GoogleAnalytics/test_data_generation_configurations.json +0 -168
  172. package/source/api-data-generators/support/GoogleChat/test_data_generation_configurations.json +0 -29
  173. package/source/api-data-generators/support/Helpcenter/test_data_generation_configurations.json +0 -98
  174. package/source/api-data-generators/support/HelpcenterAutoTranslateSetting/test_data_generation_configurations.json +0 -11
  175. package/source/api-data-generators/support/HelpcenterGroups/test_data_generation_configurations.json +0 -93
  176. package/source/api-data-generators/support/HelpcenterPages/test_data_generation_configurations.json +0 -34
  177. package/source/api-data-generators/support/HelpcenterPreference/test_data_generation_configurations.json +0 -18
  178. package/source/api-data-generators/support/HelpcenterUpload/test_data_generation_configurations.json +0 -25
  179. package/source/api-data-generators/support/HolidayList/test_data_generation_configurations.json +0 -65
  180. package/source/api-data-generators/support/IMCannedMessage/test_data_generation_configurations.json +0 -155
  181. package/source/api-data-generators/support/IMCannedMessageTranslation/test_data_generation_configurations.json +0 -92
  182. package/source/api-data-generators/support/IMTemplateMessage/test_data_generation_configurations.json +0 -22
  183. package/source/api-data-generators/support/IM_AddOn/test_data_generation_configurations.json +0 -19
  184. package/source/api-data-generators/support/IM_Bot/test_data_generation_configurations.json +0 -143
  185. package/source/api-data-generators/support/IM_Broadcast/test_data_generation_configurations.json +0 -39
  186. package/source/api-data-generators/support/IM_Channel/test_data_generation_configurations.json +0 -312
  187. package/source/api-data-generators/support/IM_ChannelPreference/test_data_generation_configurations.json +0 -35
  188. package/source/api-data-generators/support/IM_Contact/test_data_generation_configurations.json +0 -16
  189. package/source/api-data-generators/support/IM_Integration/test_data_generation_configurations.json +0 -32
  190. package/source/api-data-generators/support/IM_Message/test_data_generation_configurations.json +0 -297
  191. package/source/api-data-generators/support/IM_Metrics/test_data_generation_configurations.json +0 -38
  192. package/source/api-data-generators/support/IM_Search/test_data_generation_configurations.json +0 -56
  193. package/source/api-data-generators/support/IM_Session/test_data_generation_configurations.json +0 -149
  194. package/source/api-data-generators/support/IM_TimeSeriesMetrics/test_data_generation_configurations.json +0 -77
  195. package/source/api-data-generators/support/IM_ZiaGpt/test_data_generation_configurations.json +0 -52
  196. package/source/api-data-generators/support/Import/test_data_generation_configurations.json +0 -229
  197. package/source/api-data-generators/support/InlineImage/test_data_generation_configurations.json +0 -16
  198. package/source/api-data-generators/support/IntegModule/test_data_generation_configurations.json +0 -90
  199. package/source/api-data-generators/support/Integrations/test_data_generation_configurations.json +0 -25
  200. package/source/api-data-generators/support/InteractiveTours/test_data_generation_configurations.json +0 -66
  201. package/source/api-data-generators/support/JWT/test_data_generation_configurations.json +0 -49
  202. package/source/api-data-generators/support/KBCategoryUser/test_data_generation_configurations.json +0 -23
  203. package/source/api-data-generators/support/KBRecycleBin/test_data_generation_configurations.json +0 -131
  204. package/source/api-data-generators/support/KBRootCategory/test_data_generation_configurations.json +0 -214
  205. package/source/api-data-generators/support/KBRootCategoryTranslation/test_data_generation_configurations.json +0 -30
  206. package/source/api-data-generators/support/KBSection/test_data_generation_configurations.json +0 -173
  207. package/source/api-data-generators/support/KPIWidget/test_data_generation_configurations.json +0 -21
  208. package/source/api-data-generators/support/KbCategory/test_data_generation_configurations.json +0 -93
  209. package/source/api-data-generators/support/Label/test_data_generation_configurations.json +0 -103
  210. package/source/api-data-generators/support/Layout/test_data_generation_configurations.json +0 -503
  211. package/source/api-data-generators/support/LayoutRuleCriteria/test_data_generation_configurations.json +0 -19
  212. package/source/api-data-generators/support/LayoutRules/test_data_generation_configurations.json +0 -334
  213. package/source/api-data-generators/support/License/test_data_generation_configurations.json +0 -60
  214. package/source/api-data-generators/support/Livecall/test_data_generation_configurations.json +0 -72
  215. package/source/api-data-generators/support/LookupRecord/test_data_generation_configurations.json +0 -34
  216. package/source/api-data-generators/support/Macros/test_data_generation_configurations.json +0 -184
  217. package/source/api-data-generators/support/MailReplyAddress/test_data_generation_configurations.json +0 -32
  218. package/source/api-data-generators/support/MassAction/test_data_generation_configurations.json +0 -38
  219. package/source/api-data-generators/support/Message/test_data_generation_configurations.json +0 -38
  220. package/source/api-data-generators/support/MicrosoftTeams/test_data_generation_configurations.json +0 -50
  221. package/source/api-data-generators/support/Misc/test_data_generation_configurations.json +0 -16
  222. package/source/api-data-generators/support/Module/test_data_generation_configurations.json +0 -96
  223. package/source/api-data-generators/support/NewCriteria/test_data_generation_configurations.json +0 -26
  224. package/source/api-data-generators/support/NewFeatureFields/test_data_generation_configurations.json +0 -19
  225. package/source/api-data-generators/support/NewTicketHistory/test_data_generation_configurations.json +0 -20
  226. package/source/api-data-generators/support/NotificationRules/test_data_generation_configurations.json +0 -27
  227. package/source/api-data-generators/support/OEmbedData/test_data_generation_configurations.json +0 -19
  228. package/source/api-data-generators/support/Onboarding/test_data_generation_configurations.json +0 -29
  229. package/source/api-data-generators/support/Organization/test_data_generation_configurations.json +0 -79
  230. package/source/api-data-generators/support/PBGroup/test_data_generation_configurations.json +0 -109
  231. package/source/api-data-generators/support/PBGroupAgents/test_data_generation_configurations.json +0 -66
  232. package/source/api-data-generators/support/PBPlatform/test_data_generation_configurations.json +0 -113
  233. package/source/api-data-generators/support/PBX/test_data_generation_configurations.json +0 -28
  234. package/source/api-data-generators/support/PBXConfig/test_data_generation_configurations.json +0 -17
  235. package/source/api-data-generators/support/PBXPhoneNumbers/test_data_generation_configurations.json +0 -54
  236. package/source/api-data-generators/support/PBXPreference/test_data_generation_configurations.json +0 -54
  237. package/source/api-data-generators/support/PageSense/test_data_generation_configurations.json +0 -77
  238. package/source/api-data-generators/support/PendingApproval/test_data_generation_configurations.json +0 -14
  239. package/source/api-data-generators/support/Permalink/test_data_generation_configurations.json +0 -32
  240. package/source/api-data-generators/support/PhoneAgents/test_data_generation_configurations.json +0 -66
  241. package/source/api-data-generators/support/PinnedConversation/test_data_generation_configurations.json +0 -64
  242. package/source/api-data-generators/support/Pipeline_Service/test_data_generation_configurations.json +0 -32
  243. package/source/api-data-generators/support/Product/test_data_generation_configurations.json +0 -196
  244. package/source/api-data-generators/support/ProductAttachment/test_data_generation_configurations.json +0 -48
  245. package/source/api-data-generators/support/Profile/test_data_generation_configurations.json +0 -59
  246. package/source/api-data-generators/support/QueueView/test_data_generation_configurations.json +0 -37
  247. package/source/api-data-generators/support/Records/test_data_generation_configurations.json +0 -239
  248. package/source/api-data-generators/support/Recyclebin/test_data_generation_configurations.json +0 -52
  249. package/source/api-data-generators/support/RemoteAuth/test_data_generation_configurations.json +0 -52
  250. package/source/api-data-generators/support/Report/test_data_generation_configurations.json +0 -538
  251. package/source/api-data-generators/support/ReportChart/test_data_generation_configurations.json +0 -28
  252. package/source/api-data-generators/support/ReportFolder/test_data_generation_configurations.json +0 -100
  253. package/source/api-data-generators/support/Resources/test_data_generation_configurations.json +0 -29
  254. package/source/api-data-generators/support/Role/test_data_generation_configurations.json +0 -84
  255. package/source/api-data-generators/support/RoundRobin/test_data_generation_configurations.json +0 -58
  256. package/source/api-data-generators/support/RoundRobinTarget/test_data_generation_configurations.json +0 -50
  257. package/source/api-data-generators/support/RoutingPreference/test_data_generation_configurations.json +0 -29
  258. package/source/api-data-generators/support/SLAMetaInfo/test_data_generation_configurations.json +0 -22
  259. package/source/api-data-generators/support/Saml/test_data_generation_configurations.json +0 -42
  260. package/source/api-data-generators/support/Sandbox/test_data_generation_configurations.json +0 -92
  261. package/source/api-data-generators/support/SandboxChangeset/test_data_generation_configurations.json +0 -46
  262. package/source/api-data-generators/support/SandboxDeployment/test_data_generation_configurations.json +0 -50
  263. package/source/api-data-generators/support/SandboxDeploymentLogs/test_data_generation_configurations.json +0 -22
  264. package/source/api-data-generators/support/SavedFilters/test_data_generation_configurations.json +0 -203
  265. package/source/api-data-generators/support/Schedule/test_data_generation_configurations.json +0 -172
  266. package/source/api-data-generators/support/ScheduleReplyInfo/test_data_generation_configurations.json +0 -182
  267. package/source/api-data-generators/support/Search/test_data_generation_configurations.json +0 -636
  268. package/source/api-data-generators/support/SearchInteg/test_data_generation_configurations.json +0 -32
  269. package/source/api-data-generators/support/Setup/test_data_generation_configurations.json +0 -32
  270. package/source/api-data-generators/support/SharedSnippet/test_data_generation_configurations.json +0 -62
  271. package/source/api-data-generators/support/Signature/test_data_generation_configurations.json +0 -24
  272. package/source/api-data-generators/support/Skill/test_data_generation_configurations.json +0 -164
  273. package/source/api-data-generators/support/SkillConfiguration/test_data_generation_configurations.json +0 -21
  274. package/source/api-data-generators/support/SkillType/test_data_generation_configurations.json +0 -60
  275. package/source/api-data-generators/support/Slack/test_data_generation_configurations.json +0 -51
  276. package/source/api-data-generators/support/SmsTemplates/test_data_generation_configurations.json +0 -40
  277. package/source/api-data-generators/support/Snippets/test_data_generation_configurations.json +0 -47
  278. package/source/api-data-generators/support/SocialInteg/test_data_generation_configurations.json +0 -22
  279. package/source/api-data-generators/support/SocialPosts/test_data_generation_configurations.json +0 -223
  280. package/source/api-data-generators/support/SocialTwitterConversations/test_data_generation_configurations.json +0 -22
  281. package/source/api-data-generators/support/StarredTemplates/test_data_generation_configurations.json +0 -76
  282. package/source/api-data-generators/support/SubjectAccessRequest/test_data_generation_configurations.json +0 -104
  283. package/source/api-data-generators/support/Supervise/test_data_generation_configurations.json +0 -43
  284. package/source/api-data-generators/support/SupportPlan/test_data_generation_configurations.json +0 -65
  285. package/source/api-data-generators/support/Tab/test_data_generation_configurations.json +0 -29
  286. package/source/api-data-generators/support/Target/test_data_generation_configurations.json +0 -97
  287. package/source/api-data-generators/support/Task/test_data_generation_configurations.json +0 -219
  288. package/source/api-data-generators/support/TaskAttachment/test_data_generation_configurations.json +0 -42
  289. package/source/api-data-generators/support/TaskComments/test_data_generation_configurations.json +0 -45
  290. package/source/api-data-generators/support/TaskTimeEntry/test_data_generation_configurations.json +0 -87
  291. package/source/api-data-generators/support/TaskTimer/test_data_generation_configurations.json +0 -27
  292. package/source/api-data-generators/support/Team/test_data_generation_configurations.json +0 -115
  293. package/source/api-data-generators/support/TemplateFolders/test_data_generation_configurations.json +0 -72
  294. package/source/api-data-generators/support/Thread/test_data_generation_configurations.json +0 -383
  295. package/source/api-data-generators/support/Ticket/test_data_generation_configurations.json +0 -694
  296. package/source/api-data-generators/support/TicketApprovals/test_data_generation_configurations.json +0 -66
  297. package/source/api-data-generators/support/TicketAttachment/test_data_generation_configurations.json +0 -58
  298. package/source/api-data-generators/support/TicketComment/test_data_generation_configurations.json +0 -82
  299. package/source/api-data-generators/support/TicketCount/test_data_generation_configurations.json +0 -43
  300. package/source/api-data-generators/support/TicketFollowers/test_data_generation_configurations.json +0 -65
  301. package/source/api-data-generators/support/TicketMetrics/test_data_generation_configurations.json +0 -16
  302. package/source/api-data-generators/support/TicketTag/test_data_generation_configurations.json +0 -99
  303. package/source/api-data-generators/support/TicketTemplate/test_data_generation_configurations.json +0 -475
  304. package/source/api-data-generators/support/TicketTimeEntry/test_data_generation_configurations.json +0 -110
  305. package/source/api-data-generators/support/TicketTimer/test_data_generation_configurations.json +0 -48
  306. package/source/api-data-generators/support/TicketWithChildren/test_data_generation_configurations.json +0 -91
  307. package/source/api-data-generators/support/TimeTracking/test_data_generation_configurations.json +0 -46
  308. package/source/api-data-generators/support/TranslationLanguages/test_data_generation_configurations.json +0 -68
  309. package/source/api-data-generators/support/Upload/test_data_generation_configurations.json +0 -54
  310. package/source/api-data-generators/support/User/test_data_generation_configurations.json +0 -100
  311. package/source/api-data-generators/support/UserAuthentication/test_data_generation_configurations.json +0 -49
  312. package/source/api-data-generators/support/UserPresence/test_data_generation_configurations.json +0 -19
  313. package/source/api-data-generators/support/ValidationRuleCriteria/test_data_generation_configurations.json +0 -19
  314. package/source/api-data-generators/support/ValidationRules/test_data_generation_configurations.json +0 -321
  315. package/source/api-data-generators/support/Webhook/test_data_generation_configurations.json +0 -501
  316. package/source/api-data-generators/support/Widget/test_data_generation_configurations.json +0 -166
  317. package/source/api-data-generators/support/ZIAAnswerbotInference/test_data_generation_configurations.json +0 -26
  318. package/source/api-data-generators/support/ZIADocumentData/test_data_generation_configurations.json +0 -38
  319. package/source/api-data-generators/support/ZIAVectorSearch/test_data_generation_configurations.json +0 -22
  320. package/source/api-data-generators/support/ZiaGPT/test_data_generation_configurations.json +0 -19
  321. package/source/api-data-generators/support/ZiaScheduler/test_data_generation_configurations.json +0 -22
  322. package/source/api-data-generators/support/ZiapoweredbyGPT/test_data_generation_configurations.json +0 -33
  323. package/source/api-data-generators/support/Zwitch/test_data_generation_configurations.json +0 -71
  324. package/source/api-data-generators/support/blueprintDrafts/test_data_generation_configurations.json +0 -859
  325. package/source/api-data-generators/support/blueprintTransitions/test_data_generation_configurations.json +0 -26
  326. package/source/api-data-generators/support/blueprints/test_data_generation_configurations.json +0 -652
  327. package/source/api-data-generators/support/borrow_book/test_data_generation_configurations.json +0 -21
  328. package/source/api-data-generators/support/zlabsnlp/test_data_generation_configurations.json +0 -50
  329. package/source/openapi-specifications/v1.0/common/Common.json +0 -587
  330. package/source/openapi-specifications/v1.0/portal/Account.json +0 -183
  331. package/source/openapi-specifications/v1.0/portal/ArticleComment.json +0 -1103
  332. package/source/openapi-specifications/v1.0/portal/ArticleFeedback.json +0 -133
  333. package/source/openapi-specifications/v1.0/portal/AsapMobile.json +0 -712
  334. package/source/openapi-specifications/v1.0/portal/AsapWeb.json +0 -91
  335. package/source/openapi-specifications/v1.0/portal/Attachment.json +0 -122
  336. package/source/openapi-specifications/v1.0/portal/Captcha.json +0 -334
  337. package/source/openapi-specifications/v1.0/portal/Category.json +0 -1061
  338. package/source/openapi-specifications/v1.0/portal/Comment.json +0 -1546
  339. package/source/openapi-specifications/v1.0/portal/Community.json +0 -235
  340. package/source/openapi-specifications/v1.0/portal/CommunityUser.json +0 -296
  341. package/source/openapi-specifications/v1.0/portal/Contact.json +0 -536
  342. package/source/openapi-specifications/v1.0/portal/CustomerHappiness.json +0 -163
  343. package/source/openapi-specifications/v1.0/portal/Department.json +0 -246
  344. package/source/openapi-specifications/v1.0/portal/Extension.json +0 -1122
  345. package/source/openapi-specifications/v1.0/portal/FeedbackWidget.json +0 -96
  346. package/source/openapi-specifications/v1.0/portal/Field.json +0 -1239
  347. package/source/openapi-specifications/v1.0/portal/FileExport.json +0 -313
  348. package/source/openapi-specifications/v1.0/portal/Followers.json +0 -802
  349. package/source/openapi-specifications/v1.0/portal/Gamification.json +0 -819
  350. package/source/openapi-specifications/v1.0/portal/HashTags.json +0 -61
  351. package/source/openapi-specifications/v1.0/portal/HelpCenterUser.json +0 -605
  352. package/source/openapi-specifications/v1.0/portal/HelpCenterUserPreference.json +0 -148
  353. package/source/openapi-specifications/v1.0/portal/Helpcenter.json +0 -920
  354. package/source/openapi-specifications/v1.0/portal/HelpcenterGroups.json +0 -118
  355. package/source/openapi-specifications/v1.0/portal/HelpcenterPages.json +0 -184
  356. package/source/openapi-specifications/v1.0/portal/KBCategoryTranslation.json +0 -70
  357. package/source/openapi-specifications/v1.0/portal/KBRootCategory.json +0 -1310
  358. package/source/openapi-specifications/v1.0/portal/KbCategory.json +0 -1525
  359. package/source/openapi-specifications/v1.0/portal/KbSection.json +0 -515
  360. package/source/openapi-specifications/v1.0/portal/Label.json +0 -172
  361. package/source/openapi-specifications/v1.0/portal/Layout.json +0 -303
  362. package/source/openapi-specifications/v1.0/portal/LayoutRules.json +0 -375
  363. package/source/openapi-specifications/v1.0/portal/Mentions.json +0 -580
  364. package/source/openapi-specifications/v1.0/portal/NewAsapMobile.json +0 -699
  365. package/source/openapi-specifications/v1.0/portal/Permalink.json +0 -265
  366. package/source/openapi-specifications/v1.0/portal/Placeholders.json +0 -57
  367. package/source/openapi-specifications/v1.0/portal/Product.json +0 -401
  368. package/source/openapi-specifications/v1.0/portal/Solution.json +0 -3766
  369. package/source/openapi-specifications/v1.0/portal/Thread.json +0 -821
  370. package/source/openapi-specifications/v1.0/portal/Ticket.json +0 -2636
  371. package/source/openapi-specifications/v1.0/portal/TicketComment.json +0 -822
  372. package/source/openapi-specifications/v1.0/portal/TicketCount.json +0 -336
  373. package/source/openapi-specifications/v1.0/portal/TicketExport.json +0 -609
  374. package/source/openapi-specifications/v1.0/portal/TicketField.json +0 -358
  375. package/source/openapi-specifications/v1.0/portal/TicketForm.json +0 -517
  376. package/source/openapi-specifications/v1.0/portal/TicketStatusMapping.json +0 -155
  377. package/source/openapi-specifications/v1.0/portal/TicketTemplate.json +0 -409
  378. package/source/openapi-specifications/v1.0/portal/TicketsViewCount.json +0 -175
  379. package/source/openapi-specifications/v1.0/portal/Topic.json +0 -4079
  380. package/source/openapi-specifications/v1.0/portal/Translation.json +0 -174
  381. package/source/openapi-specifications/v1.0/portal/Upload.json +0 -156
  382. package/source/openapi-specifications/v1.0/portal/ValidationRules.json +0 -309
  383. package/source/openapi-specifications/v1.0/portal/View.json +0 -353
  384. package/source/openapi-specifications/v1.0/portal/Widget.json +0 -218
  385. package/source/openapi-specifications/v1.0/support/AEAdminTool.json +0 -354
  386. package/source/openapi-specifications/v1.0/support/Account.json +0 -3206
  387. package/source/openapi-specifications/v1.0/support/AccountAttachment.json +0 -484
  388. package/source/openapi-specifications/v1.0/support/AccountComments.json +0 -794
  389. package/source/openapi-specifications/v1.0/support/AccountContactMappingInfo.json +0 -227
  390. package/source/openapi-specifications/v1.0/support/AccountDeduplication.json +0 -578
  391. package/source/openapi-specifications/v1.0/support/AccountFollowers.json +0 -350
  392. package/source/openapi-specifications/v1.0/support/AccountSla.json +0 -341
  393. package/source/openapi-specifications/v1.0/support/AccountTimeEntry.json +0 -1152
  394. package/source/openapi-specifications/v1.0/support/ActiveCalls.json +0 -573
  395. package/source/openapi-specifications/v1.0/support/Activity.json +0 -1400
  396. package/source/openapi-specifications/v1.0/support/Actor.json +0 -88
  397. package/source/openapi-specifications/v1.0/support/ActorsAPI.json +0 -304
  398. package/source/openapi-specifications/v1.0/support/AdminTool.json +0 -489
  399. package/source/openapi-specifications/v1.0/support/Agent.json +0 -6685
  400. package/source/openapi-specifications/v1.0/support/AgentPresence.json +0 -567
  401. package/source/openapi-specifications/v1.0/support/AgentRoom.json +0 -1997
  402. package/source/openapi-specifications/v1.0/support/AgentSignatures.json +0 -359
  403. package/source/openapi-specifications/v1.0/support/AgentTimeEntry.json +0 -1402
  404. package/source/openapi-specifications/v1.0/support/AntiSpamInfo.json +0 -510
  405. package/source/openapi-specifications/v1.0/support/ApiCreditNotificationRule.json +0 -1189
  406. package/source/openapi-specifications/v1.0/support/ApiDashboard.json +0 -543
  407. package/source/openapi-specifications/v1.0/support/ApplicationFlags.json +0 -155
  408. package/source/openapi-specifications/v1.0/support/ArchivedView.json +0 -469
  409. package/source/openapi-specifications/v1.0/support/Article.json +0 -5060
  410. package/source/openapi-specifications/v1.0/support/ArticleAttachment.json +0 -544
  411. package/source/openapi-specifications/v1.0/support/ArticleComment.json +0 -1929
  412. package/source/openapi-specifications/v1.0/support/ArticleExternalImageUrlResponse.json +0 -56
  413. package/source/openapi-specifications/v1.0/support/ArticleFeedback.json +0 -1314
  414. package/source/openapi-specifications/v1.0/support/ArticleFeedbackResolution.json +0 -513
  415. package/source/openapi-specifications/v1.0/support/ArticleHistory.json +0 -2510
  416. package/source/openapi-specifications/v1.0/support/ArticleStatistics.json +0 -3053
  417. package/source/openapi-specifications/v1.0/support/ArticleTranslation.json +0 -7530
  418. package/source/openapi-specifications/v1.0/support/ArticleVersion.json +0 -184
  419. package/source/openapi-specifications/v1.0/support/ArticleViews.json +0 -564
  420. package/source/openapi-specifications/v1.0/support/Asap.json +0 -1525
  421. package/source/openapi-specifications/v1.0/support/AsapModule.json +0 -246
  422. package/source/openapi-specifications/v1.0/support/AsapStatus.json +0 -199
  423. package/source/openapi-specifications/v1.0/support/AssistInteg.json +0 -613
  424. package/source/openapi-specifications/v1.0/support/AttachmentRestriction.json +0 -786
  425. package/source/openapi-specifications/v1.0/support/AuditLog.json +0 -1122
  426. package/source/openapi-specifications/v1.0/support/AutomatedSummaryForChats.json +0 -702
  427. package/source/openapi-specifications/v1.0/support/AutomationAlerts.json +0 -868
  428. package/source/openapi-specifications/v1.0/support/AutomationEngine.json +0 -1181
  429. package/source/openapi-specifications/v1.0/support/AutomationFeatureCount.json +0 -207
  430. package/source/openapi-specifications/v1.0/support/AutomationFieldUpdates.json +0 -809
  431. package/source/openapi-specifications/v1.0/support/AutomationTask.json +0 -1054
  432. package/source/openapi-specifications/v1.0/support/Backup.json +0 -2845
  433. package/source/openapi-specifications/v1.0/support/Badge.json +0 -544
  434. package/source/openapi-specifications/v1.0/support/Bot.json +0 -2103
  435. package/source/openapi-specifications/v1.0/support/BotInference.json +0 -1071
  436. package/source/openapi-specifications/v1.0/support/BotResources.json +0 -175
  437. package/source/openapi-specifications/v1.0/support/BotStaticResources.json +0 -541
  438. package/source/openapi-specifications/v1.0/support/Bot_UserInfo.json +0 -63
  439. package/source/openapi-specifications/v1.0/support/Bots.json +0 -58
  440. package/source/openapi-specifications/v1.0/support/BugInteg.json +0 -481
  441. package/source/openapi-specifications/v1.0/support/BulkAction.json +0 -150
  442. package/source/openapi-specifications/v1.0/support/BulkImport.json +0 -2845
  443. package/source/openapi-specifications/v1.0/support/BulkUpdate.json +0 -743
  444. package/source/openapi-specifications/v1.0/support/BulkWrite.json +0 -678
  445. package/source/openapi-specifications/v1.0/support/BusinessHour.json +0 -1344
  446. package/source/openapi-specifications/v1.0/support/Call.json +0 -3839
  447. package/source/openapi-specifications/v1.0/support/CallComments.json +0 -721
  448. package/source/openapi-specifications/v1.0/support/CallHistory.json +0 -936
  449. package/source/openapi-specifications/v1.0/support/CallTimeEntry.json +0 -1745
  450. package/source/openapi-specifications/v1.0/support/CallTimer.json +0 -285
  451. package/source/openapi-specifications/v1.0/support/Channel.json +0 -730
  452. package/source/openapi-specifications/v1.0/support/Chart.json +0 -422
  453. package/source/openapi-specifications/v1.0/support/ChatTicket.json +0 -553
  454. package/source/openapi-specifications/v1.0/support/ClientAction.json +0 -1834
  455. package/source/openapi-specifications/v1.0/support/ClientEvent.json +0 -780
  456. package/source/openapi-specifications/v1.0/support/CliqIntegJsonMapping.json +0 -1123
  457. package/source/openapi-specifications/v1.0/support/CloudAttachment.json +0 -528
  458. package/source/openapi-specifications/v1.0/support/CommonMassActionError.json +0 -44
  459. package/source/openapi-specifications/v1.0/support/CommonMassActionResponse.json +0 -94
  460. package/source/openapi-specifications/v1.0/support/Community.json +0 -2545
  461. package/source/openapi-specifications/v1.0/support/CommunityAttachment.json +0 -249
  462. package/source/openapi-specifications/v1.0/support/CommunityCategory.json +0 -1896
  463. package/source/openapi-specifications/v1.0/support/CommunityCategoryLogo.json +0 -145
  464. package/source/openapi-specifications/v1.0/support/CommunityComment.json +0 -2492
  465. package/source/openapi-specifications/v1.0/support/CommunityInitPermissions.json +0 -129
  466. package/source/openapi-specifications/v1.0/support/CommunityPreferences.json +0 -343
  467. package/source/openapi-specifications/v1.0/support/CommunitySearch.json +0 -78
  468. package/source/openapi-specifications/v1.0/support/CommunityTopic.json +0 -6005
  469. package/source/openapi-specifications/v1.0/support/CommunityTopicInsights.json +0 -310
  470. package/source/openapi-specifications/v1.0/support/CommunityUser.json +0 -822
  471. package/source/openapi-specifications/v1.0/support/Composite.json +0 -414
  472. package/source/openapi-specifications/v1.0/support/Contact.json +0 -4691
  473. package/source/openapi-specifications/v1.0/support/ContactAttachment.json +0 -484
  474. package/source/openapi-specifications/v1.0/support/ContactComments.json +0 -769
  475. package/source/openapi-specifications/v1.0/support/ContactDeduplication.json +0 -683
  476. package/source/openapi-specifications/v1.0/support/ContactFollowers.json +0 -350
  477. package/source/openapi-specifications/v1.0/support/ContactProfile.json +0 -195
  478. package/source/openapi-specifications/v1.0/support/ContactTimeEntry.json +0 -1157
  479. package/source/openapi-specifications/v1.0/support/Contract.json +0 -2877
  480. package/source/openapi-specifications/v1.0/support/ContractAttachment.json +0 -307
  481. package/source/openapi-specifications/v1.0/support/Conversation.json +0 -570
  482. package/source/openapi-specifications/v1.0/support/CountriesAndLanguages.json +0 -5279
  483. package/source/openapi-specifications/v1.0/support/CreditCycle.json +0 -124
  484. package/source/openapi-specifications/v1.0/support/Criteria.json +0 -1014
  485. package/source/openapi-specifications/v1.0/support/CriteriaValue.json +0 -50
  486. package/source/openapi-specifications/v1.0/support/CrmInteg.json +0 -5938
  487. package/source/openapi-specifications/v1.0/support/CustomAction.json +0 -2106
  488. package/source/openapi-specifications/v1.0/support/CustomActionRuleMapping.json +0 -1327
  489. package/source/openapi-specifications/v1.0/support/CustomButton.json +0 -1898
  490. package/source/openapi-specifications/v1.0/support/CustomFunctionExecutionLogs.json +0 -883
  491. package/source/openapi-specifications/v1.0/support/CustomFunctionGallery.json +0 -329
  492. package/source/openapi-specifications/v1.0/support/CustomFunctionReRun.json +0 -317
  493. package/source/openapi-specifications/v1.0/support/CustomFunctionZiaCopilot.json +0 -379
  494. package/source/openapi-specifications/v1.0/support/CustomFunctions.json +0 -3457
  495. package/source/openapi-specifications/v1.0/support/CustomModuleAdminTool.json +0 -81
  496. package/source/openapi-specifications/v1.0/support/CustomTheme.json +0 -7391
  497. package/source/openapi-specifications/v1.0/support/CustomView.json +0 -3478
  498. package/source/openapi-specifications/v1.0/support/CustomerHappiness.json +0 -464
  499. package/source/openapi-specifications/v1.0/support/DBThrottle.json +0 -334
  500. package/source/openapi-specifications/v1.0/support/DashboardComponent.json +0 -1163
  501. package/source/openapi-specifications/v1.0/support/DashboardFolder.json +0 -1258
  502. package/source/openapi-specifications/v1.0/support/DashboardMetrics.json +0 -2310
  503. package/source/openapi-specifications/v1.0/support/Dashboards.json +0 -1219
  504. package/source/openapi-specifications/v1.0/support/DataChips.json +0 -477
  505. package/source/openapi-specifications/v1.0/support/DataImport.json +0 -1099
  506. package/source/openapi-specifications/v1.0/support/DataSync.json +0 -1246
  507. package/source/openapi-specifications/v1.0/support/DatasetEntry.json +0 -153
  508. package/source/openapi-specifications/v1.0/support/Department.json +0 -1971
  509. package/source/openapi-specifications/v1.0/support/DependencyMappings.json +0 -656
  510. package/source/openapi-specifications/v1.0/support/DirectAssignRuleTarget.json +0 -232
  511. package/source/openapi-specifications/v1.0/support/DirectAssignmentRules.json +0 -722
  512. package/source/openapi-specifications/v1.0/support/DisplayEntity.json +0 -91
  513. package/source/openapi-specifications/v1.0/support/DomainMapping.json +0 -1143
  514. package/source/openapi-specifications/v1.0/support/EmailFailureAlert.json +0 -306
  515. package/source/openapi-specifications/v1.0/support/EmailTemplates.json +0 -1491
  516. package/source/openapi-specifications/v1.0/support/EntityBlueprints.json +0 -572
  517. package/source/openapi-specifications/v1.0/support/Event.json +0 -3607
  518. package/source/openapi-specifications/v1.0/support/EventComments.json +0 -737
  519. package/source/openapi-specifications/v1.0/support/EventTimeEntry.json +0 -1520
  520. package/source/openapi-specifications/v1.0/support/EventTimer.json +0 -285
  521. package/source/openapi-specifications/v1.0/support/Expression.json +0 -43
  522. package/source/openapi-specifications/v1.0/support/Extension.json +0 -7152
  523. package/source/openapi-specifications/v1.0/support/ExtensionOrg.json +0 -129
  524. package/source/openapi-specifications/v1.0/support/FAQ.json +0 -142
  525. package/source/openapi-specifications/v1.0/support/FAQTranslation.json +0 -178
  526. package/source/openapi-specifications/v1.0/support/FbManager.json +0 -1147
  527. package/source/openapi-specifications/v1.0/support/Feature.json +0 -691
  528. package/source/openapi-specifications/v1.0/support/FeatureFile.json +0 -435
  529. package/source/openapi-specifications/v1.0/support/FeatureFolder.json +0 -576
  530. package/source/openapi-specifications/v1.0/support/FeaturePermission.json +0 -492
  531. package/source/openapi-specifications/v1.0/support/FederatedLogin.json +0 -318
  532. package/source/openapi-specifications/v1.0/support/FeedsAPIs.json +0 -198
  533. package/source/openapi-specifications/v1.0/support/Field.json +0 -7493
  534. package/source/openapi-specifications/v1.0/support/FieldDetails.json +0 -139
  535. package/source/openapi-specifications/v1.0/support/FieldPermissions.json +0 -113
  536. package/source/openapi-specifications/v1.0/support/FieldPrediction.json +0 -3831
  537. package/source/openapi-specifications/v1.0/support/FileExport.json +0 -324
  538. package/source/openapi-specifications/v1.0/support/Finance.json +0 -4290
  539. package/source/openapi-specifications/v1.0/support/Followers.json +0 -875
  540. package/source/openapi-specifications/v1.0/support/FormulaFunctions.json +0 -47
  541. package/source/openapi-specifications/v1.0/support/GC_Bots.json +0 -138
  542. package/source/openapi-specifications/v1.0/support/GC_Guide.json +0 -1536
  543. package/source/openapi-specifications/v1.0/support/GC_GuideHistories.json +0 -58
  544. package/source/openapi-specifications/v1.0/support/GC_GuideHistory.json +0 -79
  545. package/source/openapi-specifications/v1.0/support/GC_Guides.json +0 -89
  546. package/source/openapi-specifications/v1.0/support/GC_Info.json +0 -208
  547. package/source/openapi-specifications/v1.0/support/GC_Status.json +0 -69
  548. package/source/openapi-specifications/v1.0/support/GC_UserInfo.json +0 -79
  549. package/source/openapi-specifications/v1.0/support/GenericAction.json +0 -1888
  550. package/source/openapi-specifications/v1.0/support/GenericActionMapping.json +0 -1050
  551. package/source/openapi-specifications/v1.0/support/GoogleAnalytics.json +0 -1715
  552. package/source/openapi-specifications/v1.0/support/GoogleChat.json +0 -650
  553. package/source/openapi-specifications/v1.0/support/HelpCenterCommon.json +0 -44
  554. package/source/openapi-specifications/v1.0/support/Help_Center_OIDC_Authentication.json +0 -900
  555. package/source/openapi-specifications/v1.0/support/Helpcenter.json +0 -1212
  556. package/source/openapi-specifications/v1.0/support/HelpcenterAutoTranslateSetting.json +0 -331
  557. package/source/openapi-specifications/v1.0/support/HelpcenterGroups.json +0 -1496
  558. package/source/openapi-specifications/v1.0/support/HelpcenterPages.json +0 -504
  559. package/source/openapi-specifications/v1.0/support/HelpcenterPreference.json +0 -208
  560. package/source/openapi-specifications/v1.0/support/HelpcenterTranslationApp.json +0 -64
  561. package/source/openapi-specifications/v1.0/support/HelpcenterUpload.json +0 -211
  562. package/source/openapi-specifications/v1.0/support/HolidayList.json +0 -731
  563. package/source/openapi-specifications/v1.0/support/IMAPAddress.json +0 -1091
  564. package/source/openapi-specifications/v1.0/support/IMCannedMessage.json +0 -1357
  565. package/source/openapi-specifications/v1.0/support/IMCannedMessagePlaceHolders.json +0 -169
  566. package/source/openapi-specifications/v1.0/support/IMCannedMessageTranslation.json +0 -624
  567. package/source/openapi-specifications/v1.0/support/IMTemplateMessage.json +0 -597
  568. package/source/openapi-specifications/v1.0/support/IM_AddOn.json +0 -841
  569. package/source/openapi-specifications/v1.0/support/IM_AttachmentMessage.json +0 -64
  570. package/source/openapi-specifications/v1.0/support/IM_Bot.json +0 -1007
  571. package/source/openapi-specifications/v1.0/support/IM_BotService.json +0 -357
  572. package/source/openapi-specifications/v1.0/support/IM_Broadcast.json +0 -323
  573. package/source/openapi-specifications/v1.0/support/IM_Channel.json +0 -2849
  574. package/source/openapi-specifications/v1.0/support/IM_ChannelPreference.json +0 -502
  575. package/source/openapi-specifications/v1.0/support/IM_Contact.json +0 -165
  576. package/source/openapi-specifications/v1.0/support/IM_Efc.json +0 -188
  577. package/source/openapi-specifications/v1.0/support/IM_Integration.json +0 -1269
  578. package/source/openapi-specifications/v1.0/support/IM_IntegrationService.json +0 -454
  579. package/source/openapi-specifications/v1.0/support/IM_LayoutView.json +0 -625
  580. package/source/openapi-specifications/v1.0/support/IM_License.json +0 -225
  581. package/source/openapi-specifications/v1.0/support/IM_Message.json +0 -1371
  582. package/source/openapi-specifications/v1.0/support/IM_Metrics.json +0 -462
  583. package/source/openapi-specifications/v1.0/support/IM_Search.json +0 -547
  584. package/source/openapi-specifications/v1.0/support/IM_Session.json +0 -1397
  585. package/source/openapi-specifications/v1.0/support/IM_TemplateButton.json +0 -142
  586. package/source/openapi-specifications/v1.0/support/IM_TemplateFooter.json +0 -83
  587. package/source/openapi-specifications/v1.0/support/IM_TemplateHeader.json +0 -86
  588. package/source/openapi-specifications/v1.0/support/IM_TemplateItems.json +0 -73
  589. package/source/openapi-specifications/v1.0/support/IM_TimeSeriesMetrics.json +0 -435
  590. package/source/openapi-specifications/v1.0/support/IM_TwilioPhoneNumber.json +0 -202
  591. package/source/openapi-specifications/v1.0/support/IM_WhatsApp_Integrations.json +0 -193
  592. package/source/openapi-specifications/v1.0/support/IM_ZiaGpt.json +0 -489
  593. package/source/openapi-specifications/v1.0/support/Import.json +0 -1844
  594. package/source/openapi-specifications/v1.0/support/IncrementalDocuments.json +0 -395
  595. package/source/openapi-specifications/v1.0/support/Inference.json +0 -307
  596. package/source/openapi-specifications/v1.0/support/InlineImage.json +0 -97
  597. package/source/openapi-specifications/v1.0/support/IntegModule.json +0 -938
  598. package/source/openapi-specifications/v1.0/support/Integrations.json +0 -1264
  599. package/source/openapi-specifications/v1.0/support/InteractiveTours.json +0 -539
  600. package/source/openapi-specifications/v1.0/support/JWT.json +0 -535
  601. package/source/openapi-specifications/v1.0/support/KBCategoryPermalink.json +0 -208
  602. package/source/openapi-specifications/v1.0/support/KBCategoryUser.json +0 -241
  603. package/source/openapi-specifications/v1.0/support/KBPreference.json +0 -323
  604. package/source/openapi-specifications/v1.0/support/KBRecycleBin.json +0 -2316
  605. package/source/openapi-specifications/v1.0/support/KBRootCategory.json +0 -2839
  606. package/source/openapi-specifications/v1.0/support/KBRootCategoryTranslation.json +0 -570
  607. package/source/openapi-specifications/v1.0/support/KBSection.json +0 -1941
  608. package/source/openapi-specifications/v1.0/support/KBTranslationMassActionResponse.json +0 -169
  609. package/source/openapi-specifications/v1.0/support/KPIWidget.json +0 -206
  610. package/source/openapi-specifications/v1.0/support/KbBot.json +0 -511
  611. package/source/openapi-specifications/v1.0/support/KbCategory.json +0 -1618
  612. package/source/openapi-specifications/v1.0/support/KbCategoryLogo.json +0 -124
  613. package/source/openapi-specifications/v1.0/support/Label.json +0 -1251
  614. package/source/openapi-specifications/v1.0/support/Layout.json +0 -8042
  615. package/source/openapi-specifications/v1.0/support/LayoutRuleCriteria.json +0 -491
  616. package/source/openapi-specifications/v1.0/support/LayoutRules.json +0 -1422
  617. package/source/openapi-specifications/v1.0/support/LensInteg.json +0 -86
  618. package/source/openapi-specifications/v1.0/support/LicenseFeaturePlan.json +0 -548
  619. package/source/openapi-specifications/v1.0/support/LicenseInfo.json +0 -1231
  620. package/source/openapi-specifications/v1.0/support/LicenseTool.json +0 -165
  621. package/source/openapi-specifications/v1.0/support/Livecall.json +0 -954
  622. package/source/openapi-specifications/v1.0/support/LookupRecord.json +0 -174
  623. package/source/openapi-specifications/v1.0/support/Macros.json +0 -1960
  624. package/source/openapi-specifications/v1.0/support/MailReplyAddress.json +0 -1263
  625. package/source/openapi-specifications/v1.0/support/MassAction.json +0 -1151
  626. package/source/openapi-specifications/v1.0/support/MassActionError.json +0 -55
  627. package/source/openapi-specifications/v1.0/support/MassActionResponse.json +0 -89
  628. package/source/openapi-specifications/v1.0/support/Mentions.json +0 -491
  629. package/source/openapi-specifications/v1.0/support/Message.json +0 -685
  630. package/source/openapi-specifications/v1.0/support/Microsoft.json +0 -887
  631. package/source/openapi-specifications/v1.0/support/MicrosoftTeams.json +0 -574
  632. package/source/openapi-specifications/v1.0/support/Microsoft_PowerBI.json +0 -903
  633. package/source/openapi-specifications/v1.0/support/Misc.json +0 -214
  634. package/source/openapi-specifications/v1.0/support/Module.json +0 -1625
  635. package/source/openapi-specifications/v1.0/support/NewCriteria.json +0 -1863
  636. package/source/openapi-specifications/v1.0/support/NewFeatureFields.json +0 -204
  637. package/source/openapi-specifications/v1.0/support/NewTicketHistory.json +0 -150
  638. package/source/openapi-specifications/v1.0/support/NotificationRules.json +0 -441
  639. package/source/openapi-specifications/v1.0/support/OEmbedData.json +0 -233
  640. package/source/openapi-specifications/v1.0/support/Onboarding.json +0 -282
  641. package/source/openapi-specifications/v1.0/support/Organization.json +0 -1391
  642. package/source/openapi-specifications/v1.0/support/PBGroup.json +0 -634
  643. package/source/openapi-specifications/v1.0/support/PBGroupAgents.json +0 -433
  644. package/source/openapi-specifications/v1.0/support/PBPlatform.json +0 -1447
  645. package/source/openapi-specifications/v1.0/support/PBX.json +0 -550
  646. package/source/openapi-specifications/v1.0/support/PBXConfig.json +0 -219
  647. package/source/openapi-specifications/v1.0/support/PBXPhoneNumbers.json +0 -443
  648. package/source/openapi-specifications/v1.0/support/PBXPreference.json +0 -314
  649. package/source/openapi-specifications/v1.0/support/PageSense.json +0 -1505
  650. package/source/openapi-specifications/v1.0/support/PendingApproval.json +0 -279
  651. package/source/openapi-specifications/v1.0/support/Permalink.json +0 -393
  652. package/source/openapi-specifications/v1.0/support/PhoneAgents.json +0 -1014
  653. package/source/openapi-specifications/v1.0/support/PhoneMenu.json +0 -118
  654. package/source/openapi-specifications/v1.0/support/PinnedConversation.json +0 -1115
  655. package/source/openapi-specifications/v1.0/support/Pipeline_Info.json +0 -232
  656. package/source/openapi-specifications/v1.0/support/Pipeline_Service.json +0 -499
  657. package/source/openapi-specifications/v1.0/support/Product.json +0 -1861
  658. package/source/openapi-specifications/v1.0/support/ProductAttachment.json +0 -485
  659. package/source/openapi-specifications/v1.0/support/Profile.json +0 -4236
  660. package/source/openapi-specifications/v1.0/support/ProjectsInteg.json +0 -989
  661. package/source/openapi-specifications/v1.0/support/QueryStore.json +0 -238
  662. package/source/openapi-specifications/v1.0/support/QueueView.json +0 -335
  663. package/source/openapi-specifications/v1.0/support/RatelimitAdminTool.json +0 -1204
  664. package/source/openapi-specifications/v1.0/support/Records.json +0 -1509
  665. package/source/openapi-specifications/v1.0/support/Recyclebin.json +0 -669
  666. package/source/openapi-specifications/v1.0/support/RemoteAuth.json +0 -401
  667. package/source/openapi-specifications/v1.0/support/Report.json +0 -6491
  668. package/source/openapi-specifications/v1.0/support/ReportChart.json +0 -254
  669. package/source/openapi-specifications/v1.0/support/ReportFolder.json +0 -1076
  670. package/source/openapi-specifications/v1.0/support/ReportIntegration.json +0 -202
  671. package/source/openapi-specifications/v1.0/support/RequestFlags.json +0 -358
  672. package/source/openapi-specifications/v1.0/support/Resources.json +0 -335
  673. package/source/openapi-specifications/v1.0/support/ResponseHelpCenterUser.json +0 -128
  674. package/source/openapi-specifications/v1.0/support/Role.json +0 -996
  675. package/source/openapi-specifications/v1.0/support/RoundRobin.json +0 -796
  676. package/source/openapi-specifications/v1.0/support/RoundRobinTarget.json +0 -381
  677. package/source/openapi-specifications/v1.0/support/RoutingPreference.json +0 -615
  678. package/source/openapi-specifications/v1.0/support/RuleGroup.json +0 -1630
  679. package/source/openapi-specifications/v1.0/support/SLAMetaInfo.json +0 -227
  680. package/source/openapi-specifications/v1.0/support/Saml.json +0 -565
  681. package/source/openapi-specifications/v1.0/support/Sandbox.json +0 -1075
  682. package/source/openapi-specifications/v1.0/support/SandboxChangeset.json +0 -501
  683. package/source/openapi-specifications/v1.0/support/SandboxDeployment.json +0 -428
  684. package/source/openapi-specifications/v1.0/support/SandboxDeploymentLogs.json +0 -295
  685. package/source/openapi-specifications/v1.0/support/SandboxSourceOrganization.json +0 -268
  686. package/source/openapi-specifications/v1.0/support/SavedFilters.json +0 -652
  687. package/source/openapi-specifications/v1.0/support/Schedule.json +0 -2077
  688. package/source/openapi-specifications/v1.0/support/ScheduleReplyInfo.json +0 -2271
  689. package/source/openapi-specifications/v1.0/support/Search.json +0 -12600
  690. package/source/openapi-specifications/v1.0/support/SearchInteg.json +0 -2254
  691. package/source/openapi-specifications/v1.0/support/Setup.json +0 -1766
  692. package/source/openapi-specifications/v1.0/support/SharedSnippet.json +0 -1110
  693. package/source/openapi-specifications/v1.0/support/SharingRule.json +0 -287
  694. package/source/openapi-specifications/v1.0/support/Signature.json +0 -354
  695. package/source/openapi-specifications/v1.0/support/Skill.json +0 -2164
  696. package/source/openapi-specifications/v1.0/support/SkillConfiguration.json +0 -269
  697. package/source/openapi-specifications/v1.0/support/SkillType.json +0 -807
  698. package/source/openapi-specifications/v1.0/support/Slack.json +0 -957
  699. package/source/openapi-specifications/v1.0/support/SmsTemplates.json +0 -514
  700. package/source/openapi-specifications/v1.0/support/Snippets.json +0 -918
  701. package/source/openapi-specifications/v1.0/support/SocialBrands.json +0 -427
  702. package/source/openapi-specifications/v1.0/support/SocialInteg.json +0 -336
  703. package/source/openapi-specifications/v1.0/support/SocialPosts.json +0 -2460
  704. package/source/openapi-specifications/v1.0/support/SocialTwitterConversations.json +0 -337
  705. package/source/openapi-specifications/v1.0/support/StarredTemplates.json +0 -690
  706. package/source/openapi-specifications/v1.0/support/Statistics.json +0 -125
  707. package/source/openapi-specifications/v1.0/support/SubjectAccessRequest.json +0 -2419
  708. package/source/openapi-specifications/v1.0/support/Supervise.json +0 -774
  709. package/source/openapi-specifications/v1.0/support/SupportEmailAddress.json +0 -188
  710. package/source/openapi-specifications/v1.0/support/SupportEmailDomain.json +0 -293
  711. package/source/openapi-specifications/v1.0/support/SupportPlan.json +0 -1109
  712. package/source/openapi-specifications/v1.0/support/Tab.json +0 -606
  713. package/source/openapi-specifications/v1.0/support/Target.json +0 -1311
  714. package/source/openapi-specifications/v1.0/support/TargetFunctions.json +0 -130
  715. package/source/openapi-specifications/v1.0/support/Task.json +0 -4006
  716. package/source/openapi-specifications/v1.0/support/TaskAttachment.json +0 -443
  717. package/source/openapi-specifications/v1.0/support/TaskComments.json +0 -706
  718. package/source/openapi-specifications/v1.0/support/TaskTimeEntry.json +0 -1756
  719. package/source/openapi-specifications/v1.0/support/TaskTimer.json +0 -441
  720. package/source/openapi-specifications/v1.0/support/Team.json +0 -1383
  721. package/source/openapi-specifications/v1.0/support/TemplateFolders.json +0 -1069
  722. package/source/openapi-specifications/v1.0/support/Theme.json +0 -152
  723. package/source/openapi-specifications/v1.0/support/Thread.json +0 -3545
  724. package/source/openapi-specifications/v1.0/support/Ticket.json +0 -9495
  725. package/source/openapi-specifications/v1.0/support/TicketApprovals.json +0 -855
  726. package/source/openapi-specifications/v1.0/support/TicketAttachment.json +0 -562
  727. package/source/openapi-specifications/v1.0/support/TicketComment.json +0 -1444
  728. package/source/openapi-specifications/v1.0/support/TicketCount.json +0 -690
  729. package/source/openapi-specifications/v1.0/support/TicketFollowers.json +0 -454
  730. package/source/openapi-specifications/v1.0/support/TicketHistory.json +0 -414
  731. package/source/openapi-specifications/v1.0/support/TicketMetrics.json +0 -369
  732. package/source/openapi-specifications/v1.0/support/TicketRealTime.json +0 -178
  733. package/source/openapi-specifications/v1.0/support/TicketTag.json +0 -1513
  734. package/source/openapi-specifications/v1.0/support/TicketTemplate.json +0 -907
  735. package/source/openapi-specifications/v1.0/support/TicketTimeEntry.json +0 -1681
  736. package/source/openapi-specifications/v1.0/support/TicketTimer.json +0 -1205
  737. package/source/openapi-specifications/v1.0/support/TimeTracking.json +0 -1212
  738. package/source/openapi-specifications/v1.0/support/TrainingCourses.json +0 -614
  739. package/source/openapi-specifications/v1.0/support/TrainingIntegration.json +0 -163
  740. package/source/openapi-specifications/v1.0/support/TranslationLanguages.json +0 -2772
  741. package/source/openapi-specifications/v1.0/support/Upload.json +0 -620
  742. package/source/openapi-specifications/v1.0/support/User.json +0 -1409
  743. package/source/openapi-specifications/v1.0/support/UserAuthentication.json +0 -617
  744. package/source/openapi-specifications/v1.0/support/UserPresence.json +0 -763
  745. package/source/openapi-specifications/v1.0/support/ValidationRuleCriteria.json +0 -107
  746. package/source/openapi-specifications/v1.0/support/ValidationRules.json +0 -1173
  747. package/source/openapi-specifications/v1.0/support/Webhook.json +0 -1330
  748. package/source/openapi-specifications/v1.0/support/WhatsAppDetails.json +0 -132
  749. package/source/openapi-specifications/v1.0/support/WhatsAppMigration.json +0 -143
  750. package/source/openapi-specifications/v1.0/support/WhatsAppTemplateTags.json +0 -132
  751. package/source/openapi-specifications/v1.0/support/Widget.json +0 -3023
  752. package/source/openapi-specifications/v1.0/support/WmsDomain.json +0 -104
  753. package/source/openapi-specifications/v1.0/support/ZIAAnswerbotInference.json +0 -756
  754. package/source/openapi-specifications/v1.0/support/ZIADocumentData.json +0 -989
  755. package/source/openapi-specifications/v1.0/support/ZIASolutionService.json +0 -135
  756. package/source/openapi-specifications/v1.0/support/ZIAVectorSearch.json +0 -376
  757. package/source/openapi-specifications/v1.0/support/ZiaDCMigration.json +0 -159
  758. package/source/openapi-specifications/v1.0/support/ZiaGPT.json +0 -3229
  759. package/source/openapi-specifications/v1.0/support/ZiaScheduler.json +0 -453
  760. package/source/openapi-specifications/v1.0/support/Zwitch.json +0 -1543
  761. package/source/openapi-specifications/v1.0/support/blueprintChartData.json +0 -201
  762. package/source/openapi-specifications/v1.0/support/blueprintConnections.json +0 -75
  763. package/source/openapi-specifications/v1.0/support/blueprintCriteria.json +0 -255
  764. package/source/openapi-specifications/v1.0/support/blueprintDrafts.json +0 -1677
  765. package/source/openapi-specifications/v1.0/support/blueprintStates.json +0 -284
  766. package/source/openapi-specifications/v1.0/support/blueprintStrictModeConfig.json +0 -91
  767. package/source/openapi-specifications/v1.0/support/blueprintTransitions.json +0 -1546
  768. package/source/openapi-specifications/v1.0/support/blueprints.json +0 -2992
  769. package/source/openapi-specifications/v1.0/support/errors.json +0 -80
  770. package/source/openapi-specifications/v1.0/support/zlabsnlp.json +0 -416
@@ -1,3206 +0,0 @@
1
- {
2
- "openapi" : "3.1.0",
3
- "info" : {
4
- "title" : "Account",
5
- "version" : "1.0.0",
6
- "x-clan-group" : "accounts",
7
- "x-module-group" : "accounts"
8
- },
9
- "paths" : {
10
- "/api/v1/accounts/{accountId}/associateProducts" : {
11
- "post" : {
12
- "tags" : [ "Account" ],
13
- "summary" : "Associate products with an account",
14
- "description" : "This API associates products with an account. Only a maximum of 10 products can be associated with an account through a single API request.",
15
- "operationId" : "associateProductsWithAccount",
16
- "parameters" : [ {
17
- "$ref" : "#/components/parameters/accountId"
18
- }, {
19
- "$ref" : "../common/Common.json#/components/parameters/orgId"
20
- } ],
21
- "requestBody" : {
22
- "$ref" : "#/components/requestBodies/associateProductsWithAccount"
23
- },
24
- "responses" : {
25
- "200" : {
26
- "$ref" : "./MassActionResponse.json#/components/responses/massActionListResponse"
27
- },
28
- "422" : {
29
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
30
- }
31
- },
32
- "security" : [ {
33
- "org-oauth" : [ "Desk.accessAll.ALL" ]
34
- }, {
35
- "iam-oauth2-schema" : [ "Desk.contacts.UPDATE" ]
36
- } ],
37
- "x-audience" : [ "external-public" ],
38
- "x-custom-url-attribute" : {
39
- "security" : {
40
- "throttle" : {
41
- "policy" : "WriteAPI_Lenient_UserPolicy"
42
- },
43
- "extraparams" : {
44
- "disable" : true,
45
- "ignore" : false
46
- },
47
- "authentication" : { }
48
- },
49
- "clan-group" : "accounts",
50
- "apihash" : "243a2960a87793a8a28d2e480091afef",
51
- "module-group" : "accounts",
52
- "apimethod" : "com.zoho.support.restapi.AccountService.associateProductsWithAccount"
53
- }
54
- }
55
- },
56
- "/api/v1/accounts/{accountId}/merge" : {
57
- "post" : {
58
- "tags" : [ "Account" ],
59
- "summary" : "Merge Accounts",
60
- "description" : "This API merges two or more accounts.",
61
- "operationId" : "mergeAccounts",
62
- "parameters" : [ {
63
- "$ref" : "#/components/parameters/accountId"
64
- }, {
65
- "$ref" : "../common/Common.json#/components/parameters/orgId"
66
- } ],
67
- "requestBody" : {
68
- "$ref" : "#/components/requestBodies/accountMergeRequest"
69
- },
70
- "responses" : {
71
- "404" : {
72
- "$ref" : "../common/Common.json#/components/responses/urlNotFoundErrorResponse"
73
- },
74
- "200" : {
75
- "$ref" : "#/components/responses/accountResponse"
76
- },
77
- "422" : {
78
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
79
- },
80
- "500" : {
81
- "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
82
- },
83
- "403" : {
84
- "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
85
- }
86
- },
87
- "security" : [ {
88
- "org-oauth" : [ "Desk.accessAll.ALL" ]
89
- }, {
90
- "iam-oauth2-schema" : [ "Desk.contacts.UPDATE" ]
91
- } ],
92
- "x-audience" : [ "external-public" ],
93
- "x-custom-url-attribute" : {
94
- "security" : {
95
- "throttle" : {
96
- "policy" : "WriteAPI_Stringent_UserPolicy"
97
- },
98
- "extraparams" : {
99
- "disable" : true,
100
- "ignore" : false
101
- },
102
- "authentication" : { }
103
- },
104
- "clan-group" : "accounts",
105
- "apihash" : "3078cad06807a3f92dc34379d3beff2d",
106
- "module-group" : "accounts",
107
- "apimethod" : "com.zoho.support.restapi.AccountService.merge"
108
- }
109
- }
110
- },
111
- "/api/v1/contacts/{contactId}/accounts" : {
112
- "get" : {
113
- "tags" : [ "Account" ],
114
- "summary" : "List accounts of contact",
115
- "description" : "This API lists the accounts associated with a particular contact.",
116
- "operationId" : "getAccountsByContact",
117
- "parameters" : [ {
118
- "$ref" : "#/components/parameters/limit"
119
- }, {
120
- "$ref" : "#/components/parameters/from"
121
- }, {
122
- "name" : "sortBy",
123
- "in" : "query",
124
- "description" : "Sort by a specific attribute: @accountName@ or @createdTime@ or @mappingType@ . The default sorting order is ascending. A @-@ prefix denotes descending order of sorting.",
125
- "required" : false,
126
- "style" : "form",
127
- "explode" : true,
128
- "schema" : {
129
- "type" : [ "string", "null" ],
130
- "description" : "Sort by a specific attribute: @accountName@ or @createdTime@ or @mappingType@ . The default sorting order is ascending. A @-@ prefix denotes descending order of sorting.",
131
- "enum" : [ "accountName", "createdTime", "mappingType" ]
132
- }
133
- }, {
134
- "$ref" : "#/components/parameters/startsWith"
135
- }, {
136
- "$ref" : "#/components/parameters/contactId"
137
- }, {
138
- "$ref" : "../common/Common.json#/components/parameters/orgId"
139
- } ],
140
- "responses" : {
141
- "204" : {
142
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
143
- },
144
- "200" : {
145
- "$ref" : "#/components/responses/accountListWithMappingInfoArray"
146
- }
147
- },
148
- "security" : [ {
149
- "org-oauth" : [ "Desk.accessAll.ALL" ]
150
- }, {
151
- "iam-oauth2-schema" : [ "Desk.contacts.READ" ]
152
- } ],
153
- "x-audience" : [ "external-public" ],
154
- "x-custom-url-attribute" : {
155
- "security" : {
156
- "throttle" : {
157
- "policy" : "ReadAPI_Standard_UserPolicy"
158
- },
159
- "extraparams" : {
160
- "disable" : true,
161
- "ignore" : false
162
- },
163
- "authentication" : { }
164
- },
165
- "clan-group" : "contacts",
166
- "apihash" : "22cf770b56a22ef6cc65fd9c1c86cf46",
167
- "module-group" : "contacts",
168
- "apimethod" : "com.zoho.support.restapi.ContactService.getAssociatedAccountsForContact"
169
- }
170
- }
171
- },
172
- "/api/v1/accounts/{accountId}/statistics" : {
173
- "get" : {
174
- "tags" : [ "Account" ],
175
- "summary" : "Get account statistics",
176
- "description" : "This API fetches the overall statistics of an account.",
177
- "operationId" : "getAccountStatistics",
178
- "parameters" : [ {
179
- "$ref" : "#/components/parameters/departmentId"
180
- }, {
181
- "name" : "timeRange",
182
- "in" : "query",
183
- "description" : "Key that filters statistics observed in a specific date and time range. Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ; for example, timeRange=2017-11-05T00:00:00.000Z,2018-02-05T23:59:00.000Z. The maximum period allowed for the time range is six months.",
184
- "required" : false,
185
- "style" : "form",
186
- "explode" : true,
187
- "schema" : {
188
- "type" : [ "string", "null" ],
189
- "description" : "Key that filters statistics observed in a specific date and time range. Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ; for example, timeRange=2017-11-05T00:00:00.000Z,2018-02-05T23:59:00.000Z. The maximum period allowed for the time range is six months.",
190
- "maxLength" : 100,
191
- "minLength" : 0,
192
- "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)),(((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))|null",
193
- "x-audience" : [ "company-internal" ]
194
- }
195
- }, {
196
- "$ref" : "#/components/parameters/accountId"
197
- }, {
198
- "$ref" : "../common/Common.json#/components/parameters/orgId"
199
- } ],
200
- "responses" : {
201
- "404" : {
202
- "$ref" : "../common/Common.json#/components/responses/urlNotFoundErrorResponse"
203
- },
204
- "200" : {
205
- "$ref" : "./Statistics.json#/components/responses/statisticsResponse"
206
- },
207
- "422" : {
208
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
209
- },
210
- "401" : {
211
- "$ref" : "../common/Common.json#/components/responses/unauthorizedErrorResponse"
212
- }
213
- },
214
- "security" : [ {
215
- "org-oauth" : [ "Desk.accessAll.ALL" ]
216
- }, {
217
- "iam-oauth2-schema" : [ "Desk.contacts.READ" ]
218
- } ],
219
- "x-audience" : [ "external-public" ],
220
- "x-custom-url-attribute" : {
221
- "security" : {
222
- "throttle" : {
223
- "policy" : "ReadAPI_Standard_UserPolicy"
224
- },
225
- "extraparams" : {
226
- "disable" : true,
227
- "ignore" : false
228
- },
229
- "authentication" : { }
230
- },
231
- "clan-group" : "accounts",
232
- "apihash" : "bb8cfdc78f3d8bdd5dcc962b668c3312",
233
- "module-group" : "accounts",
234
- "apimethod" : "com.zoho.support.restapi.AccountService.getStatistics"
235
- }
236
- }
237
- },
238
- "/api/v1/accounts/{accountId}/tickets" : {
239
- "get" : {
240
- "tags" : [ "Account" ],
241
- "summary" : "List tickets by account",
242
- "description" : "This API lists tickets received from a specific account.",
243
- "operationId" : "getTicketsByAccount",
244
- "parameters" : [ {
245
- "name" : "include",
246
- "in" : "query",
247
- "description" : "Additional information related to the tickets. Values allowed are: contacts, products, departments, team, isRead and assignee. You can pass multiple values by separating them with a comma in the API request.",
248
- "required" : false,
249
- "style" : "simple",
250
- "explode" : true,
251
- "schema" : {
252
- "type" : [ "null", "array" ],
253
- "description" : "Additional information related to the tickets. Values allowed are: @contacts@, @products@, @departments@, @team@, @isRead@ and @assignee@. You can pass multiple values by separating them with a comma in the API request.",
254
- "items" : {
255
- "type" : [ "string", "null" ],
256
- "enum" : [ "contacts", "products", "departments", "team", "assignee", "isRead" ],
257
- "maxLength" : 100,
258
- "minLength" : 0,
259
- "x-custom-parameters-attributes" : [ ]
260
- },
261
- "uniqueItems" : true
262
- }
263
- }, {
264
- "name" : "statusType",
265
- "in" : "query",
266
- "description" : "Filter by status of the ticket. Values allowed are Open and On Hold and Closed. Both values include their sub-statuses too.",
267
- "required" : false,
268
- "style" : "form",
269
- "explode" : true,
270
- "schema" : {
271
- "type" : [ "string", "null" ],
272
- "description" : "Filter by status of the ticket. Values allowed are @Open@ and @On Hold@ and @Closed@. Both values include their sub-statuses too.",
273
- "enum" : [ "Open", "Closed" ],
274
- "maxLength" : 100,
275
- "minLength" : 0,
276
- "x-audience" : [ "company-internal" ]
277
- },
278
- "x-audience" : [ "company-internal" ]
279
- }, {
280
- "$ref" : "#/components/parameters/departmentId"
281
- }, {
282
- "name" : "dueDate",
283
- "in" : "query",
284
- "description" : "Filter by ticket duedate. Values allowed are @overdue@, @tomorrow@, @currentWeek@, @currentMonth@ and @today@. You can include both values by separating them with a comma",
285
- "required" : false,
286
- "style" : "form",
287
- "explode" : true,
288
- "schema" : {
289
- "type" : [ "string", "null" ],
290
- "description" : "Filter by ticket duedate. Values allowed are @overdue@, @tomorrow@, @currentWeek@, @currentMonth@ and @today@. You can include both values by separating them with a comma",
291
- "enum" : [ "overdue", "tomorrow", "currentWeek", "currentMonth", "today" ],
292
- "maxLength" : 100,
293
- "minLength" : 0,
294
- "x-custom-parameters-attributes" : {
295
- "split" : ","
296
- }
297
- }
298
- }, {
299
- "$ref" : "#/components/parameters/limit"
300
- }, {
301
- "$ref" : "#/components/parameters/from"
302
- }, {
303
- "name" : "sortBy",
304
- "in" : "query",
305
- "description" : "Sort by a specific attribute: @createdTime@ or @modifiedTime@. The default sorting order is ascending. A @-@ prefix denotes descending order of sorting.",
306
- "required" : false,
307
- "style" : "form",
308
- "explode" : true,
309
- "schema" : {
310
- "type" : [ "string", "null" ],
311
- "description" : "Sort by a specific attribute: @createdTime@ or @modifiedTime@. The default sorting order is ascending. A @-@ prefix denotes descending order of sorting.",
312
- "enum" : [ "createdTime", "modifiedTime" ],
313
- "maxLength" : 100,
314
- "minLength" : 0
315
- }
316
- }, {
317
- "name" : "isSpam",
318
- "in" : "query",
319
- "description" : "Filters Spam tickets",
320
- "required" : false,
321
- "style" : "form",
322
- "explode" : true,
323
- "schema" : {
324
- "type" : [ "boolean", "null" ],
325
- "description" : "Filters Spam tickets"
326
- }
327
- }, {
328
- "$ref" : "#/components/parameters/accountId"
329
- }, {
330
- "$ref" : "../common/Common.json#/components/parameters/orgId"
331
- } ],
332
- "responses" : {
333
- "204" : {
334
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
335
- },
336
- "200" : {
337
- "$ref" : "#/components/responses/getTicketsByAccountResponse"
338
- }
339
- },
340
- "security" : [ {
341
- "org-oauth" : [ "Desk.accessAll.ALL" ]
342
- }, {
343
- "iam-oauth2-schema" : [ "Desk.tickets.READ", "Desk.search.READ" ]
344
- } ],
345
- "x-audience" : [ "external-public" ],
346
- "x-custom-url-attribute" : {
347
- "security" : {
348
- "throttle" : {
349
- "policy" : "ReadAPI_Standard_UserPolicy"
350
- },
351
- "extraparams" : {
352
- "disable" : true,
353
- "ignore" : false
354
- },
355
- "authentication" : {
356
- "deprecatedScopes" : [ "search" ]
357
- }
358
- },
359
- "clan-group" : "tickets",
360
- "apihash" : "56e4b4244f0ffe9e1234e3e24ba6e4ea",
361
- "module-group" : "tickets",
362
- "apimethod" : "com.zoho.support.restapi.RequestService.getTicketsForAccount"
363
- }
364
- }
365
- },
366
- "/api/v1/accounts/{accountId}/dissociateContacts" : {
367
- "post" : {
368
- "tags" : [ "Account" ],
369
- "summary" : "Dissociate accounts with a contact",
370
- "description" : "This API dissociate accounts with a contact.",
371
- "operationId" : "dissociateContactsWithAccount",
372
- "parameters" : [ {
373
- "$ref" : "#/components/parameters/accountId"
374
- }, {
375
- "$ref" : "../common/Common.json#/components/parameters/orgId"
376
- } ],
377
- "requestBody" : {
378
- "$ref" : "#/components/requestBodies/dissociateContactsWithAccount"
379
- },
380
- "responses" : {
381
- "422" : {
382
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
383
- },
384
- "200" : {
385
- "$ref" : "./MassActionResponse.json#/components/responses/massActionListResponse"
386
- }
387
- },
388
- "security" : [ {
389
- "org-oauth" : [ "Desk.accessAll.ALL" ]
390
- }, {
391
- "iam-oauth2-schema" : [ "Desk.contacts.UPDATE" ]
392
- } ],
393
- "x-audience" : [ "company-internal" ],
394
- "x-custom-url-attribute" : {
395
- "security" : {
396
- "throttle" : {
397
- "policy" : "WriteAPI_Standard_UserPolicy"
398
- },
399
- "extraparams" : {
400
- "disable" : true,
401
- "ignore" : false
402
- },
403
- "authentication" : { }
404
- },
405
- "clan-group" : "accounts",
406
- "apihash" : "b0eed9a3a6a09eab7fdf8ca2c9232586",
407
- "module-group" : "accounts",
408
- "apimethod" : "com.zoho.support.restapi.AccountService.dissociateContactsWithAccount"
409
- }
410
- }
411
- },
412
- "/api/v1/accounts" : {
413
- "get" : {
414
- "tags" : [ "Account" ],
415
- "summary" : "List accounts",
416
- "description" : "This API lists a particular number of accounts, based on the limit specified. ",
417
- "operationId" : "getAccounts",
418
- "parameters" : [ {
419
- "$ref" : "#/components/parameters/limit"
420
- }, {
421
- "$ref" : "#/components/parameters/from"
422
- }, {
423
- "name" : "sortBy",
424
- "in" : "query",
425
- "required" : false,
426
- "style" : "form",
427
- "explode" : true,
428
- "schema" : {
429
- "type" : [ "string", "null" ],
430
- "enum" : [ "website", "email", "phone", "accountName", "createdTime", "modifiedTime" ],
431
- "maxLength" : 100,
432
- "minLength" : 0
433
- }
434
- }, {
435
- "$ref" : "../common/Common.json#/components/parameters/orgId"
436
- } ],
437
- "responses" : {
438
- "200" : {
439
- "$ref" : "#/components/responses/accountListArray"
440
- }
441
- },
442
- "security" : [ {
443
- "org-oauth" : [ "Desk.accessAll.ALL" ]
444
- }, {
445
- "iam-oauth2-schema" : [ "Desk.contacts.READ" ]
446
- } ],
447
- "x-audience" : [ "external-public" ],
448
- "x-custom-url-attribute" : {
449
- "security" : {
450
- "throttle" : {
451
- "policy" : "ReadAPI_Standard_UserPolicy"
452
- },
453
- "extraparams" : {
454
- "disable" : true,
455
- "ignore" : false
456
- },
457
- "authentication" : { }
458
- },
459
- "clan-group" : "accounts",
460
- "apihash" : "f800afabd1b0bef5ab3978488980b23d",
461
- "module-group" : "accounts",
462
- "apimethod" : "com.zoho.support.restapi.AccountService.getAccounts"
463
- }
464
- },
465
- "post" : {
466
- "tags" : [ "Account" ],
467
- "summary" : "Create Account",
468
- "description" : "This API creates an account in your help desk portal.",
469
- "operationId" : "createAccount",
470
- "parameters" : [ {
471
- "$ref" : "../common/Common.json#/components/parameters/orgId"
472
- } ],
473
- "requestBody" : {
474
- "$ref" : "#/components/requestBodies/accountjson"
475
- },
476
- "responses" : {
477
- "422" : {
478
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
479
- },
480
- "500" : {
481
- "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
482
- },
483
- "200" : {
484
- "$ref" : "#/components/responses/accountResponse"
485
- }
486
- },
487
- "security" : [ {
488
- "org-oauth" : [ "Desk.accessAll.ALL" ]
489
- }, {
490
- "iam-oauth2-schema" : [ "Desk.contacts.CREATE" ]
491
- } ],
492
- "x-audience" : [ "external-public" ],
493
- "x-custom-url-attribute" : {
494
- "security" : {
495
- "throttle" : {
496
- "policy" : "WriteAPI_Standard_UserPolicy"
497
- },
498
- "extraparams" : {
499
- "disable" : true,
500
- "ignore" : false
501
- },
502
- "authentication" : { }
503
- },
504
- "clan-group" : "accounts",
505
- "apihash" : "598af8ce96ffab066cd1fe50772611b8",
506
- "module-group" : "accounts",
507
- "apimethod" : "com.zoho.support.restapi.AccountService.addAccount"
508
- }
509
- }
510
- },
511
- "/api/v1/accounts/{accountId}/contracts" : {
512
- "get" : {
513
- "tags" : [ "Account" ],
514
- "summary" : "Get contract",
515
- "description" : "Getting contracts of an Account",
516
- "operationId" : "getContractsByAccount",
517
- "parameters" : [ {
518
- "name" : "contractStatus",
519
- "in" : "query",
520
- "description" : "Contract Status,Indicates the Current Status of the Contract, Values are @ACTIVE@, @EXPIRED@, @FUTURE@",
521
- "required" : false,
522
- "style" : "form",
523
- "explode" : true,
524
- "schema" : {
525
- "type" : [ "string", "null" ],
526
- "description" : "Contract Status,Indicates the Current Status of the Contract, Values are @ACTIVE@, @EXPIRED@, @FUTURE@",
527
- "enum" : [ "ACTIVE", "EXPIRED", "FUTURE" ],
528
- "maxLength" : 100,
529
- "minLength" : 0
530
- }
531
- }, {
532
- "$ref" : "#/components/parameters/departmentId"
533
- }, {
534
- "name" : "limit",
535
- "in" : "query",
536
- "description" : "Number of contracts to fetch, Ranges from 1-50, DEFAULT 50",
537
- "required" : false,
538
- "style" : "form",
539
- "explode" : true,
540
- "schema" : {
541
- "type" : [ "string", "null", "integer" ],
542
- "format" : "int32",
543
- "default" : 50,
544
- "description" : "Number of accounts to list",
545
- "maximum" : 50,
546
- "minimum" : 1,
547
- "pattern" : "([0-9]+)"
548
- }
549
- }, {
550
- "$ref" : "#/components/parameters/from"
551
- }, {
552
- "$ref" : "#/components/parameters/accountId"
553
- }, {
554
- "$ref" : "../common/Common.json#/components/parameters/orgId"
555
- } ],
556
- "responses" : {
557
- "200" : {
558
- "$ref" : "#/components/responses/getContractsForAccountResponse"
559
- }
560
- },
561
- "security" : [ {
562
- "org-oauth" : [ "Desk.accessAll.ALL" ]
563
- }, {
564
- "iam-oauth2-schema" : [ "Desk.settings.READ" ]
565
- } ],
566
- "x-audience" : [ "external-public" ],
567
- "x-custom-url-attribute" : {
568
- "security" : {
569
- "throttle" : {
570
- "policy" : "ReadAPI_Stringent_UserPolicy"
571
- },
572
- "extraparams" : {
573
- "disable" : true,
574
- "ignore" : false
575
- },
576
- "authentication" : { }
577
- },
578
- "clan-group" : "automation",
579
- "apihash" : "293db31ae4200a99a3226b3bfed51c16",
580
- "module-group" : "automation",
581
- "apimethod" : "com.zoho.support.restapi.ContractService.getContractsForAccount"
582
- }
583
- }
584
- },
585
- "/api/v1/accounts/{accountId}/associateContacts" : {
586
- "post" : {
587
- "tags" : [ "Account" ],
588
- "summary" : "Associate contacts with account",
589
- "description" : "This API associates contacts with a particular account.",
590
- "operationId" : "associateContactsWithAccount",
591
- "parameters" : [ {
592
- "$ref" : "#/components/parameters/accountId"
593
- }, {
594
- "$ref" : "../common/Common.json#/components/parameters/orgId"
595
- } ],
596
- "requestBody" : {
597
- "$ref" : "#/components/requestBodies/associateContactsWithAccount"
598
- },
599
- "responses" : {
600
- "422" : {
601
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
602
- },
603
- "200" : {
604
- "$ref" : "./MassActionResponse.json#/components/responses/massActionListResponse"
605
- }
606
- },
607
- "security" : [ {
608
- "org-oauth" : [ "Desk.accessAll.ALL" ]
609
- }, {
610
- "iam-oauth2-schema" : [ "Desk.contacts.UPDATE" ]
611
- } ],
612
- "x-audience" : [ "company-internal" ],
613
- "x-custom-url-attribute" : {
614
- "security" : {
615
- "throttle" : {
616
- "policy" : "WriteAPI_Standard_UserPolicy"
617
- },
618
- "extraparams" : {
619
- "disable" : true,
620
- "ignore" : false
621
- },
622
- "authentication" : { }
623
- },
624
- "clan-group" : "accounts",
625
- "apihash" : "e804db9f12fc85c4a470ffb9d622c4ce",
626
- "module-group" : "accounts",
627
- "apimethod" : "com.zoho.support.restapi.AccountService.associateContactsWithAccount"
628
- }
629
- }
630
- },
631
- "/api/v1/accounts/{accountId}" : {
632
- "get" : {
633
- "tags" : [ "Account" ],
634
- "summary" : "Get Account",
635
- "description" : "This API fetches an account from your help desk portal.",
636
- "operationId" : "getAccount",
637
- "parameters" : [ {
638
- "name" : "include",
639
- "in" : "query",
640
- "description" : "Allowed values are : @owner@",
641
- "required" : false,
642
- "style" : "simple",
643
- "explode" : true,
644
- "schema" : {
645
- "type" : [ "null", "array" ],
646
- "description" : "Allowed values are : @owner@",
647
- "items" : {
648
- "type" : [ "string", "null" ],
649
- "enum" : [ "owner" ],
650
- "maxLength" : 100,
651
- "minLength" : 0,
652
- "x-custom-parameters-attributes" : [ ]
653
- },
654
- "uniqueItems" : true
655
- }
656
- }, {
657
- "$ref" : "#/components/parameters/accountId"
658
- }, {
659
- "$ref" : "../common/Common.json#/components/parameters/orgId"
660
- } ],
661
- "responses" : {
662
- "200" : {
663
- "$ref" : "#/components/responses/accountResponse"
664
- }
665
- },
666
- "security" : [ {
667
- "org-oauth" : [ "Desk.accessAll.ALL" ]
668
- }, {
669
- "iam-oauth2-schema" : [ "Desk.contacts.READ" ]
670
- } ],
671
- "x-audience" : [ "external-public" ],
672
- "x-custom-url-attribute" : {
673
- "security" : {
674
- "throttle" : {
675
- "policy" : "ReadAPI_Lenient_UserPolicy"
676
- },
677
- "extraparams" : {
678
- "disable" : true,
679
- "ignore" : false
680
- },
681
- "authentication" : { }
682
- },
683
- "clan-group" : "accounts",
684
- "apihash" : "b64863b253e6a505af62e8751c4fda44",
685
- "module-group" : "accounts",
686
- "apimethod" : "com.zoho.support.restapi.AccountService.getAccount"
687
- }
688
- },
689
- "patch" : {
690
- "tags" : [ "Account" ],
691
- "summary" : "Update Account",
692
- "description" : "This API updates details of an existing account.",
693
- "operationId" : "updateAccount",
694
- "parameters" : [ {
695
- "$ref" : "#/components/parameters/accountId"
696
- }, {
697
- "$ref" : "../common/Common.json#/components/parameters/orgId"
698
- } ],
699
- "requestBody" : {
700
- "$ref" : "#/components/requestBodies/updateAccount_accountjson"
701
- },
702
- "responses" : {
703
- "200" : {
704
- "$ref" : "#/components/responses/accountResponse"
705
- },
706
- "422" : {
707
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
708
- }
709
- },
710
- "security" : [ {
711
- "org-oauth" : [ "Desk.accessAll.ALL" ]
712
- }, {
713
- "iam-oauth2-schema" : [ "Desk.contacts.UPDATE" ]
714
- } ],
715
- "x-audience" : [ "external-public" ],
716
- "x-custom-url-attribute" : {
717
- "security" : {
718
- "throttle" : {
719
- "policy" : "WriteAPI_Lenient_UserPolicy"
720
- },
721
- "extraparams" : {
722
- "disable" : true,
723
- "ignore" : false
724
- },
725
- "authentication" : { }
726
- },
727
- "clan-group" : "accounts",
728
- "apihash" : "1517bdab65481038e47016b20b07fbd5",
729
- "module-group" : "accounts",
730
- "apimethod" : "com.zoho.support.restapi.AccountService.updateAccount"
731
- }
732
- }
733
- },
734
- "/api/v1/accounts/{accountId}/history" : {
735
- "get" : {
736
- "tags" : [ "Account" ],
737
- "summary" : "Get account history",
738
- "description" : "This API fetches the ticket history of an account.",
739
- "operationId" : "getTicketHistoryByAccount",
740
- "parameters" : [ {
741
- "name" : "agentId",
742
- "in" : "query",
743
- "description" : "Key that filters ticket activities performed by a particular agent",
744
- "required" : false,
745
- "style" : "form",
746
- "explode" : true,
747
- "schema" : {
748
- "type" : [ "string", "null", "integer" ],
749
- "format" : "int64",
750
- "description" : " Key that filters ticket activities performed by a particular agent",
751
- "pattern" : "([0-9]+)"
752
- }
753
- }, {
754
- "$ref" : "#/components/parameters/contactId"
755
- }, {
756
- "$ref" : "#/components/parameters/departmentId"
757
- }, {
758
- "$ref" : "#/components/parameters/limit"
759
- }, {
760
- "$ref" : "#/components/parameters/from"
761
- }, {
762
- "$ref" : "#/components/parameters/accountId"
763
- }, {
764
- "$ref" : "../common/Common.json#/components/parameters/orgId"
765
- } ],
766
- "responses" : {
767
- "404" : {
768
- "$ref" : "../common/Common.json#/components/responses/urlNotFoundErrorResponse"
769
- },
770
- "200" : {
771
- "$ref" : "./TicketHistory.json#/components/responses/accountContactHistoryResponse"
772
- },
773
- "422" : {
774
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
775
- },
776
- "401" : {
777
- "$ref" : "../common/Common.json#/components/responses/unauthorizedErrorResponse"
778
- }
779
- },
780
- "security" : [ {
781
- "org-oauth" : [ "Desk.accessAll.ALL" ]
782
- }, {
783
- "iam-oauth2-schema" : [ "Desk.contacts.READ", "Desk.tickets.READ" ]
784
- } ],
785
- "x-audience" : [ "external-public" ],
786
- "x-custom-url-attribute" : {
787
- "security" : {
788
- "throttle" : {
789
- "policy" : "ReadAPI_Standard_UserPolicy"
790
- },
791
- "extraparams" : {
792
- "disable" : true,
793
- "ignore" : false
794
- },
795
- "authentication" : { }
796
- },
797
- "clan-group" : "tickets",
798
- "apihash" : "3f991af77cc400da18a7000106d582aa",
799
- "module-group" : "tickets",
800
- "apimethod" : "com.zoho.support.restapi.HistoryService.getTicketsHistoryForAccounts"
801
- }
802
- }
803
- },
804
- "/api/v1/accounts/count" : {
805
- "get" : {
806
- "tags" : [ "Account" ],
807
- "summary" : "List all accounts count",
808
- "description" : "Get accounts count",
809
- "operationId" : "getAccountsCount",
810
- "parameters" : [ {
811
- "name" : "viewId",
812
- "in" : "query",
813
- "description" : "ID of the view to apply while fetching the resources",
814
- "required" : true,
815
- "style" : "form",
816
- "explode" : true,
817
- "schema" : {
818
- "type" : [ "string", "integer" ],
819
- "format" : "int64",
820
- "pattern" : "([0-9]+)"
821
- }
822
- }, {
823
- "$ref" : "#/components/parameters/startsWith"
824
- }, {
825
- "$ref" : "../common/Common.json#/components/parameters/orgId"
826
- } ],
827
- "responses" : {
828
- "404" : {
829
- "$ref" : "../common/Common.json#/components/responses/urlNotFoundErrorResponse"
830
- },
831
- "200" : {
832
- "$ref" : "#/components/responses/getCountResponse"
833
- },
834
- "422" : {
835
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
836
- },
837
- "403" : {
838
- "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
839
- }
840
- },
841
- "security" : [ {
842
- "org-oauth" : [ "Desk.accessAll.ALL" ]
843
- }, {
844
- "iam-oauth2-schema" : [ "Desk.contacts.READ" ]
845
- } ],
846
- "x-audience" : [ "company-internal" ],
847
- "x-custom-url-attribute" : {
848
- "security" : {
849
- "throttle" : {
850
- "policy" : "ReadAPI_Stringent_UserPolicy"
851
- },
852
- "extraparams" : {
853
- "disable" : true,
854
- "ignore" : false
855
- },
856
- "authentication" : { }
857
- },
858
- "clan-group" : "accounts",
859
- "apihash" : "8da3a4ed57136dc2a411860591619cc3",
860
- "module-group" : "accounts",
861
- "apimethod" : "com.zoho.support.restapi.RecordsCountService.getAccountsCount"
862
- }
863
- }
864
- },
865
- "/api/v1/accounts/moveToTrash" : {
866
- "post" : {
867
- "tags" : [ "Account" ],
868
- "summary" : "Delete Accounts",
869
- "description" : "This API moves the accounts specified to the Recycle Bin.",
870
- "operationId" : "deleteAccount",
871
- "parameters" : [ {
872
- "$ref" : "../common/Common.json#/components/parameters/orgId"
873
- } ],
874
- "requestBody" : {
875
- "$ref" : "#/components/requestBodies/accountsrecyclebinjson"
876
- },
877
- "responses" : {
878
- "422" : {
879
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
880
- },
881
- "204" : {
882
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
883
- }
884
- },
885
- "security" : [ {
886
- "org-oauth" : [ "Desk.accessAll.ALL" ]
887
- }, {
888
- "iam-oauth2-schema" : [ "Desk.contacts.DELETE" ]
889
- } ],
890
- "x-audience" : [ "external-public" ],
891
- "x-custom-url-attribute" : {
892
- "security" : {
893
- "throttle" : {
894
- "policy" : "WriteAPI_Stringent_UserPolicy"
895
- },
896
- "extraparams" : {
897
- "disable" : true,
898
- "ignore" : false
899
- },
900
- "authentication" : { }
901
- },
902
- "clan-group" : "accounts",
903
- "apihash" : "c393d9f9553db305d1e6a5f19a64964a",
904
- "module-group" : "accounts",
905
- "apimethod" : "com.zoho.support.restapi.AccountService.moveAccountsToTrash"
906
- }
907
- }
908
- },
909
- "/api/v1/products/{productId}/accounts" : {
910
- "get" : {
911
- "tags" : [ "Account" ],
912
- "summary" : "List accounts associated with product",
913
- "description" : "This API lists the accounts associated with a product",
914
- "operationId" : "getAccountsByProduct",
915
- "parameters" : [ {
916
- "$ref" : "#/components/parameters/limit"
917
- }, {
918
- "$ref" : "#/components/parameters/from"
919
- }, {
920
- "name" : "sortBy",
921
- "in" : "query",
922
- "description" : "Key that sorts the accounts by a specific attribute: @accountName@ or @createdTime@.The default sorting order is ascending. A @-@ prefix denotes descending order of sorting",
923
- "required" : false,
924
- "style" : "form",
925
- "explode" : true,
926
- "schema" : {
927
- "type" : [ "string", "null" ],
928
- "description" : "Key that sorts the accounts by a specific attribute: @accountName@ or @createdTime@.The default sorting order is ascending. A @-@ prefix denotes descending order of sorting",
929
- "enum" : [ "website", "email", "phone", "accountName", "createdTime", "modifiedTime" ],
930
- "maxLength" : 100,
931
- "minLength" : 0
932
- }
933
- }, {
934
- "name" : "productId",
935
- "in" : "path",
936
- "required" : true,
937
- "style" : "simple",
938
- "explode" : false,
939
- "schema" : {
940
- "type" : [ "string", "null", "integer" ],
941
- "format" : "int64",
942
- "pattern" : "([0-9]+)"
943
- }
944
- }, {
945
- "$ref" : "../common/Common.json#/components/parameters/orgId"
946
- } ],
947
- "responses" : {
948
- "204" : {
949
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
950
- },
951
- "200" : {
952
- "$ref" : "#/components/responses/accountListArray"
953
- }
954
- },
955
- "security" : [ {
956
- "org-oauth" : [ "Desk.accessAll.ALL" ]
957
- }, {
958
- "iam-oauth2-schema" : [ "Desk.settings.READ", "Desk.contacts.READ" ]
959
- } ],
960
- "x-audience" : [ "external-public" ],
961
- "x-custom-url-attribute" : {
962
- "security" : {
963
- "throttle" : {
964
- "policy" : "ReadAPI_Standard_UserPolicy"
965
- },
966
- "extraparams" : {
967
- "disable" : true,
968
- "ignore" : false
969
- },
970
- "authentication" : {
971
- "deprecatedScopes" : [ "settings" ]
972
- }
973
- },
974
- "clan-group" : "accounts",
975
- "apihash" : "262d0cf2a9a9de6a4744b84edb105d73",
976
- "module-group" : "accounts",
977
- "apimethod" : "com.zoho.support.restapi.AccountService.getAccountsUnderProduct"
978
- }
979
- }
980
- },
981
- "/api/v1/accounts/updateMany" : {
982
- "post" : {
983
- "tags" : [ "Account" ],
984
- "summary" : "Update many accounts",
985
- "description" : "This API updates multiple accounts at once.",
986
- "operationId" : "bulkUpdateAccounts",
987
- "parameters" : [ {
988
- "$ref" : "../common/Common.json#/components/parameters/orgId"
989
- } ],
990
- "requestBody" : {
991
- "$ref" : "#/components/requestBodies/account_massupdate"
992
- },
993
- "responses" : {
994
- "422" : {
995
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
996
- },
997
- "200" : {
998
- "$ref" : "#/components/responses/updateManyResponse"
999
- }
1000
- },
1001
- "security" : [ {
1002
- "org-oauth" : [ "Desk.accessAll.ALL" ]
1003
- }, {
1004
- "iam-oauth2-schema" : [ "Desk.contacts.UPDATE" ]
1005
- } ],
1006
- "x-audience" : [ "external-public" ],
1007
- "x-custom-url-attribute" : {
1008
- "security" : {
1009
- "throttle" : {
1010
- "policy" : "WriteAPI_Stringent_UserPolicy"
1011
- },
1012
- "extraparams" : {
1013
- "disable" : true,
1014
- "ignore" : false
1015
- },
1016
- "authentication" : { }
1017
- },
1018
- "clan-group" : "accounts",
1019
- "apihash" : "aeda40503f08f3da0b654c0d0ab6aadc",
1020
- "module-group" : "accounts",
1021
- "apimethod" : "com.zoho.support.restapi.AccountService.updateMany"
1022
- }
1023
- }
1024
- }
1025
- },
1026
- "components" : {
1027
- "schemas" : {
1028
- "zohoCrmAccount" : {
1029
- "type" : [ "null", "object" ],
1030
- "additionalProperties" : false,
1031
- "properties" : {
1032
- "id" : {
1033
- "type" : [ "string", "null", "integer" ],
1034
- "format" : "int64",
1035
- "pattern" : "([0-9]+)"
1036
- }
1037
- },
1038
- "required" : [ "id" ]
1039
- },
1040
- "commonObject" : {
1041
- "type" : [ "null", "object" ],
1042
- "additionalProperties" : false,
1043
- "properties" : {
1044
- "website" : {
1045
- "type" : [ "string", "null" ],
1046
- "description" : "Website of the account",
1047
- "maxLength" : 120,
1048
- "minLength" : 0,
1049
- "pattern" : "^(ht|f)tp(s?)\\:\\/\\/[-.\\w]*(\\/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'\\/\\\\+=&%\\$#_@]*)?$"
1050
- },
1051
- "accountName" : {
1052
- "type" : [ "string", "null" ],
1053
- "description" : "Name of the account",
1054
- "maxLength" : 200,
1055
- "minLength" : 0
1056
- },
1057
- "phone" : {
1058
- "type" : [ "string", "null" ],
1059
- "description" : "Phone number of the account",
1060
- "maxLength" : 30,
1061
- "minLength" : 0,
1062
- "pattern" : "[0-9a-zA-Z_\\+\\-\\.\\(\\)\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+"
1063
- },
1064
- "email" : {
1065
- "type" : [ "string", "null" ],
1066
- "description" : "Email ID of the account",
1067
- "maxLength" : 255,
1068
- "minLength" : 0,
1069
- "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'\\&\\~]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$"
1070
- }
1071
- }
1072
- },
1073
- "accountjson" : {
1074
- "additionalProperties" : false,
1075
- "allOf" : [ {
1076
- "$ref" : "./Account.json#/components/schemas/commonObject"
1077
- }, {
1078
- "type" : [ "null", "object" ],
1079
- "properties" : {
1080
- "country" : {
1081
- "type" : [ "string", "null" ],
1082
- "maxLength" : 30,
1083
- "minLength" : 0
1084
- },
1085
- "code" : {
1086
- "type" : [ "string", "null" ],
1087
- "maxLength" : 30,
1088
- "minLength" : 0,
1089
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1090
- },
1091
- "cf" : {
1092
- "type" : [ "null", "object" ],
1093
- "additionalProperties" : false,
1094
- "patternProperties" : {
1095
- "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : {
1096
- "type" : [ "string", "null" ],
1097
- "maxLength" : 100,
1098
- "minLength" : 0,
1099
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+",
1100
- "x-custom-parameters-attributes" : {
1101
- "ids" : [ { } ],
1102
- "source" : {
1103
- "country" : {
1104
- "removeExif" : false,
1105
- "filterMatchedContent" : false,
1106
- "antivirus" : false,
1107
- "replacementString" : "",
1108
- "allowInvalid" : false,
1109
- "descrption" : "Country in which the account is based",
1110
- "secret" : false,
1111
- "preserveCharsLimit" : 10,
1112
- "trim" : false,
1113
- "internalParam" : false,
1114
- "preserveChars" : "0,5",
1115
- "importUrl" : false,
1116
- "decrypt" : false
1117
- },
1118
- "website" : {
1119
- "removeExif" : false,
1120
- "filterMatchedContent" : false,
1121
- "antivirus" : false,
1122
- "replacementString" : "",
1123
- "allowInvalid" : false,
1124
- "descrption" : "Website of the account",
1125
- "secret" : false,
1126
- "preserveCharsLimit" : 10,
1127
- "trim" : false,
1128
- "internalParam" : false,
1129
- "preserveChars" : "0,5",
1130
- "importUrl" : false,
1131
- "decrypt" : false
1132
- },
1133
- "code" : {
1134
- "removeExif" : false,
1135
- "filterMatchedContent" : false,
1136
- "antivirus" : false,
1137
- "replacementString" : "",
1138
- "allowInvalid" : false,
1139
- "descrption" : "Zip code in account's office address",
1140
- "secret" : false,
1141
- "preserveCharsLimit" : 10,
1142
- "trim" : false,
1143
- "internalParam" : false,
1144
- "preserveChars" : "0,5",
1145
- "importUrl" : false,
1146
- "decrypt" : false
1147
- },
1148
- "cf" : { },
1149
- "city" : {
1150
- "removeExif" : false,
1151
- "filterMatchedContent" : false,
1152
- "antivirus" : false,
1153
- "replacementString" : "",
1154
- "allowInvalid" : false,
1155
- "descrption" : "City in which the account's office is located",
1156
- "secret" : false,
1157
- "preserveCharsLimit" : 10,
1158
- "trim" : false,
1159
- "internalParam" : false,
1160
- "preserveChars" : "0,5",
1161
- "importUrl" : false,
1162
- "decrypt" : false
1163
- },
1164
- "customFields" : { },
1165
- "description" : {
1166
- "removeExif" : false,
1167
- "filterMatchedContent" : false,
1168
- "antivirus" : false,
1169
- "replacementString" : "",
1170
- "allowInvalid" : false,
1171
- "descrption" : "Description of the account",
1172
- "secret" : false,
1173
- "preserveCharsLimit" : 10,
1174
- "trim" : false,
1175
- "internalParam" : false,
1176
- "preserveChars" : "0,5",
1177
- "importUrl" : false,
1178
- "decrypt" : false
1179
- },
1180
- "industry" : {
1181
- "removeExif" : false,
1182
- "filterMatchedContent" : false,
1183
- "antivirus" : false,
1184
- "replacementString" : "",
1185
- "allowInvalid" : false,
1186
- "descrption" : "Industry in which the account operates",
1187
- "secret" : false,
1188
- "preserveCharsLimit" : 10,
1189
- "trim" : false,
1190
- "internalParam" : false,
1191
- "preserveChars" : "0,5",
1192
- "importUrl" : false,
1193
- "decrypt" : false
1194
- },
1195
- "phone" : {
1196
- "removeExif" : false,
1197
- "filterMatchedContent" : false,
1198
- "antivirus" : false,
1199
- "replacementString" : "",
1200
- "allowInvalid" : false,
1201
- "descrption" : "Phone number of the account",
1202
- "secret" : false,
1203
- "preserveCharsLimit" : 10,
1204
- "trim" : false,
1205
- "internalParam" : false,
1206
- "preserveChars" : "0,5",
1207
- "importUrl" : false,
1208
- "decrypt" : false
1209
- },
1210
- "annualrevenue" : {
1211
- "removeExif" : false,
1212
- "filterMatchedContent" : false,
1213
- "antivirus" : false,
1214
- "replacementString" : "",
1215
- "allowInvalid" : false,
1216
- "descrption" : "Annual revenue of the account",
1217
- "secret" : false,
1218
- "preserveCharsLimit" : 10,
1219
- "trim" : false,
1220
- "internalParam" : false,
1221
- "preserveChars" : "0,5",
1222
- "importUrl" : false,
1223
- "decrypt" : false
1224
- },
1225
- "street" : {
1226
- "removeExif" : false,
1227
- "filterMatchedContent" : false,
1228
- "antivirus" : false,
1229
- "replacementString" : "",
1230
- "allowInvalid" : false,
1231
- "descrption" : "Name of the street in which the account's office is located",
1232
- "secret" : false,
1233
- "preserveCharsLimit" : 10,
1234
- "trim" : false,
1235
- "internalParam" : false,
1236
- "preserveChars" : "0,5",
1237
- "importUrl" : false,
1238
- "decrypt" : false
1239
- },
1240
- "state" : {
1241
- "removeExif" : false,
1242
- "filterMatchedContent" : false,
1243
- "antivirus" : false,
1244
- "replacementString" : "",
1245
- "allowInvalid" : false,
1246
- "descrption" : "State in which the account's office is located",
1247
- "secret" : false,
1248
- "preserveCharsLimit" : 10,
1249
- "trim" : false,
1250
- "internalParam" : false,
1251
- "preserveChars" : "0,5",
1252
- "importUrl" : false,
1253
- "decrypt" : false
1254
- },
1255
- "fax" : {
1256
- "removeExif" : false,
1257
- "filterMatchedContent" : false,
1258
- "antivirus" : false,
1259
- "replacementString" : "",
1260
- "allowInvalid" : false,
1261
- "descrption" : "Fax number of the account",
1262
- "secret" : false,
1263
- "preserveCharsLimit" : 10,
1264
- "trim" : false,
1265
- "internalParam" : false,
1266
- "preserveChars" : "0,5",
1267
- "importUrl" : false,
1268
- "decrypt" : false
1269
- },
1270
- "email" : {
1271
- "removeExif" : false,
1272
- "filterMatchedContent" : false,
1273
- "antivirus" : false,
1274
- "replacementString" : "",
1275
- "allowInvalid" : false,
1276
- "descrption" : "Email ID of the account",
1277
- "secret" : false,
1278
- "preserveCharsLimit" : 10,
1279
- "trim" : false,
1280
- "internalParam" : false,
1281
- "preserveChars" : "0,5",
1282
- "importUrl" : false,
1283
- "decrypt" : false
1284
- }
1285
- }
1286
- }
1287
- }
1288
- }
1289
- },
1290
- "city" : {
1291
- "type" : [ "string", "null" ],
1292
- "maxLength" : 30,
1293
- "minLength" : 0
1294
- },
1295
- "customFields" : {
1296
- "type" : [ "null", "object" ],
1297
- "additionalProperties" : false,
1298
- "patternProperties" : {
1299
- "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : {
1300
- "type" : [ "string", "null" ],
1301
- "maxLength" : 100,
1302
- "minLength" : 0,
1303
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+",
1304
- "x-custom-parameters-attributes" : {
1305
- "ids" : [ { } ],
1306
- "source" : {
1307
- "country" : {
1308
- "removeExif" : false,
1309
- "filterMatchedContent" : false,
1310
- "antivirus" : false,
1311
- "replacementString" : "",
1312
- "allowInvalid" : false,
1313
- "descrption" : "Country in which the account is based",
1314
- "secret" : false,
1315
- "preserveCharsLimit" : 10,
1316
- "trim" : false,
1317
- "internalParam" : false,
1318
- "preserveChars" : "0,5",
1319
- "importUrl" : false,
1320
- "decrypt" : false
1321
- },
1322
- "website" : {
1323
- "removeExif" : false,
1324
- "filterMatchedContent" : false,
1325
- "antivirus" : false,
1326
- "replacementString" : "",
1327
- "allowInvalid" : false,
1328
- "descrption" : "Website of the account",
1329
- "secret" : false,
1330
- "preserveCharsLimit" : 10,
1331
- "trim" : false,
1332
- "internalParam" : false,
1333
- "preserveChars" : "0,5",
1334
- "importUrl" : false,
1335
- "decrypt" : false
1336
- },
1337
- "code" : {
1338
- "removeExif" : false,
1339
- "filterMatchedContent" : false,
1340
- "antivirus" : false,
1341
- "replacementString" : "",
1342
- "allowInvalid" : false,
1343
- "descrption" : "Zip code in account's office address",
1344
- "secret" : false,
1345
- "preserveCharsLimit" : 10,
1346
- "trim" : false,
1347
- "internalParam" : false,
1348
- "preserveChars" : "0,5",
1349
- "importUrl" : false,
1350
- "decrypt" : false
1351
- },
1352
- "cf" : { },
1353
- "city" : {
1354
- "removeExif" : false,
1355
- "filterMatchedContent" : false,
1356
- "antivirus" : false,
1357
- "replacementString" : "",
1358
- "allowInvalid" : false,
1359
- "descrption" : "City in which the account's office is located",
1360
- "secret" : false,
1361
- "preserveCharsLimit" : 10,
1362
- "trim" : false,
1363
- "internalParam" : false,
1364
- "preserveChars" : "0,5",
1365
- "importUrl" : false,
1366
- "decrypt" : false
1367
- },
1368
- "customFields" : { },
1369
- "description" : {
1370
- "removeExif" : false,
1371
- "filterMatchedContent" : false,
1372
- "antivirus" : false,
1373
- "replacementString" : "",
1374
- "allowInvalid" : false,
1375
- "descrption" : "Description of the account",
1376
- "secret" : false,
1377
- "preserveCharsLimit" : 10,
1378
- "trim" : false,
1379
- "internalParam" : false,
1380
- "preserveChars" : "0,5",
1381
- "importUrl" : false,
1382
- "decrypt" : false
1383
- },
1384
- "industry" : {
1385
- "removeExif" : false,
1386
- "filterMatchedContent" : false,
1387
- "antivirus" : false,
1388
- "replacementString" : "",
1389
- "allowInvalid" : false,
1390
- "descrption" : "Industry in which the account operates",
1391
- "secret" : false,
1392
- "preserveCharsLimit" : 10,
1393
- "trim" : false,
1394
- "internalParam" : false,
1395
- "preserveChars" : "0,5",
1396
- "importUrl" : false,
1397
- "decrypt" : false
1398
- },
1399
- "phone" : {
1400
- "removeExif" : false,
1401
- "filterMatchedContent" : false,
1402
- "antivirus" : false,
1403
- "replacementString" : "",
1404
- "allowInvalid" : false,
1405
- "descrption" : "Phone number of the account",
1406
- "secret" : false,
1407
- "preserveCharsLimit" : 10,
1408
- "trim" : false,
1409
- "internalParam" : false,
1410
- "preserveChars" : "0,5",
1411
- "importUrl" : false,
1412
- "decrypt" : false
1413
- },
1414
- "annualrevenue" : {
1415
- "removeExif" : false,
1416
- "filterMatchedContent" : false,
1417
- "antivirus" : false,
1418
- "replacementString" : "",
1419
- "allowInvalid" : false,
1420
- "descrption" : "Annual revenue of the account",
1421
- "secret" : false,
1422
- "preserveCharsLimit" : 10,
1423
- "trim" : false,
1424
- "internalParam" : false,
1425
- "preserveChars" : "0,5",
1426
- "importUrl" : false,
1427
- "decrypt" : false
1428
- },
1429
- "street" : {
1430
- "removeExif" : false,
1431
- "filterMatchedContent" : false,
1432
- "antivirus" : false,
1433
- "replacementString" : "",
1434
- "allowInvalid" : false,
1435
- "descrption" : "Name of the street in which the account's office is located",
1436
- "secret" : false,
1437
- "preserveCharsLimit" : 10,
1438
- "trim" : false,
1439
- "internalParam" : false,
1440
- "preserveChars" : "0,5",
1441
- "importUrl" : false,
1442
- "decrypt" : false
1443
- },
1444
- "state" : {
1445
- "removeExif" : false,
1446
- "filterMatchedContent" : false,
1447
- "antivirus" : false,
1448
- "replacementString" : "",
1449
- "allowInvalid" : false,
1450
- "descrption" : "State in which the account's office is located",
1451
- "secret" : false,
1452
- "preserveCharsLimit" : 10,
1453
- "trim" : false,
1454
- "internalParam" : false,
1455
- "preserveChars" : "0,5",
1456
- "importUrl" : false,
1457
- "decrypt" : false
1458
- },
1459
- "fax" : {
1460
- "removeExif" : false,
1461
- "filterMatchedContent" : false,
1462
- "antivirus" : false,
1463
- "replacementString" : "",
1464
- "allowInvalid" : false,
1465
- "descrption" : "Fax number of the account",
1466
- "secret" : false,
1467
- "preserveCharsLimit" : 10,
1468
- "trim" : false,
1469
- "internalParam" : false,
1470
- "preserveChars" : "0,5",
1471
- "importUrl" : false,
1472
- "decrypt" : false
1473
- },
1474
- "email" : {
1475
- "removeExif" : false,
1476
- "filterMatchedContent" : false,
1477
- "antivirus" : false,
1478
- "replacementString" : "",
1479
- "allowInvalid" : false,
1480
- "descrption" : "Email ID of the account",
1481
- "secret" : false,
1482
- "preserveCharsLimit" : 10,
1483
- "trim" : false,
1484
- "internalParam" : false,
1485
- "preserveChars" : "0,5",
1486
- "importUrl" : false,
1487
- "decrypt" : false
1488
- }
1489
- }
1490
- }
1491
- }
1492
- }
1493
- },
1494
- "street" : {
1495
- "type" : [ "string", "null" ],
1496
- "maxLength" : 250,
1497
- "minLength" : 0
1498
- },
1499
- "annualrevenue" : {
1500
- "type" : [ "string", "null" ],
1501
- "maxLength" : 100,
1502
- "minLength" : 0,
1503
- "pattern" : "([0-9]{1,13}(\\.[0-9]*)?)"
1504
- },
1505
- "description" : {
1506
- "type" : [ "string", "null" ],
1507
- "maxLength" : 65535,
1508
- "minLength" : 0
1509
- },
1510
- "industry" : {
1511
- "type" : [ "string", "null" ],
1512
- "maxLength" : 120,
1513
- "minLength" : 0,
1514
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1515
- },
1516
- "state" : {
1517
- "type" : [ "string", "null" ],
1518
- "maxLength" : 30,
1519
- "minLength" : 0
1520
- },
1521
- "ownerId" : {
1522
- "type" : [ "string", "null", "integer" ],
1523
- "format" : "int64",
1524
- "pattern" : "([0-9]+)"
1525
- },
1526
- "fax" : {
1527
- "type" : [ "string", "null" ],
1528
- "maxLength" : 30,
1529
- "minLength" : 0,
1530
- "pattern" : "[0-9a-zA-Z_\\+\\-\\.\\(\\)\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+"
1531
- }
1532
- },
1533
- "required" : [ "annualrevenue", "cf", "city", "code", "country", "customFields", "description", "fax", "industry", "ownerId", "state", "street" ]
1534
- }, {
1535
- "type" : "object",
1536
- "required" : [ "accountName" ]
1537
- } ]
1538
- },
1539
- "sourceValues" : {
1540
- "type" : [ "null", "object" ],
1541
- "additionalProperties" : false,
1542
- "properties" : {
1543
- "country" : {
1544
- "type" : [ "string", "null", "integer" ],
1545
- "format" : "int64",
1546
- "pattern" : "([0-9]+)"
1547
- },
1548
- "website" : {
1549
- "type" : [ "string", "null", "integer" ],
1550
- "format" : "int64",
1551
- "pattern" : "([0-9]+)"
1552
- },
1553
- "code" : {
1554
- "type" : [ "string", "null", "integer" ],
1555
- "format" : "int64",
1556
- "pattern" : "([0-9]+)"
1557
- },
1558
- "cf" : {
1559
- "type" : [ "null", "object" ],
1560
- "additionalProperties" : false,
1561
- "patternProperties" : {
1562
- "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : {
1563
- "type" : [ "string", "null", "integer" ],
1564
- "format" : "int64",
1565
- "pattern" : "([0-9]+)"
1566
- }
1567
- }
1568
- },
1569
- "city" : {
1570
- "type" : [ "string", "null", "integer" ],
1571
- "format" : "int64",
1572
- "pattern" : "([0-9]+)"
1573
- },
1574
- "customFields" : {
1575
- "type" : [ "null", "object" ],
1576
- "additionalProperties" : false,
1577
- "patternProperties" : {
1578
- "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : {
1579
- "type" : [ "string", "null", "integer" ],
1580
- "format" : "int64",
1581
- "pattern" : "([0-9]+)"
1582
- }
1583
- }
1584
- },
1585
- "description" : {
1586
- "type" : [ "string", "null", "integer" ],
1587
- "format" : "int64",
1588
- "pattern" : "([0-9]+)"
1589
- },
1590
- "industry" : {
1591
- "type" : [ "string", "null", "integer" ],
1592
- "format" : "int64",
1593
- "pattern" : "([0-9]+)"
1594
- },
1595
- "phone" : {
1596
- "type" : [ "string", "null", "integer" ],
1597
- "format" : "int64",
1598
- "pattern" : "([0-9]+)"
1599
- },
1600
- "annualrevenue" : {
1601
- "type" : [ "string", "null", "integer" ],
1602
- "format" : "int64",
1603
- "pattern" : "([0-9]+)"
1604
- },
1605
- "street" : {
1606
- "type" : [ "string", "null", "integer" ],
1607
- "format" : "int64",
1608
- "pattern" : "([0-9]+)"
1609
- },
1610
- "state" : {
1611
- "type" : [ "string", "null", "integer" ],
1612
- "format" : "int64",
1613
- "pattern" : "([0-9]+)"
1614
- },
1615
- "fax" : {
1616
- "type" : [ "string", "null", "integer" ],
1617
- "format" : "int64",
1618
- "pattern" : "([0-9]+)"
1619
- },
1620
- "email" : {
1621
- "type" : [ "string", "null", "integer" ],
1622
- "format" : "int64",
1623
- "pattern" : "([0-9]+)"
1624
- }
1625
- },
1626
- "required" : [ "annualrevenue", "cf", "city", "code", "country", "customFields", "description", "email", "fax", "industry", "phone", "state", "street", "website" ]
1627
- },
1628
- "mappingInfo" : {
1629
- "type" : [ "null", "object" ],
1630
- "additionalProperties" : false,
1631
- "properties" : {
1632
- "mappingId" : {
1633
- "type" : [ "string", "null", "integer" ],
1634
- "format" : "int64",
1635
- "pattern" : "([0-9]+)"
1636
- },
1637
- "mappingType" : {
1638
- "type" : [ "string", "null" ],
1639
- "enum" : [ "PRIMARY", "SECONDARY" ],
1640
- "maxLength" : 100,
1641
- "minLength" : 0
1642
- },
1643
- "isAccountTicketsViewable" : {
1644
- "type" : [ "boolean", "null" ]
1645
- }
1646
- },
1647
- "required" : [ "isAccountTicketsViewable", "mappingId", "mappingType" ]
1648
- },
1649
- "accountListViewObject" : {
1650
- "additionalProperties" : false,
1651
- "allOf" : [ {
1652
- "$ref" : "./Account.json#/components/schemas/commonObject"
1653
- }, {
1654
- "type" : [ "null", "object" ],
1655
- "properties" : {
1656
- "webUrl" : {
1657
- "type" : [ "string", "null" ],
1658
- "maxLength" : 500,
1659
- "minLength" : 0,
1660
- "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
1661
- },
1662
- "createdTime" : {
1663
- "type" : [ "string", "null" ],
1664
- "maxLength" : 100,
1665
- "minLength" : 0,
1666
- "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))"
1667
- },
1668
- "zohoCRMAccount" : {
1669
- "$ref" : "./Account.json#/components/schemas/zohoCrmAccount"
1670
- },
1671
- "id" : {
1672
- "type" : [ "string", "null", "integer" ],
1673
- "format" : "int64",
1674
- "pattern" : "([0-9]+)"
1675
- },
1676
- "customerHappiness" : {
1677
- "$ref" : "./Contact.json#/components/schemas/customerHappiness"
1678
- }
1679
- },
1680
- "required" : [ "createdTime", "customerHappiness", "id", "webUrl", "zohoCRMAccount" ]
1681
- }, {
1682
- "type" : "object",
1683
- "required" : [
1684
- "accountName", "email", "phone"
1685
- ]
1686
- } ]
1687
- },
1688
- "accountListWithMappingInfo" : {
1689
- "additionalProperties" : false,
1690
- "allOf" : [ {
1691
- "$ref" : "./Account.json#/components/schemas/accountListViewObject"
1692
- }, {
1693
- "type" : [ "null", "object" ],
1694
- "properties" : {
1695
- "mappingInfo" : {
1696
- "$ref" : "./Account.json#/components/schemas/mappingInfo"
1697
- },
1698
- "mappingType" : {
1699
- "type" : [ "string", "null" ],
1700
- "maxLength" : 100,
1701
- "minLength" : 0
1702
- }
1703
- },
1704
- "required" : [ "mappingInfo", "mappingType" ]
1705
- } ]
1706
- },
1707
- "dataWitMappingInfo" : {
1708
- "type" : [ "null", "array" ],
1709
- "items" : {
1710
- "$ref" : "./Account.json#/components/schemas/accountListWithMappingInfo"
1711
- }
1712
- },
1713
- "getTicketsByAccountListObject" : {
1714
- "additionalProperties" : false,
1715
- "allOf" : [ {
1716
- "$ref" : "./Ticket.json#/components/schemas/listviewCommonJson"
1717
- }, {
1718
- "type" : [ "null", "object" ],
1719
- "properties" : {
1720
- "subCategory" : {
1721
- "type" : [ "string", "null" ],
1722
- "x-dynamic-enum" : true
1723
- },
1724
- "category" : {
1725
- "type" : [ "string", "null" ],
1726
- "x-dynamic-enum" : true
1727
- },
1728
- "layoutId" : {
1729
- "type" : [ "string", "null", "integer" ],
1730
- "format" : "int64",
1731
- "pattern" : "([0-9]+)"
1732
- }
1733
- },
1734
- "required" : [ "category", "layoutId", "subCategory" ]
1735
- } ]
1736
- },
1737
- "getTicketsByAccountArr" : {
1738
- "type" : [ "null", "array" ],
1739
- "items" : {
1740
- "$ref" : "./Account.json#/components/schemas/getTicketsByAccountListObject"
1741
- }
1742
- },
1743
- "contractsForAccountDataListJson" : {
1744
- "type" : [ "null", "object" ],
1745
- "additionalProperties" : false,
1746
- "properties" : {
1747
- "slaName" : {
1748
- "type" : [ "string", "null" ],
1749
- "maxLength" : 100,
1750
- "minLength" : 0
1751
- },
1752
- "associatedSLAId" : {
1753
- "type" : [ "string", "null", "integer" ],
1754
- "format" : "int64",
1755
- "pattern" : "([0-9]+)"
1756
- },
1757
- "accountId" : {
1758
- "type" : [ "string", "null", "integer" ],
1759
- "format" : "int64",
1760
- "pattern" : "([0-9]+)"
1761
- },
1762
- "contractStatus" : {
1763
- "type" : [ "string", "null" ],
1764
- "enum" : [ "ACTIVE", "EXPIRED", "FUTURE" ],
1765
- "maxLength" : 100,
1766
- "minLength" : 0,
1767
- "x-custom-parameters-attributes" : {
1768
- "removeExif" : false,
1769
- "filterMatchedContent" : false,
1770
- "antivirus" : false,
1771
- "replacementString" : "",
1772
- "allowInvalid" : false,
1773
- "descrption" : "Contract Status,Indicates the Current Status of the Contract, Values are @ACTIVE@, @EXPIRED@, @FUTURE@",
1774
- "secret" : false,
1775
- "preserveCharsLimit" : 10,
1776
- "trim" : false,
1777
- "internalParam" : false,
1778
- "preserveChars" : "0,5",
1779
- "importUrl" : false,
1780
- "decrypt" : false
1781
- }
1782
- },
1783
- "endDate" : {
1784
- "type" : [ "string", "null" ],
1785
- "maxLength" : 100,
1786
- "minLength" : 0,
1787
- "pattern" : "^([12][0-9]{3})-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$"
1788
- },
1789
- "departmentId" : {
1790
- "type" : [ "string", "null", "integer" ],
1791
- "format" : "int64",
1792
- "pattern" : "([0-9]+)",
1793
- "x-custom-parameters-attributes" : {
1794
- "removeExif" : false,
1795
- "filterMatchedContent" : false,
1796
- "antivirus" : false,
1797
- "replacementString" : "",
1798
- "allowInvalid" : false,
1799
- "descrption" : "ID of the department from which the contracts must be fetched",
1800
- "secret" : false,
1801
- "preserveCharsLimit" : 10,
1802
- "trim" : false,
1803
- "internalParam" : false,
1804
- "preserveChars" : "0,5",
1805
- "importUrl" : false,
1806
- "decrypt" : false
1807
- }
1808
- },
1809
- "contractNumber" : {
1810
- "type" : [ "string", "null" ],
1811
- "maxLength" : 50,
1812
- "minLength" : 0,
1813
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1814
- },
1815
- "contractName" : {
1816
- "type" : [ "string", "null" ],
1817
- "maxLength" : 80,
1818
- "minLength" : 0,
1819
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1820
- },
1821
- "id" : {
1822
- "type" : [ "string", "null", "integer" ],
1823
- "format" : "int64",
1824
- "pattern" : "([0-9]+)"
1825
- },
1826
- "startDate" : {
1827
- "type" : [ "string", "null" ],
1828
- "maxLength" : 100,
1829
- "minLength" : 0,
1830
- "pattern" : "^([12][0-9]{3})-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$"
1831
- }
1832
- },
1833
- "required" : [ "accountId", "associatedSLAId", "contractName", "contractNumber", "contractStatus", "departmentId", "endDate", "id", "slaName", "startDate" ]
1834
- },
1835
- "contractsForAccountData" : {
1836
- "type" : [ "null", "array" ],
1837
- "items" : {
1838
- "$ref" : "./Account.json#/components/schemas/contractsForAccountDataListJson"
1839
- }
1840
- },
1841
- "data" : {
1842
- "type" : [ "null", "array" ],
1843
- "items" : {
1844
- "$ref" : "./Account.json#/components/schemas/accountListViewObject"
1845
- }
1846
- },
1847
- "long_array" : {
1848
- "type" : [ "null", "array" ],
1849
- "items" : {
1850
- "type" : [ "string", "null", "integer" ],
1851
- "format" : "int64",
1852
- "pattern" : "([0-9]+)"
1853
- }
1854
- }
1855
- },
1856
- "responses" : {
1857
- "accountResponse" : {
1858
- "description" : "accountResponse template definitions",
1859
- "content" : {
1860
- "application/json" : {
1861
- "schema" : {
1862
- "allOf" : [ {
1863
- "type" : "object",
1864
- "properties" : {
1865
- "owner" : {
1866
- "type" : [ "null", "object" ],
1867
- "additionalProperties" : false,
1868
- "maxProperties" : 3,
1869
- "minProperties" : 3,
1870
- "properties" : {
1871
- "firstName" : {
1872
- "type" : [ "string", "null" ],
1873
- "maxLength" : 50,
1874
- "minLength" : 0
1875
- },
1876
- "lastName" : {
1877
- "type" : [ "string", "null" ],
1878
- "maxLength" : 50,
1879
- "minLength" : 0
1880
- },
1881
- "id" : {
1882
- "type" : [ "string", "null", "integer" ],
1883
- "format" : "int64",
1884
- "pattern" : "([0-9]+)"
1885
- }
1886
- },
1887
- "required" : [ "firstName", "id", "lastName" ]
1888
- }
1889
- }
1890
- }, {
1891
- "additionalProperties" : false,
1892
- "allOf" : [ {
1893
- "$ref" : "./Account.json#/components/schemas/accountjson"
1894
- }, {
1895
- "type" : [ "null", "object" ],
1896
- "properties" : {
1897
- "modifiedTime" : {
1898
- "type" : [ "string", "null" ],
1899
- "maxLength" : 100,
1900
- "minLength" : 0,
1901
- "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))"
1902
- },
1903
- "isFollowing" : {
1904
- "type" : [ "boolean", "null" ]
1905
- },
1906
- "isDeleted" : {
1907
- "type" : [ "boolean", "null" ]
1908
- },
1909
- "isTrashed" : {
1910
- "type" : [ "boolean", "null" ]
1911
- },
1912
- "associatedSLAIds" : {
1913
- "type" : [ "null", "array" ],
1914
- "items" : {
1915
- "type" : [ "string", "null", "integer" ],
1916
- "format" : "int64",
1917
- "pattern" : "([0-9]+)"
1918
- },
1919
- "uniqueItems" : false
1920
- },
1921
- "webUrl" : {
1922
- "type" : [ "string", "null" ],
1923
- "maxLength" : 500,
1924
- "minLength" : 0,
1925
- "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
1926
- },
1927
- "createdTime" : {
1928
- "type" : [ "string", "null" ],
1929
- "maxLength" : 100,
1930
- "minLength" : 0,
1931
- "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))"
1932
- },
1933
- "zohoCRMAccount" : {
1934
- "$ref" : "./Account.json#/components/schemas/zohoCrmAccount"
1935
- },
1936
- "id" : {
1937
- "type" : [ "string", "null", "integer" ],
1938
- "format" : "int64",
1939
- "pattern" : "([0-9]+)"
1940
- },
1941
- "layoutId" : {
1942
- "type" : [ "string", "null", "integer" ],
1943
- "format" : "int64",
1944
- "pattern" : "([0-9]+)"
1945
- },
1946
- "layoutDetails" : {
1947
- "type" : [ "null", "object" ],
1948
- "additionalProperties" : false,
1949
- "maxProperties" : 2,
1950
- "minProperties" : 2,
1951
- "properties" : {
1952
- "id" : {
1953
- "type" : [ "string", "null", "integer" ],
1954
- "format" : "int64",
1955
- "pattern" : "([0-9]+)"
1956
- },
1957
- "layoutName" : {
1958
- "type" : [ "string", "null" ],
1959
- "maxLength" : 120,
1960
- "minLength" : 0,
1961
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1962
- }
1963
- },
1964
- "required" : [ "id", "layoutName" ]
1965
- }
1966
- },
1967
- "required" : [ "associatedSLAIds", "createdTime", "id", "isDeleted", "isFollowing", "isTrashed", "layoutDetails", "layoutId", "modifiedTime", "webUrl", "zohoCRMAccount" ]
1968
- } ]
1969
- } ]
1970
- },
1971
- "examples" : {
1972
- "Valid responses Definitions" : {
1973
- "value" : {
1974
- "country" : "USA",
1975
- "modifiedTime" : 1425307758000,
1976
- "code" : "3211",
1977
- "accountName" : "Zylker",
1978
- "city" : null,
1979
- "associatedSLAIds" : [ 3263000000057, 3000000057001 ],
1980
- "description" : null,
1981
- "industry" : "Automation",
1982
- "zohoCRMAccount" : {
1983
- "id" : "32754000000537001"
1984
- },
1985
- "ownerId" : "3263000000057001",
1986
- "isDeleted" : false,
1987
- "isTrashed" : false,
1988
- "street" : null,
1989
- "annualrevenue" : null,
1990
- "createdTime" : 1424105864000,
1991
- "state" : null,
1992
- "id" : "3263000000074571",
1993
- "fax" : "+1 444 8656 8732",
1994
- "email" : "support@zylker.com",
1995
- "owner" : {
1996
- "firstName" : "Twin",
1997
- "lastName" : "john",
1998
- "id" : "3263000000057001"
1999
- },
2000
- "website" : "www.zylker.com",
2001
- "cf" : {
2002
- "cf_contactcount" : "1"
2003
- },
2004
- "isFollowing" : "true",
2005
- "phone" : "6218129190",
2006
- "webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Accounts/dv/d126330fb061247d9ebddaeb9d93ba74750b0284bc703b38"
2007
- }
2008
- }
2009
- }
2010
- }
2011
- },
2012
- "x-custom-response-attributes" : {
2013
- "disable-safe-headers" : "[]"
2014
- }
2015
- },
2016
- "accountListWithMappingInfoArray" : {
2017
- "description" : "accountListWithMappingInfoArray template definitions",
2018
- "content" : {
2019
- "application/json" : {
2020
- "schema" : {
2021
- "type" : [ "null", "object" ],
2022
- "additionalProperties" : false,
2023
- "properties" : {
2024
- "data" : {
2025
- "$ref" : "./Account.json#/components/schemas/dataWitMappingInfo"
2026
- }
2027
- },
2028
- "required" : [ "data" ]
2029
- },
2030
- "examples" : {
2031
- "Valid responses Definitions" : {
2032
- "value" : {
2033
- "data" : [ {
2034
- "website" : "www.zoho.com",
2035
- "accountName" : "ZOHO",
2036
- "phone" : "8822120911",
2037
- "mappingInfo" : {
2038
- "mappingId" : 1892000000052072,
2039
- "mappingType" : "PRIMARY",
2040
- "isAccountTicketsViewable" : true
2041
- },
2042
- "webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Accounts/dv/d126330fb061247d9ebddaeb9d93ba74750b0284bc703b38",
2043
- "createdTime" : 1424105864000,
2044
- "zohoCRMAccount" : {
2045
- "id" : "32754000000537001"
2046
- },
2047
- "customerHappiness" : {
2048
- "badPercentage" : "30",
2049
- "okPercentage" : "30",
2050
- "goodPercentage" : "40"
2051
- },
2052
- "id" : "1892000000052077",
2053
- "email" : "admin@zylker.com"
2054
- } ]
2055
- }
2056
- }
2057
- }
2058
- }
2059
- },
2060
- "x-custom-response-attributes" : {
2061
- "disable-safe-headers" : "[]"
2062
- }
2063
- },
2064
- "getTicketsByAccountResponse" : {
2065
- "description" : "getTicketsByAccountResponse template definitions",
2066
- "content" : {
2067
- "application/json" : {
2068
- "schema" : {
2069
- "allOf" : [ {
2070
- "type" : "object",
2071
- "properties" : {
2072
- "data" : {
2073
- "type" : "array",
2074
- "items" : {
2075
- "type" : "object",
2076
- "properties" : {
2077
- "product" : {
2078
- "type" : [ "null", "object" ],
2079
- "additionalProperties" : false,
2080
- "maxProperties" : 2,
2081
- "minProperties" : 2,
2082
- "properties" : {
2083
- "id" : {
2084
- "type" : [ "string", "null", "integer" ],
2085
- "format" : "int64",
2086
- "pattern" : "([0-9]+)"
2087
- },
2088
- "productName" : {
2089
- "type" : [ "string", "null" ],
2090
- "maxLength" : 200,
2091
- "minLength" : 0
2092
- }
2093
- },
2094
- "required" : [ "id", "productName" ]
2095
- },
2096
- "contact" : {
2097
- "type" : [ "null", "object" ],
2098
- "additionalProperties" : false,
2099
- "maxProperties" : 8,
2100
- "minProperties" : 8,
2101
- "properties" : {
2102
- "lastName" : {
2103
- "type" : [ "string", "null" ],
2104
- "maxLength" : 200,
2105
- "minLength" : 0
2106
- },
2107
- "firstName" : {
2108
- "type" : [ "string", "null" ],
2109
- "maxLength" : 40,
2110
- "minLength" : 0
2111
- },
2112
- "phone" : {
2113
- "type" : [ "string", "null" ],
2114
- "maxLength" : 50,
2115
- "minLength" : 0,
2116
- "pattern" : "[0-9a-zA-Z_\\+\\-\\.\\(\\)\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+"
2117
- },
2118
- "mobile" : {
2119
- "type" : [ "string", "null" ],
2120
- "maxLength" : 50,
2121
- "minLength" : 0,
2122
- "pattern" : "[0-9a-zA-Z_\\+\\-\\.\\(\\)\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+"
2123
- },
2124
- "id" : {
2125
- "type" : [ "string", "null", "integer" ],
2126
- "format" : "int64",
2127
- "pattern" : "([0-9]+)"
2128
- },
2129
- "type" : {
2130
- "type" : [ "string", "null" ],
2131
- "x-dynamic-enum" : true
2132
- },
2133
- "email" : {
2134
- "type" : [ "string", "null" ],
2135
- "maxLength" : 255,
2136
- "minLength" : 0,
2137
- "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'\\&\\~]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$"
2138
- },
2139
- "account" : {
2140
- "type" : [ "null", "object" ],
2141
- "additionalProperties" : false,
2142
- "maxProperties" : 3,
2143
- "minProperties" : 3,
2144
- "properties" : {
2145
- "website" : {
2146
- "type" : [ "string", "null" ],
2147
- "maxLength" : 120,
2148
- "minLength" : 0
2149
- },
2150
- "accountName" : {
2151
- "type" : [ "string", "null" ],
2152
- "maxLength" : 200,
2153
- "minLength" : 0
2154
- },
2155
- "id" : {
2156
- "type" : [ "string", "null", "integer" ],
2157
- "format" : "int64",
2158
- "pattern" : "([0-9]+)"
2159
- }
2160
- },
2161
- "required" : [ "accountName", "id", "website" ]
2162
- }
2163
- },
2164
- "required" : [ "account", "email", "firstName", "id", "lastName", "mobile", "phone", "type" ]
2165
- },
2166
- "isRead" : {
2167
- "type" : [ "boolean", "null" ]
2168
- },
2169
- "team" : {
2170
- "type" : [ "null", "object" ],
2171
- "additionalProperties" : false,
2172
- "maxProperties" : 3,
2173
- "minProperties" : 3,
2174
- "properties" : {
2175
- "name" : {
2176
- "type" : [ "string", "null" ],
2177
- "maxLength" : 50,
2178
- "minLength" : 1,
2179
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
2180
- },
2181
- "id" : {
2182
- "type" : [ "string", "null", "integer" ],
2183
- "format" : "int64",
2184
- "pattern" : "([0-9]+)"
2185
- },
2186
- "logoUrl" : {
2187
- "type" : [ "string", "null" ],
2188
- "maxLength" : 200,
2189
- "minLength" : 0,
2190
- "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
2191
- }
2192
- },
2193
- "required" : [ "id", "logoUrl", "name" ]
2194
- },
2195
- "assignee" : {
2196
- "type" : [ "null", "object" ],
2197
- "additionalProperties" : false,
2198
- "maxProperties" : 5,
2199
- "minProperties" : 5,
2200
- "properties" : {
2201
- "firstName" : {
2202
- "type" : [ "string", "null" ],
2203
- "maxLength" : 50,
2204
- "minLength" : 0
2205
- },
2206
- "photoURL" : {
2207
- "type" : [ "string", "null" ],
2208
- "maxLength" : 200,
2209
- "minLength" : 0,
2210
- "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
2211
- },
2212
- "lastName" : {
2213
- "type" : [ "string", "null" ],
2214
- "maxLength" : 50,
2215
- "minLength" : 0
2216
- },
2217
- "id" : {
2218
- "type" : [ "string", "null", "integer" ],
2219
- "format" : "int64",
2220
- "pattern" : "([0-9]+)"
2221
- },
2222
- "email" : {
2223
- "type" : [ "string", "null" ],
2224
- "maxLength" : 100,
2225
- "minLength" : 0,
2226
- "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$"
2227
- }
2228
- },
2229
- "required" : [ "email", "firstName", "id", "lastName", "photoURL" ]
2230
- },
2231
- "department" : {
2232
- "type" : [ "null", "object" ],
2233
- "additionalProperties" : false,
2234
- "maxProperties" : 2,
2235
- "minProperties" : 2,
2236
- "properties" : {
2237
- "name" : {
2238
- "type" : [ "string", "null" ],
2239
- "maxLength" : 200,
2240
- "minLength" : 0,
2241
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
2242
- },
2243
- "id" : {
2244
- "type" : [ "string", "null", "integer" ],
2245
- "format" : "int64",
2246
- "pattern" : "([0-9]+)"
2247
- }
2248
- },
2249
- "required" : [ "id", "name" ]
2250
- }
2251
- }
2252
- }
2253
- }
2254
- }
2255
- }, {
2256
- "type" : [ "null", "object" ],
2257
- "additionalProperties" : false,
2258
- "properties" : {
2259
- "data" : {
2260
- "$ref" : "./Account.json#/components/schemas/getTicketsByAccountArr"
2261
- }
2262
- },
2263
- "required" : [ "data" ]
2264
- } ]
2265
- },
2266
- "examples" : {
2267
- "Valid responses Definitions" : {
2268
- "value" : {
2269
- "data" : [ {
2270
- "ticketNumber" : "149",
2271
- "statusType" : "Open",
2272
- "subject" : "Hi. There is a sudden delay in the processing of the orders. Check this with high priority",
2273
- "dueDate" : 1509778989000,
2274
- "departmentId" : "1892000000006907",
2275
- "channel" : "Email",
2276
- "isRead" : false,
2277
- "onholdTime" : null,
2278
- "language" : "English",
2279
- "closedTime" : null,
2280
- "contact" : {
2281
- "lastName" : "Carol",
2282
- "firstName" : "Lucas",
2283
- "phone" : "1 888 900 9646",
2284
- "mobile" : "8845678909",
2285
- "id" : "18944000000421011",
2286
- "type" : null,
2287
- "email" : "carol@zylker.com",
2288
- "account" : {
2289
- "website" : "www.desk.com",
2290
- "accountName" : "desk Account",
2291
- "id" : "1892000000975382"
2292
- }
2293
- },
2294
- "createdTime" : 1507813910000,
2295
- "id" : "18944000000336005",
2296
- "department" : {
2297
- "name" : "dasdasdasd",
2298
- "id" : "1892000000006907"
2299
- },
2300
- "email" : "support@zylker.com",
2301
- "customerResponseTime" : 1509692589203,
2302
- "productId" : "18944000000424033",
2303
- "contactId" : "18944000000421011",
2304
- "threadCount" : "7",
2305
- "lastThread" : null,
2306
- "team" : {
2307
- "name" : "kjsdfjks",
2308
- "id" : "8920000000069071",
2309
- "logoUrl" : "https://desk.zoho.com/api/v1/teams/8920000000069071/logo?orgId=11278831"
2310
- },
2311
- "priority" : "Medium",
2312
- "assigneeId" : "1892000000042001",
2313
- "commentCount" : "0",
2314
- "accountId" : "189200000005345",
2315
- "phone" : "9876543321",
2316
- "webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Cases/dv/20d7881a46edfcffefe308ab38676ec3e612657a51fd5fbe",
2317
- "teamId" : "8920000000069071",
2318
- "isSpam" : false,
2319
- "assignee" : {
2320
- "firstName" : "dasca",
2321
- "lastName" : "vins",
2322
- "photoURL" : "https://desk.zoho.com/api/v1/agent/1892000000042001/photo",
2323
- "id" : "1892000000042001",
2324
- "email" : "jack@zylker.com"
2325
- },
2326
- "status" : "Open"
2327
- } ]
2328
- }
2329
- }
2330
- }
2331
- }
2332
- },
2333
- "x-custom-response-attributes" : {
2334
- "disable-safe-headers" : "[]"
2335
- }
2336
- },
2337
- "getContractsForAccountResponse" : {
2338
- "description" : "getContractsForAccountResponse template definitions",
2339
- "content" : {
2340
- "application/json" : {
2341
- "schema" : {
2342
- "type" : [ "null", "object" ],
2343
- "additionalProperties" : false,
2344
- "properties" : {
2345
- "data" : {
2346
- "$ref" : "./Account.json#/components/schemas/contractsForAccountData"
2347
- }
2348
- },
2349
- "required" : [ "data" ]
2350
- },
2351
- "examples" : {
2352
- "Valid responses Definitions" : {
2353
- "value" : {
2354
- "data" : [ {
2355
- "slaName" : "Priority-based SLAs",
2356
- "endDate" : 1468627200000,
2357
- "slaGroupId" : "4000000007069",
2358
- "departmentId" : "4000000007043",
2359
- "contractId" : "4000000032003",
2360
- "contractNumber" : "1212",
2361
- "description" : "contract for all desk account",
2362
- "contractName" : "Contract for desk account",
2363
- "ownerId" : "4000000008692",
2364
- "startDate" : 1466035200000
2365
- } ]
2366
- }
2367
- }
2368
- }
2369
- }
2370
- },
2371
- "x-custom-response-attributes" : {
2372
- "disable-safe-headers" : "[]"
2373
- }
2374
- },
2375
- "getCountResponse" : {
2376
- "description" : "getCountResponse template definitions",
2377
- "content" : {
2378
- "application/json" : {
2379
- "schema" : {
2380
- "type" : [ "null", "object" ],
2381
- "additionalProperties" : false,
2382
- "properties" : {
2383
- "count" : {
2384
- "type" : [ "string", "null", "integer" ],
2385
- "format" : "int64",
2386
- "pattern" : "([0-9]+)"
2387
- }
2388
- },
2389
- "required" : [ "count" ]
2390
- },
2391
- "examples" : {
2392
- "Valid responses Definitions" : {
2393
- "value" : {
2394
- "count" : "10"
2395
- }
2396
- }
2397
- }
2398
- }
2399
- },
2400
- "x-custom-response-attributes" : {
2401
- "disable-safe-headers" : "[]"
2402
- }
2403
- },
2404
- "accountListArray" : {
2405
- "description" : "accountListArray template definitions",
2406
- "content" : {
2407
- "application/json" : {
2408
- "schema" : {
2409
- "type" : [ "null", "object" ],
2410
- "additionalProperties" : false,
2411
- "properties" : {
2412
- "data" : {
2413
- "$ref" : "./Account.json#/components/schemas/data"
2414
- }
2415
- },
2416
- "required" : [ "data" ]
2417
- },
2418
- "examples" : {
2419
- "Valid responses Definitions" : {
2420
- "value" : {
2421
- "data" : [ {
2422
- "website" : "112121",
2423
- "accountName" : "Admin Account",
2424
- "phone" : "121212",
2425
- "webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Accounts/dv/d126330fb061247d9ebddaeb9d93ba74750b0284bc703b38",
2426
- "createdTime" : 1424105864000,
2427
- "zohoCRMAccount" : {
2428
- "id" : "32754000000537001"
2429
- },
2430
- "customerHappiness" : {
2431
- "badPercentage" : "30",
2432
- "okPercentage" : "30",
2433
- "goodPercentage" : "40"
2434
- },
2435
- "id" : "1892000000052077",
2436
- "email" : "admin@zylker.com"
2437
- }, {
2438
- "website" : "1211212",
2439
- "accountName" : "Agent Account",
2440
- "phone" : "11211",
2441
- "webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Accounts/dv/d126330fb061247d9ebddaeb9d93ba74750b0284bc703b38",
2442
- "createdTime" : 1424105864000,
2443
- "zohoCRMAccount" : {
2444
- "id" : "32754000000537001"
2445
- },
2446
- "customerHappiness" : {
2447
- "badPercentage" : "20",
2448
- "okPercentage" : "40",
2449
- "goodPercentage" : "40"
2450
- },
2451
- "id" : "1892000000052090",
2452
- "email" : "agent@zylker.com"
2453
- } ]
2454
- }
2455
- }
2456
- }
2457
- }
2458
- },
2459
- "x-custom-response-attributes" : {
2460
- "disable-safe-headers" : "[]"
2461
- }
2462
- },
2463
- "updateManyResponse" : {
2464
- "description" : "updateManyResponse template definitions",
2465
- "content" : {
2466
- "application/json" : {
2467
- "schema" : {
2468
- "oneOf" : [ {
2469
- "type" : [ "null", "object" ],
2470
- "additionalProperties" : false,
2471
- "properties" : {
2472
- "results" : {
2473
- "$ref" : "./MassActionResponse.json#/components/schemas/results"
2474
- }
2475
- },
2476
- "required" : [ "results" ]
2477
- }, {
2478
- "additionalProperties" : false,
2479
- "allOf" : [ {
2480
- "$ref" : "../common/Common.json#/components/schemas/errorJson"
2481
- }, {
2482
- "type" : [ "null", "object" ],
2483
- "properties" : {
2484
- "errors" : {
2485
- "type" : [ "null", "array" ],
2486
- "items" : {
2487
- "type" : [ "null", "object" ],
2488
- "additionalProperties" : false,
2489
- "maxProperties" : 3,
2490
- "minProperties" : 3,
2491
- "properties" : {
2492
- "fieldName" : {
2493
- "type" : [ "string", "null" ],
2494
- "maxLength" : 100,
2495
- "minLength" : 0
2496
- },
2497
- "errorType" : {
2498
- "type" : [ "string", "null" ],
2499
- "enum" : [ "invalid", "duplicate", "missing" ],
2500
- "maxLength" : 100,
2501
- "minLength" : 0
2502
- },
2503
- "errorMessage" : {
2504
- "type" : [ "string", "null" ],
2505
- "maxLength" : 100,
2506
- "minLength" : 0
2507
- }
2508
- },
2509
- "required" : [ "errorMessage", "errorType", "fieldName" ]
2510
- },
2511
- "uniqueItems" : false
2512
- }
2513
- },
2514
- "required" : [ "errors" ]
2515
- } ]
2516
- }, {
2517
- "type" : [ "null", "object" ],
2518
- "additionalProperties" : false,
2519
- "properties" : {
2520
- "errorCode" : {
2521
- "type" : [ "string", "null" ],
2522
- "enum" : [ "URL_NOT_FOUND", "UNAUTHORIZED", "INVALID_OAUTH", "SCOPE_MISMATCH", "FORBIDDEN", "LICENSE_ACCESS_LIMITED", "METHOD_NOT_ALLOWED", "RESOURCE_SIZE_EXCEEDED", "UNSUPPORTED_MEDIA_TYPE", "INVALID_DATA", "UNPROCESSABLE_ENTITY", "ONLY_LIVECHAT_USER", "INTEGRATION_ADMIN_ERROR", "THRESHOLD_EXCEEDED", "INTERNAL_SERVER_ERROR", "EMPTY_PAYLOAD" ],
2523
- "maxLength" : 100,
2524
- "minLength" : 0
2525
- },
2526
- "message" : {
2527
- "type" : [ "string", "null" ],
2528
- "maxLength" : 255,
2529
- "minLength" : 0
2530
- }
2531
- },
2532
- "required" : [ "errorCode", "message" ]
2533
- }, {
2534
- "type" : [ "null", "object" ],
2535
- "additionalProperties" : false,
2536
- "properties" : {
2537
- "errorCode" : {
2538
- "type" : [ "string", "null" ],
2539
- "enum" : [ "URL_NOT_FOUND", "UNAUTHORIZED", "INVALID_OAUTH", "SCOPE_MISMATCH", "FORBIDDEN", "LICENSE_ACCESS_LIMITED", "METHOD_NOT_ALLOWED", "RESOURCE_SIZE_EXCEEDED", "UNSUPPORTED_MEDIA_TYPE", "INVALID_DATA", "UNPROCESSABLE_ENTITY", "ONLY_LIVECHAT_USER", "INTEGRATION_ADMIN_ERROR", "THRESHOLD_EXCEEDED", "INTERNAL_SERVER_ERROR", "EMPTY_PAYLOAD" ],
2540
- "maxLength" : 100,
2541
- "minLength" : 0
2542
- },
2543
- "message" : {
2544
- "type" : [ "string", "null" ],
2545
- "maxLength" : 255,
2546
- "minLength" : 0
2547
- }
2548
- },
2549
- "required" : [ "errorCode", "message" ]
2550
- } ]
2551
- },
2552
- "examples" : {
2553
- "Valid responses Definitions" : {
2554
- "value" : {
2555
- "results" : [ {
2556
- "success" : true,
2557
- "id" : "1892000000093303",
2558
- "errors" : null
2559
- }, {
2560
- "success" : true,
2561
- "id" : "1892000000085009",
2562
- "errors" : null
2563
- }, {
2564
- "success" : false,
2565
- "id" : "1892000000050003",
2566
- "errors" : {
2567
- "errorCode" : "UNPROCESSABLE_ENTITY",
2568
- "httpCode" : "422"
2569
- }
2570
- } ]
2571
- }
2572
- }
2573
- }
2574
- }
2575
- },
2576
- "x-custom-response-attributes" : {
2577
- "disable-safe-headers" : "[]"
2578
- }
2579
- }
2580
- },
2581
- "parameters" : {
2582
- "accountId" : {
2583
- "name" : "accountId",
2584
- "in" : "path",
2585
- "description" : "Unique ID of the account",
2586
- "required" : true,
2587
- "style" : "simple",
2588
- "explode" : false,
2589
- "schema" : {
2590
- "type" : [ "string", "null", "integer" ],
2591
- "format" : "int64",
2592
- "pattern" : "([0-9]+)"
2593
- }
2594
- },
2595
- "contactId" : {
2596
- "name" : "contactId",
2597
- "in" : "path",
2598
- "description" : "Unique ID of the contact",
2599
- "required" : true,
2600
- "style" : "simple",
2601
- "explode" : false,
2602
- "schema" : {
2603
- "type" : [ "string", "null", "integer" ],
2604
- "format" : "int64",
2605
- "description" : "Key that filters ticket activities related to a particular contact",
2606
- "pattern" : "([0-9]+)"
2607
- }
2608
- },
2609
- "departmentId" : {
2610
- "name" : "departmentId",
2611
- "in" : "query",
2612
- "description" : "Unique ID of the department",
2613
- "required" : false,
2614
- "style" : "form",
2615
- "explode" : true,
2616
- "schema" : {
2617
- "type" : [ "string", "null", "integer" ],
2618
- "format" : "int64",
2619
- "description" : "ID of the department from which the statistics must be fetched. If you do not pass this parameter in the API request, statistics from all permitted departments will be fetched.",
2620
- "pattern" : "([0-9]+)"
2621
- }
2622
- },
2623
- "limit" : {
2624
- "name" : "limit",
2625
- "in" : "query",
2626
- "description" : "Number of accounts to fetch",
2627
- "required" : false,
2628
- "style" : "form",
2629
- "explode" : true,
2630
- "schema" : {
2631
- "type" : [ "string", "null", "integer" ],
2632
- "format" : "int32",
2633
- "description" : "Number of accounts to list",
2634
- "maximum" : 99,
2635
- "minimum" : 1,
2636
- "pattern" : "([0-9]+)"
2637
- }
2638
- },
2639
- "from" : {
2640
- "name" : "from",
2641
- "in" : "query",
2642
- "description" : "Index number, starting from which the accounts must be fetched",
2643
- "required" : false,
2644
- "style" : "form",
2645
- "explode" : true,
2646
- "schema" : {
2647
- "type" : "integer",
2648
- "format" : "int32",
2649
- "default" : 1,
2650
- "description" : "Index number, starting from which the accounts must be fetched",
2651
- "minimum" : 1
2652
- }
2653
- },
2654
- "startsWith" : {
2655
- "name" : "startsWith",
2656
- "in" : "query",
2657
- "description" : "Letter with which the names of the accounts must start",
2658
- "required" : false,
2659
- "style" : "form",
2660
- "explode" : true,
2661
- "schema" : {
2662
- "type" : [ "string", "null" ],
2663
- "description" : "Letter with which the names of the accounts must start",
2664
- "maxLength" : 100,
2665
- "minLength" : 0
2666
- }
2667
- }
2668
- },
2669
- "requestBodies" : {
2670
- "associateProductsWithAccount" : {
2671
- "content" : {
2672
- "application/json" : {
2673
- "schema" : {
2674
- "type" : [ "null", "object" ],
2675
- "additionalProperties" : false,
2676
- "properties" : {
2677
- "departmentId" : {
2678
- "type" : [ "string", "null", "integer" ],
2679
- "format" : "int64",
2680
- "pattern" : "([0-9]+)",
2681
- "x-custom-parameters-attributes" : {
2682
- "entity" : "Departments"
2683
- }
2684
- },
2685
- "ids" : {
2686
- "type" : [ "null", "array" ],
2687
- "items" : {
2688
- "type" : [ "string", "null", "integer" ],
2689
- "format" : "int64",
2690
- "pattern" : "([0-9]+)",
2691
- "x-custom-parameters-attributes" : [ { } ]
2692
- },
2693
- "uniqueItems" : false
2694
- },
2695
- "associate" : {
2696
- "type" : [ "boolean", "null" ]
2697
- }
2698
- },
2699
- "required" : [ "associate", "ids" ]
2700
- },
2701
- "examples" : {
2702
- "Valid requestBody Definitions" : {
2703
- "value" : {
2704
- "departmentId" : "7000000062800",
2705
- "ids" : [ "7000000027223", "7000000043968" ],
2706
- "associate" : true
2707
- }
2708
- }
2709
- }
2710
- }
2711
- },
2712
- "x-custom-request-body-attributes" : {
2713
- "non-empty" : false,
2714
- "allow-invalid" : false
2715
- }
2716
- },
2717
- "accountMergeRequest" : {
2718
- "content" : {
2719
- "application/json" : {
2720
- "schema" : {
2721
- "type" : [ "null", "object" ],
2722
- "additionalProperties" : false,
2723
- "properties" : {
2724
- "ids" : {
2725
- "type" : [ "null", "array" ],
2726
- "items" : {
2727
- "type" : [ "string", "null", "integer" ],
2728
- "format" : "int64",
2729
- "pattern" : "([0-9]+)",
2730
- "x-custom-parameters-attributes" : [ { } ]
2731
- },
2732
- "uniqueItems" : true
2733
- },
2734
- "source" : {
2735
- "$ref" : "./Account.json#/components/schemas/sourceValues"
2736
- }
2737
- },
2738
- "required" : [ "ids" ]
2739
- },
2740
- "examples" : {
2741
- "Valid requestBody Definitions" : {
2742
- "value" : {
2743
- "ids" : [ "4000000018011", "4000000018033" ],
2744
- "source" : {
2745
- "country" : "4000000018011",
2746
- "website" : "4000000018011",
2747
- "code" : "4000000018011",
2748
- "cf" : {
2749
- "cf_contactcount" : 1892220000042001
2750
- },
2751
- "city" : "4000000018011",
2752
- "description" : "4000000018011",
2753
- "industry" : "4000000018011",
2754
- "phone" : "4000000018011",
2755
- "annualrevenue" : "4000000018011",
2756
- "street" : "4000000018011",
2757
- "state" : "4000000018011",
2758
- "fax" : "4000000018011",
2759
- "email" : "4000000018011"
2760
- }
2761
- }
2762
- }
2763
- }
2764
- }
2765
- },
2766
- "x-custom-request-body-attributes" : {
2767
- "non-empty" : false,
2768
- "allow-invalid" : false
2769
- }
2770
- },
2771
- "dissociateContactsWithAccount" : {
2772
- "content" : {
2773
- "application/json" : {
2774
- "schema" : {
2775
- "type" : [ "null", "object" ],
2776
- "additionalProperties" : false,
2777
- "properties" : {
2778
- "ids" : {
2779
- "type" : [ "null", "array" ],
2780
- "items" : {
2781
- "type" : [ "string", "null", "integer" ],
2782
- "format" : "int64",
2783
- "pattern" : "([0-9]+)",
2784
- "x-custom-parameters-attributes" : [ { } ]
2785
- },
2786
- "uniqueItems" : false
2787
- }
2788
- },
2789
- "required" : [ "ids" ]
2790
- },
2791
- "examples" : {
2792
- "Valid requestBody Definitions" : {
2793
- "value" : {
2794
- "ids" : [ "7000000027223", "7000000043968" ]
2795
- }
2796
- }
2797
- }
2798
- }
2799
- },
2800
- "x-custom-request-body-attributes" : {
2801
- "non-empty" : false,
2802
- "allow-invalid" : false
2803
- }
2804
- },
2805
- "accountjson" : {
2806
- "content" : {
2807
- "application/json" : {
2808
- "schema" : {
2809
- "additionalProperties" : false,
2810
- "allOf" : [ {
2811
- "$ref" : "#/components/schemas/commonObject"
2812
- }, {
2813
- "type" : [ "null", "object" ],
2814
- "properties" : {
2815
- "country" : {
2816
- "type" : [ "string", "null" ],
2817
- "description" : "Country in which the account is based",
2818
- "maxLength" : 30,
2819
- "minLength" : 0
2820
- },
2821
- "code" : {
2822
- "type" : [ "string", "null" ],
2823
- "description" : "Zip code",
2824
- "maxLength" : 30,
2825
- "minLength" : 0,
2826
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
2827
- },
2828
- "cf" : {
2829
- "type" : [ "null", "object" ],
2830
- "additionalProperties" : false,
2831
- "patternProperties" : {
2832
- "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : {
2833
- "type" : [ "string", "null" ],
2834
- "maxLength" : 100,
2835
- "minLength" : 0,
2836
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
2837
- }
2838
- }
2839
- },
2840
- "city" : {
2841
- "type" : [ "string", "null" ],
2842
- "description" : "City in which the account is based",
2843
- "maxLength" : 30,
2844
- "minLength" : 0
2845
- },
2846
- "customFields" : {
2847
- "type" : [ "null", "object" ],
2848
- "additionalProperties" : false,
2849
- "patternProperties" : {
2850
- "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : {
2851
- "type" : [ "string", "null" ],
2852
- "maxLength" : 100,
2853
- "minLength" : 0,
2854
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
2855
- }
2856
- }
2857
- },
2858
- "street" : {
2859
- "type" : [ "string", "null" ],
2860
- "description" : "Address of the account",
2861
- "maxLength" : 250,
2862
- "minLength" : 0
2863
- },
2864
- "annualrevenue" : {
2865
- "type" : [ "string", "null" ],
2866
- "description" : "Annual revenue of the account",
2867
- "maxLength" : 100,
2868
- "minLength" : 0,
2869
- "pattern" : "([0-9]{1,13}(\\.[0-9]*)?)"
2870
- },
2871
- "description" : {
2872
- "type" : [ "string", "null" ],
2873
- "description" : "A short description of the account",
2874
- "maxLength" : 65535,
2875
- "minLength" : 0
2876
- },
2877
- "industry" : {
2878
- "type" : [ "string", "null" ],
2879
- "description" : "Industry in which the account operates",
2880
- "maxLength" : 120,
2881
- "minLength" : 0,
2882
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
2883
- },
2884
- "state" : {
2885
- "type" : [ "string", "null" ],
2886
- "description" : "State in which the account is based",
2887
- "maxLength" : 30,
2888
- "minLength" : 0
2889
- },
2890
- "ownerId" : {
2891
- "type" : [ "string", "null", "integer" ],
2892
- "format" : "int64",
2893
- "description" : "ID of account owner",
2894
- "pattern" : "([0-9]+)"
2895
- },
2896
- "fax" : {
2897
- "type" : [ "string", "null" ],
2898
- "description" : "Fax number of the account",
2899
- "maxLength" : 30,
2900
- "minLength" : 0,
2901
- "pattern" : "[0-9a-zA-Z_\\+\\-\\.\\(\\)\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+",
2902
- "x-custom-parameters-attributes" : {
2903
- "filterMatchedContent" : true,
2904
- "replacementString" : ""
2905
- }
2906
- }
2907
- }
2908
- }, {
2909
- "type" : "object",
2910
- "required" : [ "accountName" ]
2911
- } ]
2912
- },
2913
- "examples" : {
2914
- "Valid requestBody Definitions" : {
2915
- "value" : {
2916
- "accountName" : "Zylker",
2917
- "phone" : "98348229382"
2918
- }
2919
- }
2920
- }
2921
- }
2922
- },
2923
- "x-custom-request-body-attributes" : {
2924
- "non-empty" : false,
2925
- "allow-invalid" : false
2926
- }
2927
- },
2928
- "associateContactsWithAccount" : {
2929
- "content" : {
2930
- "application/json" : {
2931
- "schema" : {
2932
- "type" : [ "null", "object" ],
2933
- "additionalProperties" : false,
2934
- "properties" : {
2935
- "ids" : {
2936
- "type" : [ "null", "array" ],
2937
- "items" : {
2938
- "type" : [ "string", "null", "integer" ],
2939
- "format" : "int64",
2940
- "pattern" : "([0-9]+)",
2941
- "x-custom-parameters-attributes" : [ { } ]
2942
- },
2943
- "uniqueItems" : false
2944
- }
2945
- },
2946
- "required" : [ "ids" ]
2947
- },
2948
- "examples" : {
2949
- "Valid requestBody Definitions" : {
2950
- "value" : {
2951
- "ids" : [ "7000000027223", "7000000043968" ]
2952
- }
2953
- }
2954
- }
2955
- }
2956
- },
2957
- "x-custom-request-body-attributes" : {
2958
- "non-empty" : false,
2959
- "allow-invalid" : false
2960
- }
2961
- },
2962
- "updateAccount_accountjson" : {
2963
- "content" : {
2964
- "application/json" : {
2965
- "schema" : {
2966
- "additionalProperties" : false,
2967
- "allOf" : [ {
2968
- "$ref" : "./Account.json#/components/schemas/commonObject"
2969
- }, {
2970
- "type" : [ "null", "object" ],
2971
- "properties" : {
2972
- "country" : {
2973
- "type" : [ "string", "null" ],
2974
- "description" : "Country in which the account is based",
2975
- "maxLength" : 30,
2976
- "minLength" : 0
2977
- },
2978
- "code" : {
2979
- "type" : [ "string", "null" ],
2980
- "description" : "Zip code",
2981
- "maxLength" : 30,
2982
- "minLength" : 0,
2983
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
2984
- },
2985
- "cf" : {
2986
- "type" : [ "null", "object" ],
2987
- "additionalProperties" : false,
2988
- "patternProperties" : {
2989
- "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : {
2990
- "type" : [ "string", "null" ],
2991
- "maxLength" : 100,
2992
- "minLength" : 0,
2993
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
2994
- }
2995
- }
2996
- },
2997
- "city" : {
2998
- "type" : [ "string", "null" ],
2999
- "description" : "City in which the account is based",
3000
- "maxLength" : 30,
3001
- "minLength" : 0
3002
- },
3003
- "customFields" : {
3004
- "type" : [ "null", "object" ],
3005
- "additionalProperties" : false,
3006
- "patternProperties" : {
3007
- "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : {
3008
- "type" : [ "string", "null" ],
3009
- "maxLength" : 100,
3010
- "minLength" : 0,
3011
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
3012
- }
3013
- }
3014
- },
3015
- "street" : {
3016
- "type" : [ "string", "null" ],
3017
- "description" : "Address of the account",
3018
- "maxLength" : 250,
3019
- "minLength" : 0
3020
- },
3021
- "annualrevenue" : {
3022
- "type" : [ "string", "null" ],
3023
- "description" : "Annual revenue of the account",
3024
- "maxLength" : 100,
3025
- "minLength" : 0,
3026
- "pattern" : "([0-9]{1,13}(\\.[0-9]*)?)"
3027
- },
3028
- "description" : {
3029
- "type" : [ "string", "null" ],
3030
- "description" : "A short description of the account",
3031
- "maxLength" : 65535,
3032
- "minLength" : 0
3033
- },
3034
- "industry" : {
3035
- "type" : [ "string", "null" ],
3036
- "description" : "Industry in which the account operates",
3037
- "maxLength" : 120,
3038
- "minLength" : 0,
3039
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
3040
- },
3041
- "state" : {
3042
- "type" : [ "string", "null" ],
3043
- "description" : "State in which the account is based",
3044
- "maxLength" : 30,
3045
- "minLength" : 0
3046
- },
3047
- "ownerId" : {
3048
- "type" : [ "string", "null", "integer" ],
3049
- "format" : "int64",
3050
- "description" : "ID of account owner",
3051
- "pattern" : "([0-9]+)"
3052
- },
3053
- "fax" : {
3054
- "type" : [ "string", "null" ],
3055
- "description" : "Fax number of the account",
3056
- "maxLength" : 30,
3057
- "minLength" : 0,
3058
- "pattern" : "[0-9a-zA-Z_\\+\\-\\.\\(\\)\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+",
3059
- "x-custom-parameters-attributes" : {
3060
- "filterMatchedContent" : true,
3061
- "replacementString" : ""
3062
- }
3063
- }
3064
- }
3065
- }, {
3066
- "type" : "object"
3067
- } ]
3068
- },
3069
- "examples" : {
3070
- "Valid requestBody Definitions" : {
3071
- "value" : null
3072
- }
3073
- }
3074
- }
3075
- },
3076
- "x-custom-request-body-attributes" : {
3077
- "non-empty" : false,
3078
- "allow-invalid" : false
3079
- }
3080
- },
3081
- "deleteAccountsRequest" : {
3082
- "content" : {
3083
- "application/json" : {
3084
- "schema" : {
3085
- "type" : [ "null", "object" ],
3086
- "additionalProperties" : false,
3087
- "properties" : {
3088
- "accountIds" : {
3089
- "type" : [ "null", "array" ],
3090
- "items" : {
3091
- "type" : [ "string", "null", "integer" ],
3092
- "format" : "int64",
3093
- "pattern" : "([0-9]+)",
3094
- "x-custom-parameters-attributes" : [ { } ]
3095
- },
3096
- "uniqueItems" : false
3097
- }
3098
- },
3099
- "required" : [ "accountIds" ]
3100
- },
3101
- "examples" : {
3102
- "Valid requestBody Definitions" : {
3103
- "value" : {
3104
- "accountIds" : [ "2000032003232" ]
3105
- }
3106
- }
3107
- }
3108
- }
3109
- },
3110
- "x-custom-request-body-attributes" : {
3111
- "non-empty" : false,
3112
- "allow-invalid" : false
3113
- }
3114
- },
3115
- "account_massupdate" : {
3116
- "content" : {
3117
- "application/json" : {
3118
- "schema" : {
3119
- "type" : [ "null", "object" ],
3120
- "additionalProperties" : false,
3121
- "properties" : {
3122
- "isCustomField" : {
3123
- "type" : [ "boolean", "null" ]
3124
- },
3125
- "fieldName" : {
3126
- "type" : [ "string", "null" ],
3127
- "x-dynamic-enum" : true
3128
- },
3129
- "ids" : {
3130
- "$ref" : "./Account.json#/components/schemas/long_array"
3131
- },
3132
- "fieldValue" : {
3133
- "type" : [ "string", "null" ],
3134
- "maxLength" : 100,
3135
- "minLength" : 0,
3136
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
3137
- }
3138
- },
3139
- "required" : [ "fieldName", "ids" ]
3140
- },
3141
- "examples" : {
3142
- "Valid requestBody Definitions" : {
3143
- "value" : {
3144
- "fieldName" : "phone",
3145
- "isCustomField" : false,
3146
- "ids" : [ "1892000000093303", "1892000000085009", "1892000000050003" ],
3147
- "fieldValue" : "8508569875"
3148
- }
3149
- }
3150
- }
3151
- }
3152
- },
3153
- "x-custom-request-body-attributes" : {
3154
- "non-empty" : false,
3155
- "allow-invalid" : false
3156
- }
3157
- },
3158
- "accountsrecyclebinjson" : {
3159
- "content" : {
3160
- "application/json" : {
3161
- "schema" : {
3162
- "type" : [ "null", "object" ],
3163
- "additionalProperties" : false,
3164
- "properties" : {
3165
- "accountIds" : {
3166
- "type" : [ "null", "array" ],
3167
- "items" : {
3168
- "type" : [ "string", "null", "integer" ],
3169
- "format" : "int64",
3170
- "pattern" : "([0-9]+)",
3171
- "x-custom-parameters-attributes" : [ { } ]
3172
- },
3173
- "uniqueItems" : false
3174
- }
3175
- },
3176
- "required" : [ "accountIds" ]
3177
- },
3178
- "examples" : {
3179
- "Valid requestBody Definitions" : {
3180
- "value" : {
3181
- "accountIds" : [ "2000032003232" ]
3182
- }
3183
- }
3184
- }
3185
- }
3186
- },
3187
- "x-custom-request-body-attributes" : {
3188
- "non-empty" : false,
3189
- "allow-invalid" : false
3190
- }
3191
- }
3192
- },
3193
- "securitySchemes" : {
3194
- "cookie-auth" : {
3195
- "$ref" : "../common/Common.json#/components/securitySchemes/cookie-auth"
3196
- },
3197
- "org-oauth" : {
3198
- "$ref" : "../common/Common.json#/components/securitySchemes/org-oauth"
3199
- },
3200
- "iam-oauth2-schema" : {
3201
- "$ref" : "../common/Common.json#/components/securitySchemes/iam-oauth2-schema"
3202
- }
3203
- }
3204
- },
3205
- "x-entity" : "Account"
3206
- }