agent-generator-cli 1.0.0 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (766) hide show
  1. package/README.md +2 -22
  2. package/install-extension.js +89 -0
  3. package/main.js +45 -7
  4. package/package.json +21 -8
  5. package/source/api-data-generators/.idea/api-data-generators.iml +9 -0
  6. package/source/api-data-generators/.idea/misc.xml +6 -0
  7. package/source/api-data-generators/.idea/modules.xml +8 -0
  8. package/source/api-data-generators/.idea/vcs.xml +6 -0
  9. package/source/api-data-generators/portal/ArticleComment/test_data_generation_configurations.json +318 -0
  10. package/source/api-data-generators/portal/ArticleFeedback/test_data_generation_configurations.json +32 -0
  11. package/source/api-data-generators/portal/AsapMobile/test_data_generation_configurations.json +21 -0
  12. package/source/api-data-generators/portal/AsapWeb/test_data_generation_configurations.json +18 -0
  13. package/source/api-data-generators/portal/Category/test_data_generation_configurations.json +39 -0
  14. package/source/api-data-generators/portal/Comment/test_data_generation_configurations.json +157 -0
  15. package/source/api-data-generators/portal/Community/test_data_generation_configurations.json +46 -0
  16. package/source/api-data-generators/portal/CommunityUser/test_data_generation_configurations.json +16 -0
  17. package/source/api-data-generators/portal/Contact/test_data_generation_configurations.json +33 -0
  18. package/source/api-data-generators/portal/Department/test_data_generation_configurations.json +13 -0
  19. package/source/api-data-generators/portal/Extension/test_data_generation_configurations.json +91 -0
  20. package/source/api-data-generators/portal/FeedbackWidget/test_data_generation_configurations.json +18 -0
  21. package/source/api-data-generators/portal/FileExport/test_data_generation_configurations.json +42 -0
  22. package/source/api-data-generators/portal/Followers/test_data_generation_configurations.json +92 -0
  23. package/source/api-data-generators/portal/Gamification/test_data_generation_configurations.json +51 -0
  24. package/source/api-data-generators/portal/HelpCenters/test_data_generation_configurations.json +11 -0
  25. package/source/api-data-generators/portal/Helpcenter/test_data_generation_configurations.json +41 -0
  26. package/source/api-data-generators/portal/HelpcenterGroups/test_data_generation_configurations.json +18 -0
  27. package/source/api-data-generators/portal/KBRootCategory/test_data_generation_configurations.json +76 -0
  28. package/source/api-data-generators/portal/KbCategory/test_data_generation_configurations.json +51 -0
  29. package/source/api-data-generators/portal/KbSection/test_data_generation_configurations.json +25 -0
  30. package/source/api-data-generators/portal/KnowledgeBase/test_data_generation_configurations.json +26 -0
  31. package/source/api-data-generators/portal/Label/test_data_generation_configurations.json +18 -0
  32. package/source/api-data-generators/portal/Layout/test_data_generation_configurations.json +17 -0
  33. package/source/api-data-generators/portal/LayoutRules/test_data_generation_configurations.json +17 -0
  34. package/source/api-data-generators/portal/NewAsapMobile/test_data_generation_configurations.json +21 -0
  35. package/source/api-data-generators/portal/Permalink/test_data_generation_configurations.json +32 -0
  36. package/source/api-data-generators/portal/Product/test_data_generation_configurations.json +43 -0
  37. package/source/api-data-generators/portal/Solution/test_data_generation_configurations.json +631 -0
  38. package/source/api-data-generators/portal/Thread/test_data_generation_configurations.json +70 -0
  39. package/source/api-data-generators/portal/Ticket/test_data_generation_configurations.json +294 -0
  40. package/source/api-data-generators/portal/TicketComment/test_data_generation_configurations.json +58 -0
  41. package/source/api-data-generators/portal/TicketCount/test_data_generation_configurations.json +74 -0
  42. package/source/api-data-generators/portal/TicketStatusMapping/test_data_generation_configurations.json +11 -0
  43. package/source/api-data-generators/portal/TicketTemplate/test_data_generation_configurations.json +24 -0
  44. package/source/api-data-generators/portal/Topic/test_data_generation_configurations.json +259 -0
  45. package/source/api-data-generators/portal/Translation/test_data_generation_configurations.json +6 -0
  46. package/source/api-data-generators/portal/ValidationRules/test_data_generation_configurations.json +14 -0
  47. package/source/api-data-generators/portal/View/test_data_generation_configurations.json +19 -0
  48. package/source/api-data-generators/support/Account/test_data_generation_configurations.json +265 -0
  49. package/source/api-data-generators/support/AccountAttachment/test_data_generation_configurations.json +48 -0
  50. package/source/api-data-generators/support/AccountComments/test_data_generation_configurations.json +47 -0
  51. package/source/api-data-generators/support/AccountContactMappingInfo/test_data_generation_configurations.json +14 -0
  52. package/source/api-data-generators/support/AccountFollowers/test_data_generation_configurations.json +52 -0
  53. package/source/api-data-generators/support/AccountSla/test_data_generation_configurations.json +33 -0
  54. package/source/api-data-generators/support/AccountTimeEntry/test_data_generation_configurations.json +45 -0
  55. package/source/api-data-generators/support/ActiveCalls/test_data_generation_configurations.json +38 -0
  56. package/source/api-data-generators/support/Activity/test_data_generation_configurations.json +50 -0
  57. package/source/api-data-generators/support/ActorsAPI/test_data_generation_configurations.json +22 -0
  58. package/source/api-data-generators/support/Agent/test_data_generation_configurations.json +217 -0
  59. package/source/api-data-generators/support/AgentPresence/test_data_generation_configurations.json +30 -0
  60. package/source/api-data-generators/support/AgentSignatures/test_data_generation_configurations.json +31 -0
  61. package/source/api-data-generators/support/AgentTimeEntry/test_data_generation_configurations.json +36 -0
  62. package/source/api-data-generators/support/AntiSpamInfo/test_data_generation_configurations.json +32 -0
  63. package/source/api-data-generators/support/ApiCreditNotificationRule/test_data_generation_configurations.json +49 -0
  64. package/source/api-data-generators/support/ArchivedView/test_data_generation_configurations.json +66 -0
  65. package/source/api-data-generators/support/Article/test_data_generation_configurations.json +294 -0
  66. package/source/api-data-generators/support/ArticleAttachment/test_data_generation_configurations.json +150 -0
  67. package/source/api-data-generators/support/ArticleComment/test_data_generation_configurations.json +238 -0
  68. package/source/api-data-generators/support/ArticleFeedback/test_data_generation_configurations.json +147 -0
  69. package/source/api-data-generators/support/ArticleFeedbackResolution/test_data_generation_configurations.json +56 -0
  70. package/source/api-data-generators/support/ArticleStatistics/test_data_generation_configurations.json +397 -0
  71. package/source/api-data-generators/support/ArticleTranslation/test_data_generation_configurations.json +1123 -0
  72. package/source/api-data-generators/support/ArticleVersion/test_data_generation_configurations.json +26 -0
  73. package/source/api-data-generators/support/ArticleViews/test_data_generation_configurations.json +26 -0
  74. package/source/api-data-generators/support/Asap/test_data_generation_configurations.json +49 -0
  75. package/source/api-data-generators/support/AuditLog/test_data_generation_configurations.json +58 -0
  76. package/source/api-data-generators/support/AutomationAlerts/test_data_generation_configurations.json +27 -0
  77. package/source/api-data-generators/support/AutomationEngine/test_data_generation_configurations.json +20 -0
  78. package/source/api-data-generators/support/AutomationFeatureCount/test_data_generation_configurations.json +13 -0
  79. package/source/api-data-generators/support/AutomationFieldUpdates/test_data_generation_configurations.json +24 -0
  80. package/source/api-data-generators/support/AutomationTask/test_data_generation_configurations.json +29 -0
  81. package/source/api-data-generators/support/Backup/test_data_generation_configurations.json +115 -0
  82. package/source/api-data-generators/support/Badge/test_data_generation_configurations.json +64 -0
  83. package/source/api-data-generators/support/Bot/test_data_generation_configurations.json +288 -0
  84. package/source/api-data-generators/support/BotInference/test_data_generation_configurations.json +119 -0
  85. package/source/api-data-generators/support/BugInteg/test_data_generation_configurations.json +37 -0
  86. package/source/api-data-generators/support/BulkAction/test_data_generation_configurations.json +26 -0
  87. package/source/api-data-generators/support/BulkImport/test_data_generation_configurations.json +211 -0
  88. package/source/api-data-generators/support/BulkUpdate/test_data_generation_configurations.json +40 -0
  89. package/source/api-data-generators/support/BulkWrite/test_data_generation_configurations.json +32 -0
  90. package/source/api-data-generators/support/BusinessHour/test_data_generation_configurations.json +72 -0
  91. package/source/api-data-generators/support/Call/test_data_generation_configurations.json +247 -0
  92. package/source/api-data-generators/support/CallComments/test_data_generation_configurations.json +51 -0
  93. package/source/api-data-generators/support/CallHistory/test_data_generation_configurations.json +65 -0
  94. package/source/api-data-generators/support/CallTimeEntry/test_data_generation_configurations.json +77 -0
  95. package/source/api-data-generators/support/CallTimer/test_data_generation_configurations.json +14 -0
  96. package/source/api-data-generators/support/Channel/test_data_generation_configurations.json +44 -0
  97. package/source/api-data-generators/support/Chart/test_data_generation_configurations.json +35 -0
  98. package/source/api-data-generators/support/ChatTicket/test_data_generation_configurations.json +185 -0
  99. package/source/api-data-generators/support/Common/test_data_generation_configurations.json +43 -0
  100. package/source/api-data-generators/support/Community/test_data_generation_configurations.json +313 -0
  101. package/source/api-data-generators/support/CommunityAttachment/test_data_generation_configurations.json +16 -0
  102. package/source/api-data-generators/support/CommunityCategory/test_data_generation_configurations.json +121 -0
  103. package/source/api-data-generators/support/CommunityComment/test_data_generation_configurations.json +350 -0
  104. package/source/api-data-generators/support/CommunityInitPermissions/test_data_generation_configurations.json +16 -0
  105. package/source/api-data-generators/support/CommunityPreferences/test_data_generation_configurations.json +19 -0
  106. package/source/api-data-generators/support/CommunityTopic/test_data_generation_configurations.json +509 -0
  107. package/source/api-data-generators/support/CommunityTopicInsights/test_data_generation_configurations.json +32 -0
  108. package/source/api-data-generators/support/CommunityUser/test_data_generation_configurations.json +63 -0
  109. package/source/api-data-generators/support/Contact/test_data_generation_configurations.json +370 -0
  110. package/source/api-data-generators/support/ContactAttachment/test_data_generation_configurations.json +44 -0
  111. package/source/api-data-generators/support/ContactComments/test_data_generation_configurations.json +47 -0
  112. package/source/api-data-generators/support/ContactFollowers/test_data_generation_configurations.json +52 -0
  113. package/source/api-data-generators/support/ContactProfile/test_data_generation_configurations.json +11 -0
  114. package/source/api-data-generators/support/ContactTimeEntry/test_data_generation_configurations.json +45 -0
  115. package/source/api-data-generators/support/Contract/test_data_generation_configurations.json +184 -0
  116. package/source/api-data-generators/support/ContractAttachment/test_data_generation_configurations.json +30 -0
  117. package/source/api-data-generators/support/CreateTicket/test_data_generation_configurations.json +93 -0
  118. package/source/api-data-generators/support/Criteria/test_data_generation_configurations.json +19 -0
  119. package/source/api-data-generators/support/CrmInteg/test_data_generation_configurations.json +202 -0
  120. package/source/api-data-generators/support/CustomAction/test_data_generation_configurations.json +56 -0
  121. package/source/api-data-generators/support/CustomActionRuleMapping/test_data_generation_configurations.json +334 -0
  122. package/source/api-data-generators/support/CustomButton/test_data_generation_configurations.json +113 -0
  123. package/source/api-data-generators/support/CustomFunctionExecutionLogs/test_data_generation_configurations.json +68 -0
  124. package/source/api-data-generators/support/CustomFunctionGallery/test_data_generation_configurations.json +16 -0
  125. package/source/api-data-generators/support/CustomFunctions/test_data_generation_configurations.json +270 -0
  126. package/source/api-data-generators/support/CustomTheme/test_data_generation_configurations.json +70 -0
  127. package/source/api-data-generators/support/CustomView/test_data_generation_configurations.json +486 -0
  128. package/source/api-data-generators/support/CustomerHappiness/test_data_generation_configurations.json +77 -0
  129. package/source/api-data-generators/support/DashboardComponent/test_data_generation_configurations.json +305 -0
  130. package/source/api-data-generators/support/DashboardFolder/test_data_generation_configurations.json +126 -0
  131. package/source/api-data-generators/support/DashboardMetrics/test_data_generation_configurations.json +205 -0
  132. package/source/api-data-generators/support/Dashboards/test_data_generation_configurations.json +90 -0
  133. package/source/api-data-generators/support/DataChips/test_data_generation_configurations.json +33 -0
  134. package/source/api-data-generators/support/DataSync/test_data_generation_configurations.json +228 -0
  135. package/source/api-data-generators/support/DeleteTicket/test_data_generation_configurations.json +44 -0
  136. package/source/api-data-generators/support/Department/test_data_generation_configurations.json +156 -0
  137. package/source/api-data-generators/support/DependencyMappings/test_data_generation_configurations.json +50 -0
  138. package/source/api-data-generators/support/DirectAssignRuleTarget/test_data_generation_configurations.json +17 -0
  139. package/source/api-data-generators/support/DirectAssignmentRules/test_data_generation_configurations.json +37 -0
  140. package/source/api-data-generators/support/DisplayEntity/test_data_generation_configurations.json +45 -0
  141. package/source/api-data-generators/support/DomainMapping/test_data_generation_configurations.json +6 -0
  142. package/source/api-data-generators/support/EmailFailureAlert/test_data_generation_configurations.json +21 -0
  143. package/source/api-data-generators/support/EmailTemplates/test_data_generation_configurations.json +106 -0
  144. package/source/api-data-generators/support/EntityBlueprints/test_data_generation_configurations.json +205 -0
  145. package/source/api-data-generators/support/Event/test_data_generation_configurations.json +196 -0
  146. package/source/api-data-generators/support/EventComments/test_data_generation_configurations.json +45 -0
  147. package/source/api-data-generators/support/EventTimeEntry/test_data_generation_configurations.json +77 -0
  148. package/source/api-data-generators/support/EventTimer/test_data_generation_configurations.json +14 -0
  149. package/source/api-data-generators/support/Extension/test_data_generation_configurations.json +689 -0
  150. package/source/api-data-generators/support/FbManager/test_data_generation_configurations.json +64 -0
  151. package/source/api-data-generators/support/Feature/test_data_generation_configurations.json +61 -0
  152. package/source/api-data-generators/support/FeatureFile/test_data_generation_configurations.json +49 -0
  153. package/source/api-data-generators/support/FeatureFolder/test_data_generation_configurations.json +44 -0
  154. package/source/api-data-generators/support/FeaturePermission/test_data_generation_configurations.json +108 -0
  155. package/source/api-data-generators/support/FederatedLogin/test_data_generation_configurations.json +39 -0
  156. package/source/api-data-generators/support/FeedsAPIs/test_data_generation_configurations.json +54 -0
  157. package/source/api-data-generators/support/Field/test_data_generation_configurations.json +1031 -0
  158. package/source/api-data-generators/support/FieldPrediction/test_data_generation_configurations.json +564 -0
  159. package/source/api-data-generators/support/FileExport/test_data_generation_configurations.json +36 -0
  160. package/source/api-data-generators/support/Finance/test_data_generation_configurations.json +180 -0
  161. package/source/api-data-generators/support/Followers/test_data_generation_configurations.json +60 -0
  162. package/source/api-data-generators/support/GC_Bots/test_data_generation_configurations.json +26 -0
  163. package/source/api-data-generators/support/GC_Guide/test_data_generation_configurations.json +240 -0
  164. package/source/api-data-generators/support/GenericAction/test_data_generation_configurations.json +16 -0
  165. package/source/api-data-generators/support/GenericActionMapping/test_data_generation_configurations.json +216 -0
  166. package/source/api-data-generators/support/GoogleAnalytics/test_data_generation_configurations.json +168 -0
  167. package/source/api-data-generators/support/GoogleChat/test_data_generation_configurations.json +29 -0
  168. package/source/api-data-generators/support/Helpcenter/test_data_generation_configurations.json +98 -0
  169. package/source/api-data-generators/support/HelpcenterAutoTranslateSetting/test_data_generation_configurations.json +11 -0
  170. package/source/api-data-generators/support/HelpcenterGroups/test_data_generation_configurations.json +93 -0
  171. package/source/api-data-generators/support/HelpcenterPages/test_data_generation_configurations.json +34 -0
  172. package/source/api-data-generators/support/HelpcenterPreference/test_data_generation_configurations.json +18 -0
  173. package/source/api-data-generators/support/HelpcenterUpload/test_data_generation_configurations.json +25 -0
  174. package/source/api-data-generators/support/HolidayList/test_data_generation_configurations.json +65 -0
  175. package/source/api-data-generators/support/IMCannedMessage/test_data_generation_configurations.json +155 -0
  176. package/source/api-data-generators/support/IMCannedMessageTranslation/test_data_generation_configurations.json +92 -0
  177. package/source/api-data-generators/support/IMTemplateMessage/test_data_generation_configurations.json +22 -0
  178. package/source/api-data-generators/support/IM_AddOn/test_data_generation_configurations.json +19 -0
  179. package/source/api-data-generators/support/IM_Bot/test_data_generation_configurations.json +143 -0
  180. package/source/api-data-generators/support/IM_Broadcast/test_data_generation_configurations.json +39 -0
  181. package/source/api-data-generators/support/IM_Channel/test_data_generation_configurations.json +312 -0
  182. package/source/api-data-generators/support/IM_ChannelPreference/test_data_generation_configurations.json +35 -0
  183. package/source/api-data-generators/support/IM_Contact/test_data_generation_configurations.json +16 -0
  184. package/source/api-data-generators/support/IM_Integration/test_data_generation_configurations.json +32 -0
  185. package/source/api-data-generators/support/IM_Message/test_data_generation_configurations.json +297 -0
  186. package/source/api-data-generators/support/IM_Metrics/test_data_generation_configurations.json +38 -0
  187. package/source/api-data-generators/support/IM_Search/test_data_generation_configurations.json +56 -0
  188. package/source/api-data-generators/support/IM_Session/test_data_generation_configurations.json +149 -0
  189. package/source/api-data-generators/support/IM_TimeSeriesMetrics/test_data_generation_configurations.json +77 -0
  190. package/source/api-data-generators/support/IM_ZiaGpt/test_data_generation_configurations.json +52 -0
  191. package/source/api-data-generators/support/Import/test_data_generation_configurations.json +229 -0
  192. package/source/api-data-generators/support/InlineImage/test_data_generation_configurations.json +16 -0
  193. package/source/api-data-generators/support/IntegModule/test_data_generation_configurations.json +90 -0
  194. package/source/api-data-generators/support/Integrations/test_data_generation_configurations.json +25 -0
  195. package/source/api-data-generators/support/InteractiveTours/test_data_generation_configurations.json +66 -0
  196. package/source/api-data-generators/support/JWT/test_data_generation_configurations.json +49 -0
  197. package/source/api-data-generators/support/KBCategoryUser/test_data_generation_configurations.json +23 -0
  198. package/source/api-data-generators/support/KBRecycleBin/test_data_generation_configurations.json +131 -0
  199. package/source/api-data-generators/support/KBRootCategory/test_data_generation_configurations.json +214 -0
  200. package/source/api-data-generators/support/KBRootCategoryTranslation/test_data_generation_configurations.json +30 -0
  201. package/source/api-data-generators/support/KBSection/test_data_generation_configurations.json +173 -0
  202. package/source/api-data-generators/support/KPIWidget/test_data_generation_configurations.json +21 -0
  203. package/source/api-data-generators/support/KbCategory/test_data_generation_configurations.json +93 -0
  204. package/source/api-data-generators/support/Label/test_data_generation_configurations.json +103 -0
  205. package/source/api-data-generators/support/Layout/test_data_generation_configurations.json +503 -0
  206. package/source/api-data-generators/support/LayoutRuleCriteria/test_data_generation_configurations.json +19 -0
  207. package/source/api-data-generators/support/LayoutRules/test_data_generation_configurations.json +334 -0
  208. package/source/api-data-generators/support/License/test_data_generation_configurations.json +60 -0
  209. package/source/api-data-generators/support/Livecall/test_data_generation_configurations.json +72 -0
  210. package/source/api-data-generators/support/LookupRecord/test_data_generation_configurations.json +34 -0
  211. package/source/api-data-generators/support/Macros/test_data_generation_configurations.json +184 -0
  212. package/source/api-data-generators/support/MailReplyAddress/test_data_generation_configurations.json +32 -0
  213. package/source/api-data-generators/support/MassAction/test_data_generation_configurations.json +38 -0
  214. package/source/api-data-generators/support/Message/test_data_generation_configurations.json +38 -0
  215. package/source/api-data-generators/support/MicrosoftTeams/test_data_generation_configurations.json +50 -0
  216. package/source/api-data-generators/support/Misc/test_data_generation_configurations.json +16 -0
  217. package/source/api-data-generators/support/Module/test_data_generation_configurations.json +96 -0
  218. package/source/api-data-generators/support/NewCriteria/test_data_generation_configurations.json +26 -0
  219. package/source/api-data-generators/support/NewFeatureFields/test_data_generation_configurations.json +19 -0
  220. package/source/api-data-generators/support/NewTicketHistory/test_data_generation_configurations.json +20 -0
  221. package/source/api-data-generators/support/NotificationRules/test_data_generation_configurations.json +27 -0
  222. package/source/api-data-generators/support/OEmbedData/test_data_generation_configurations.json +19 -0
  223. package/source/api-data-generators/support/Onboarding/test_data_generation_configurations.json +29 -0
  224. package/source/api-data-generators/support/Organization/test_data_generation_configurations.json +79 -0
  225. package/source/api-data-generators/support/PBGroup/test_data_generation_configurations.json +109 -0
  226. package/source/api-data-generators/support/PBGroupAgents/test_data_generation_configurations.json +66 -0
  227. package/source/api-data-generators/support/PBPlatform/test_data_generation_configurations.json +113 -0
  228. package/source/api-data-generators/support/PBX/test_data_generation_configurations.json +28 -0
  229. package/source/api-data-generators/support/PBXConfig/test_data_generation_configurations.json +17 -0
  230. package/source/api-data-generators/support/PBXPhoneNumbers/test_data_generation_configurations.json +54 -0
  231. package/source/api-data-generators/support/PBXPreference/test_data_generation_configurations.json +54 -0
  232. package/source/api-data-generators/support/PageSense/test_data_generation_configurations.json +77 -0
  233. package/source/api-data-generators/support/PendingApproval/test_data_generation_configurations.json +14 -0
  234. package/source/api-data-generators/support/Permalink/test_data_generation_configurations.json +32 -0
  235. package/source/api-data-generators/support/PhoneAgents/test_data_generation_configurations.json +66 -0
  236. package/source/api-data-generators/support/PinnedConversation/test_data_generation_configurations.json +64 -0
  237. package/source/api-data-generators/support/Pipeline_Service/test_data_generation_configurations.json +32 -0
  238. package/source/api-data-generators/support/Product/test_data_generation_configurations.json +196 -0
  239. package/source/api-data-generators/support/ProductAttachment/test_data_generation_configurations.json +48 -0
  240. package/source/api-data-generators/support/Profile/test_data_generation_configurations.json +59 -0
  241. package/source/api-data-generators/support/QueueView/test_data_generation_configurations.json +37 -0
  242. package/source/api-data-generators/support/Records/test_data_generation_configurations.json +239 -0
  243. package/source/api-data-generators/support/Recyclebin/test_data_generation_configurations.json +52 -0
  244. package/source/api-data-generators/support/RemoteAuth/test_data_generation_configurations.json +52 -0
  245. package/source/api-data-generators/support/Report/test_data_generation_configurations.json +538 -0
  246. package/source/api-data-generators/support/ReportChart/test_data_generation_configurations.json +28 -0
  247. package/source/api-data-generators/support/ReportFolder/test_data_generation_configurations.json +100 -0
  248. package/source/api-data-generators/support/Resources/test_data_generation_configurations.json +29 -0
  249. package/source/api-data-generators/support/Role/test_data_generation_configurations.json +84 -0
  250. package/source/api-data-generators/support/RoundRobin/test_data_generation_configurations.json +58 -0
  251. package/source/api-data-generators/support/RoundRobinTarget/test_data_generation_configurations.json +50 -0
  252. package/source/api-data-generators/support/RoutingPreference/test_data_generation_configurations.json +29 -0
  253. package/source/api-data-generators/support/SLAMetaInfo/test_data_generation_configurations.json +22 -0
  254. package/source/api-data-generators/support/Saml/test_data_generation_configurations.json +42 -0
  255. package/source/api-data-generators/support/Sandbox/test_data_generation_configurations.json +92 -0
  256. package/source/api-data-generators/support/SandboxChangeset/test_data_generation_configurations.json +46 -0
  257. package/source/api-data-generators/support/SandboxDeployment/test_data_generation_configurations.json +50 -0
  258. package/source/api-data-generators/support/SandboxDeploymentLogs/test_data_generation_configurations.json +22 -0
  259. package/source/api-data-generators/support/SavedFilters/test_data_generation_configurations.json +203 -0
  260. package/source/api-data-generators/support/Schedule/test_data_generation_configurations.json +172 -0
  261. package/source/api-data-generators/support/ScheduleReplyInfo/test_data_generation_configurations.json +182 -0
  262. package/source/api-data-generators/support/Search/test_data_generation_configurations.json +636 -0
  263. package/source/api-data-generators/support/SearchInteg/test_data_generation_configurations.json +32 -0
  264. package/source/api-data-generators/support/Setup/test_data_generation_configurations.json +32 -0
  265. package/source/api-data-generators/support/SharedSnippet/test_data_generation_configurations.json +62 -0
  266. package/source/api-data-generators/support/Signature/test_data_generation_configurations.json +24 -0
  267. package/source/api-data-generators/support/Skill/test_data_generation_configurations.json +164 -0
  268. package/source/api-data-generators/support/SkillConfiguration/test_data_generation_configurations.json +21 -0
  269. package/source/api-data-generators/support/SkillType/test_data_generation_configurations.json +60 -0
  270. package/source/api-data-generators/support/Slack/test_data_generation_configurations.json +51 -0
  271. package/source/api-data-generators/support/SmsTemplates/test_data_generation_configurations.json +40 -0
  272. package/source/api-data-generators/support/Snippets/test_data_generation_configurations.json +47 -0
  273. package/source/api-data-generators/support/SocialInteg/test_data_generation_configurations.json +22 -0
  274. package/source/api-data-generators/support/SocialPosts/test_data_generation_configurations.json +223 -0
  275. package/source/api-data-generators/support/SocialTwitterConversations/test_data_generation_configurations.json +22 -0
  276. package/source/api-data-generators/support/StarredTemplates/test_data_generation_configurations.json +76 -0
  277. package/source/api-data-generators/support/SubjectAccessRequest/test_data_generation_configurations.json +104 -0
  278. package/source/api-data-generators/support/Supervise/test_data_generation_configurations.json +43 -0
  279. package/source/api-data-generators/support/SupportPlan/test_data_generation_configurations.json +65 -0
  280. package/source/api-data-generators/support/Tab/test_data_generation_configurations.json +29 -0
  281. package/source/api-data-generators/support/Target/test_data_generation_configurations.json +97 -0
  282. package/source/api-data-generators/support/Task/test_data_generation_configurations.json +219 -0
  283. package/source/api-data-generators/support/TaskAttachment/test_data_generation_configurations.json +42 -0
  284. package/source/api-data-generators/support/TaskComments/test_data_generation_configurations.json +45 -0
  285. package/source/api-data-generators/support/TaskTimeEntry/test_data_generation_configurations.json +87 -0
  286. package/source/api-data-generators/support/TaskTimer/test_data_generation_configurations.json +27 -0
  287. package/source/api-data-generators/support/Team/test_data_generation_configurations.json +115 -0
  288. package/source/api-data-generators/support/TemplateFolders/test_data_generation_configurations.json +72 -0
  289. package/source/api-data-generators/support/Thread/test_data_generation_configurations.json +383 -0
  290. package/source/api-data-generators/support/Ticket/test_data_generation_configurations.json +694 -0
  291. package/source/api-data-generators/support/TicketApprovals/test_data_generation_configurations.json +66 -0
  292. package/source/api-data-generators/support/TicketAttachment/test_data_generation_configurations.json +58 -0
  293. package/source/api-data-generators/support/TicketComment/test_data_generation_configurations.json +82 -0
  294. package/source/api-data-generators/support/TicketCount/test_data_generation_configurations.json +43 -0
  295. package/source/api-data-generators/support/TicketFollowers/test_data_generation_configurations.json +65 -0
  296. package/source/api-data-generators/support/TicketMetrics/test_data_generation_configurations.json +16 -0
  297. package/source/api-data-generators/support/TicketTag/test_data_generation_configurations.json +99 -0
  298. package/source/api-data-generators/support/TicketTemplate/test_data_generation_configurations.json +475 -0
  299. package/source/api-data-generators/support/TicketTimeEntry/test_data_generation_configurations.json +110 -0
  300. package/source/api-data-generators/support/TicketTimer/test_data_generation_configurations.json +48 -0
  301. package/source/api-data-generators/support/TicketWithChildren/test_data_generation_configurations.json +91 -0
  302. package/source/api-data-generators/support/TimeTracking/test_data_generation_configurations.json +46 -0
  303. package/source/api-data-generators/support/TranslationLanguages/test_data_generation_configurations.json +68 -0
  304. package/source/api-data-generators/support/Upload/test_data_generation_configurations.json +54 -0
  305. package/source/api-data-generators/support/User/test_data_generation_configurations.json +100 -0
  306. package/source/api-data-generators/support/UserAuthentication/test_data_generation_configurations.json +49 -0
  307. package/source/api-data-generators/support/UserPresence/test_data_generation_configurations.json +19 -0
  308. package/source/api-data-generators/support/ValidationRuleCriteria/test_data_generation_configurations.json +19 -0
  309. package/source/api-data-generators/support/ValidationRules/test_data_generation_configurations.json +321 -0
  310. package/source/api-data-generators/support/Webhook/test_data_generation_configurations.json +501 -0
  311. package/source/api-data-generators/support/Widget/test_data_generation_configurations.json +166 -0
  312. package/source/api-data-generators/support/ZIAAnswerbotInference/test_data_generation_configurations.json +26 -0
  313. package/source/api-data-generators/support/ZIADocumentData/test_data_generation_configurations.json +38 -0
  314. package/source/api-data-generators/support/ZIAVectorSearch/test_data_generation_configurations.json +22 -0
  315. package/source/api-data-generators/support/ZiaGPT/test_data_generation_configurations.json +19 -0
  316. package/source/api-data-generators/support/ZiaScheduler/test_data_generation_configurations.json +22 -0
  317. package/source/api-data-generators/support/ZiapoweredbyGPT/test_data_generation_configurations.json +33 -0
  318. package/source/api-data-generators/support/Zwitch/test_data_generation_configurations.json +71 -0
  319. package/source/api-data-generators/support/blueprintDrafts/test_data_generation_configurations.json +859 -0
  320. package/source/api-data-generators/support/blueprintTransitions/test_data_generation_configurations.json +26 -0
  321. package/source/api-data-generators/support/blueprints/test_data_generation_configurations.json +652 -0
  322. package/source/api-data-generators/support/borrow_book/test_data_generation_configurations.json +21 -0
  323. package/source/api-data-generators/support/zlabsnlp/test_data_generation_configurations.json +50 -0
  324. package/source/openapi-specifications/v1.0/common/Common.json +587 -0
  325. package/source/openapi-specifications/v1.0/portal/Account.json +183 -0
  326. package/source/openapi-specifications/v1.0/portal/ArticleComment.json +1103 -0
  327. package/source/openapi-specifications/v1.0/portal/ArticleFeedback.json +133 -0
  328. package/source/openapi-specifications/v1.0/portal/AsapMobile.json +712 -0
  329. package/source/openapi-specifications/v1.0/portal/AsapWeb.json +91 -0
  330. package/source/openapi-specifications/v1.0/portal/Attachment.json +122 -0
  331. package/source/openapi-specifications/v1.0/portal/Captcha.json +334 -0
  332. package/source/openapi-specifications/v1.0/portal/Category.json +1061 -0
  333. package/source/openapi-specifications/v1.0/portal/Comment.json +1546 -0
  334. package/source/openapi-specifications/v1.0/portal/Community.json +235 -0
  335. package/source/openapi-specifications/v1.0/portal/CommunityUser.json +296 -0
  336. package/source/openapi-specifications/v1.0/portal/Contact.json +536 -0
  337. package/source/openapi-specifications/v1.0/portal/CustomerHappiness.json +163 -0
  338. package/source/openapi-specifications/v1.0/portal/Department.json +246 -0
  339. package/source/openapi-specifications/v1.0/portal/Extension.json +1122 -0
  340. package/source/openapi-specifications/v1.0/portal/FeedbackWidget.json +96 -0
  341. package/source/openapi-specifications/v1.0/portal/Field.json +1239 -0
  342. package/source/openapi-specifications/v1.0/portal/FileExport.json +313 -0
  343. package/source/openapi-specifications/v1.0/portal/Followers.json +802 -0
  344. package/source/openapi-specifications/v1.0/portal/Gamification.json +819 -0
  345. package/source/openapi-specifications/v1.0/portal/HashTags.json +61 -0
  346. package/source/openapi-specifications/v1.0/portal/HelpCenterUser.json +605 -0
  347. package/source/openapi-specifications/v1.0/portal/HelpCenterUserPreference.json +148 -0
  348. package/source/openapi-specifications/v1.0/portal/Helpcenter.json +920 -0
  349. package/source/openapi-specifications/v1.0/portal/HelpcenterGroups.json +118 -0
  350. package/source/openapi-specifications/v1.0/portal/HelpcenterPages.json +184 -0
  351. package/source/openapi-specifications/v1.0/portal/KBCategoryTranslation.json +70 -0
  352. package/source/openapi-specifications/v1.0/portal/KBRootCategory.json +1310 -0
  353. package/source/openapi-specifications/v1.0/portal/KbCategory.json +1525 -0
  354. package/source/openapi-specifications/v1.0/portal/KbSection.json +515 -0
  355. package/source/openapi-specifications/v1.0/portal/Label.json +172 -0
  356. package/source/openapi-specifications/v1.0/portal/Layout.json +303 -0
  357. package/source/openapi-specifications/v1.0/portal/LayoutRules.json +375 -0
  358. package/source/openapi-specifications/v1.0/portal/Mentions.json +580 -0
  359. package/source/openapi-specifications/v1.0/portal/NewAsapMobile.json +699 -0
  360. package/source/openapi-specifications/v1.0/portal/Permalink.json +265 -0
  361. package/source/openapi-specifications/v1.0/portal/Placeholders.json +57 -0
  362. package/source/openapi-specifications/v1.0/portal/Product.json +401 -0
  363. package/source/openapi-specifications/v1.0/portal/Solution.json +3766 -0
  364. package/source/openapi-specifications/v1.0/portal/Thread.json +821 -0
  365. package/source/openapi-specifications/v1.0/portal/Ticket.json +2636 -0
  366. package/source/openapi-specifications/v1.0/portal/TicketComment.json +822 -0
  367. package/source/openapi-specifications/v1.0/portal/TicketCount.json +336 -0
  368. package/source/openapi-specifications/v1.0/portal/TicketExport.json +609 -0
  369. package/source/openapi-specifications/v1.0/portal/TicketField.json +358 -0
  370. package/source/openapi-specifications/v1.0/portal/TicketForm.json +517 -0
  371. package/source/openapi-specifications/v1.0/portal/TicketStatusMapping.json +155 -0
  372. package/source/openapi-specifications/v1.0/portal/TicketTemplate.json +409 -0
  373. package/source/openapi-specifications/v1.0/portal/TicketsViewCount.json +175 -0
  374. package/source/openapi-specifications/v1.0/portal/Topic.json +4079 -0
  375. package/source/openapi-specifications/v1.0/portal/Translation.json +174 -0
  376. package/source/openapi-specifications/v1.0/portal/Upload.json +156 -0
  377. package/source/openapi-specifications/v1.0/portal/ValidationRules.json +309 -0
  378. package/source/openapi-specifications/v1.0/portal/View.json +353 -0
  379. package/source/openapi-specifications/v1.0/portal/Widget.json +218 -0
  380. package/source/openapi-specifications/v1.0/support/AEAdminTool.json +354 -0
  381. package/source/openapi-specifications/v1.0/support/Account.json +3206 -0
  382. package/source/openapi-specifications/v1.0/support/AccountAttachment.json +484 -0
  383. package/source/openapi-specifications/v1.0/support/AccountComments.json +794 -0
  384. package/source/openapi-specifications/v1.0/support/AccountContactMappingInfo.json +227 -0
  385. package/source/openapi-specifications/v1.0/support/AccountDeduplication.json +578 -0
  386. package/source/openapi-specifications/v1.0/support/AccountFollowers.json +350 -0
  387. package/source/openapi-specifications/v1.0/support/AccountSla.json +341 -0
  388. package/source/openapi-specifications/v1.0/support/AccountTimeEntry.json +1152 -0
  389. package/source/openapi-specifications/v1.0/support/ActiveCalls.json +573 -0
  390. package/source/openapi-specifications/v1.0/support/Activity.json +1400 -0
  391. package/source/openapi-specifications/v1.0/support/Actor.json +88 -0
  392. package/source/openapi-specifications/v1.0/support/ActorsAPI.json +304 -0
  393. package/source/openapi-specifications/v1.0/support/AdminTool.json +489 -0
  394. package/source/openapi-specifications/v1.0/support/Agent.json +6685 -0
  395. package/source/openapi-specifications/v1.0/support/AgentPresence.json +567 -0
  396. package/source/openapi-specifications/v1.0/support/AgentRoom.json +1997 -0
  397. package/source/openapi-specifications/v1.0/support/AgentSignatures.json +359 -0
  398. package/source/openapi-specifications/v1.0/support/AgentTimeEntry.json +1402 -0
  399. package/source/openapi-specifications/v1.0/support/AntiSpamInfo.json +510 -0
  400. package/source/openapi-specifications/v1.0/support/ApiCreditNotificationRule.json +1189 -0
  401. package/source/openapi-specifications/v1.0/support/ApiDashboard.json +543 -0
  402. package/source/openapi-specifications/v1.0/support/ApplicationFlags.json +155 -0
  403. package/source/openapi-specifications/v1.0/support/ArchivedView.json +469 -0
  404. package/source/openapi-specifications/v1.0/support/Article.json +5060 -0
  405. package/source/openapi-specifications/v1.0/support/ArticleAttachment.json +544 -0
  406. package/source/openapi-specifications/v1.0/support/ArticleComment.json +1929 -0
  407. package/source/openapi-specifications/v1.0/support/ArticleExternalImageUrlResponse.json +56 -0
  408. package/source/openapi-specifications/v1.0/support/ArticleFeedback.json +1314 -0
  409. package/source/openapi-specifications/v1.0/support/ArticleFeedbackResolution.json +513 -0
  410. package/source/openapi-specifications/v1.0/support/ArticleHistory.json +2510 -0
  411. package/source/openapi-specifications/v1.0/support/ArticleStatistics.json +3053 -0
  412. package/source/openapi-specifications/v1.0/support/ArticleTranslation.json +7530 -0
  413. package/source/openapi-specifications/v1.0/support/ArticleVersion.json +184 -0
  414. package/source/openapi-specifications/v1.0/support/ArticleViews.json +564 -0
  415. package/source/openapi-specifications/v1.0/support/Asap.json +1525 -0
  416. package/source/openapi-specifications/v1.0/support/AsapModule.json +246 -0
  417. package/source/openapi-specifications/v1.0/support/AsapStatus.json +199 -0
  418. package/source/openapi-specifications/v1.0/support/AssistInteg.json +613 -0
  419. package/source/openapi-specifications/v1.0/support/AttachmentRestriction.json +786 -0
  420. package/source/openapi-specifications/v1.0/support/AuditLog.json +1122 -0
  421. package/source/openapi-specifications/v1.0/support/AutomatedSummaryForChats.json +702 -0
  422. package/source/openapi-specifications/v1.0/support/AutomationAlerts.json +868 -0
  423. package/source/openapi-specifications/v1.0/support/AutomationEngine.json +1181 -0
  424. package/source/openapi-specifications/v1.0/support/AutomationFeatureCount.json +207 -0
  425. package/source/openapi-specifications/v1.0/support/AutomationFieldUpdates.json +809 -0
  426. package/source/openapi-specifications/v1.0/support/AutomationTask.json +1054 -0
  427. package/source/openapi-specifications/v1.0/support/Backup.json +2845 -0
  428. package/source/openapi-specifications/v1.0/support/Badge.json +544 -0
  429. package/source/openapi-specifications/v1.0/support/Bot.json +2103 -0
  430. package/source/openapi-specifications/v1.0/support/BotInference.json +1071 -0
  431. package/source/openapi-specifications/v1.0/support/BotResources.json +175 -0
  432. package/source/openapi-specifications/v1.0/support/BotStaticResources.json +541 -0
  433. package/source/openapi-specifications/v1.0/support/Bot_UserInfo.json +63 -0
  434. package/source/openapi-specifications/v1.0/support/Bots.json +58 -0
  435. package/source/openapi-specifications/v1.0/support/BugInteg.json +481 -0
  436. package/source/openapi-specifications/v1.0/support/BulkAction.json +150 -0
  437. package/source/openapi-specifications/v1.0/support/BulkImport.json +2845 -0
  438. package/source/openapi-specifications/v1.0/support/BulkUpdate.json +743 -0
  439. package/source/openapi-specifications/v1.0/support/BulkWrite.json +678 -0
  440. package/source/openapi-specifications/v1.0/support/BusinessHour.json +1344 -0
  441. package/source/openapi-specifications/v1.0/support/Call.json +3839 -0
  442. package/source/openapi-specifications/v1.0/support/CallComments.json +721 -0
  443. package/source/openapi-specifications/v1.0/support/CallHistory.json +936 -0
  444. package/source/openapi-specifications/v1.0/support/CallTimeEntry.json +1745 -0
  445. package/source/openapi-specifications/v1.0/support/CallTimer.json +285 -0
  446. package/source/openapi-specifications/v1.0/support/Channel.json +730 -0
  447. package/source/openapi-specifications/v1.0/support/Chart.json +422 -0
  448. package/source/openapi-specifications/v1.0/support/ChatTicket.json +553 -0
  449. package/source/openapi-specifications/v1.0/support/ClientAction.json +1834 -0
  450. package/source/openapi-specifications/v1.0/support/ClientEvent.json +780 -0
  451. package/source/openapi-specifications/v1.0/support/CliqIntegJsonMapping.json +1123 -0
  452. package/source/openapi-specifications/v1.0/support/CloudAttachment.json +528 -0
  453. package/source/openapi-specifications/v1.0/support/CommonMassActionError.json +44 -0
  454. package/source/openapi-specifications/v1.0/support/CommonMassActionResponse.json +94 -0
  455. package/source/openapi-specifications/v1.0/support/Community.json +2545 -0
  456. package/source/openapi-specifications/v1.0/support/CommunityAttachment.json +249 -0
  457. package/source/openapi-specifications/v1.0/support/CommunityCategory.json +1896 -0
  458. package/source/openapi-specifications/v1.0/support/CommunityCategoryLogo.json +145 -0
  459. package/source/openapi-specifications/v1.0/support/CommunityComment.json +2492 -0
  460. package/source/openapi-specifications/v1.0/support/CommunityInitPermissions.json +129 -0
  461. package/source/openapi-specifications/v1.0/support/CommunityPreferences.json +343 -0
  462. package/source/openapi-specifications/v1.0/support/CommunitySearch.json +78 -0
  463. package/source/openapi-specifications/v1.0/support/CommunityTopic.json +6005 -0
  464. package/source/openapi-specifications/v1.0/support/CommunityTopicInsights.json +310 -0
  465. package/source/openapi-specifications/v1.0/support/CommunityUser.json +822 -0
  466. package/source/openapi-specifications/v1.0/support/Composite.json +414 -0
  467. package/source/openapi-specifications/v1.0/support/Contact.json +4691 -0
  468. package/source/openapi-specifications/v1.0/support/ContactAttachment.json +484 -0
  469. package/source/openapi-specifications/v1.0/support/ContactComments.json +769 -0
  470. package/source/openapi-specifications/v1.0/support/ContactDeduplication.json +683 -0
  471. package/source/openapi-specifications/v1.0/support/ContactFollowers.json +350 -0
  472. package/source/openapi-specifications/v1.0/support/ContactProfile.json +195 -0
  473. package/source/openapi-specifications/v1.0/support/ContactTimeEntry.json +1157 -0
  474. package/source/openapi-specifications/v1.0/support/Contract.json +2877 -0
  475. package/source/openapi-specifications/v1.0/support/ContractAttachment.json +307 -0
  476. package/source/openapi-specifications/v1.0/support/Conversation.json +570 -0
  477. package/source/openapi-specifications/v1.0/support/CountriesAndLanguages.json +5279 -0
  478. package/source/openapi-specifications/v1.0/support/CreditCycle.json +124 -0
  479. package/source/openapi-specifications/v1.0/support/Criteria.json +1014 -0
  480. package/source/openapi-specifications/v1.0/support/CriteriaValue.json +50 -0
  481. package/source/openapi-specifications/v1.0/support/CrmInteg.json +5938 -0
  482. package/source/openapi-specifications/v1.0/support/CustomAction.json +2106 -0
  483. package/source/openapi-specifications/v1.0/support/CustomActionRuleMapping.json +1327 -0
  484. package/source/openapi-specifications/v1.0/support/CustomButton.json +1898 -0
  485. package/source/openapi-specifications/v1.0/support/CustomFunctionExecutionLogs.json +883 -0
  486. package/source/openapi-specifications/v1.0/support/CustomFunctionGallery.json +329 -0
  487. package/source/openapi-specifications/v1.0/support/CustomFunctionReRun.json +317 -0
  488. package/source/openapi-specifications/v1.0/support/CustomFunctionZiaCopilot.json +379 -0
  489. package/source/openapi-specifications/v1.0/support/CustomFunctions.json +3457 -0
  490. package/source/openapi-specifications/v1.0/support/CustomModuleAdminTool.json +81 -0
  491. package/source/openapi-specifications/v1.0/support/CustomTheme.json +7391 -0
  492. package/source/openapi-specifications/v1.0/support/CustomView.json +3478 -0
  493. package/source/openapi-specifications/v1.0/support/CustomerHappiness.json +464 -0
  494. package/source/openapi-specifications/v1.0/support/DBThrottle.json +334 -0
  495. package/source/openapi-specifications/v1.0/support/DashboardComponent.json +1163 -0
  496. package/source/openapi-specifications/v1.0/support/DashboardFolder.json +1258 -0
  497. package/source/openapi-specifications/v1.0/support/DashboardMetrics.json +2310 -0
  498. package/source/openapi-specifications/v1.0/support/Dashboards.json +1219 -0
  499. package/source/openapi-specifications/v1.0/support/DataChips.json +477 -0
  500. package/source/openapi-specifications/v1.0/support/DataImport.json +1099 -0
  501. package/source/openapi-specifications/v1.0/support/DataSync.json +1246 -0
  502. package/source/openapi-specifications/v1.0/support/DatasetEntry.json +153 -0
  503. package/source/openapi-specifications/v1.0/support/Department.json +1971 -0
  504. package/source/openapi-specifications/v1.0/support/DependencyMappings.json +656 -0
  505. package/source/openapi-specifications/v1.0/support/DirectAssignRuleTarget.json +232 -0
  506. package/source/openapi-specifications/v1.0/support/DirectAssignmentRules.json +722 -0
  507. package/source/openapi-specifications/v1.0/support/DisplayEntity.json +91 -0
  508. package/source/openapi-specifications/v1.0/support/DomainMapping.json +1143 -0
  509. package/source/openapi-specifications/v1.0/support/EmailFailureAlert.json +306 -0
  510. package/source/openapi-specifications/v1.0/support/EmailTemplates.json +1491 -0
  511. package/source/openapi-specifications/v1.0/support/EntityBlueprints.json +572 -0
  512. package/source/openapi-specifications/v1.0/support/Event.json +3607 -0
  513. package/source/openapi-specifications/v1.0/support/EventComments.json +737 -0
  514. package/source/openapi-specifications/v1.0/support/EventTimeEntry.json +1520 -0
  515. package/source/openapi-specifications/v1.0/support/EventTimer.json +285 -0
  516. package/source/openapi-specifications/v1.0/support/Expression.json +43 -0
  517. package/source/openapi-specifications/v1.0/support/Extension.json +7152 -0
  518. package/source/openapi-specifications/v1.0/support/ExtensionOrg.json +129 -0
  519. package/source/openapi-specifications/v1.0/support/FAQ.json +142 -0
  520. package/source/openapi-specifications/v1.0/support/FAQTranslation.json +178 -0
  521. package/source/openapi-specifications/v1.0/support/FbManager.json +1147 -0
  522. package/source/openapi-specifications/v1.0/support/Feature.json +691 -0
  523. package/source/openapi-specifications/v1.0/support/FeatureFile.json +435 -0
  524. package/source/openapi-specifications/v1.0/support/FeatureFolder.json +576 -0
  525. package/source/openapi-specifications/v1.0/support/FeaturePermission.json +492 -0
  526. package/source/openapi-specifications/v1.0/support/FederatedLogin.json +318 -0
  527. package/source/openapi-specifications/v1.0/support/FeedsAPIs.json +198 -0
  528. package/source/openapi-specifications/v1.0/support/Field.json +7493 -0
  529. package/source/openapi-specifications/v1.0/support/FieldDetails.json +139 -0
  530. package/source/openapi-specifications/v1.0/support/FieldPermissions.json +113 -0
  531. package/source/openapi-specifications/v1.0/support/FieldPrediction.json +3831 -0
  532. package/source/openapi-specifications/v1.0/support/FileExport.json +324 -0
  533. package/source/openapi-specifications/v1.0/support/Finance.json +4290 -0
  534. package/source/openapi-specifications/v1.0/support/Followers.json +875 -0
  535. package/source/openapi-specifications/v1.0/support/FormulaFunctions.json +47 -0
  536. package/source/openapi-specifications/v1.0/support/GC_Bots.json +138 -0
  537. package/source/openapi-specifications/v1.0/support/GC_Guide.json +1536 -0
  538. package/source/openapi-specifications/v1.0/support/GC_GuideHistories.json +58 -0
  539. package/source/openapi-specifications/v1.0/support/GC_GuideHistory.json +79 -0
  540. package/source/openapi-specifications/v1.0/support/GC_Guides.json +89 -0
  541. package/source/openapi-specifications/v1.0/support/GC_Info.json +208 -0
  542. package/source/openapi-specifications/v1.0/support/GC_Status.json +69 -0
  543. package/source/openapi-specifications/v1.0/support/GC_UserInfo.json +79 -0
  544. package/source/openapi-specifications/v1.0/support/GenericAction.json +1888 -0
  545. package/source/openapi-specifications/v1.0/support/GenericActionMapping.json +1050 -0
  546. package/source/openapi-specifications/v1.0/support/GoogleAnalytics.json +1715 -0
  547. package/source/openapi-specifications/v1.0/support/GoogleChat.json +650 -0
  548. package/source/openapi-specifications/v1.0/support/HelpCenterCommon.json +44 -0
  549. package/source/openapi-specifications/v1.0/support/Help_Center_OIDC_Authentication.json +900 -0
  550. package/source/openapi-specifications/v1.0/support/Helpcenter.json +1212 -0
  551. package/source/openapi-specifications/v1.0/support/HelpcenterAutoTranslateSetting.json +331 -0
  552. package/source/openapi-specifications/v1.0/support/HelpcenterGroups.json +1496 -0
  553. package/source/openapi-specifications/v1.0/support/HelpcenterPages.json +504 -0
  554. package/source/openapi-specifications/v1.0/support/HelpcenterPreference.json +208 -0
  555. package/source/openapi-specifications/v1.0/support/HelpcenterTranslationApp.json +64 -0
  556. package/source/openapi-specifications/v1.0/support/HelpcenterUpload.json +211 -0
  557. package/source/openapi-specifications/v1.0/support/HolidayList.json +731 -0
  558. package/source/openapi-specifications/v1.0/support/IMAPAddress.json +1091 -0
  559. package/source/openapi-specifications/v1.0/support/IMCannedMessage.json +1357 -0
  560. package/source/openapi-specifications/v1.0/support/IMCannedMessagePlaceHolders.json +169 -0
  561. package/source/openapi-specifications/v1.0/support/IMCannedMessageTranslation.json +624 -0
  562. package/source/openapi-specifications/v1.0/support/IMTemplateMessage.json +597 -0
  563. package/source/openapi-specifications/v1.0/support/IM_AddOn.json +841 -0
  564. package/source/openapi-specifications/v1.0/support/IM_AttachmentMessage.json +64 -0
  565. package/source/openapi-specifications/v1.0/support/IM_Bot.json +1007 -0
  566. package/source/openapi-specifications/v1.0/support/IM_BotService.json +357 -0
  567. package/source/openapi-specifications/v1.0/support/IM_Broadcast.json +323 -0
  568. package/source/openapi-specifications/v1.0/support/IM_Channel.json +2849 -0
  569. package/source/openapi-specifications/v1.0/support/IM_ChannelPreference.json +502 -0
  570. package/source/openapi-specifications/v1.0/support/IM_Contact.json +165 -0
  571. package/source/openapi-specifications/v1.0/support/IM_Efc.json +188 -0
  572. package/source/openapi-specifications/v1.0/support/IM_Integration.json +1269 -0
  573. package/source/openapi-specifications/v1.0/support/IM_IntegrationService.json +454 -0
  574. package/source/openapi-specifications/v1.0/support/IM_LayoutView.json +625 -0
  575. package/source/openapi-specifications/v1.0/support/IM_License.json +225 -0
  576. package/source/openapi-specifications/v1.0/support/IM_Message.json +1371 -0
  577. package/source/openapi-specifications/v1.0/support/IM_Metrics.json +462 -0
  578. package/source/openapi-specifications/v1.0/support/IM_Search.json +547 -0
  579. package/source/openapi-specifications/v1.0/support/IM_Session.json +1397 -0
  580. package/source/openapi-specifications/v1.0/support/IM_TemplateButton.json +142 -0
  581. package/source/openapi-specifications/v1.0/support/IM_TemplateFooter.json +83 -0
  582. package/source/openapi-specifications/v1.0/support/IM_TemplateHeader.json +86 -0
  583. package/source/openapi-specifications/v1.0/support/IM_TemplateItems.json +73 -0
  584. package/source/openapi-specifications/v1.0/support/IM_TimeSeriesMetrics.json +435 -0
  585. package/source/openapi-specifications/v1.0/support/IM_TwilioPhoneNumber.json +202 -0
  586. package/source/openapi-specifications/v1.0/support/IM_WhatsApp_Integrations.json +193 -0
  587. package/source/openapi-specifications/v1.0/support/IM_ZiaGpt.json +489 -0
  588. package/source/openapi-specifications/v1.0/support/Import.json +1844 -0
  589. package/source/openapi-specifications/v1.0/support/IncrementalDocuments.json +395 -0
  590. package/source/openapi-specifications/v1.0/support/Inference.json +307 -0
  591. package/source/openapi-specifications/v1.0/support/InlineImage.json +97 -0
  592. package/source/openapi-specifications/v1.0/support/IntegModule.json +938 -0
  593. package/source/openapi-specifications/v1.0/support/Integrations.json +1264 -0
  594. package/source/openapi-specifications/v1.0/support/InteractiveTours.json +539 -0
  595. package/source/openapi-specifications/v1.0/support/JWT.json +535 -0
  596. package/source/openapi-specifications/v1.0/support/KBCategoryPermalink.json +208 -0
  597. package/source/openapi-specifications/v1.0/support/KBCategoryUser.json +241 -0
  598. package/source/openapi-specifications/v1.0/support/KBPreference.json +323 -0
  599. package/source/openapi-specifications/v1.0/support/KBRecycleBin.json +2316 -0
  600. package/source/openapi-specifications/v1.0/support/KBRootCategory.json +2839 -0
  601. package/source/openapi-specifications/v1.0/support/KBRootCategoryTranslation.json +570 -0
  602. package/source/openapi-specifications/v1.0/support/KBSection.json +1941 -0
  603. package/source/openapi-specifications/v1.0/support/KBTranslationMassActionResponse.json +169 -0
  604. package/source/openapi-specifications/v1.0/support/KPIWidget.json +206 -0
  605. package/source/openapi-specifications/v1.0/support/KbBot.json +511 -0
  606. package/source/openapi-specifications/v1.0/support/KbCategory.json +1618 -0
  607. package/source/openapi-specifications/v1.0/support/KbCategoryLogo.json +124 -0
  608. package/source/openapi-specifications/v1.0/support/Label.json +1251 -0
  609. package/source/openapi-specifications/v1.0/support/Layout.json +8042 -0
  610. package/source/openapi-specifications/v1.0/support/LayoutRuleCriteria.json +491 -0
  611. package/source/openapi-specifications/v1.0/support/LayoutRules.json +1422 -0
  612. package/source/openapi-specifications/v1.0/support/LensInteg.json +86 -0
  613. package/source/openapi-specifications/v1.0/support/LicenseFeaturePlan.json +548 -0
  614. package/source/openapi-specifications/v1.0/support/LicenseInfo.json +1231 -0
  615. package/source/openapi-specifications/v1.0/support/LicenseTool.json +165 -0
  616. package/source/openapi-specifications/v1.0/support/Livecall.json +954 -0
  617. package/source/openapi-specifications/v1.0/support/LookupRecord.json +174 -0
  618. package/source/openapi-specifications/v1.0/support/Macros.json +1960 -0
  619. package/source/openapi-specifications/v1.0/support/MailReplyAddress.json +1263 -0
  620. package/source/openapi-specifications/v1.0/support/MassAction.json +1151 -0
  621. package/source/openapi-specifications/v1.0/support/MassActionError.json +55 -0
  622. package/source/openapi-specifications/v1.0/support/MassActionResponse.json +89 -0
  623. package/source/openapi-specifications/v1.0/support/Mentions.json +491 -0
  624. package/source/openapi-specifications/v1.0/support/Message.json +685 -0
  625. package/source/openapi-specifications/v1.0/support/Microsoft.json +887 -0
  626. package/source/openapi-specifications/v1.0/support/MicrosoftTeams.json +574 -0
  627. package/source/openapi-specifications/v1.0/support/Microsoft_PowerBI.json +903 -0
  628. package/source/openapi-specifications/v1.0/support/Misc.json +214 -0
  629. package/source/openapi-specifications/v1.0/support/Module.json +1625 -0
  630. package/source/openapi-specifications/v1.0/support/NewCriteria.json +1863 -0
  631. package/source/openapi-specifications/v1.0/support/NewFeatureFields.json +204 -0
  632. package/source/openapi-specifications/v1.0/support/NewTicketHistory.json +150 -0
  633. package/source/openapi-specifications/v1.0/support/NotificationRules.json +441 -0
  634. package/source/openapi-specifications/v1.0/support/OEmbedData.json +233 -0
  635. package/source/openapi-specifications/v1.0/support/Onboarding.json +282 -0
  636. package/source/openapi-specifications/v1.0/support/Organization.json +1391 -0
  637. package/source/openapi-specifications/v1.0/support/PBGroup.json +634 -0
  638. package/source/openapi-specifications/v1.0/support/PBGroupAgents.json +433 -0
  639. package/source/openapi-specifications/v1.0/support/PBPlatform.json +1447 -0
  640. package/source/openapi-specifications/v1.0/support/PBX.json +550 -0
  641. package/source/openapi-specifications/v1.0/support/PBXConfig.json +219 -0
  642. package/source/openapi-specifications/v1.0/support/PBXPhoneNumbers.json +443 -0
  643. package/source/openapi-specifications/v1.0/support/PBXPreference.json +314 -0
  644. package/source/openapi-specifications/v1.0/support/PageSense.json +1505 -0
  645. package/source/openapi-specifications/v1.0/support/PendingApproval.json +279 -0
  646. package/source/openapi-specifications/v1.0/support/Permalink.json +393 -0
  647. package/source/openapi-specifications/v1.0/support/PhoneAgents.json +1014 -0
  648. package/source/openapi-specifications/v1.0/support/PhoneMenu.json +118 -0
  649. package/source/openapi-specifications/v1.0/support/PinnedConversation.json +1115 -0
  650. package/source/openapi-specifications/v1.0/support/Pipeline_Info.json +232 -0
  651. package/source/openapi-specifications/v1.0/support/Pipeline_Service.json +499 -0
  652. package/source/openapi-specifications/v1.0/support/Product.json +1861 -0
  653. package/source/openapi-specifications/v1.0/support/ProductAttachment.json +485 -0
  654. package/source/openapi-specifications/v1.0/support/Profile.json +4236 -0
  655. package/source/openapi-specifications/v1.0/support/ProjectsInteg.json +989 -0
  656. package/source/openapi-specifications/v1.0/support/QueryStore.json +238 -0
  657. package/source/openapi-specifications/v1.0/support/QueueView.json +335 -0
  658. package/source/openapi-specifications/v1.0/support/RatelimitAdminTool.json +1204 -0
  659. package/source/openapi-specifications/v1.0/support/Records.json +1509 -0
  660. package/source/openapi-specifications/v1.0/support/Recyclebin.json +669 -0
  661. package/source/openapi-specifications/v1.0/support/RemoteAuth.json +401 -0
  662. package/source/openapi-specifications/v1.0/support/Report.json +6491 -0
  663. package/source/openapi-specifications/v1.0/support/ReportChart.json +254 -0
  664. package/source/openapi-specifications/v1.0/support/ReportFolder.json +1076 -0
  665. package/source/openapi-specifications/v1.0/support/ReportIntegration.json +202 -0
  666. package/source/openapi-specifications/v1.0/support/RequestFlags.json +358 -0
  667. package/source/openapi-specifications/v1.0/support/Resources.json +335 -0
  668. package/source/openapi-specifications/v1.0/support/ResponseHelpCenterUser.json +128 -0
  669. package/source/openapi-specifications/v1.0/support/Role.json +996 -0
  670. package/source/openapi-specifications/v1.0/support/RoundRobin.json +796 -0
  671. package/source/openapi-specifications/v1.0/support/RoundRobinTarget.json +381 -0
  672. package/source/openapi-specifications/v1.0/support/RoutingPreference.json +615 -0
  673. package/source/openapi-specifications/v1.0/support/RuleGroup.json +1630 -0
  674. package/source/openapi-specifications/v1.0/support/SLAMetaInfo.json +227 -0
  675. package/source/openapi-specifications/v1.0/support/Saml.json +565 -0
  676. package/source/openapi-specifications/v1.0/support/Sandbox.json +1075 -0
  677. package/source/openapi-specifications/v1.0/support/SandboxChangeset.json +501 -0
  678. package/source/openapi-specifications/v1.0/support/SandboxDeployment.json +428 -0
  679. package/source/openapi-specifications/v1.0/support/SandboxDeploymentLogs.json +295 -0
  680. package/source/openapi-specifications/v1.0/support/SandboxSourceOrganization.json +268 -0
  681. package/source/openapi-specifications/v1.0/support/SavedFilters.json +652 -0
  682. package/source/openapi-specifications/v1.0/support/Schedule.json +2077 -0
  683. package/source/openapi-specifications/v1.0/support/ScheduleReplyInfo.json +2271 -0
  684. package/source/openapi-specifications/v1.0/support/Search.json +12600 -0
  685. package/source/openapi-specifications/v1.0/support/SearchInteg.json +2254 -0
  686. package/source/openapi-specifications/v1.0/support/Setup.json +1766 -0
  687. package/source/openapi-specifications/v1.0/support/SharedSnippet.json +1110 -0
  688. package/source/openapi-specifications/v1.0/support/SharingRule.json +287 -0
  689. package/source/openapi-specifications/v1.0/support/Signature.json +354 -0
  690. package/source/openapi-specifications/v1.0/support/Skill.json +2164 -0
  691. package/source/openapi-specifications/v1.0/support/SkillConfiguration.json +269 -0
  692. package/source/openapi-specifications/v1.0/support/SkillType.json +807 -0
  693. package/source/openapi-specifications/v1.0/support/Slack.json +957 -0
  694. package/source/openapi-specifications/v1.0/support/SmsTemplates.json +514 -0
  695. package/source/openapi-specifications/v1.0/support/Snippets.json +918 -0
  696. package/source/openapi-specifications/v1.0/support/SocialBrands.json +427 -0
  697. package/source/openapi-specifications/v1.0/support/SocialInteg.json +336 -0
  698. package/source/openapi-specifications/v1.0/support/SocialPosts.json +2460 -0
  699. package/source/openapi-specifications/v1.0/support/SocialTwitterConversations.json +337 -0
  700. package/source/openapi-specifications/v1.0/support/StarredTemplates.json +690 -0
  701. package/source/openapi-specifications/v1.0/support/Statistics.json +125 -0
  702. package/source/openapi-specifications/v1.0/support/SubjectAccessRequest.json +2419 -0
  703. package/source/openapi-specifications/v1.0/support/Supervise.json +774 -0
  704. package/source/openapi-specifications/v1.0/support/SupportEmailAddress.json +188 -0
  705. package/source/openapi-specifications/v1.0/support/SupportEmailDomain.json +293 -0
  706. package/source/openapi-specifications/v1.0/support/SupportPlan.json +1109 -0
  707. package/source/openapi-specifications/v1.0/support/Tab.json +606 -0
  708. package/source/openapi-specifications/v1.0/support/Target.json +1311 -0
  709. package/source/openapi-specifications/v1.0/support/TargetFunctions.json +130 -0
  710. package/source/openapi-specifications/v1.0/support/Task.json +4006 -0
  711. package/source/openapi-specifications/v1.0/support/TaskAttachment.json +443 -0
  712. package/source/openapi-specifications/v1.0/support/TaskComments.json +706 -0
  713. package/source/openapi-specifications/v1.0/support/TaskTimeEntry.json +1756 -0
  714. package/source/openapi-specifications/v1.0/support/TaskTimer.json +441 -0
  715. package/source/openapi-specifications/v1.0/support/Team.json +1383 -0
  716. package/source/openapi-specifications/v1.0/support/TemplateFolders.json +1069 -0
  717. package/source/openapi-specifications/v1.0/support/Theme.json +152 -0
  718. package/source/openapi-specifications/v1.0/support/Thread.json +3545 -0
  719. package/source/openapi-specifications/v1.0/support/Ticket.json +9495 -0
  720. package/source/openapi-specifications/v1.0/support/TicketApprovals.json +855 -0
  721. package/source/openapi-specifications/v1.0/support/TicketAttachment.json +562 -0
  722. package/source/openapi-specifications/v1.0/support/TicketComment.json +1444 -0
  723. package/source/openapi-specifications/v1.0/support/TicketCount.json +690 -0
  724. package/source/openapi-specifications/v1.0/support/TicketFollowers.json +454 -0
  725. package/source/openapi-specifications/v1.0/support/TicketHistory.json +414 -0
  726. package/source/openapi-specifications/v1.0/support/TicketMetrics.json +369 -0
  727. package/source/openapi-specifications/v1.0/support/TicketRealTime.json +178 -0
  728. package/source/openapi-specifications/v1.0/support/TicketTag.json +1513 -0
  729. package/source/openapi-specifications/v1.0/support/TicketTemplate.json +907 -0
  730. package/source/openapi-specifications/v1.0/support/TicketTimeEntry.json +1681 -0
  731. package/source/openapi-specifications/v1.0/support/TicketTimer.json +1205 -0
  732. package/source/openapi-specifications/v1.0/support/TimeTracking.json +1212 -0
  733. package/source/openapi-specifications/v1.0/support/TrainingCourses.json +614 -0
  734. package/source/openapi-specifications/v1.0/support/TrainingIntegration.json +163 -0
  735. package/source/openapi-specifications/v1.0/support/TranslationLanguages.json +2772 -0
  736. package/source/openapi-specifications/v1.0/support/Upload.json +620 -0
  737. package/source/openapi-specifications/v1.0/support/User.json +1409 -0
  738. package/source/openapi-specifications/v1.0/support/UserAuthentication.json +617 -0
  739. package/source/openapi-specifications/v1.0/support/UserPresence.json +763 -0
  740. package/source/openapi-specifications/v1.0/support/ValidationRuleCriteria.json +107 -0
  741. package/source/openapi-specifications/v1.0/support/ValidationRules.json +1173 -0
  742. package/source/openapi-specifications/v1.0/support/Webhook.json +1330 -0
  743. package/source/openapi-specifications/v1.0/support/WhatsAppDetails.json +132 -0
  744. package/source/openapi-specifications/v1.0/support/WhatsAppMigration.json +143 -0
  745. package/source/openapi-specifications/v1.0/support/WhatsAppTemplateTags.json +132 -0
  746. package/source/openapi-specifications/v1.0/support/Widget.json +3023 -0
  747. package/source/openapi-specifications/v1.0/support/WmsDomain.json +104 -0
  748. package/source/openapi-specifications/v1.0/support/ZIAAnswerbotInference.json +756 -0
  749. package/source/openapi-specifications/v1.0/support/ZIADocumentData.json +989 -0
  750. package/source/openapi-specifications/v1.0/support/ZIASolutionService.json +135 -0
  751. package/source/openapi-specifications/v1.0/support/ZIAVectorSearch.json +376 -0
  752. package/source/openapi-specifications/v1.0/support/ZiaDCMigration.json +159 -0
  753. package/source/openapi-specifications/v1.0/support/ZiaGPT.json +3229 -0
  754. package/source/openapi-specifications/v1.0/support/ZiaScheduler.json +453 -0
  755. package/source/openapi-specifications/v1.0/support/Zwitch.json +1543 -0
  756. package/source/openapi-specifications/v1.0/support/blueprintChartData.json +201 -0
  757. package/source/openapi-specifications/v1.0/support/blueprintConnections.json +75 -0
  758. package/source/openapi-specifications/v1.0/support/blueprintCriteria.json +255 -0
  759. package/source/openapi-specifications/v1.0/support/blueprintDrafts.json +1677 -0
  760. package/source/openapi-specifications/v1.0/support/blueprintStates.json +284 -0
  761. package/source/openapi-specifications/v1.0/support/blueprintStrictModeConfig.json +91 -0
  762. package/source/openapi-specifications/v1.0/support/blueprintTransitions.json +1546 -0
  763. package/source/openapi-specifications/v1.0/support/blueprints.json +2992 -0
  764. package/source/openapi-specifications/v1.0/support/errors.json +80 -0
  765. package/source/openapi-specifications/v1.0/support/zlabsnlp.json +416 -0
  766. package/.github/agents/Generators.agent.md +0 -121
