agent-generator 1.0.3 → 1.0.5

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