@@ -0,0 +1,2845 @@
1
+ {
2
+ "openapi" : "3.1.0",
3
+ "info" : {
4
+ "title" : "Backup",
5
+ "version" : "1.0.0",
6
+ "x-clan-group" : "reports",
7
+ "x-module-group" : "reports"
8
+ },
9
+ "paths" : {
10
+ "/api/v1/backup" : {
11
+ "get" : {
12
+ "tags" : [ "Backup" ],
13
+ "summary" : "GetActiveBackupDetails",
14
+ "description" : "To get Active Backup",
15
+ "operationId" : "getRecentBackups",
16
+ "parameters" : [ {
17
+ "$ref" : "#/components/parameters/limit"
18
+ }, {
19
+ "$ref" : "#/components/parameters/from"
20
+ }, {
21
+ "$ref" : "#/components/parameters/status"
22
+ }, {
23
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
24
+ } ],
25
+ "responses" : {
26
+ "404" : {
27
+ "$ref" : "../common/Common.json#/components/responses/urlNotFoundErrorResponse"
28
+ },
29
+ "200" : {
30
+ "$ref" : "#/components/responses/getRecentBackups"
31
+ },
32
+ "422" : {
33
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
34
+ },
35
+ "401" : {
36
+ "$ref" : "../common/Common.json#/components/responses/unauthorizedErrorResponse"
37
+ },
38
+ "403" : {
39
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
40
+ }
41
+ },
42
+ "security" : [ {
43
+ "org-oauth" : [ "accessAll.ALL" ]
44
+ }, {
45
+ "cookie-auth" : [ "cookie-auth" ]
46
+ } ],
47
+ "x-audience" : [ "company-internal" ],
48
+ "x-custom-url-attribute" : {
49
+ "security" : {
50
+ "throttle" : {
51
+ "inline" : [ {
52
+ "scope" : "APPSERVER",
53
+ "rules" : [ {
54
+ "duration" : 60000,
55
+ "lock-period" : 300000,
56
+ "threshold" : 60,
57
+ "hip" : false
58
+ } ],
59
+ "window" : "ROLLING",
60
+ "key" : "url.path+user.zuid"
61
+ } ]
62
+ },
63
+ "extraparams" : {
64
+ "disable" : true,
65
+ "ignore" : false
66
+ },
67
+ "authentication" : { }
68
+ },
69
+ "clan-group" : "reports",
70
+ "apihash" : "0f27fba78d1923b6235b707cb6d27ac5",
71
+ "module-group" : "reports",
72
+ "apimethod" : "com.adventnet.support.export.service.BackupService.getRecentBackups"
73
+ }
74
+ },
75
+ "post" : {
76
+ "tags" : [ "Backup" ],
77
+ "summary" : "initiateBackup",
78
+ "description" : "To start the backup of the given modules.",
79
+ "operationId" : "initiateBackup",
80
+ "parameters" : [ {
81
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
82
+ } ],
83
+ "requestBody" : {
84
+ "$ref" : "#/components/requestBodies/getBackupReqObject"
85
+ },
86
+ "responses" : {
87
+ "200" : {
88
+ "$ref" : "#/components/responses/initiateBackupResponse"
89
+ }
90
+ },
91
+ "security" : [ {
92
+ "org-oauth" : [ "accessAll.ALL" ]
93
+ }, {
94
+ "cookie-auth" : [ "cookie-auth" ]
95
+ } ],
96
+ "x-audience" : [ "company-internal" ],
97
+ "x-custom-url-attribute" : {
98
+ "security" : {
99
+ "throttle" : {
100
+ "inline" : [ {
101
+ "scope" : "APPSERVER",
102
+ "rules" : [ {
103
+ "duration" : 60000,
104
+ "lock-period" : 300000,
105
+ "threshold" : 20,
106
+ "hip" : false
107
+ }, {
108
+ "duration" : 3600000,
109
+ "lock-period" : 1800000,
110
+ "threshold" : 50,
111
+ "hip" : false
112
+ }, {
113
+ "duration" : 86400000,
114
+ "lock-period" : 1800000,
115
+ "threshold" : 240,
116
+ "hip" : false
117
+ } ],
118
+ "window" : "ROLLING",
119
+ "key" : "url.path+user.zuid"
120
+ } ]
121
+ },
122
+ "extraparams" : {
123
+ "disable" : true,
124
+ "ignore" : false
125
+ },
126
+ "authentication" : { }
127
+ },
128
+ "clan-group" : "reports",
129
+ "apihash" : "d4a8ae0ee0c6f8ca7cf3c36abe82cfc3",
130
+ "module-group" : "reports",
131
+ "apimethod" : "com.adventnet.support.export.service.BackupService.intiateDatabackUp"
132
+ }
133
+ }
134
+ },
135
+ "/api/v1/backup/files" : {
136
+ "get" : {
137
+ "tags" : [ "Backup" ],
138
+ "summary" : "GetBackupFiles",
139
+ "description" : "To get Backup File Details",
140
+ "operationId" : "getBackupFiles",
141
+ "parameters" : [ {
142
+ "$ref" : "#/components/parameters/limit"
143
+ }, {
144
+ "$ref" : "#/components/parameters/from"
145
+ }, {
146
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
147
+ } ],
148
+ "responses" : {
149
+ "404" : {
150
+ "$ref" : "../common/Common.json#/components/responses/urlNotFoundErrorResponse"
151
+ },
152
+ "200" : {
153
+ "$ref" : "#/components/responses/getBackupFilesResp"
154
+ },
155
+ "422" : {
156
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
157
+ },
158
+ "401" : {
159
+ "$ref" : "../common/Common.json#/components/responses/unauthorizedErrorResponse"
160
+ },
161
+ "403" : {
162
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
163
+ }
164
+ },
165
+ "security" : [ {
166
+ "org-oauth" : [ "accessAll.ALL" ]
167
+ }, {
168
+ "cookie-auth" : [ "cookie-auth" ]
169
+ } ],
170
+ "x-audience" : [ "company-internal" ],
171
+ "x-custom-url-attribute" : {
172
+ "security" : {
173
+ "throttle" : {
174
+ "inline" : [ {
175
+ "scope" : "APPSERVER",
176
+ "rules" : [ {
177
+ "duration" : 60000,
178
+ "lock-period" : 300000,
179
+ "threshold" : 60,
180
+ "hip" : false
181
+ } ],
182
+ "window" : "ROLLING",
183
+ "key" : "url.path+user.zuid"
184
+ } ]
185
+ },
186
+ "extraparams" : {
187
+ "disable" : true,
188
+ "ignore" : false
189
+ },
190
+ "authentication" : { }
191
+ },
192
+ "clan-group" : "reports",
193
+ "apihash" : "d0515a1ed1924a4392c2cc2a768f273b",
194
+ "module-group" : "reports",
195
+ "apimethod" : "com.adventnet.support.export.service.BackupService.getValidBackupFiles"
196
+ }
197
+ }
198
+ },
199
+ "/api/v1/bulkExport" : {
200
+ "get" : {
201
+ "tags" : [ "Backup" ],
202
+ "summary" : "Get Details of Multiple Exports",
203
+ "description" : "This API fetches details of exports and provides the URL to download the bulk export ZIP file.",
204
+ "operationId" : "GetAllExport",
205
+ "parameters" : [ {
206
+ "name" : "initiatedEndTime",
207
+ "in" : "query",
208
+ "description" : "The key that filters exports based on the end time of the duration in which the exports were initiated.",
209
+ "required" : false,
210
+ "style" : "form",
211
+ "explode" : true,
212
+ "schema" : {
213
+ "type" : [ "string", "null" ],
214
+ "description" : "The key that filters exports based on the end time of the duration in which the exports were initiated.",
215
+ "maxLength" : 100,
216
+ "minLength" : 0,
217
+ "pattern" : "(((19|20)\\d\\d)-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])T([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9](\\.\\d{1,3})?Z)"
218
+ }
219
+ }, {
220
+ "name" : "initiatedStartTime",
221
+ "in" : "query",
222
+ "description" : "The key that filters exports based on the start time of the duration in which the exports were initiated.",
223
+ "required" : false,
224
+ "style" : "form",
225
+ "explode" : true,
226
+ "schema" : {
227
+ "type" : [ "string", "null" ],
228
+ "description" : "The key that filters exports based on the start time of the duration in which the exports were initiated.",
229
+ "maxLength" : 100,
230
+ "minLength" : 0,
231
+ "pattern" : "(((19|20)\\d\\d)-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])T([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9](\\.\\d{1,3})?Z)"
232
+ }
233
+ }, {
234
+ "name" : "initiatedDuration",
235
+ "in" : "query",
236
+ "description" : "The key that filters exports within a specific duration. The allowed values are @today@, @yesterday@, @currentWeek@, @currentMonth@, @last3days@, @last7days@, @last15days@, @last30days@, @last3months@, @CUSTOM_IN_DATE@.",
237
+ "required" : false,
238
+ "style" : "form",
239
+ "explode" : true,
240
+ "schema" : {
241
+ "type" : [ "string", "null" ],
242
+ "description" : "The key that filters exports within a specific duration. The allowed values are @today@, @yesterday@, @currentWeek@, @currentMonth@, @last3days@, @last7days@, @last15days@, @last30days@, @last3months@, @CUSTOM_IN_DATE@.",
243
+ "enum" : [ "CUSTOM_IN_DATE" ],
244
+ "maxLength" : 100,
245
+ "minLength" : 0
246
+ }
247
+ }, {
248
+ "name" : "initiatorIds",
249
+ "in" : "query",
250
+ "description" : "The key that filters exports based on the users who initiated the exports. The default value includes all initiators.",
251
+ "required" : false,
252
+ "style" : "simple",
253
+ "explode" : true,
254
+ "schema" : {
255
+ "type" : [ "null", "array" ],
256
+ "description" : "The key that filters exports based on the users who initiated the exports. The default value includes all initiators.",
257
+ "items" : {
258
+ "type" : [ "string", "null", "integer" ],
259
+ "format" : "int64",
260
+ "pattern" : "([0-9]+)",
261
+ "x-custom-parameters-attributes" : [ false, false, false, "", false, "The key that filters exports based on the users who initiated the exports. The default value includes all initiators.", false, 10, ",", false, false, "0,5", false, false ]
262
+ },
263
+ "maxItems" : 50,
264
+ "uniqueItems" : false
265
+ }
266
+ }, {
267
+ "$ref" : "#/components/parameters/limit"
268
+ }, {
269
+ "name" : "from",
270
+ "in" : "query",
271
+ "description" : "Starting point of the record",
272
+ "required" : true,
273
+ "style" : "form",
274
+ "explode" : true,
275
+ "schema" : {
276
+ "type" : [ "string", "null", "integer" ],
277
+ "format" : "int32",
278
+ "description" : "Starting point of the record",
279
+ "pattern" : "([0-9]+)"
280
+ }
281
+ },{
282
+ "name" : "sortBy",
283
+ "in" : "query",
284
+ "description" : "The key that sorts exports by _initiatedTime_.<br> If the value of sortBy key is:<br> * @initiatedTime@ - Sort in ascending order<br> * @-initiatedTime@ - Sort in descending order (prefixed with '-')<br> <br> _Note_: By default, sorting is done in descending order based on initiatedTime.",
285
+ "required" : false,
286
+ "style" : "form",
287
+ "explode" : true,
288
+ "schema" : {
289
+ "type" : [ "string", "null" ],
290
+ "description" : "The key that sorts exports by _initiatedTime_.<br> If the value of sortBy key is:<br> * @initiatedTime@ - Sort in ascending order<br> * @-initiatedTime@ - Sort in descending order (prefixed with '-')<br> <br> _Note_: By default, sorting is done in descending order based on initiatedTime.",
291
+ "maxLength" : 100,
292
+ "minLength" : 0
293
+ }
294
+ }, {
295
+ "name" : "departmentIds",
296
+ "in" : "query",
297
+ "description" : "The key that filters exports based on specific departments. The default value includes all departments.",
298
+ "required" : false,
299
+ "style" : "simple",
300
+ "explode" : true,
301
+ "schema" : {
302
+ "type" : [ "null", "array" ],
303
+ "description" : "The key that filters exports based on specific departments. The default value includes all departments.",
304
+ "items" : {
305
+ "type" : [ "string", "null", "integer" ],
306
+ "format" : "int64",
307
+ "pattern" : "([0-9]+)",
308
+ "x-custom-parameters-attributes" : [ false, false, false, "", false, "The key that filters exports based on specific departments. The default value includes all departments.", false, 10, ",", false, false, "0,5", false, false ]
309
+ },
310
+ "maxItems" : 50,
311
+ "uniqueItems" : false
312
+ }
313
+ }, {
314
+ "name" : "modules",
315
+ "in" : "query",
316
+ "description" : "The key that filters exports based on specific modules. The default value includes all modules.",
317
+ "required" : false,
318
+ "style" : "form",
319
+ "explode" : true,
320
+ "schema" : {
321
+ "type" : [ "string", "null" ],
322
+ "description" : "The key that filters exports based on specific modules. The default value includes all modules.",
323
+ "maxLength" : 100,
324
+ "minLength" : 0,
325
+ "x-custom-parameters-attributes" : {
326
+ "split" : ","
327
+ }
328
+ }
329
+ }, {
330
+ "name" : "status",
331
+ "in" : "query",
332
+ "description" : "The key that filters exports based on their statuses. The allowed values are @INITIATED@, @INPROGRESS@, @COMPLETED@, @FAILED@. The default value includes all statuses",
333
+ "required" : false,
334
+ "style" : "form",
335
+ "explode" : true,
336
+ "schema" : {
337
+ "type" : [ "string", "null" ],
338
+ "description" : "The key that filters exports based on their statuses. The allowed values are @INITIATED@, @INPROGRESS@, @COMPLETED@, @FAILED@. The default value includes all statuses",
339
+ "enum" : [ "INITIATED", "INPROGRESS", "COMPLETED", "FAILED" ],
340
+ "maxLength" : 100,
341
+ "minLength" : 0
342
+ }
343
+ }, {
344
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
345
+ } ],
346
+ "responses" : {
347
+ "200" : {
348
+ "$ref" : "#/components/responses/GetAllExport"
349
+ }
350
+ },
351
+ "security" : [ {
352
+ "org-oauth" : [ "accessAll.ALL" ]
353
+ }, {
354
+ "iam-oauth2-schema" : [ "Desk.exports.CUSTOM" ]
355
+ } ],
356
+ "x-audience" : [ "company-internal" ],
357
+ "x-custom-url-attribute" : {
358
+ "security" : {
359
+ "throttle" : {
360
+ "inline" : [ {
361
+ "scope" : "APPSERVER",
362
+ "rules" : [ {
363
+ "duration" : 60000,
364
+ "lock-period" : 300000,
365
+ "threshold" : 50,
366
+ "hip" : false
367
+ } ],
368
+ "window" : "ROLLING",
369
+ "key" : "url.path+user.zuid"
370
+ } ],
371
+ "policy" : "ReadAPI_Standard_UserPolicy"
372
+ },
373
+ "extraparams" : {
374
+ "disable" : true,
375
+ "ignore" : false
376
+ },
377
+ "authentication" : { }
378
+ },
379
+ "clan-group" : "reports",
380
+ "apihash" : "fe4fd00c073abb42587e92748b471b81",
381
+ "module-group" : "reports",
382
+ "apimethod" : "com.adventnet.support.export.service.BulkDataExportService.getAllExport"
383
+ }
384
+ },
385
+ "post" : {
386
+ "tags" : [ "Backup" ],
387
+ "summary" : "Initiate Bulk Export",
388
+ "description" : "To initiate module Exports.",
389
+ "operationId" : "initiateBulkExport",
390
+ "parameters" : [ {
391
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
392
+ } ],
393
+ "requestBody" : {
394
+ "$ref" : "#/components/requestBodies/getExportReqpObj"
395
+ },
396
+ "responses" : {
397
+ "200" : {
398
+ "$ref" : "#/components/responses/getExportRespObject"
399
+ }
400
+ },
401
+ "security" : [ {
402
+ "org-oauth" : [ "accessAll.ALL" ]
403
+ }, {
404
+ "iam-oauth2-schema" : [ "Desk.exports.CUSTOM" ]
405
+ } ],
406
+ "x-audience" : [ "external-public" ],
407
+ "x-custom-url-attribute" : {
408
+ "security" : {
409
+ "throttle" : {
410
+ "policy" : "BulkExport_DOSRateLimiter"
411
+ },
412
+ "extraparams" : {
413
+ "disable" : true,
414
+ "ignore" : false
415
+ },
416
+ "authentication" : {
417
+ "iscscope" : [ "SupCrmAPI" ]
418
+ }
419
+ },
420
+ "clan-group" : "reports",
421
+ "apihash" : "a5714549ae5daf77cb45027baac1cd70",
422
+ "module-group" : "reports",
423
+ "apimethod" : "com.adventnet.support.export.service.BulkDataExportService.initiateBulkExport"
424
+ }
425
+ }
426
+ },
427
+ "/api/v1/backup/logs" : {
428
+ "get" : {
429
+ "tags" : [ "Backup" ],
430
+ "summary" : "Get Backup Logs",
431
+ "description" : "To get backup logs",
432
+ "operationId" : "getBackupLogs",
433
+ "parameters" : [ {
434
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
435
+ } ],
436
+ "responses" : {
437
+ "404" : {
438
+ "$ref" : "../common/Common.json#/components/responses/urlNotFoundErrorResponse"
439
+ },
440
+ "200" : {
441
+ "$ref" : "#/components/responses/getBackupLogsResp"
442
+ },
443
+ "422" : {
444
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
445
+ },
446
+ "401" : {
447
+ "$ref" : "../common/Common.json#/components/responses/unauthorizedErrorResponse"
448
+ },
449
+ "403" : {
450
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
451
+ }
452
+ },
453
+ "security" : [ {
454
+ "org-oauth" : [ "accessAll.ALL" ]
455
+ }, {
456
+ "cookie-auth" : [ "cookie-auth" ]
457
+ } ],
458
+ "x-audience" : [ "company-internal" ],
459
+ "x-custom-url-attribute" : {
460
+ "security" : {
461
+ "throttle" : {
462
+ "inline" : [ {
463
+ "scope" : "APPSERVER",
464
+ "rules" : [ {
465
+ "duration" : 60000,
466
+ "lock-period" : 300000,
467
+ "threshold" : 60,
468
+ "hip" : false
469
+ } ],
470
+ "window" : "ROLLING",
471
+ "key" : "url.path+user.zuid"
472
+ } ]
473
+ },
474
+ "extraparams" : {
475
+ "disable" : true,
476
+ "ignore" : false
477
+ },
478
+ "authentication" : { }
479
+ },
480
+ "clan-group" : "reports",
481
+ "apihash" : "b72dc7e4add90f2c8242c7f2fc16031e",
482
+ "module-group" : "reports",
483
+ "apimethod" : "com.adventnet.support.export.service.BackupService.getBackupLogs"
484
+ }
485
+ }
486
+ },
487
+ "/api/v1/bulkExport/{exportId}" : {
488
+ "get" : {
489
+ "tags" : [ "Backup" ],
490
+ "summary" : "Get Bulk Export",
491
+ "description" : "To get Bulk Export details.",
492
+ "operationId" : "getBulkExport",
493
+ "parameters" : [ {
494
+ "$ref" : "#/components/parameters/exportId"
495
+ }, {
496
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
497
+ } ],
498
+ "responses" : {
499
+ "200" : {
500
+ "$ref" : "#/components/responses/getExportRespObject"
501
+ }
502
+ },
503
+ "security" : [ {
504
+ "org-oauth" : [ "accessAll.ALL" ]
505
+ }, {
506
+ "iam-oauth2-schema" : [ "Desk.exports.CUSTOM" ]
507
+ } ],
508
+ "x-audience" : [ "external-public" ],
509
+ "x-custom-url-attribute" : {
510
+ "security" : {
511
+ "throttle" : {
512
+ "inline" : [ {
513
+ "scope" : "APPSERVER",
514
+ "rules" : [ {
515
+ "duration" : 60000,
516
+ "lock-period" : 600000,
517
+ "threshold" : 30,
518
+ "hip" : false
519
+ } ],
520
+ "window" : "ROLLING",
521
+ "key" : "url.path+user.zuid"
522
+ } ]
523
+ },
524
+ "extraparams" : {
525
+ "disable" : true,
526
+ "ignore" : false
527
+ },
528
+ "authentication" : {
529
+ "iscscope" : [ "SupCrmAPI" ]
530
+ }
531
+ },
532
+ "clan-group" : "reports",
533
+ "apihash" : "445273798b77e8365afc46158776c2a1",
534
+ "module-group" : "reports",
535
+ "apimethod" : "com.adventnet.support.export.service.BulkDataExportService.getModuleExportDetails"
536
+ }
537
+ }
538
+ },
539
+ "/api/v1/backup/{backupId}" : {
540
+ "get" : {
541
+ "tags" : [ "Backup" ],
542
+ "summary" : "GetBackupDetails",
543
+ "description" : "To get Backup details.",
544
+ "operationId" : "getBackupDetails",
545
+ "parameters" : [ {
546
+ "$ref" : "#/components/parameters/backupId"
547
+ }, {
548
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
549
+ } ],
550
+ "responses" : {
551
+ "404" : {
552
+ "$ref" : "../common/Common.json#/components/responses/urlNotFoundErrorResponse"
553
+ },
554
+ "200" : {
555
+ "$ref" : "#/components/responses/getBackupRespObject"
556
+ },
557
+ "422" : {
558
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
559
+ },
560
+ "401" : {
561
+ "$ref" : "../common/Common.json#/components/responses/unauthorizedErrorResponse"
562
+ },
563
+ "403" : {
564
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
565
+ }
566
+ },
567
+ "security" : [ {
568
+ "org-oauth" : [ "accessAll.ALL" ]
569
+ }, {
570
+ "cookie-auth" : [ "cookie-auth" ]
571
+ } ],
572
+ "x-audience" : [ "company-internal" ],
573
+ "x-custom-url-attribute" : {
574
+ "security" : {
575
+ "throttle" : {
576
+ "inline" : [ {
577
+ "scope" : "APPSERVER",
578
+ "rules" : [ {
579
+ "duration" : 60000,
580
+ "lock-period" : 600000,
581
+ "threshold" : 60,
582
+ "hip" : false
583
+ } ],
584
+ "window" : "ROLLING",
585
+ "key" : "url.path+user.zuid"
586
+ } ]
587
+ },
588
+ "extraparams" : {
589
+ "disable" : true,
590
+ "ignore" : false
591
+ },
592
+ "authentication" : { }
593
+ },
594
+ "clan-group" : "reports",
595
+ "apihash" : "368b52d2a714e5a7c86c7efcc569cc8b",
596
+ "module-group" : "reports",
597
+ "apimethod" : "com.adventnet.support.export.service.BackupService.getBackupDetails"
598
+ }
599
+ },
600
+ "patch" : {
601
+ "tags" : [ "Backup" ],
602
+ "summary" : "Update Backup Frequency",
603
+ "description" : "To update backup frequency",
604
+ "operationId" : "updateBackup",
605
+ "parameters" : [ {
606
+ "$ref" : "#/components/parameters/backupId"
607
+ }, {
608
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
609
+ } ],
610
+ "requestBody" : {
611
+ "$ref" : "#/components/requestBodies/updateBackup_getBackupReqObject"
612
+ },
613
+ "responses" : {
614
+ "404" : {
615
+ "$ref" : "../common/Common.json#/components/responses/urlNotFoundErrorResponse"
616
+ },
617
+ "200" : {
618
+ "$ref" : "#/components/responses/updateBackupResponse"
619
+ },
620
+ "422" : {
621
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
622
+ },
623
+ "401" : {
624
+ "$ref" : "../common/Common.json#/components/responses/unauthorizedErrorResponse"
625
+ },
626
+ "403" : {
627
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
628
+ }
629
+ },
630
+ "security" : [ {
631
+ "org-oauth" : [ "accessAll.ALL" ]
632
+ }, {
633
+ "cookie-auth" : [ "cookie-auth" ]
634
+ } ],
635
+ "x-audience" : [ "company-internal" ],
636
+ "x-custom-url-attribute" : {
637
+ "security" : {
638
+ "throttle" : {
639
+ "inline" : [ {
640
+ "scope" : "APPSERVER",
641
+ "rules" : [ {
642
+ "duration" : 60000,
643
+ "lock-period" : 300000,
644
+ "threshold" : 5,
645
+ "hip" : false
646
+ }, {
647
+ "duration" : 3600000,
648
+ "lock-period" : 600000,
649
+ "threshold" : 10,
650
+ "hip" : false
651
+ }, {
652
+ "duration" : 86400000,
653
+ "lock-period" : 1800000,
654
+ "threshold" : 20,
655
+ "hip" : false
656
+ } ],
657
+ "window" : "ROLLING",
658
+ "key" : "url.path+user.zuid"
659
+ } ]
660
+ },
661
+ "extraparams" : {
662
+ "disable" : true,
663
+ "ignore" : false
664
+ },
665
+ "authentication" : { }
666
+ },
667
+ "clan-group" : "reports",
668
+ "apihash" : "ccd3efe8a27e5c46f453b4421fe7e804",
669
+ "module-group" : "reports",
670
+ "apimethod" : "com.adventnet.support.export.service.BackupService.updateBackupFrequency"
671
+ }
672
+ }
673
+ },
674
+ "/api/v1/downloadBulkExportFile" : {
675
+ "get" : {
676
+ "tags" : [ "Backup" ],
677
+ "summary" : "Download Bulk Export File",
678
+ "description" : "To download the exported data as a ZIP file",
679
+ "operationId" : "downloadBulkExportFile",
680
+ "parameters" : [ {
681
+ "$ref" : "#/components/parameters/exportId"
682
+ }, {
683
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
684
+ } ],
685
+ "responses" : {
686
+ "404" : {
687
+ "$ref" : "../common/Common.json#/components/responses/urlNotFoundErrorResponse"
688
+ },
689
+ "200" : {
690
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
691
+ },
692
+ "401" : {
693
+ "$ref" : "../common/Common.json#/components/responses/unauthorizedErrorResponse"
694
+ },
695
+ "500" : {
696
+ "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
697
+ }
698
+ },
699
+ "security" : [ {
700
+ "org-oauth" : [ "accessAll.ALL" ]
701
+ }, {
702
+ "iam-oauth2-schema" : [ "Desk.exports.CUSTOM" ]
703
+ } ],
704
+ "x-audience" : [ "external-public" ],
705
+ "x-custom-url-attribute" : {
706
+ "security" : {
707
+ "throttle" : {
708
+ "inline" : [ {
709
+ "scope" : "APPSERVER",
710
+ "rules" : [ {
711
+ "duration" : 60000,
712
+ "lock-period" : 300000,
713
+ "threshold" : 50,
714
+ "hip" : false
715
+ }, {
716
+ "duration" : 3600000,
717
+ "lock-period" : 900000,
718
+ "threshold" : 200,
719
+ "hip" : false
720
+ }, {
721
+ "duration" : 86400000,
722
+ "lock-period" : 1800000,
723
+ "threshold" : 400,
724
+ "hip" : false
725
+ } ],
726
+ "window" : "ROLLING",
727
+ "key" : "url.path+user.zuid"
728
+ } ]
729
+ },
730
+ "extraparams" : {
731
+ "disable" : true,
732
+ "ignore" : false
733
+ },
734
+ "authentication" : {
735
+ "iscscope" : [ "SupCrmAPI" ]
736
+ }
737
+ },
738
+ "clan-group" : "reports",
739
+ "apihash" : "c7d1ac47711750b3b566aca747782e40",
740
+ "module-group" : "reports",
741
+ "apimethod" : "com.adventnet.support.export.service.BulkDataExportService.downloadModuleExportFile"
742
+ }
743
+ }
744
+ },
745
+ "/api/v1/backup/{backupId}/stopScheduledBackup" : {
746
+ "post" : {
747
+ "tags" : [ "Backup" ],
748
+ "summary" : "Stop Scheduled Backup",
749
+ "description" : "To Stop a scheduled Backup",
750
+ "operationId" : "stopScheduledBackup",
751
+ "parameters" : [ {
752
+ "$ref" : "#/components/parameters/backupId"
753
+ }, {
754
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
755
+ } ],
756
+ "responses" : {
757
+ "404" : {
758
+ "$ref" : "../common/Common.json#/components/responses/urlNotFoundErrorResponse"
759
+ },
760
+ "200" : {
761
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
762
+ },
763
+ "422" : {
764
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
765
+ },
766
+ "401" : {
767
+ "$ref" : "../common/Common.json#/components/responses/unauthorizedErrorResponse"
768
+ },
769
+ "403" : {
770
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
771
+ }
772
+ },
773
+ "security" : [ {
774
+ "org-oauth" : [ "accessAll.ALL" ]
775
+ }, {
776
+ "cookie-auth" : [ "cookie-auth" ]
777
+ } ],
778
+ "x-audience" : [ "company-internal" ],
779
+ "x-custom-url-attribute" : {
780
+ "security" : {
781
+ "throttle" : {
782
+ "inline" : [ {
783
+ "scope" : "APPSERVER",
784
+ "rules" : [ {
785
+ "duration" : 60000,
786
+ "lock-period" : 300000,
787
+ "threshold" : 30,
788
+ "hip" : false
789
+ } ],
790
+ "window" : "ROLLING",
791
+ "key" : "url.path+user.zuid"
792
+ } ]
793
+ },
794
+ "extraparams" : {
795
+ "disable" : true,
796
+ "ignore" : false
797
+ },
798
+ "authentication" : { }
799
+ },
800
+ "clan-group" : "reports",
801
+ "apihash" : "00a58899e0219b8387b9b07aab8ace9d",
802
+ "module-group" : "reports",
803
+ "apimethod" : "com.adventnet.support.export.service.BackupService.stopRecurringScheduler"
804
+ }
805
+ }
806
+ },
807
+ "/api/v1/backup/{backupId}/files/{fileId}" : {
808
+ "delete" : {
809
+ "tags" : [ "Backup" ],
810
+ "summary" : "Delete Backup File",
811
+ "description" : "To Delete Backup file.",
812
+ "operationId" : "deleteBackupFile",
813
+ "parameters" : [ {
814
+ "$ref" : "#/components/parameters/backupId"
815
+ }, {
816
+ "name" : "fileId",
817
+ "in" : "path",
818
+ "required" : true,
819
+ "style" : "simple",
820
+ "explode" : false,
821
+ "schema" : {
822
+ "type" : [ "string", "null", "integer" ],
823
+ "format" : "int64",
824
+ "pattern" : "([0-9]+)"
825
+ }
826
+ }, {
827
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
828
+ } ],
829
+ "responses" : {
830
+ "404" : {
831
+ "$ref" : "../common/Common.json#/components/responses/urlNotFoundErrorResponse"
832
+ },
833
+ "200" : {
834
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
835
+ },
836
+ "422" : {
837
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
838
+ },
839
+ "401" : {
840
+ "$ref" : "../common/Common.json#/components/responses/unauthorizedErrorResponse"
841
+ },
842
+ "403" : {
843
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
844
+ }
845
+ },
846
+ "security" : [ {
847
+ "org-oauth" : [ "accessAll.ALL" ]
848
+ }, {
849
+ "cookie-auth" : [ "cookie-auth" ]
850
+ } ],
851
+ "x-audience" : [ "company-internal" ],
852
+ "x-custom-url-attribute" : {
853
+ "security" : {
854
+ "throttle" : {
855
+ "inline" : [ {
856
+ "scope" : "APPSERVER",
857
+ "rules" : [ {
858
+ "duration" : 60000,
859
+ "lock-period" : 300000,
860
+ "threshold" : 30,
861
+ "hip" : false
862
+ }, {
863
+ "duration" : 3600000,
864
+ "lock-period" : 600000,
865
+ "threshold" : 60,
866
+ "hip" : false
867
+ } ],
868
+ "window" : "ROLLING",
869
+ "key" : "url.path+user.zuid"
870
+ } ]
871
+ },
872
+ "extraparams" : {
873
+ "disable" : true,
874
+ "ignore" : false
875
+ },
876
+ "authentication" : { }
877
+ },
878
+ "clan-group" : "reports",
879
+ "apihash" : "e195fba4c14bf321bba74a8ebbd17f9e",
880
+ "module-group" : "reports",
881
+ "apimethod" : "com.adventnet.support.export.service.BackupService.deleteBackupFiles"
882
+ }
883
+ }
884
+ }
885
+ },
886
+ "components" : {
887
+ "schemas" : {
888
+ "getBackupRespObject" : {
889
+ "type" : [ "null", "object" ],
890
+ "additionalProperties" : false,
891
+ "properties" : {
892
+ "modifiedAfter" : {
893
+ "type" : [ "string", "null" ],
894
+ "maxLength" : 100,
895
+ "minLength" : 0,
896
+ "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))"
897
+ },
898
+ "nextBackupDate" : {
899
+ "type" : [ "string", "null" ],
900
+ "maxLength" : 100,
901
+ "minLength" : 0,
902
+ "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))"
903
+ },
904
+ "lastBackupDate" : {
905
+ "type" : [ "string", "null" ],
906
+ "maxLength" : 100,
907
+ "minLength" : 0,
908
+ "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))"
909
+ },
910
+ "endsAfter" : {
911
+ "type" : [ "null", "object" ],
912
+ "additionalProperties" : false
913
+ },
914
+ "backupId" : {
915
+ "type" : [ "string", "null", "integer" ],
916
+ "format" : "int64",
917
+ "pattern" : "([0-9]+)"
918
+ },
919
+ "modifiedTill" : {
920
+ "type" : [ "string", "null" ],
921
+ "maxLength" : 100,
922
+ "minLength" : 0,
923
+ "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))"
924
+ },
925
+ "modules" : {
926
+ "type" : [ "null", "array" ],
927
+ "items" : {
928
+ "type" : [ "string", "null" ],
929
+ "enum" : [ "attachments", "comments", "tickets", "contacts", "departments", "agents", "products", "accounts", "tasks", "timeEntry", "solutions", "topics", "teams" ],
930
+ "maxLength" : 100,
931
+ "minLength" : 0
932
+ },
933
+ "uniqueItems" : false
934
+ },
935
+ "status" : {
936
+ "type" : [ "string", "null" ],
937
+ "enum" : [ "INITIATED", "IN_PROGRESS", "PARTIALLY_COMPLETED", "COMPLETED", "SUSPENDED" ],
938
+ "maxLength" : 100,
939
+ "minLength" : 0
940
+ },
941
+ "backupType" : {
942
+ "type" : [ "string", "null" ],
943
+ "enum" : [ "FULL", "INCREMENTAL" ],
944
+ "maxLength" : 100,
945
+ "minLength" : 0
946
+ },
947
+ "limitPerFile" : {
948
+ "type" : [ "string", "null", "integer" ],
949
+ "format" : "int64",
950
+ "pattern" : "([0-9]+)"
951
+ },
952
+ "frequency" : {
953
+ "type" : [ "null", "object" ],
954
+ "additionalProperties" : false,
955
+ "maxProperties" : 2,
956
+ "minProperties" : 2,
957
+ "properties" : {
958
+ "repeatsOn" : {
959
+ "type" : [ "null", "object" ],
960
+ "additionalProperties" : false,
961
+ "maxProperties" : 6,
962
+ "minProperties" : 6,
963
+ "properties" : {
964
+ "dates" : {
965
+ "type" : [ "null", "array" ],
966
+ "items" : {
967
+ "type" : [ "string", "null", "integer" ],
968
+ "format" : "int32",
969
+ "maximum" : 31,
970
+ "minimum" : 1,
971
+ "pattern" : "([0-9]+)"
972
+ },
973
+ "uniqueItems" : false
974
+ },
975
+ "repetitionType" : {
976
+ "type" : [ "string", "null" ],
977
+ "enum" : [ "WEEKLY", "MONTHLY", "YEARLY" ],
978
+ "maxLength" : 100,
979
+ "minLength" : 0
980
+ },
981
+ "daysOfWeek" : {
982
+ "type" : [ "null", "array" ],
983
+ "items" : {
984
+ "type" : [ "string", "null" ],
985
+ "enum" : [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ],
986
+ "maxLength" : 100,
987
+ "minLength" : 0
988
+ },
989
+ "uniqueItems" : false
990
+ },
991
+ "skipFrequency" : {
992
+ "type" : [ "string", "null", "integer" ],
993
+ "format" : "int32",
994
+ "maximum" : 2,
995
+ "minimum" : 1,
996
+ "pattern" : "([0-9]+)"
997
+ },
998
+ "monthsOfYear" : {
999
+ "type" : [ "null", "array" ],
1000
+ "items" : {
1001
+ "type" : [ "string", "null" ],
1002
+ "enum" : [ "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" ],
1003
+ "maxLength" : 100,
1004
+ "minLength" : 0
1005
+ },
1006
+ "uniqueItems" : false
1007
+ },
1008
+ "weeksOfMonth" : {
1009
+ "type" : [ "string", "null" ],
1010
+ "enum" : [ "FIRST", "SECOND", "THIRD", "FOURTH", "LAST" ],
1011
+ "maxLength" : 100,
1012
+ "minLength" : 0
1013
+ }
1014
+ },
1015
+ "required" : [ "dates", "daysOfWeek", "monthsOfYear", "repetitionType", "skipFrequency", "weeksOfMonth" ]
1016
+ },
1017
+ "type" : {
1018
+ "type" : [ "string", "null" ],
1019
+ "enum" : [ "NONE", "WEEKLY", "MONTHLY", "YEARLY" ],
1020
+ "maxLength" : 100,
1021
+ "minLength" : 0
1022
+ }
1023
+ },
1024
+ "required" : [ "repeatsOn", "type" ]
1025
+ }
1026
+ },
1027
+ "required" : [ "backupId", "backupType", "endsAfter", "frequency", "lastBackupDate", "limitPerFile", "modifiedAfter", "modifiedTill", "modules", "nextBackupDate", "status" ]
1028
+ },
1029
+ "getRecentBackupsList" : {
1030
+ "type" : [ "null", "array" ],
1031
+ "items" : {
1032
+ "$ref" : "./Backup.json#/components/schemas/getBackupRespObject"
1033
+ }
1034
+ },
1035
+ "getBackupFileResp" : {
1036
+ "type" : [ "null", "object" ],
1037
+ "additionalProperties" : false,
1038
+ "properties" : {
1039
+ "modifiedAfter" : {
1040
+ "type" : [ "string", "null" ],
1041
+ "maxLength" : 100,
1042
+ "minLength" : 0,
1043
+ "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))"
1044
+ },
1045
+ "fileName" : {
1046
+ "type" : [ "string", "null" ],
1047
+ "maxLength" : 100,
1048
+ "minLength" : 0
1049
+ },
1050
+ "fileSize" : {
1051
+ "type" : [ "string", "null", "integer" ],
1052
+ "format" : "int32",
1053
+ "pattern" : "([0-9]+)"
1054
+ },
1055
+ "backupId" : {
1056
+ "type" : [ "string", "null", "integer" ],
1057
+ "format" : "int64",
1058
+ "pattern" : "([0-9]+)"
1059
+ },
1060
+ "downloadUrl" : {
1061
+ "type" : [ "string", "null" ],
1062
+ "maxLength" : 100,
1063
+ "minLength" : 0,
1064
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&amp;%\\$#_@]*)?$)"
1065
+ },
1066
+ "expiryTime" : {
1067
+ "type" : [ "string", "null" ],
1068
+ "maxLength" : 100,
1069
+ "minLength" : 0,
1070
+ "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))"
1071
+ },
1072
+ "createdTime" : {
1073
+ "type" : [ "string", "null" ],
1074
+ "maxLength" : 100,
1075
+ "minLength" : 0,
1076
+ "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))"
1077
+ },
1078
+ "modifiedTill" : {
1079
+ "type" : [ "string", "null" ],
1080
+ "maxLength" : 100,
1081
+ "minLength" : 0,
1082
+ "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))"
1083
+ },
1084
+ "fileId" : {
1085
+ "type" : [ "string", "null", "integer" ],
1086
+ "format" : "int64",
1087
+ "pattern" : "([0-9]+)"
1088
+ }
1089
+ },
1090
+ "required" : [ "backupId", "createdTime", "downloadUrl", "expiryTime", "fileId", "fileName", "fileSize", "modifiedAfter", "modifiedTill" ]
1091
+ },
1092
+ "getBackupFilesRespList" : {
1093
+ "type" : [ "null", "array" ],
1094
+ "items" : {
1095
+ "$ref" : "./Backup.json#/components/schemas/getBackupFileResp"
1096
+ }
1097
+ },
1098
+ "criteriaFieldsArr" : {
1099
+ "type" : [ "null", "array" ],
1100
+ "items" : {
1101
+ "type" : [ "null", "object" ],
1102
+ "additionalProperties" : false,
1103
+ "maxProperties" : 3,
1104
+ "minProperties" : 3,
1105
+ "properties" : {
1106
+ "condition" : {
1107
+ "type" : [ "string", "null" ],
1108
+ "maxLength" : 100,
1109
+ "minLength" : 0
1110
+ },
1111
+ "field" : {
1112
+ "type" : [ "null", "object" ],
1113
+ "additionalProperties" : false,
1114
+ "maxProperties" : 3,
1115
+ "minProperties" : 3,
1116
+ "properties" : {
1117
+ "apiName" : {
1118
+ "type" : [ "string", "null" ],
1119
+ "maxLength" : 100,
1120
+ "minLength" : 0
1121
+ },
1122
+ "module" : {
1123
+ "type" : [ "string", "null" ],
1124
+ "maxLength" : 100,
1125
+ "minLength" : 0,
1126
+ "pattern" : "[0-9a-zA-Z_\\-\\s\\P{InBasicLatin}.$@,\\?\\:]+"
1127
+ },
1128
+ "fieldLabel" : {
1129
+ "type" : [ "string", "null" ],
1130
+ "maxLength" : 100,
1131
+ "minLength" : 0
1132
+ }
1133
+ },
1134
+ "required" : [ "apiName", "fieldLabel", "module" ]
1135
+ },
1136
+ "value" : {
1137
+ "type" : [ "null", "object" ],
1138
+ "additionalProperties" : false,
1139
+ "maxProperties" : 2,
1140
+ "minProperties" : 2,
1141
+ "properties" : {
1142
+ "primitive" : {
1143
+ "type" : [ "null", "array" ],
1144
+ "items" : {
1145
+ "type" : [ "null", "object" ],
1146
+ "additionalProperties" : false,
1147
+ "maxProperties" : 1,
1148
+ "minProperties" : 1,
1149
+ "properties" : {
1150
+ "key" : {
1151
+ "type" : [ "string", "null" ],
1152
+ "maxLength" : 100,
1153
+ "minLength" : 0
1154
+ }
1155
+ },
1156
+ "required" : [ "key" ]
1157
+ },
1158
+ "uniqueItems" : false
1159
+ },
1160
+ "type" : {
1161
+ "type" : [ "string", "null" ],
1162
+ "maxLength" : 100,
1163
+ "minLength" : 0
1164
+ }
1165
+ },
1166
+ "required" : [ "primitive", "type" ]
1167
+ }
1168
+ },
1169
+ "required" : [ "condition", "field", "value" ]
1170
+ }
1171
+ },
1172
+ "criteriaObject" : {
1173
+ "type" : [ "null", "object" ],
1174
+ "additionalProperties" : false,
1175
+ "properties" : {
1176
+ "criteriaFields" : {
1177
+ "$ref" : "./Backup.json#/components/schemas/criteriaFieldsArr"
1178
+ },
1179
+ "criteriaPattern" : {
1180
+ "type" : [ "string", "null" ],
1181
+ "maxLength" : 100,
1182
+ "minLength" : 0
1183
+ }
1184
+ },
1185
+ "required" : [ "criteriaFields", "criteriaPattern" ]
1186
+ },
1187
+ "getBackupLogsRespObject" : {
1188
+ "type" : [ "null", "object" ],
1189
+ "additionalProperties" : false,
1190
+ "properties" : {
1191
+ "backupId" : {
1192
+ "type" : [ "string", "null", "integer" ],
1193
+ "format" : "int64",
1194
+ "pattern" : "([0-9]+)"
1195
+ },
1196
+ "eventTime" : {
1197
+ "type" : [ "string", "null" ],
1198
+ "maxLength" : 100,
1199
+ "minLength" : 0,
1200
+ "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))"
1201
+ },
1202
+ "message" : {
1203
+ "type" : [ "string", "null" ],
1204
+ "maxLength" : 100,
1205
+ "minLength" : 0
1206
+ },
1207
+ "userId" : {
1208
+ "type" : [ "string", "null", "integer" ],
1209
+ "format" : "int64",
1210
+ "pattern" : "([0-9]+)"
1211
+ },
1212
+ "status" : {
1213
+ "type" : [ "string", "null" ],
1214
+ "maxLength" : 100,
1215
+ "minLength" : 0
1216
+ }
1217
+ },
1218
+ "required" : [ "backupId", "eventTime", "message", "status", "userId" ]
1219
+ },
1220
+ "getBackupLogsRespList" : {
1221
+ "type" : [ "null", "array" ],
1222
+ "items" : {
1223
+ "$ref" : "./Backup.json#/components/schemas/getBackupLogsRespObject"
1224
+ }
1225
+ },
1226
+ "exportArray" : {
1227
+ "type" : [ "null", "array" ],
1228
+ "items" : {
1229
+ "type" : [ "null", "object" ],
1230
+ "additionalProperties" : false,
1231
+ "maxProperties" : 10,
1232
+ "minProperties" : 8,
1233
+ "properties" : {
1234
+ "creator" : {
1235
+ "type" : [ "null", "object" ],
1236
+ "additionalProperties" : false,
1237
+ "maxProperties" : 5,
1238
+ "minProperties" : 5,
1239
+ "properties" : {
1240
+ "firstName" : {
1241
+ "type" : [ "string", "null" ],
1242
+ "maxLength" : 50,
1243
+ "minLength" : 0
1244
+ },
1245
+ "lastName" : {
1246
+ "type" : [ "string", "null" ],
1247
+ "maxLength" : 50,
1248
+ "minLength" : 0
1249
+ },
1250
+ "photoURL" : {
1251
+ "type" : [ "string", "null" ],
1252
+ "maxLength" : 100,
1253
+ "minLength" : 0,
1254
+ "pattern" : "[0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+"
1255
+ },
1256
+ "name" : {
1257
+ "type" : [ "string", "null" ],
1258
+ "maxLength" : 100,
1259
+ "minLength" : 0,
1260
+ "pattern" : "[0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+"
1261
+ },
1262
+ "id" : {
1263
+ "type" : [ "string", "null", "integer" ],
1264
+ "format" : "int64",
1265
+ "pattern" : "([0-9]+)"
1266
+ }
1267
+ },
1268
+ "required" : [ "firstName", "id", "lastName", "name", "photoURL" ]
1269
+ },
1270
+ "completedTime" : {
1271
+ "type" : [ "string", "null" ],
1272
+ "maxLength" : 100,
1273
+ "minLength" : 0,
1274
+ "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))"
1275
+ },
1276
+ "filePath" : {
1277
+ "type" : [ "string", "null" ],
1278
+ "maxLength" : 500,
1279
+ "minLength" : 0
1280
+ },
1281
+ "module" : {
1282
+ "type" : [ "null", "object" ],
1283
+ "additionalProperties" : false,
1284
+ "maxProperties" : 6,
1285
+ "minProperties" : 6,
1286
+ "properties" : {
1287
+ "apiName" : {
1288
+ "type" : [ "string", "null" ],
1289
+ "maxLength" : 100,
1290
+ "minLength" : 0
1291
+ },
1292
+ "isCustomModule" : {
1293
+ "type" : [ "boolean", "null" ]
1294
+ },
1295
+ "isDeptSpecific" : {
1296
+ "type" : [ "boolean", "null" ]
1297
+ },
1298
+ "id" : {
1299
+ "type" : [ "string", "null", "integer" ],
1300
+ "format" : "int64",
1301
+ "pattern" : "([0-9]+)"
1302
+ },
1303
+ "pluralLabel" : {
1304
+ "type" : [ "string", "null" ],
1305
+ "maxLength" : 100,
1306
+ "minLength" : 0,
1307
+ "pattern" : "[0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+"
1308
+ },
1309
+ "singularLabel" : {
1310
+ "type" : [ "string", "null" ],
1311
+ "maxLength" : 100,
1312
+ "minLength" : 0,
1313
+ "pattern" : "[0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+"
1314
+ }
1315
+ },
1316
+ "required" : [ "apiName", "id", "isCustomModule", "isDeptSpecific", "pluralLabel", "singularLabel" ]
1317
+ },
1318
+ "initiatedTime" : {
1319
+ "type" : [ "string", "null" ],
1320
+ "maxLength" : 100,
1321
+ "minLength" : 0,
1322
+ "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))"
1323
+ },
1324
+ "expiryTime" : {
1325
+ "type" : [ "string", "null" ],
1326
+ "maxLength" : 100,
1327
+ "minLength" : 0,
1328
+ "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))"
1329
+ },
1330
+ "count" : {
1331
+ "type" : [ "string", "null", "integer" ],
1332
+ "format" : "int32",
1333
+ "pattern" : "([0-9]+)"
1334
+ },
1335
+ "exportId" : {
1336
+ "type" : [ "string", "null", "integer" ],
1337
+ "format" : "int64",
1338
+ "pattern" : "([0-9]+)"
1339
+ },
1340
+ "initiatedBy" : {
1341
+ "type" : [ "string", "null", "integer" ],
1342
+ "format" : "int64",
1343
+ "pattern" : "([0-9]+)"
1344
+ },
1345
+ "status" : {
1346
+ "type" : [ "string", "null" ],
1347
+ "maxLength" : 100,
1348
+ "minLength" : 0
1349
+ }
1350
+ },
1351
+ "required" : [ "completedTime", "count", "creator", "expiryTime", "exportId", "filePath", "initiatedBy", "initiatedTime", "module", "status" ]
1352
+ }
1353
+ }
1354
+ },
1355
+ "responses" : {
1356
+ "getRecentBackups" : {
1357
+ "description" : "getRecentBackups template definitions",
1358
+ "content" : {
1359
+ "application/json" : {
1360
+ "schema" : {
1361
+ "type" : [ "null", "object" ],
1362
+ "additionalProperties" : false,
1363
+ "properties" : {
1364
+ "data" : {
1365
+ "$ref" : "./Backup.json#/components/schemas/getRecentBackupsList"
1366
+ }
1367
+ },
1368
+ "required" : [ "data" ]
1369
+ },
1370
+ "examples" : {
1371
+ "Valid responses Definitions" : {
1372
+ "value" : {
1373
+ "data" : [ {
1374
+ "modifiedAfter" : null,
1375
+ "nextBackupDate" : 1606820569013,
1376
+ "lastBackupDate" : null,
1377
+ "endsAfter" : {
1378
+ "type" : "NONE",
1379
+ "value" : "0"
1380
+ },
1381
+ "backupId" : "45664000001403809",
1382
+ "modifiedTill" : null,
1383
+ "backupFiles" : null,
1384
+ "modules" : [ "tickets", "contacts" ],
1385
+ "backupType" : "INCREMENTAL",
1386
+ "limitPerFile" : null,
1387
+ "frequency" : {
1388
+ "repeatsOn" : {
1389
+ "dates" : null,
1390
+ "repetitionType" : "WEEKLY",
1391
+ "daysOfWeek" : [ "Sunday" ],
1392
+ "skipFrequency" : "1",
1393
+ "monthsOfYear" : null,
1394
+ "weeksOfMonth" : null
1395
+ },
1396
+ "type" : "WEEKLY"
1397
+ },
1398
+ "status" : "INITIATED"
1399
+ } ]
1400
+ }
1401
+ }
1402
+ }
1403
+ }
1404
+ },
1405
+ "x-custom-response-attributes" : {
1406
+ "disable-safe-headers" : "[]"
1407
+ }
1408
+ },
1409
+ "getBackupFilesResp" : {
1410
+ "description" : "getBackupFilesResp template definitions",
1411
+ "content" : {
1412
+ "application/json" : {
1413
+ "schema" : {
1414
+ "type" : [ "null", "object" ],
1415
+ "additionalProperties" : false,
1416
+ "properties" : {
1417
+ "data" : {
1418
+ "$ref" : "./Backup.json#/components/schemas/getBackupFilesRespList"
1419
+ }
1420
+ },
1421
+ "required" : [ "data" ]
1422
+ },
1423
+ "examples" : {
1424
+ "Valid responses Definitions" : {
1425
+ "value" : {
1426
+ "data" : [ {
1427
+ "modifiedAfter" : null,
1428
+ "fileName" : "A1111_scheduled_weekly_2020-12-01_2020-12-01.zip",
1429
+ "fileSize" : "41319",
1430
+ "backupId" : "45664000001403001",
1431
+ "downloadUrl" : "https://downloadserver.zoho.com/webdownload?x-service=deskplus1&event-id=765e54dd4a25e33a16671e950de8f827bea2ad2729448d43c86de269bc4bbb628c5cafc915c1ce2867c9c93ad97d07099d030f9275115cd73f478d5d39fcaba2&x-cli-msg=%7B%22portalname%22%3A%22ffffffff%22%2C%22inline%22%3A%22false%22%7D",
1432
+ "expiryTime" : 1607418104000,
1433
+ "createdTime" : 1606813343892,
1434
+ "modifiedTill" : 1606793504000,
1435
+ "fileId" : "45664000001403793"
1436
+ } ]
1437
+ }
1438
+ }
1439
+ }
1440
+ }
1441
+ },
1442
+ "x-custom-response-attributes" : {
1443
+ "disable-safe-headers" : "[]"
1444
+ }
1445
+ },
1446
+ "getExportRespObject" : {
1447
+ "description" : "getExportRespObject template definitions",
1448
+ "content" : {
1449
+ "application/json" : {
1450
+ "schema" : {
1451
+ "type" : [ "null", "object" ],
1452
+ "additionalProperties" : false,
1453
+ "properties" : {
1454
+ "modifiedAfter" : {
1455
+ "type" : [ "string", "null" ],
1456
+ "maxLength" : 100,
1457
+ "minLength" : 0,
1458
+ "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))"
1459
+ },
1460
+ "exportTimeFilter" : {
1461
+ "type" : [ "null", "object" ],
1462
+ "additionalProperties" : false,
1463
+ "maxProperties" : 4,
1464
+ "minProperties" : 4,
1465
+ "properties" : {
1466
+ "duration" : {
1467
+ "type" : [ "string", "null" ],
1468
+ "maxLength" : 100,
1469
+ "minLength" : 0
1470
+ },
1471
+ "endDate" : {
1472
+ "type" : [ "string", "null" ],
1473
+ "maxLength" : 100,
1474
+ "minLength" : 0
1475
+ },
1476
+ "filterField" : {
1477
+ "type" : [ "string", "null" ],
1478
+ "maxLength" : 100,
1479
+ "minLength" : 0
1480
+ },
1481
+ "startDate" : {
1482
+ "type" : [ "string", "null" ],
1483
+ "maxLength" : 100,
1484
+ "minLength" : 0
1485
+ }
1486
+ },
1487
+ "required" : [ "duration", "endDate", "filterField", "startDate" ]
1488
+ },
1489
+ "callBackUrl" : {
1490
+ "type" : [ "string", "null" ],
1491
+ "maxLength" : 100,
1492
+ "minLength" : 0,
1493
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1494
+ },
1495
+ "criteria" : {
1496
+ "$ref" : "./Backup.json#/components/schemas/criteriaObject"
1497
+ },
1498
+ "module" : {
1499
+ "type" : [ "string", "null" ],
1500
+ "enum" : [ "tickets", "contacts", "departments", "agents", "products", "accounts", "tasks", "timeEntry", "solutions", "topics", "teams", "comments", "attachments", "calls", "events" ],
1501
+ "maxLength" : 100,
1502
+ "minLength" : 0
1503
+ },
1504
+ "fields" : {
1505
+ "type" : [ "null", "array" ],
1506
+ "items" : {
1507
+ "type" : [ "string", "null" ],
1508
+ "maxLength" : 100,
1509
+ "minLength" : 0
1510
+ },
1511
+ "minItems" : 1,
1512
+ "uniqueItems" : false
1513
+ },
1514
+ "exportId" : {
1515
+ "type" : [ "string", "null", "integer" ],
1516
+ "format" : "int64",
1517
+ "pattern" : "([0-9]+)"
1518
+ },
1519
+ "status" : {
1520
+ "type" : [ "string", "null" ],
1521
+ "enum" : [ "INITIATED", "INPROGRESS", "INIT_FAILED", "COMPLETED", "SUSPENDED", "FAILED", "DELETED" ],
1522
+ "maxLength" : 100,
1523
+ "minLength" : 0
1524
+ },
1525
+ "limitPerFile" : {
1526
+ "type" : [ "string", "null", "integer" ],
1527
+ "format" : "int64",
1528
+ "pattern" : "([0-9]+)"
1529
+ }
1530
+ },
1531
+ "required" : [ "callBackUrl", "criteria", "exportId", "exportTimeFilter", "fields", "limitPerFile", "modifiedAfter", "module", "status" ]
1532
+ },
1533
+ "examples" : {
1534
+ "Valid responses Definitions" : {
1535
+ "value" : {
1536
+ "modifiedAfter" : 1557166837733,
1537
+ "callBackUrl" : "https://webhook.site/c57564f2-f262-4092-adc4-7c416d401d50",
1538
+ "viewId" : "5000000031695",
1539
+ "hasNextPage" : "false",
1540
+ "module" : "tickets",
1541
+ "departmentId" : "5000000031695",
1542
+ "fields" : [ "email", "subject", "status", "isSpam" ],
1543
+ "exportId" : "5000001003083",
1544
+ "limitPerFile" : "100000",
1545
+ "status" : "INITIATED"
1546
+ }
1547
+ }
1548
+ }
1549
+ }
1550
+ },
1551
+ "x-custom-response-attributes" : {
1552
+ "disable-safe-headers" : "[]"
1553
+ }
1554
+ },
1555
+ "getBackupLogsResp" : {
1556
+ "description" : "getBackupLogsResp template definitions",
1557
+ "content" : {
1558
+ "application/json" : {
1559
+ "schema" : {
1560
+ "type" : [ "null", "object" ],
1561
+ "additionalProperties" : false,
1562
+ "properties" : {
1563
+ "data" : {
1564
+ "$ref" : "./Backup.json#/components/schemas/getBackupLogsRespList"
1565
+ }
1566
+ },
1567
+ "required" : [ "data" ]
1568
+ },
1569
+ "examples" : {
1570
+ "Valid responses Definitions" : {
1571
+ "value" : {
1572
+ "data" : [ {
1573
+ "backupId" : "45664000001403809",
1574
+ "eventTime" : 1606820972000,
1575
+ "message" : "Reccuring backup Stopped",
1576
+ "userId" : "45664000002904512",
1577
+ "status" : "STOPPED"
1578
+ }, {
1579
+ "backupId" : "45664000001403809",
1580
+ "eventTime" : 1606820592000,
1581
+ "message" : "A1111_scheduled_weekly_2020-12-01_2020-12-01.zip ready for download",
1582
+ "userId" : "45664000002904512",
1583
+ "status" : "COMPLETED"
1584
+ }, {
1585
+ "backupId" : "45664000001403809",
1586
+ "eventTime" : 1606820570000,
1587
+ "message" : "Weekly Backup scheduled",
1588
+ "userId" : "45664000002904512",
1589
+ "status" : "INPROGRESS"
1590
+ }, {
1591
+ "backupId" : "45664000001403809",
1592
+ "eventTime" : 1606820549000,
1593
+ "message" : "Weekly Backup initiated",
1594
+ "userId" : "45664000002904512",
1595
+ "status" : "INITIATED"
1596
+ } ]
1597
+ }
1598
+ }
1599
+ }
1600
+ }
1601
+ },
1602
+ "x-custom-response-attributes" : {
1603
+ "disable-safe-headers" : "[]"
1604
+ }
1605
+ },
1606
+ "initiateBackupResponse" : {
1607
+ "description" : "initiateBackupResponse template definitions",
1608
+ "content" : {
1609
+ "application/json" : {
1610
+ "schema" : {
1611
+ "oneOf" : [ {
1612
+ "type" : [ "null", "object" ],
1613
+ "additionalProperties" : false,
1614
+ "properties" : {
1615
+ "modifiedAfter" : {
1616
+ "type" : [ "string", "null" ],
1617
+ "maxLength" : 100,
1618
+ "minLength" : 0,
1619
+ "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))",
1620
+ "x-custom-parameters-attributes" : {
1621
+ "removeExif" : false,
1622
+ "filterMatchedContent" : false,
1623
+ "antivirus" : false,
1624
+ "replacementString" : "",
1625
+ "allowInvalid" : false,
1626
+ "descrption" : "Specifies the timestamp after which data modifications are included in the backup.",
1627
+ "secret" : false,
1628
+ "preserveCharsLimit" : 10,
1629
+ "trim" : false,
1630
+ "internalParam" : false,
1631
+ "preserveChars" : "0,5",
1632
+ "importUrl" : false,
1633
+ "decrypt" : false
1634
+ }
1635
+ },
1636
+ "nextBackupDate" : {
1637
+ "type" : [ "string", "null" ],
1638
+ "maxLength" : 100,
1639
+ "minLength" : 0,
1640
+ "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))"
1641
+ },
1642
+ "lastBackupDate" : {
1643
+ "type" : [ "string", "null" ],
1644
+ "maxLength" : 100,
1645
+ "minLength" : 0,
1646
+ "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))"
1647
+ },
1648
+ "endsAfter" : {
1649
+ "type" : [ "null", "object" ],
1650
+ "additionalProperties" : false
1651
+ },
1652
+ "backupId" : {
1653
+ "type" : [ "string", "null", "integer" ],
1654
+ "format" : "int64",
1655
+ "pattern" : "([0-9]+)"
1656
+ },
1657
+ "modifiedTill" : {
1658
+ "type" : [ "string", "null" ],
1659
+ "maxLength" : 100,
1660
+ "minLength" : 0,
1661
+ "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))",
1662
+ "x-custom-parameters-attributes" : {
1663
+ "removeExif" : false,
1664
+ "filterMatchedContent" : false,
1665
+ "antivirus" : false,
1666
+ "replacementString" : "",
1667
+ "allowInvalid" : false,
1668
+ "descrption" : "Specifies the timestamp until which data modifications are included in the backup.",
1669
+ "secret" : false,
1670
+ "preserveCharsLimit" : 10,
1671
+ "trim" : false,
1672
+ "internalParam" : false,
1673
+ "preserveChars" : "0,5",
1674
+ "importUrl" : false,
1675
+ "decrypt" : false
1676
+ }
1677
+ },
1678
+ "modules" : {
1679
+ "type" : [ "null", "array" ],
1680
+ "items" : {
1681
+ "type" : [ "string", "null" ],
1682
+ "enum" : [ "attachments", "comments", "tickets", "contacts", "departments", "agents", "products", "accounts", "tasks", "timeEntry", "solutions", "topics", "teams" ],
1683
+ "maxLength" : 100,
1684
+ "minLength" : 0
1685
+ },
1686
+ "uniqueItems" : false
1687
+ },
1688
+ "status" : {
1689
+ "type" : [ "string", "null" ],
1690
+ "enum" : [ "INITIATED", "IN_PROGRESS", "PARTIALLY_COMPLETED", "COMPLETED", "SUSPENDED" ],
1691
+ "maxLength" : 100,
1692
+ "minLength" : 0
1693
+ },
1694
+ "backupType" : {
1695
+ "type" : [ "string", "null" ],
1696
+ "enum" : [ "FULL", "INCREMENTAL" ],
1697
+ "maxLength" : 100,
1698
+ "minLength" : 0,
1699
+ "x-custom-parameters-attributes" : {
1700
+ "removeExif" : false,
1701
+ "filterMatchedContent" : false,
1702
+ "antivirus" : false,
1703
+ "replacementString" : "",
1704
+ "allowInvalid" : false,
1705
+ "descrption" : "Specifies the type of backup. The allowed values are @INCREMENTAL@ and @FULL@",
1706
+ "secret" : false,
1707
+ "preserveCharsLimit" : 10,
1708
+ "trim" : false,
1709
+ "internalParam" : false,
1710
+ "preserveChars" : "0,5",
1711
+ "importUrl" : false,
1712
+ "decrypt" : false
1713
+ }
1714
+ },
1715
+ "limitPerFile" : {
1716
+ "type" : [ "string", "null", "integer" ],
1717
+ "format" : "int64",
1718
+ "pattern" : "([0-9]+)",
1719
+ "x-custom-parameters-attributes" : {
1720
+ "removeExif" : false,
1721
+ "filterMatchedContent" : false,
1722
+ "antivirus" : false,
1723
+ "replacementString" : "",
1724
+ "allowInvalid" : false,
1725
+ "descrption" : "The maximum number of rows per file.",
1726
+ "secret" : false,
1727
+ "preserveCharsLimit" : 10,
1728
+ "trim" : false,
1729
+ "internalParam" : false,
1730
+ "preserveChars" : "0,5",
1731
+ "importUrl" : false,
1732
+ "decrypt" : false
1733
+ }
1734
+ },
1735
+ "frequency" : {
1736
+ "type" : [ "null", "object" ],
1737
+ "additionalProperties" : false,
1738
+ "maxProperties" : 2,
1739
+ "minProperties" : 2,
1740
+ "properties" : {
1741
+ "repeatsOn" : {
1742
+ "type" : [ "null", "object" ],
1743
+ "additionalProperties" : false,
1744
+ "maxProperties" : 6,
1745
+ "minProperties" : 6,
1746
+ "properties" : {
1747
+ "dates" : {
1748
+ "type" : [ "null", "array" ],
1749
+ "items" : {
1750
+ "type" : [ "string", "null", "integer" ],
1751
+ "format" : "int32",
1752
+ "maximum" : 31,
1753
+ "minimum" : 1,
1754
+ "pattern" : "([0-9]+)"
1755
+ },
1756
+ "uniqueItems" : false
1757
+ },
1758
+ "repetitionType" : {
1759
+ "type" : [ "string", "null" ],
1760
+ "enum" : [ "WEEKLY", "MONTHLY", "YEARLY" ],
1761
+ "maxLength" : 100,
1762
+ "minLength" : 0
1763
+ },
1764
+ "daysOfWeek" : {
1765
+ "type" : [ "null", "array" ],
1766
+ "items" : {
1767
+ "type" : [ "string", "null" ],
1768
+ "enum" : [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ],
1769
+ "maxLength" : 100,
1770
+ "minLength" : 0
1771
+ },
1772
+ "uniqueItems" : false
1773
+ },
1774
+ "skipFrequency" : {
1775
+ "type" : [ "string", "null", "integer" ],
1776
+ "format" : "int32",
1777
+ "maximum" : 2,
1778
+ "minimum" : 1,
1779
+ "pattern" : "([0-9]+)"
1780
+ },
1781
+ "monthsOfYear" : {
1782
+ "type" : [ "null", "array" ],
1783
+ "items" : {
1784
+ "type" : [ "string", "null" ],
1785
+ "enum" : [ "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" ],
1786
+ "maxLength" : 100,
1787
+ "minLength" : 0
1788
+ },
1789
+ "uniqueItems" : false
1790
+ },
1791
+ "weeksOfMonth" : {
1792
+ "type" : [ "string", "null" ],
1793
+ "enum" : [ "FIRST", "SECOND", "THIRD", "FOURTH", "LAST" ],
1794
+ "maxLength" : 100,
1795
+ "minLength" : 0
1796
+ }
1797
+ },
1798
+ "required" : [ "dates", "daysOfWeek", "monthsOfYear", "repetitionType", "skipFrequency", "weeksOfMonth" ]
1799
+ },
1800
+ "type" : {
1801
+ "type" : [ "string", "null" ],
1802
+ "enum" : [ "NONE", "WEEKLY", "MONTHLY", "YEARLY" ],
1803
+ "maxLength" : 100,
1804
+ "minLength" : 0
1805
+ }
1806
+ },
1807
+ "required" : [ "repeatsOn", "type" ]
1808
+ }
1809
+ },
1810
+ "required" : [ "backupId", "backupType", "endsAfter", "frequency", "lastBackupDate", "limitPerFile", "modifiedAfter", "modifiedTill", "modules", "nextBackupDate", "status" ]
1811
+ }, {
1812
+ "type" : [ "null", "object" ],
1813
+ "additionalProperties" : false,
1814
+ "properties" : {
1815
+ "errorMessage" : {
1816
+ "type" : [ "string", "null" ],
1817
+ "enum" : [ "Sync Already in progress" ],
1818
+ "maxLength" : 100,
1819
+ "minLength" : 0
1820
+ }
1821
+ },
1822
+ "required" : [ "errorMessage" ]
1823
+ } ]
1824
+ },
1825
+ "examples" : {
1826
+ "Valid responses Definitions" : {
1827
+ "value" : {
1828
+ "modifiedAfter" : null,
1829
+ "nextBackupDate" : null,
1830
+ "lastBackupDate" : null,
1831
+ "endsAfter" : {
1832
+ "type" : "NONE",
1833
+ "value" : "0"
1834
+ },
1835
+ "backupId" : "45664000001405433",
1836
+ "modifiedTill" : null,
1837
+ "backupFiles" : null,
1838
+ "modules" : [ "tickets", "contacts" ],
1839
+ "backupType" : "FULL",
1840
+ "limitPerFile" : null,
1841
+ "status" : "INITIATED",
1842
+ "frequency" : {
1843
+ "repeatsOn" : null,
1844
+ "type" : "NONE"
1845
+ }
1846
+ }
1847
+ }
1848
+ }
1849
+ }
1850
+ },
1851
+ "x-custom-response-attributes" : {
1852
+ "disable-safe-headers" : "[]"
1853
+ }
1854
+ },
1855
+ "updateBackupResponse" : {
1856
+ "description" : "updateBackupResponse template definitions",
1857
+ "content" : {
1858
+ "application/json" : {
1859
+ "schema" : {
1860
+ "oneOf" : [ {
1861
+ "type" : [ "null", "object" ],
1862
+ "additionalProperties" : false,
1863
+ "properties" : {
1864
+ "modifiedAfter" : {
1865
+ "type" : [ "string", "null" ],
1866
+ "maxLength" : 100,
1867
+ "minLength" : 0,
1868
+ "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))",
1869
+ "x-custom-parameters-attributes" : {
1870
+ "removeExif" : false,
1871
+ "filterMatchedContent" : false,
1872
+ "antivirus" : false,
1873
+ "replacementString" : "",
1874
+ "allowInvalid" : false,
1875
+ "descrption" : "Specifies the timestamp after which data modifications are included in the backup.",
1876
+ "secret" : false,
1877
+ "preserveCharsLimit" : 10,
1878
+ "trim" : false,
1879
+ "internalParam" : false,
1880
+ "preserveChars" : "0,5",
1881
+ "importUrl" : false,
1882
+ "decrypt" : false
1883
+ }
1884
+ },
1885
+ "nextBackupDate" : {
1886
+ "type" : [ "string", "null" ],
1887
+ "maxLength" : 100,
1888
+ "minLength" : 0,
1889
+ "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))"
1890
+ },
1891
+ "lastBackupDate" : {
1892
+ "type" : [ "string", "null" ],
1893
+ "maxLength" : 100,
1894
+ "minLength" : 0,
1895
+ "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))"
1896
+ },
1897
+ "endsAfter" : {
1898
+ "type" : [ "null", "object" ],
1899
+ "additionalProperties" : false
1900
+ },
1901
+ "backupId" : {
1902
+ "type" : [ "string", "null", "integer" ],
1903
+ "format" : "int64",
1904
+ "pattern" : "([0-9]+)"
1905
+ },
1906
+ "modifiedTill" : {
1907
+ "type" : [ "string", "null" ],
1908
+ "maxLength" : 100,
1909
+ "minLength" : 0,
1910
+ "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))",
1911
+ "x-custom-parameters-attributes" : {
1912
+ "removeExif" : false,
1913
+ "filterMatchedContent" : false,
1914
+ "antivirus" : false,
1915
+ "replacementString" : "",
1916
+ "allowInvalid" : false,
1917
+ "descrption" : "Specifies the timestamp until which data modifications are included in the backup.",
1918
+ "secret" : false,
1919
+ "preserveCharsLimit" : 10,
1920
+ "trim" : false,
1921
+ "internalParam" : false,
1922
+ "preserveChars" : "0,5",
1923
+ "importUrl" : false,
1924
+ "decrypt" : false
1925
+ }
1926
+ },
1927
+ "modules" : {
1928
+ "type" : [ "null", "array" ],
1929
+ "items" : {
1930
+ "type" : [ "string", "null" ],
1931
+ "enum" : [ "attachments", "comments", "tickets", "contacts", "departments", "agents", "products", "accounts", "tasks", "timeEntry", "solutions", "topics", "teams" ],
1932
+ "maxLength" : 100,
1933
+ "minLength" : 0
1934
+ },
1935
+ "uniqueItems" : false
1936
+ },
1937
+ "status" : {
1938
+ "type" : [ "string", "null" ],
1939
+ "enum" : [ "INITIATED", "IN_PROGRESS", "PARTIALLY_COMPLETED", "COMPLETED", "SUSPENDED" ],
1940
+ "maxLength" : 100,
1941
+ "minLength" : 0
1942
+ },
1943
+ "backupType" : {
1944
+ "type" : [ "string", "null" ],
1945
+ "enum" : [ "FULL", "INCREMENTAL" ],
1946
+ "maxLength" : 100,
1947
+ "minLength" : 0,
1948
+ "x-custom-parameters-attributes" : {
1949
+ "removeExif" : false,
1950
+ "filterMatchedContent" : false,
1951
+ "antivirus" : false,
1952
+ "replacementString" : "",
1953
+ "allowInvalid" : false,
1954
+ "descrption" : "Specifies the type of backup. The allowed values are @INCREMENTAL@ and @FULL@",
1955
+ "secret" : false,
1956
+ "preserveCharsLimit" : 10,
1957
+ "trim" : false,
1958
+ "internalParam" : false,
1959
+ "preserveChars" : "0,5",
1960
+ "importUrl" : false,
1961
+ "decrypt" : false
1962
+ }
1963
+ },
1964
+ "limitPerFile" : {
1965
+ "type" : [ "string", "null", "integer" ],
1966
+ "format" : "int64",
1967
+ "pattern" : "([0-9]+)",
1968
+ "x-custom-parameters-attributes" : {
1969
+ "removeExif" : false,
1970
+ "filterMatchedContent" : false,
1971
+ "antivirus" : false,
1972
+ "replacementString" : "",
1973
+ "allowInvalid" : false,
1974
+ "descrption" : "The maximum number of rows per file.",
1975
+ "secret" : false,
1976
+ "preserveCharsLimit" : 10,
1977
+ "trim" : false,
1978
+ "internalParam" : false,
1979
+ "preserveChars" : "0,5",
1980
+ "importUrl" : false,
1981
+ "decrypt" : false
1982
+ }
1983
+ },
1984
+ "frequency" : {
1985
+ "type" : [ "null", "object" ],
1986
+ "additionalProperties" : false,
1987
+ "maxProperties" : 2,
1988
+ "minProperties" : 2,
1989
+ "properties" : {
1990
+ "repeatsOn" : {
1991
+ "type" : [ "null", "object" ],
1992
+ "additionalProperties" : false,
1993
+ "maxProperties" : 6,
1994
+ "minProperties" : 6,
1995
+ "properties" : {
1996
+ "dates" : {
1997
+ "type" : [ "null", "array" ],
1998
+ "items" : {
1999
+ "type" : [ "string", "null", "integer" ],
2000
+ "format" : "int32",
2001
+ "maximum" : 31,
2002
+ "minimum" : 1,
2003
+ "pattern" : "([0-9]+)"
2004
+ },
2005
+ "uniqueItems" : false
2006
+ },
2007
+ "repetitionType" : {
2008
+ "type" : [ "string", "null" ],
2009
+ "enum" : [ "WEEKLY", "MONTHLY", "YEARLY" ],
2010
+ "maxLength" : 100,
2011
+ "minLength" : 0
2012
+ },
2013
+ "daysOfWeek" : {
2014
+ "type" : [ "null", "array" ],
2015
+ "items" : {
2016
+ "type" : [ "string", "null" ],
2017
+ "enum" : [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ],
2018
+ "maxLength" : 100,
2019
+ "minLength" : 0
2020
+ },
2021
+ "uniqueItems" : false
2022
+ },
2023
+ "skipFrequency" : {
2024
+ "type" : [ "string", "null", "integer" ],
2025
+ "format" : "int32",
2026
+ "maximum" : 2,
2027
+ "minimum" : 1,
2028
+ "pattern" : "([0-9]+)"
2029
+ },
2030
+ "monthsOfYear" : {
2031
+ "type" : [ "null", "array" ],
2032
+ "items" : {
2033
+ "type" : [ "string", "null" ],
2034
+ "enum" : [ "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" ],
2035
+ "maxLength" : 100,
2036
+ "minLength" : 0
2037
+ },
2038
+ "uniqueItems" : false
2039
+ },
2040
+ "weeksOfMonth" : {
2041
+ "type" : [ "string", "null" ],
2042
+ "enum" : [ "FIRST", "SECOND", "THIRD", "FOURTH", "LAST" ],
2043
+ "maxLength" : 100,
2044
+ "minLength" : 0
2045
+ }
2046
+ },
2047
+ "required" : [ "dates", "daysOfWeek", "monthsOfYear", "repetitionType", "skipFrequency", "weeksOfMonth" ]
2048
+ },
2049
+ "type" : {
2050
+ "type" : [ "string", "null" ],
2051
+ "enum" : [ "NONE", "WEEKLY", "MONTHLY", "YEARLY" ],
2052
+ "maxLength" : 100,
2053
+ "minLength" : 0
2054
+ }
2055
+ },
2056
+ "required" : [ "repeatsOn", "type" ]
2057
+ }
2058
+ },
2059
+ "required" : [ "backupId", "backupType", "endsAfter", "frequency", "lastBackupDate", "limitPerFile", "modifiedAfter", "modifiedTill", "modules", "nextBackupDate", "status" ]
2060
+ }, {
2061
+ "type" : [ "null", "object" ],
2062
+ "additionalProperties" : false,
2063
+ "properties" : {
2064
+ "errorMessage" : {
2065
+ "type" : [ "string", "null" ],
2066
+ "enum" : [ "Sync Already in progress" ],
2067
+ "maxLength" : 100,
2068
+ "minLength" : 0
2069
+ }
2070
+ },
2071
+ "required" : [ "errorMessage" ]
2072
+ } ]
2073
+ },
2074
+ "examples" : {
2075
+ "Valid responses Definitions" : {
2076
+ "value" : {
2077
+ "modifiedAfter" : null,
2078
+ "nextBackupDate" : 1606821513464,
2079
+ "lastBackupDate" : null,
2080
+ "endsAfter" : {
2081
+ "type" : "NONE",
2082
+ "value" : "0"
2083
+ },
2084
+ "backupId" : "45664000001404617",
2085
+ "modifiedTill" : null,
2086
+ "backupFiles" : null,
2087
+ "modules" : [ "tickets", "contacts" ],
2088
+ "backupType" : "INCREMENTAL",
2089
+ "limitPerFile" : null,
2090
+ "status" : "INITIATED",
2091
+ "frequency" : {
2092
+ "repeatsOn" : {
2093
+ "dates" : null,
2094
+ "repetitionType" : "WEEKLY",
2095
+ "daysOfWeek" : [ "Sunday" ],
2096
+ "skipFrequency" : "2",
2097
+ "monthsOfYear" : null,
2098
+ "weeksOfMonth" : null
2099
+ },
2100
+ "type" : "WEEKLY"
2101
+ }
2102
+ }
2103
+ }
2104
+ }
2105
+ }
2106
+ },
2107
+ "x-custom-response-attributes" : {
2108
+ "disable-safe-headers" : "[]"
2109
+ }
2110
+ },
2111
+ "GetAllExport" : {
2112
+ "description" : "GetAllExport template definitions",
2113
+ "content" : {
2114
+ "application/json" : {
2115
+ "schema" : {
2116
+ "type" : [ "null", "object" ],
2117
+ "additionalProperties" : false,
2118
+ "properties" : {
2119
+ "data" : {
2120
+ "$ref" : "./Backup.json#/components/schemas/exportArray"
2121
+ }
2122
+ },
2123
+ "required" : [ "data" ]
2124
+ },
2125
+ "examples" : {
2126
+ "Valid responses Definitions" : {
2127
+ "value" : {
2128
+ "data" : [ {
2129
+ "creator" : {
2130
+ "photoURL" : "https://desk.zoho.com/api/v1/agents/12000000000521/photo?orgId=26825991",
2131
+ "firstName" : "",
2132
+ "lastName" : "chan",
2133
+ "name" : "chan",
2134
+ "id" : "12000000000521"
2135
+ },
2136
+ "completedTime" : 1733654126000,
2137
+ "filePath" : "Expired",
2138
+ "module" : {
2139
+ "apiName" : "tickets",
2140
+ "isCustomModule" : false,
2141
+ "isDeptSpecific" : true,
2142
+ "id" : "12000000000581",
2143
+ "pluralLabel" : "Tickets",
2144
+ "singularLabel" : "Ticket"
2145
+ },
2146
+ "initiatedTime" : 1733654038000,
2147
+ "expiryTime" : 1724258854507,
2148
+ "count" : "187",
2149
+ "exportId" : "12000000109001",
2150
+ "initiatedBy" : "12000000000521",
2151
+ "status" : "COMPLETED"
2152
+ } ]
2153
+ }
2154
+ }
2155
+ }
2156
+ }
2157
+ },
2158
+ "x-custom-response-attributes" : {
2159
+ "disable-safe-headers" : "[]"
2160
+ }
2161
+ },
2162
+ "getBackupRespObject" : {
2163
+ "description" : "getBackupRespObject template definitions",
2164
+ "content" : {
2165
+ "application/json" : {
2166
+ "schema" : {
2167
+ "type" : [ "null", "object" ],
2168
+ "additionalProperties" : false,
2169
+ "properties" : {
2170
+ "modifiedAfter" : {
2171
+ "type" : [ "string", "null" ],
2172
+ "maxLength" : 100,
2173
+ "minLength" : 0,
2174
+ "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))"
2175
+ },
2176
+ "nextBackupDate" : {
2177
+ "type" : [ "string", "null" ],
2178
+ "maxLength" : 100,
2179
+ "minLength" : 0,
2180
+ "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))"
2181
+ },
2182
+ "lastBackupDate" : {
2183
+ "type" : [ "string", "null" ],
2184
+ "maxLength" : 100,
2185
+ "minLength" : 0,
2186
+ "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))"
2187
+ },
2188
+ "endsAfter" : {
2189
+ "type" : [ "null", "object" ],
2190
+ "additionalProperties" : false
2191
+ },
2192
+ "backupId" : {
2193
+ "type" : [ "string", "null", "integer" ],
2194
+ "format" : "int64",
2195
+ "pattern" : "([0-9]+)"
2196
+ },
2197
+ "modifiedTill" : {
2198
+ "type" : [ "string", "null" ],
2199
+ "maxLength" : 100,
2200
+ "minLength" : 0,
2201
+ "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))"
2202
+ },
2203
+ "modules" : {
2204
+ "type" : [ "null", "array" ],
2205
+ "items" : {
2206
+ "type" : [ "string", "null" ],
2207
+ "enum" : [ "attachments", "comments", "tickets", "contacts", "departments", "agents", "products", "accounts", "tasks", "timeEntry", "solutions", "topics", "teams" ],
2208
+ "maxLength" : 100,
2209
+ "minLength" : 0
2210
+ },
2211
+ "uniqueItems" : false
2212
+ },
2213
+ "status" : {
2214
+ "type" : [ "string", "null" ],
2215
+ "enum" : [ "INITIATED", "IN_PROGRESS", "PARTIALLY_COMPLETED", "COMPLETED", "SUSPENDED" ],
2216
+ "maxLength" : 100,
2217
+ "minLength" : 0
2218
+ },
2219
+ "backupType" : {
2220
+ "type" : [ "string", "null" ],
2221
+ "enum" : [ "FULL", "INCREMENTAL" ],
2222
+ "maxLength" : 100,
2223
+ "minLength" : 0
2224
+ },
2225
+ "limitPerFile" : {
2226
+ "type" : [ "string", "null", "integer" ],
2227
+ "format" : "int64",
2228
+ "pattern" : "([0-9]+)"
2229
+ },
2230
+ "frequency" : {
2231
+ "type" : [ "null", "object" ],
2232
+ "additionalProperties" : false,
2233
+ "maxProperties" : 2,
2234
+ "minProperties" : 2,
2235
+ "properties" : {
2236
+ "repeatsOn" : {
2237
+ "type" : [ "null", "object" ],
2238
+ "additionalProperties" : false,
2239
+ "maxProperties" : 6,
2240
+ "minProperties" : 6,
2241
+ "properties" : {
2242
+ "dates" : {
2243
+ "type" : [ "null", "array" ],
2244
+ "items" : {
2245
+ "type" : [ "string", "null", "integer" ],
2246
+ "format" : "int32",
2247
+ "maximum" : 31,
2248
+ "minimum" : 1,
2249
+ "pattern" : "([0-9]+)"
2250
+ },
2251
+ "uniqueItems" : false
2252
+ },
2253
+ "repetitionType" : {
2254
+ "type" : [ "string", "null" ],
2255
+ "enum" : [ "WEEKLY", "MONTHLY", "YEARLY" ],
2256
+ "maxLength" : 100,
2257
+ "minLength" : 0
2258
+ },
2259
+ "daysOfWeek" : {
2260
+ "type" : [ "null", "array" ],
2261
+ "items" : {
2262
+ "type" : [ "string", "null" ],
2263
+ "enum" : [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ],
2264
+ "maxLength" : 100,
2265
+ "minLength" : 0
2266
+ },
2267
+ "uniqueItems" : false
2268
+ },
2269
+ "skipFrequency" : {
2270
+ "type" : [ "string", "null", "integer" ],
2271
+ "format" : "int32",
2272
+ "maximum" : 2,
2273
+ "minimum" : 1,
2274
+ "pattern" : "([0-9]+)"
2275
+ },
2276
+ "monthsOfYear" : {
2277
+ "type" : [ "null", "array" ],
2278
+ "items" : {
2279
+ "type" : [ "string", "null" ],
2280
+ "enum" : [ "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" ],
2281
+ "maxLength" : 100,
2282
+ "minLength" : 0
2283
+ },
2284
+ "uniqueItems" : false
2285
+ },
2286
+ "weeksOfMonth" : {
2287
+ "type" : [ "string", "null" ],
2288
+ "enum" : [ "FIRST", "SECOND", "THIRD", "FOURTH", "LAST" ],
2289
+ "maxLength" : 100,
2290
+ "minLength" : 0
2291
+ }
2292
+ },
2293
+ "required" : [ "dates", "daysOfWeek", "monthsOfYear", "repetitionType", "skipFrequency", "weeksOfMonth" ]
2294
+ },
2295
+ "type" : {
2296
+ "type" : [ "string", "null" ],
2297
+ "enum" : [ "NONE", "WEEKLY", "MONTHLY", "YEARLY" ],
2298
+ "maxLength" : 100,
2299
+ "minLength" : 0
2300
+ }
2301
+ },
2302
+ "required" : [ "repeatsOn", "type" ]
2303
+ }
2304
+ },
2305
+ "required" : [ "backupId", "backupType", "endsAfter", "frequency", "lastBackupDate", "limitPerFile", "modifiedAfter", "modifiedTill", "modules", "nextBackupDate", "status" ]
2306
+ },
2307
+ "examples" : {
2308
+ "Valid responses Definitions" : {
2309
+ "value" : {
2310
+ "nextBackupDate" : "SCHEDULEENDED",
2311
+ "lastBackupDate" : 1606820569000,
2312
+ "backupId" : "45664000001403809",
2313
+ "modifiedTill" : null,
2314
+ "notificationType" : "mail",
2315
+ "backupFiles" : [ ],
2316
+ "modules" : [ "tickets", "contacts" ],
2317
+ "backupType" : "INCREMENTAL",
2318
+ "limitPerFile" : null,
2319
+ "frequency" : {
2320
+ "repeatsOn" : {
2321
+ "dates" : null,
2322
+ "repetitionType" : "WEEKLY",
2323
+ "daysOfWeek" : [ "Sunday" ],
2324
+ "skipFrequency" : "1",
2325
+ "monthsOfYear" : null,
2326
+ "weeksOfMonth" : null
2327
+ },
2328
+ "type" : "WEEKLY"
2329
+ },
2330
+ "modifiedAfter" : null,
2331
+ "endsAfter" : {
2332
+ "type" : "NONE",
2333
+ "value" : "0"
2334
+ },
2335
+ "status" : "STOPPED"
2336
+ }
2337
+ }
2338
+ }
2339
+ }
2340
+ },
2341
+ "x-custom-response-attributes" : {
2342
+ "disable-safe-headers" : "[]"
2343
+ }
2344
+ }
2345
+ },
2346
+ "parameters" : {
2347
+ "backupId" : {
2348
+ "name" : "backupId",
2349
+ "in" : "path",
2350
+ "required" : true,
2351
+ "style" : "simple",
2352
+ "explode" : false,
2353
+ "schema" : {
2354
+ "type" : [ "string", "null", "integer" ],
2355
+ "format" : "int64",
2356
+ "pattern" : "([0-9]+)"
2357
+ }
2358
+ },
2359
+ "limit" : {
2360
+ "name" : "limit",
2361
+ "in" : "query",
2362
+ "description" : "Number of record limit to fetch",
2363
+ "required" : false,
2364
+ "style" : "form",
2365
+ "explode" : true,
2366
+ "schema" : {
2367
+ "type" : [ "string", "null", "integer" ],
2368
+ "format" : "int32",
2369
+ "description" : "Number of record limit to fetch",
2370
+ "maximum" : 50,
2371
+ "minimum" : 1,
2372
+ "pattern" : "([0-9]+)"
2373
+ }
2374
+ },
2375
+ "from" : {
2376
+ "name" : "from",
2377
+ "in" : "query",
2378
+ "description" : "Starting point of the record",
2379
+ "required" : true,
2380
+ "style" : "form",
2381
+ "explode" : true,
2382
+ "schema" : {
2383
+ "type" : [ "string", "null", "integer" ],
2384
+ "format" : "int32",
2385
+ "description" : "Starting point of the record",
2386
+ "pattern" : "([0-9]+)"
2387
+ }
2388
+ },
2389
+ "exportId" : {
2390
+ "name" : "exportId",
2391
+ "in" : "path",
2392
+ "description" : "the id of the export which was initiated for first time",
2393
+ "required" : true,
2394
+ "style" : "simple",
2395
+ "explode" : false,
2396
+ "schema" : {
2397
+ "type" : [ "string", "null", "integer" ],
2398
+ "format" : "int64",
2399
+ "description" : "the id of the export which was initiated for first time",
2400
+ "pattern" : "([0-9]+)"
2401
+ }
2402
+ },
2403
+ "status" : {
2404
+ "name" : "status",
2405
+ "in" : "query",
2406
+ "description" : "Status of the backup",
2407
+ "required" : true,
2408
+ "style" : "form",
2409
+ "explode" : true,
2410
+ "schema" : {
2411
+ "type" : [ "string", "null" ],
2412
+ "description" : "Status of the backup",
2413
+ "enum" : [ "ACTIVE" ],
2414
+ "maxLength" : 100,
2415
+ "minLength" : 0
2416
+ }
2417
+ }
2418
+ },
2419
+ "requestBodies" : {
2420
+ "getExportReqpObj" : {
2421
+ "content" : {
2422
+ "application/json" : {
2423
+ "schema" : {
2424
+ "type" : [ "null", "object" ],
2425
+ "additionalProperties" : false,
2426
+ "properties" : {
2427
+ "modifiedAfter" : {
2428
+ "type" : [ "string", "null" ],
2429
+ "maxLength" : 100,
2430
+ "minLength" : 0,
2431
+ "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))"
2432
+ },
2433
+ "exportTimeFilter" : {
2434
+ "type" : [ "null", "object" ],
2435
+ "additionalProperties" : false,
2436
+ "maxProperties" : 4,
2437
+ "minProperties" : 4,
2438
+ "properties" : {
2439
+ "duration" : {
2440
+ "type" : [ "string", "null" ],
2441
+ "maxLength" : 100,
2442
+ "minLength" : 0
2443
+ },
2444
+ "endDate" : {
2445
+ "type" : [ "string", "null" ],
2446
+ "maxLength" : 100,
2447
+ "minLength" : 0
2448
+ },
2449
+ "filterField" : {
2450
+ "type" : [ "string", "null" ],
2451
+ "maxLength" : 100,
2452
+ "minLength" : 0
2453
+ },
2454
+ "startDate" : {
2455
+ "type" : [ "string", "null" ],
2456
+ "maxLength" : 100,
2457
+ "minLength" : 0
2458
+ }
2459
+ },
2460
+ "required" : [ "duration", "endDate", "filterField", "startDate" ]
2461
+ },
2462
+ "callBackUrl" : {
2463
+ "type" : [ "string", "null" ],
2464
+ "maxLength" : 100,
2465
+ "minLength" : 0,
2466
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
2467
+ },
2468
+ "apiNameAsHeader" : {
2469
+ "type" : [ "boolean", "null" ]
2470
+ },
2471
+ "criteria" : {
2472
+ "$ref" : "./Backup.json#/components/schemas/criteriaObject"
2473
+ },
2474
+ "module" : {
2475
+ "type" : [ "string", "null" ],
2476
+ "enum" : [ "tickets", "contacts", "departments", "agents", "products", "accounts", "tasks", "timeEntry", "solutions", "topics", "teams", "comments", "attachments", "calls", "events" ],
2477
+ "maxLength" : 100,
2478
+ "minLength" : 0
2479
+ },
2480
+ "fields" : {
2481
+ "type" : [ "null", "array" ],
2482
+ "items" : {
2483
+ "type" : [ "string", "null" ],
2484
+ "maxLength" : 100,
2485
+ "minLength" : 0
2486
+ },
2487
+ "minItems" : 1,
2488
+ "uniqueItems" : false
2489
+ },
2490
+ "limitPerFile" : {
2491
+ "type" : [ "string", "null", "integer" ],
2492
+ "format" : "int64",
2493
+ "pattern" : "([0-9]+)"
2494
+ }
2495
+ },
2496
+ "required" : [ "module" ]
2497
+ },
2498
+ "examples" : {
2499
+ "Valid requestBody Definitions" : {
2500
+ "value" : {
2501
+ "modifiedAfter" : 1557166837733,
2502
+ "exportTimeFilter" : {
2503
+ "duration" : "CUSTOM_IN_DATE",
2504
+ "endDate" : "06-06-2024",
2505
+ "filterField" : "4000000250354",
2506
+ "startDate" : "06-05-2024"
2507
+ },
2508
+ "callBackUrl" : "https://webhook.site/c57564f2-f262-4092-adc4-7c416d401d50",
2509
+ "viewId" : "5000000031695",
2510
+ "criteria" : {
2511
+ "criteriaFields" : [ {
2512
+ "condition" : "is",
2513
+ "field" : {
2514
+ "apiName" : "contactId",
2515
+ "module" : "tickets",
2516
+ "fieldLabel" : "Contact Name"
2517
+ },
2518
+ "value" : {
2519
+ "primitive" : [ {
2520
+ "key" : "13735000002029311"
2521
+ } ],
2522
+ "type" : "primitive"
2523
+ }
2524
+ }, {
2525
+ "condition" : "is not empty",
2526
+ "field" : {
2527
+ "apiName" : "contactId",
2528
+ "module" : "tickets",
2529
+ "fieldLabel" : "Contact Name"
2530
+ },
2531
+ "value" : {
2532
+ "primitive" : [ ],
2533
+ "type" : "primitive"
2534
+ }
2535
+ }, {
2536
+ "condition" : "is CLOSED",
2537
+ "field" : {
2538
+ "apiName" : "status",
2539
+ "module" : "tickets",
2540
+ "fieldLabel" : "Status"
2541
+ },
2542
+ "value" : {
2543
+ "primitive" : [ ],
2544
+ "type" : "primitive"
2545
+ }
2546
+ } ],
2547
+ "criteriaPattern" : "((1and2)and3)"
2548
+ },
2549
+ "module" : "tickets",
2550
+ "departmentId" : "5000000031695",
2551
+ "fields" : [ "email", "subject", "status", "isSpam" ]
2552
+ }
2553
+ }
2554
+ }
2555
+ }
2556
+ },
2557
+ "x-custom-request-body-attributes" : {
2558
+ "non-empty" : false,
2559
+ "allow-invalid" : false
2560
+ }
2561
+ },
2562
+ "getBackupReqObject" : {
2563
+ "content" : {
2564
+ "application/json" : {
2565
+ "schema" : {
2566
+ "type" : [ "null", "object" ],
2567
+ "additionalProperties" : false,
2568
+ "properties" : {
2569
+ "modifiedAfter" : {
2570
+ "type" : [ "string", "null" ],
2571
+ "maxLength" : 100,
2572
+ "minLength" : 0,
2573
+ "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))"
2574
+ },
2575
+ "endsAfter" : {
2576
+ "type" : [ "null", "object" ],
2577
+ "additionalProperties" : false
2578
+ },
2579
+ "modifiedTill" : {
2580
+ "type" : [ "string", "null" ],
2581
+ "maxLength" : 100,
2582
+ "minLength" : 0,
2583
+ "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))"
2584
+ },
2585
+ "modules" : {
2586
+ "type" : [ "null", "array" ],
2587
+ "items" : {
2588
+ "type" : [ "string", "null" ],
2589
+ "enum" : [ "attachments", "comments", "tickets", "contacts", "departments", "agents", "products", "accounts", "tasks", "timeEntry", "solutions", "topics", "teams" ],
2590
+ "maxLength" : 100,
2591
+ "minLength" : 0
2592
+ },
2593
+ "uniqueItems" : false
2594
+ },
2595
+ "backupType" : {
2596
+ "type" : [ "string", "null" ],
2597
+ "enum" : [ "FULL", "INCREMENTAL" ],
2598
+ "maxLength" : 100,
2599
+ "minLength" : 0
2600
+ },
2601
+ "limitPerFile" : {
2602
+ "type" : [ "string", "null", "integer" ],
2603
+ "format" : "int64",
2604
+ "pattern" : "([0-9]+)"
2605
+ },
2606
+ "frequency" : {
2607
+ "type" : [ "null", "object" ],
2608
+ "additionalProperties" : false,
2609
+ "maxProperties" : 2,
2610
+ "minProperties" : 2,
2611
+ "properties" : {
2612
+ "repeatsOn" : {
2613
+ "type" : [ "null", "object" ],
2614
+ "additionalProperties" : false,
2615
+ "maxProperties" : 6,
2616
+ "minProperties" : 6,
2617
+ "properties" : {
2618
+ "dates" : {
2619
+ "type" : [ "null", "array" ],
2620
+ "items" : {
2621
+ "type" : [ "string", "null", "integer" ],
2622
+ "format" : "int32",
2623
+ "maximum" : 31,
2624
+ "minimum" : 1,
2625
+ "pattern" : "([0-9]+)"
2626
+ },
2627
+ "uniqueItems" : false
2628
+ },
2629
+ "repetitionType" : {
2630
+ "type" : [ "string", "null" ],
2631
+ "enum" : [ "WEEKLY", "MONTHLY", "YEARLY" ],
2632
+ "maxLength" : 100,
2633
+ "minLength" : 0
2634
+ },
2635
+ "daysOfWeek" : {
2636
+ "type" : [ "null", "array" ],
2637
+ "items" : {
2638
+ "type" : [ "string", "null" ],
2639
+ "enum" : [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ],
2640
+ "maxLength" : 100,
2641
+ "minLength" : 0
2642
+ },
2643
+ "uniqueItems" : false
2644
+ },
2645
+ "skipFrequency" : {
2646
+ "type" : [ "string", "null", "integer" ],
2647
+ "format" : "int32",
2648
+ "maximum" : 2,
2649
+ "minimum" : 1,
2650
+ "pattern" : "([0-9]+)"
2651
+ },
2652
+ "monthsOfYear" : {
2653
+ "type" : [ "null", "array" ],
2654
+ "items" : {
2655
+ "type" : [ "string", "null" ],
2656
+ "enum" : [ "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" ],
2657
+ "maxLength" : 100,
2658
+ "minLength" : 0
2659
+ },
2660
+ "uniqueItems" : false
2661
+ },
2662
+ "weeksOfMonth" : {
2663
+ "type" : [ "string", "null" ],
2664
+ "enum" : [ "FIRST", "SECOND", "THIRD", "FOURTH", "LAST" ],
2665
+ "maxLength" : 100,
2666
+ "minLength" : 0
2667
+ }
2668
+ },
2669
+ "required" : [ "dates", "daysOfWeek", "monthsOfYear", "repetitionType", "skipFrequency", "weeksOfMonth" ]
2670
+ },
2671
+ "type" : {
2672
+ "type" : [ "string", "null" ],
2673
+ "enum" : [ "NONE", "WEEKLY", "MONTHLY", "YEARLY" ],
2674
+ "maxLength" : 100,
2675
+ "minLength" : 0
2676
+ }
2677
+ },
2678
+ "required" : [ "repeatsOn", "type" ]
2679
+ }
2680
+ },
2681
+ "required" : [ "modules" ]
2682
+ },
2683
+ "examples" : {
2684
+ "Valid requestBody Definitions" : {
2685
+ "value" : {
2686
+ "modules" : [ "tickets", "contacts" ],
2687
+ "backupType" : "FULL"
2688
+ }
2689
+ }
2690
+ }
2691
+ }
2692
+ },
2693
+ "x-custom-request-body-attributes" : {
2694
+ "non-empty" : false,
2695
+ "allow-invalid" : false
2696
+ }
2697
+ },
2698
+ "updateBackup_getBackupReqObject" : {
2699
+ "content" : {
2700
+ "application/json" : {
2701
+ "schema" : {
2702
+ "type" : [ "null", "object" ],
2703
+ "additionalProperties" : false,
2704
+ "properties" : {
2705
+ "modifiedAfter" : {
2706
+ "type" : [ "string", "null" ],
2707
+ "maxLength" : 100,
2708
+ "minLength" : 0,
2709
+ "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))"
2710
+ },
2711
+ "endsAfter" : {
2712
+ "type" : [ "null", "object" ],
2713
+ "additionalProperties" : false
2714
+ },
2715
+ "modifiedTill" : {
2716
+ "type" : [ "string", "null" ],
2717
+ "maxLength" : 100,
2718
+ "minLength" : 0,
2719
+ "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))"
2720
+ },
2721
+ "modules" : {
2722
+ "type" : [ "null", "array" ],
2723
+ "items" : {
2724
+ "type" : [ "string", "null" ],
2725
+ "enum" : [ "attachments", "comments", "tickets", "contacts", "departments", "agents", "products", "accounts", "tasks", "timeEntry", "solutions", "topics", "teams" ],
2726
+ "maxLength" : 100,
2727
+ "minLength" : 0
2728
+ },
2729
+ "uniqueItems" : false
2730
+ },
2731
+ "backupType" : {
2732
+ "type" : [ "string", "null" ],
2733
+ "enum" : [ "FULL", "INCREMENTAL" ],
2734
+ "maxLength" : 100,
2735
+ "minLength" : 0
2736
+ },
2737
+ "limitPerFile" : {
2738
+ "type" : [ "string", "null", "integer" ],
2739
+ "format" : "int64",
2740
+ "pattern" : "([0-9]+)"
2741
+ },
2742
+ "frequency" : {
2743
+ "type" : [ "null", "object" ],
2744
+ "additionalProperties" : false,
2745
+ "maxProperties" : 2,
2746
+ "minProperties" : 2,
2747
+ "properties" : {
2748
+ "repeatsOn" : {
2749
+ "type" : [ "null", "object" ],
2750
+ "additionalProperties" : false,
2751
+ "maxProperties" : 6,
2752
+ "minProperties" : 6,
2753
+ "properties" : {
2754
+ "dates" : {
2755
+ "type" : [ "null", "array" ],
2756
+ "items" : {
2757
+ "type" : [ "string", "null", "integer" ],
2758
+ "format" : "int32",
2759
+ "maximum" : 31,
2760
+ "minimum" : 1,
2761
+ "pattern" : "([0-9]+)"
2762
+ },
2763
+ "uniqueItems" : false
2764
+ },
2765
+ "repetitionType" : {
2766
+ "type" : [ "string", "null" ],
2767
+ "enum" : [ "WEEKLY", "MONTHLY", "YEARLY" ],
2768
+ "maxLength" : 100,
2769
+ "minLength" : 0
2770
+ },
2771
+ "daysOfWeek" : {
2772
+ "type" : [ "null", "array" ],
2773
+ "items" : {
2774
+ "type" : [ "string", "null" ],
2775
+ "enum" : [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ],
2776
+ "maxLength" : 100,
2777
+ "minLength" : 0
2778
+ },
2779
+ "uniqueItems" : false
2780
+ },
2781
+ "skipFrequency" : {
2782
+ "type" : [ "string", "null", "integer" ],
2783
+ "format" : "int32",
2784
+ "maximum" : 2,
2785
+ "minimum" : 1,
2786
+ "pattern" : "([0-9]+)"
2787
+ },
2788
+ "monthsOfYear" : {
2789
+ "type" : [ "null", "array" ],
2790
+ "items" : {
2791
+ "type" : [ "string", "null" ],
2792
+ "enum" : [ "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" ],
2793
+ "maxLength" : 100,
2794
+ "minLength" : 0
2795
+ },
2796
+ "uniqueItems" : false
2797
+ },
2798
+ "weeksOfMonth" : {
2799
+ "type" : [ "string", "null" ],
2800
+ "enum" : [ "FIRST", "SECOND", "THIRD", "FOURTH", "LAST" ],
2801
+ "maxLength" : 100,
2802
+ "minLength" : 0
2803
+ }
2804
+ },
2805
+ "required" : [ "dates", "daysOfWeek", "monthsOfYear", "repetitionType", "skipFrequency", "weeksOfMonth" ]
2806
+ },
2807
+ "type" : {
2808
+ "type" : [ "string", "null" ],
2809
+ "enum" : [ "NONE", "WEEKLY", "MONTHLY", "YEARLY" ],
2810
+ "maxLength" : 100,
2811
+ "minLength" : 0
2812
+ }
2813
+ },
2814
+ "required" : [ "repeatsOn", "type" ]
2815
+ }
2816
+ },
2817
+ "required" : [ "frequency" ]
2818
+ },
2819
+ "examples" : {
2820
+ "Valid requestBody Definitions" : {
2821
+ "value" : null
2822
+ }
2823
+ }
2824
+ }
2825
+ },
2826
+ "x-custom-request-body-attributes" : {
2827
+ "non-empty" : false,
2828
+ "allow-invalid" : false
2829
+ }
2830
+ }
2831
+ },
2832
+ "securitySchemes" : {
2833
+ "cookie-auth" : {
2834
+ "$ref" : "../common/Common.json#/components/securitySchemes/cookie-auth"
2835
+ },
2836
+ "org-oauth" : {
2837
+ "$ref" : "../common/Common.json#/components/securitySchemes/org-oauth"
2838
+ },
2839
+ "iam-oauth2-schema" : {
2840
+ "$ref" : "../common/Common.json#/components/securitySchemes/iam-oauth2-schema"
2841
+ }
2842
+ }
2843
+ },
2844
+ "x-entity" : "Backup"
2845
+ }